database: PostgreSQL DSN breaks IPv6 hosts and Validate accepts out-of-range ports
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 67/100
Research direction
Locate PostgresConfig.DSN(), PostgresConfig.Validate(), MySQLConfig.Validate(), and the existing MySQLConfig.DSN() implementation in the database package. Read those methods and their tests first; the issue gives the IPv6 and port cases to cover. Done means PostgreSQL DSNs parse for the listed host forms, both validators reject ports below 0 or above 65535 while accepting 0, and the database tests pass.
Written by the indexing model from the issue text.
Description
Describe the Bug
PostgresConfig.DSN() builds an invalid URL when Host is an IPv6 address, and Validate() accepts any port.
- IPv6 hosts:
DSN()joins the host and port withfmt.Sprintf("%s:%d", c.Host, c.Port). ForHost: "::1", Port: 5432the URL host is::1:5432, which pgx rejects ("too many colons in address"), soNewfails. IPv4-mapped literals such as::ffff:10.0.0.1fail the same way.MySQLConfig.DSN()already usesnet.JoinHostPort, so only PostgreSQL is affected. - Out-of-range ports:
PostgresConfig.Validate()andMySQLConfig.Validate()don't checkPort, so a negative port or one above 65535 passes validation and fails later, at connect time, with a driver error. A port of 0 (omitted) is documented as "use the driver default" and is fine.
To Reproduce
cfg := database.PostgresConfig{
Host: "::1", Port: 5432, User: "postgres", Password: "secret",
Name: "app", SSLMode: "disable",
}
fmt.Println(cfg.Validate()) // <nil>
_, err := pgconn.ParseConfig(cfg.DSN())
fmt.Println(err)
// cannot parse `postgres://postgres:xxxxx@::1:5432/app?sslmode=disable`: failed to parse as URL
// (failed to split host:port in '::1:5432', err: address ::1:5432: too many colons in address)
cfg.Host, cfg.Port = "localhost", 70000
fmt.Println(cfg.Validate()) // <nil>
Expected Behavior
DSN()brackets IPv6 hosts, e.g.postgres://...@[::1]:5432/app, by usingnet.JoinHostPortasMySQLConfig.DSN()does. A host with no port that is an IPv6 literal is bracketed too ([::1]).Validate()for PostgreSQL and MySQL rejects ports below 0 or above 65535. 0 keeps meaning "driver default".- A test parses
DSN()withpgconn.ParseConfigfor a hostname, IPv4, IPv6, an IPv4-mapped IPv6 address, and an already-bracketed[::1], with and without a port.
Screenshots
N/A
Version
database/v0.3.0
Environment Details (with versions)
Go 1.26, pgx v5, PostgreSQL 16
Additional Context
Found while moving the OpenNDX Portal Backend onto this package (openndx/openndx-core#688). The PB's old hand-built keyword DSN accepted host=::1, so this is a small regression for OpenNDX deployments that use an IPv6 database address. OpenNDX will bump the dependency once a fix is released, rather than work around it in each service.
- Dominant language
- Go
- Stars
- 6
- Forks
- 8
- Avg merge
- 21h 36m
- Merged PRs (30d)
- 42
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenNSW/core
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
-
payment: test fixtures hardcode real gateway names (govpay/lankapay) instead of generic placeholdersOpen
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
nsw-sl cleanup Type/Improvement
Difficulty 3/5 1-2 days Newbie friendliness 48/100
Maintainers usually reply within 1 day
-
remote: let the host inject a logger, and log with one consistent policyPossibly taken @mushrafmim claimed this 5 days ago. OpenType/Improvement
Difficulty 4/5 3-5 days Newbie friendliness 22/100
Maintainers usually reply within 1 day
Similar issues
-
☢️ Bug v3
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
area/import-export area/projects concern/ux
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
go-vikunja/vikunja#4455 · 1 comment ·
Maintainers usually reply within 2 days
-
Dependabot PRs no longer merge automaticallyPossibly taken @dwisiswant0 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
projectdiscovery/urlfinder#160 ·
Maintainers usually reply within 1 day
-
database
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
chnm/legal-modernism#450 ·
Maintainers usually reply within 1 day
-
tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day