Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

openapi3: improve ipv6 validation #971

Merged
merged 1 commit into from
Jun 27, 2024
Merged

openapi3: improve ipv6 validation #971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions openapi3/schema_formats.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ package openapi3

import (
"fmt"
"net"
"net/netip"
"regexp"
"strings"
)

const (
Expand Down Expand Up @@ -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)",
Expand All @@ -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)",
Expand Down
9 changes: 5 additions & 4 deletions openapi3/schema_formats_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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)
}
}
}
Expand Down
Loading