openapi3: improve ipv6 validation (#971)

AnatolyRugalev · web-flow · commit 42a2d80973ff · 2024-06-27T15:04:03.000+02:00
diff --git a/openapi3/schema_formats.go b/openapi3/schema_formats.go
@@ -2,9 +2,8 @@ package openapi3
 
 import (
 	"fmt"
-	"net"
+	"net/netip"
 	"regexp"
-	"strings"
 )
 
 const (
@@ -43,23 +42,15 @@ func DefineStringFormatCallback(name string, callback FormatCallback) {
 	SchemaStringFormats[name] = Format{callback: callback}
 }
 
-func validateIP(ip string) error {
-	parsed := net.ParseIP(ip)
-	if parsed == nil {
+func validateIPv4(ip string) error {
+	addr, err := netip.ParseAddr(ip)
+	if err != nil {
 		return &SchemaError{
 			Value:  ip,
 			Reason: "Not an IP address",
 		}
 	}
-	return nil
-}
-
-func validateIPv4(ip string) error {
-	if err := validateIP(ip); err != nil {
-		return err
-	}
-
-	if !(strings.Count(ip, ":") < 2) {
+	if !addr.Is4() {
 		return &SchemaError{
 			Value:  ip,
 			Reason: "Not an IPv4 address (it's IPv6)",
@@ -69,11 +60,15 @@ func validateIPv4(ip string) error {
 }
 
 func validateIPv6(ip string) error {
-	if err := validateIP(ip); err != nil {
-		return err
+	addr, err := netip.ParseAddr(ip)
+	if err != nil {
+		return &SchemaError{
+			Value:  ip,
+			Reason: "Not an IP address",
+			Origin: err,
+		}
 	}
-
-	if !(strings.Count(ip, ":") >= 2) {
+	if !addr.Is6() {
 		return &SchemaError{
 			Value:  ip,
 			Reason: "Not an IPv6 address (it's IPv4)",
diff --git a/openapi3/schema_formats_test.go b/openapi3/schema_formats_test.go
@@ -39,6 +39,7 @@ func TestIssue430(t *testing.T) {
 		"::FFFF:192.168.0.1": false,
 		// "[::FFFF:C0A8:1]:80" doesn't parse per net.ParseIP()
 		// "[::FFFF:C0A8:1%1]:80" doesn't parse per net.ParseIP()
+		"2001:db8::": false,
 	}
 
 	for datum := range data {
@@ -53,11 +54,11 @@ func TestIssue430(t *testing.T) {
 		err = schema.VisitJSON(datum)
 		require.NoError(t, err)
 		if isV4 {
-			require.Nil(t, validateIPv4(datum), "%q should be IPv4", datum)
-			require.NotNil(t, validateIPv6(datum), "%q should not be IPv6", datum)
+			assert.Nil(t, validateIPv4(datum), "%q should be IPv4", datum)
+			assert.NotNil(t, validateIPv6(datum), "%q should not be IPv6", datum)
 		} else {
-			require.NotNil(t, validateIPv4(datum), "%q should not be IPv4", datum)
-			require.Nil(t, validateIPv6(datum), "%q should be IPv6", datum)
+			assert.NotNil(t, validateIPv4(datum), "%q should not be IPv4", datum)
+			assert.Nil(t, validateIPv6(datum), "%q should be IPv6", datum)
 		}
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ func TestIssue430(t *testing.T) {`
`39`	`39`	`"::FFFF:192.168.0.1": false,`
`40`	`40`	`// "[::FFFF:C0A8:1]:80" doesn't parse per net.ParseIP()`
`41`	`41`	`// "[::FFFF:C0A8:1%1]:80" doesn't parse per net.ParseIP()`
	`42`	`+ "2001:db8::": false,`
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`for datum := range data {`
`@@ -53,11 +54,11 @@ func TestIssue430(t *testing.T) {`
`53`	`54`	`err = schema.VisitJSON(datum)`
`54`	`55`	`require.NoError(t, err)`
`55`	`56`	`if isV4 {`
`56`		`- require.Nil(t, validateIPv4(datum), "%q should be IPv4", datum)`
`57`		`- require.NotNil(t, validateIPv6(datum), "%q should not be IPv6", datum)`
	`57`	`+ assert.Nil(t, validateIPv4(datum), "%q should be IPv4", datum)`
	`58`	`+ assert.NotNil(t, validateIPv6(datum), "%q should not be IPv6", datum)`
`58`	`59`	`} else {`
`59`		`- require.NotNil(t, validateIPv4(datum), "%q should not be IPv4", datum)`
`60`		`- require.Nil(t, validateIPv6(datum), "%q should be IPv6", datum)`
	`60`	`+ assert.NotNil(t, validateIPv4(datum), "%q should not be IPv4", datum)`
	`61`	`+ assert.Nil(t, validateIPv6(datum), "%q should be IPv6", datum)`
`61`	`62`	`}`
`62`	`63`	`}`
`63`	`64`	`}`