Merge pull request #792 from costela/add-support-for-dualstack-ip-parsing

proposal: extend netip.Addr support to ipv6

Author: wolveix

docs/docs/features/request-inputs.md

@@ -107,7 +107,7 @@ The following special types are supported out of the box:
 | `time.Time`       | `{"type": "string", "format": "date-time"}` | `"2020-01-01T12:00:00Z"`      |
 | `url.URL`         | `{"type": "string", "format": "uri"}`       | `"https://example.com"`       |
 | `net.IP`          | `{"type": "string", "format": "ipv4"}`      | `"127.0.0.1"`                 |
-| `netip.Addr`      | `{"type": "string", "format": "ipv4"}`      | `"127.0.0.1"`                 |
+| `netip.Addr`      | `{"type": "string", "format": "ip"}`        | `"127.0.0.1"` or `fe80::1`    |
 | `json.RawMessage` | `{}`                                        | `["whatever", "you", "want"]` |
 
 You can override this default behavior if needed as described in [Schema Customization](./schema-customization.md) and [Request Validation](./request-validation.md), e.g. setting a custom `format` tag for IPv6.

schema.go

@@ -750,7 +750,7 @@ func schemaFromType(r Registry, t reflect.Type) *Schema {
 	case ipType:
 		return &Schema{Type: TypeString, Nullable: isPointer, Format: "ipv4"}
 	case ipAddrType:
-		return &Schema{Type: TypeString, Nullable: isPointer, Format: "ipv4"}
+		return &Schema{Type: TypeString, Nullable: isPointer, Format: "ip"}
 	case rawMessageType:
 		return &Schema{}
 	}

schema_test.go

@@ -190,7 +190,7 @@ func TestSchema(t *testing.T) {
 		{
 			name:     "ipAddr",
 			input:    netip.AddrFrom4([4]byte{127, 0, 0, 1}),
-			expected: `{"type": "string", "format": "ipv4"}`,
+			expected: `{"type": "string", "format": "ip"}`,
 		},
 		{
 			name:     "json.RawMessage",

validate.go

@@ -4,8 +4,8 @@ import (
 	"errors"
 	"fmt"
 	"math"
-	"net"
 	"net/mail"
+	"net/netip"
 	"net/url"
 	"reflect"
 	"regexp"
@@ -249,18 +249,27 @@ func validateFormat(path *PathBuffer, str string, s *Schema, res *ValidateResult
 		if len(str) >= 256 || !rxHostname.MatchString(str) {
 			res.Add(path, str, validation.MsgExpectedRFC5890Hostname)
 		}
+	case "ipv4", "ipv6", "ip":
+		addr, err := netip.ParseAddr(str)
+
+		switch s.Format {
+		case "ipv4":
+			if err != nil || !addr.Is4() {
+				res.Add(path, str, validation.MsgExpectedRFC2673IPv4)
+			}
+		case "ipv6":
+			if err != nil || !addr.Is6() || addr.Is4In6() {
+				res.Add(path, str, validation.MsgExpectedRFC2373IPv6)
+			}
+		default: // case "ip".
+			if err != nil {
+				res.Add(path, str, validation.MsgExpectedRFCIPAddr)
+			}
+		}
 	case "idn-hostname":
 		if _, err := idnaProfile.ToASCII(str); err != nil {
 			res.Add(path, str, validation.MsgExpectedRFC5890Hostname)
 		}
-	case "ipv4":
-		if ip := net.ParseIP(str); ip == nil || ip.To4() == nil {
-			res.Add(path, str, validation.MsgExpectedRFC2673IPv4)
-		}
-	case "ipv6":
-		if ip := net.ParseIP(str); ip == nil || ip.To16() == nil {
-			res.Add(path, str, validation.MsgExpectedRFC2373IPv6)
-		}
 	case "uri", "uri-reference", "iri", "iri-reference":
 		if _, err := url.Parse(str); err != nil {
 			res.Add(path, str, ErrorFormatter(validation.MsgExpectedRFC3986URI, err))

validate_test.go

@@ -456,6 +456,28 @@ var validateTests = []struct {
 		input: map[string]any{"value": "1234"},
 		errs:  []string{"expected string to be RFC 2373 ipv6"},
 	},
+	{
+		name: "ipv4 success",
+		typ: reflect.TypeOf(struct {
+			Value string `json:"value" format:"ip"`
+		}{}),
+		input: map[string]any{"value": "127.0.0.1"},
+	},
+	{
+		name: "ipv6 success",
+		typ: reflect.TypeOf(struct {
+			Value string `json:"value" format:"ip"`
+		}{}),
+		input: map[string]any{"value": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"},
+	},
+	{
+		name: "expected ipv4 or ipv6",
+		typ: reflect.TypeOf(struct {
+			Value string `json:"value" format:"ip"`
+		}{}),
+		input: map[string]any{"value": "1234"},
+		errs:  []string{"expected string to be either RFC 2673 ipv4 or RFC 2373 ipv6"},
+	},
 	{
 		name: "uri success",
 		typ: reflect.TypeFor[struct {

validation/messages.go

@@ -11,6 +11,7 @@ var (
 	MsgExpectedRFC5890Hostname            = "expected string to be RFC 5890 hostname"
 	MsgExpectedRFC2673IPv4                = "expected string to be RFC 2673 ipv4"
 	MsgExpectedRFC2373IPv6                = "expected string to be RFC 2373 ipv6"
+	MsgExpectedRFCIPAddr                  = "expected string to be either RFC 2673 ipv4 or RFC 2373 ipv6"
 	MsgExpectedRFC3986URI                 = "expected string to be RFC 3986 uri: %v"
 	MsgExpectedRFC4122UUID                = "expected string to be RFC 4122 uuid: %v"
 	MsgExpectedRFC6570URITemplate         = "expected string to be RFC 6570 uri-template"