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.

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

sort out possible mishandling of ipv4 vs v6 #431

Merged
merged 3 commits into from Oct 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions openapi3/schema_formats.go
Expand Up @@ -4,6 +4,7 @@ import (
"fmt"
"net"
"regexp"
"strings"
)

const (
Expand Down Expand Up @@ -37,38 +38,37 @@ func DefineStringFormatCallback(name string, callback FormatCallback) {
SchemaStringFormats[name] = Format{callback: callback}
}

func validateIP(ip string) (*net.IP, error) {
func validateIP(ip string) error {
parsed := net.ParseIP(ip)
if parsed == nil {
return nil, &SchemaError{
return &SchemaError{
Value: ip,
Reason: "Not an IP address",
}
}
return &parsed, nil
return nil
}

func validateIPv4(ip string) error {
parsed, err := validateIP(ip)
if err != nil {
if err := validateIP(ip); err != nil {
return err
}

if parsed.To4() == nil {
if !(strings.Count(ip, ":") < 2) {
return &SchemaError{
Value: ip,
Reason: "Not an IPv4 address (it's IPv6)",
}
}
return nil
}

func validateIPv6(ip string) error {
parsed, err := validateIP(ip)
if err != nil {
if err := validateIP(ip); err != nil {
return err
}

if parsed.To4() != nil {
if !(strings.Count(ip, ":") >= 2) {
return &SchemaError{
Value: ip,
Reason: "Not an IPv6 address (it's IPv4)",
Expand Down
57 changes: 57 additions & 0 deletions openapi3/schema_formats_test.go
@@ -0,0 +1,57 @@
package openapi3

import (
"context"
"testing"

"github.com/stretchr/testify/require"
)

func TestIssue430(t *testing.T) {
schema := NewOneOfSchema(
NewStringSchema().WithFormat("ipv4"),
NewStringSchema().WithFormat("ipv6"),
)

err := schema.Validate(context.Background())
require.NoError(t, err)

data := map[string]bool{
"127.0.1.1": true,

// https://stackoverflow.com/a/48519490/1418165

// v4
"192.168.0.1": true,
// "192.168.0.1:80" doesn't parse per net.ParseIP()

// v6
"::FFFF:C0A8:1": false,
"::FFFF:C0A8:0001": false,
"0000:0000:0000:0000:0000:FFFF:C0A8:1": false,
// "::FFFF:C0A8:1%1" doesn't parse per net.ParseIP()
"::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()
}

for datum := range data {
err = schema.VisitJSON(datum)
require.Error(t, err, ErrOneOfConflict.Error())
}

DefineIPv4Format()
DefineIPv6Format()

for datum, isV4 := range data {
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)
} else {
require.NotNil(t, validateIPv4(datum), "%q should not be IPv4", datum)
require.Nil(t, validateIPv6(datum), "%q should be IPv6", datum)
}
}
}