Skip to content

Commit 14aea2f

Browse files
fix: tighten format email and uri validation (#1068)
Co-authored-by: AgentSmithClaw <[email protected]>
1 parent bba0d54 commit 14aea2f

3 files changed

Lines changed: 70 additions & 4 deletions

File tree

‎validate.go‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,16 @@ func validateFormat(path *PathBuffer, str string, s *Schema, res *ValidateResult
239239
res.Add(path, str, validation.MsgExpectedRFC3339Time)
240240
}
241241
case "email", "idn-email":
242-
if _, err := mail.ParseAddress(str); err != nil {
243-
res.Add(path, str, ErrorFormatter(validation.MsgExpectedRFC5322Email, err))
242+
// mail.ParseAddress accepts full mailbox forms ("Name <addr>"). OpenAPI
243+
// format "email" is documented as an addr-spec; require a bare address
244+
// with no display name so validation matches the RFC-oriented error text.
245+
addr, err := mail.ParseAddress(str)
246+
if err != nil || addr.Name != "" || addr.Address == "" || strings.TrimSpace(str) != addr.Address {
247+
msg := validation.MsgExpectedRFC5322EmailBare
248+
if err != nil {
249+
msg = ErrorFormatter(validation.MsgExpectedRFC5322Email, err)
250+
}
251+
res.Add(path, str, msg)
244252
}
245253
case "idn-hostname", "hostname":
246254
if len(str) >= 256 || !rxHostname.MatchString(str) {
@@ -268,11 +276,20 @@ func validateFormat(path *PathBuffer, str string, s *Schema, res *ValidateResult
268276
// if _, err := idnaProfile.ToASCII(str); err != nil {
269277
// res.Add(path, str, validation.MsgExpectedRFC5890Hostname)
270278
// }
271-
case "uri", "uri-reference", "iri", "iri-reference":
279+
case "uri", "iri":
280+
// format "uri"/"iri" require an absolute URI (non-empty scheme). Bare
281+
// url.Parse accepts empty strings, path-only values, and other relative
282+
// references that are only valid for uri-reference / iri-reference.
283+
u, err := url.Parse(str)
284+
if err != nil {
285+
res.Add(path, str, ErrorFormatter(validation.MsgExpectedRFC3986URI, err))
286+
} else if str == "" || u.Scheme == "" {
287+
res.Add(path, str, validation.MsgExpectedRFC3986AbsoluteURI)
288+
}
289+
case "uri-reference", "iri-reference":
272290
if _, err := url.Parse(str); err != nil {
273291
res.Add(path, str, ErrorFormatter(validation.MsgExpectedRFC3986URI, err))
274292
}
275-
// TODO: check if it's actually a reference?
276293
case "uri-template":
277294
u, err := url.Parse(str)
278295
if err != nil {

‎validate_test.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,22 @@ var validateTests = []struct {
395395
input: map[string]any{"value": "alice"},
396396
errs: []string{"expected string to be RFC 5322 email: mail: missing '@' or angle-addr"},
397397
},
398+
{
399+
name: "expected email bare addr-spec rejects mailbox with display name",
400+
typ: reflect.TypeFor[struct {
401+
Value string "json:\"value\" format:\"email\""
402+
}](),
403+
input: map[string]any{"value": "Alice <[email protected]>"},
404+
errs: []string{"expected string to be RFC 5322 email (addr-spec only, no display name)"},
405+
},
406+
{
407+
name: "expected idn-email bare addr-spec rejects mailbox with display name",
408+
typ: reflect.TypeFor[struct {
409+
Value string "json:\"value\" format:\"idn-email\""
410+
}](),
411+
input: map[string]any{"value": "Name <[email protected]>"},
412+
errs: []string{"expected string to be RFC 5322 email (addr-spec only, no display name)"},
413+
},
398414
{
399415
name: "hostname success",
400416
typ: reflect.TypeFor[struct {
@@ -477,6 +493,37 @@ var validateTests = []struct {
477493
input: map[string]any{"value": ":"},
478494
errs: []string{"expected string to be RFC 3986 uri: parse \":\": missing protocol scheme"},
479495
},
496+
{
497+
name: "expected uri absolute rejects empty string",
498+
typ: reflect.TypeFor[struct {
499+
Value string "json:\"value\" format:\"uri\""
500+
}](),
501+
input: map[string]any{"value": ""},
502+
errs: []string{"expected string to be RFC 3986 absolute uri (non-empty scheme)"},
503+
},
504+
{
505+
name: "expected uri absolute rejects path-only reference",
506+
typ: reflect.TypeFor[struct {
507+
Value string "json:\"value\" format:\"uri\""
508+
}](),
509+
input: map[string]any{"value": "/relative"},
510+
errs: []string{"expected string to be RFC 3986 absolute uri (non-empty scheme)"},
511+
},
512+
{
513+
name: "expected uri absolute rejects scheme-less token",
514+
typ: reflect.TypeFor[struct {
515+
Value string "json:\"value\" format:\"uri\""
516+
}](),
517+
input: map[string]any{"value": "foo"},
518+
errs: []string{"expected string to be RFC 3986 absolute uri (non-empty scheme)"},
519+
},
520+
{
521+
name: "uri-reference allows relative path",
522+
typ: reflect.TypeFor[struct {
523+
Value string "json:\"value\" format:\"uri-reference\""
524+
}](),
525+
input: map[string]any{"value": "/relative"},
526+
},
480527
{
481528
name: "uuid success",
482529
typ: reflect.TypeFor[struct {

‎validation/messages.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ var (
88
MsgExpectedRFC3339Date = "expected string to be RFC 3339 date"
99
MsgExpectedRFC3339Time = "expected string to be RFC 3339 time"
1010
MsgExpectedRFC5322Email = "expected string to be RFC 5322 email: %v"
11+
MsgExpectedRFC5322EmailBare = "expected string to be RFC 5322 email (addr-spec only, no display name)"
1112
MsgExpectedRFC5890Hostname = "expected string to be RFC 5890 hostname"
1213
MsgExpectedRFC2673IPv4 = "expected string to be RFC 2673 ipv4"
1314
MsgExpectedRFC2373IPv6 = "expected string to be RFC 2373 ipv6"
1415
MsgExpectedRFCIPAddr = "expected string to be either RFC 2673 ipv4 or RFC 2373 ipv6"
1516
MsgExpectedRFC3986URI = "expected string to be RFC 3986 uri: %v"
17+
MsgExpectedRFC3986AbsoluteURI = "expected string to be RFC 3986 absolute uri (non-empty scheme)"
1618
MsgExpectedRFC4122UUID = "expected string to be RFC 4122 uuid: %v"
1719
MsgExpectedRFC6570URITemplate = "expected string to be RFC 6570 uri-template"
1820
MsgExpectedRFC6901JSONPointer = "expected string to be RFC 6901 json-pointer"

0 commit comments

Comments
 (0)