Skip to content

Commit 617caf2

Browse files
irenarindosirenarindos
authored
target(addr): add validation for ipv4, ipv6, and dns addr (#6038)
* target(addr): add validation for ipv4, ipv6, and dns addr
1 parent 74e41e0 commit 617caf2

File tree

2 files changed

+195
-1
lines changed

2 files changed

+195
-1
lines changed

‎internal/target/address.go‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ package target
55

66
import (
77
"context"
8+
"net"
9+
"regexp"
810
"strings"
911

1012
"github.com/hashicorp/boundary/internal/db"
@@ -31,6 +33,59 @@ var (
3133
_ oplog.ReplayableMessage = (*Address)(nil)
3234
)
3335

36+
var (
37+
labelRegex = regexp.MustCompile(`^[a-zA-Z0-9-]{1,63}$`)
38+
numbersRegex = regexp.MustCompile(`^\d+$`)
39+
)
40+
41+
// DNS names consists of at least one label joined together by a "."
42+
// Each label can consist of a-z 0-9 and "-" case insensitive
43+
// A label cannot start or end with a "-"
44+
// A label can be between 1 and 63 characters long
45+
// The final label in the dns name cannot be all numeric
46+
// See https://en.wikipedia.org/wiki/Domain_Name_System#Domain_name_syntax,_internationalization
47+
func isValidDnsName(name string) bool {
48+
// Trim any trailing dot, otherwise a name like "thing." will split to ["thing", ""] and return false for the empty label
49+
name = strings.Trim(name, ".")
50+
labels := strings.Split(name, ".")
51+
if len(labels) == 0 {
52+
return false
53+
}
54+
for i, label := range labels {
55+
if len(label) < 1 || len(label) > 63 {
56+
return false
57+
}
58+
if strings.HasPrefix(label, "-") || strings.HasSuffix(label, "-") {
59+
return false
60+
}
61+
if !labelRegex.MatchString(label) {
62+
return false
63+
}
64+
// Last label cannot be all numeric
65+
if i == len(labels)-1 {
66+
if numbersRegex.MatchString(label) {
67+
return false
68+
}
69+
}
70+
}
71+
return true
72+
}
73+
74+
// Current addresses supported are IPv4, IPv6 addresses
75+
// or DNS names. More may be supported in the future.
76+
func isValidAddress(address string) bool {
77+
// Try to split host and port
78+
_, _, splitErr := net.SplitHostPort(address)
79+
if splitErr == nil {
80+
return true
81+
}
82+
ip := net.ParseIP(address)
83+
if ip != nil {
84+
return true
85+
}
86+
return isValidDnsName(address)
87+
}
88+
3489
// NewAddress creates a new in memory address. No options are
3590
// currently supported.
3691
func NewAddress(ctx context.Context, targetId, address string, _ ...Option) (*Address, error) {
@@ -42,6 +97,9 @@ func NewAddress(ctx context.Context, targetId, address string, _ ...Option) (*Ad
4297
return nil, errors.New(ctx, errors.InvalidParameter, op, "missing address")
4398
}
4499
address = strings.TrimSpace(address)
100+
if !isValidAddress(address) {
101+
return nil, errors.New(ctx, errors.InvalidParameter, op, "invalid address")
102+
}
45103
t := &Address{
46104
TargetAddress: &store.TargetAddress{
47105
TargetId: targetId,

‎internal/target/address_ext_test.go‎

Lines changed: 137 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,104 @@ func TestAddress_New(t *testing.T) {
4040
wantErr: errors.InvalidParameter,
4141
},
4242
{
43-
name: "valid",
43+
name: "invalid-address-1",
44+
args: args{
45+
address: "-invalid.address",
46+
targetId: "targ_0000000",
47+
},
48+
wantErr: errors.InvalidParameter,
49+
},
50+
{
51+
name: "invalid-address-2",
52+
args: args{
53+
address: "invalid.1234",
54+
targetId: "targ_0000000",
55+
},
56+
wantErr: errors.InvalidParameter,
57+
},
58+
{
59+
name: "invalid-address-3",
60+
args: args{
61+
address: "invalid_address",
62+
targetId: "targ_0000000",
63+
},
64+
wantErr: errors.InvalidParameter,
65+
},
66+
{
67+
name: "invalid-address-4",
68+
args: args{
69+
address: "toolonglabeltoolonglabeltoolonglabeltoolonglabeltoolonglabeltoolonglabeltoolong.co",
70+
targetId: "targ_0000000",
71+
},
72+
wantErr: errors.InvalidParameter,
73+
},
74+
{
75+
name: "valid-dns-1",
76+
args: args{
77+
targetId: "targ_0000000",
78+
address: "valid.",
79+
},
80+
want: &target.Address{
81+
TargetAddress: &store.TargetAddress{
82+
TargetId: "targ_0000000",
83+
Address: "valid.",
84+
},
85+
},
86+
},
87+
{
88+
name: "valid-dns-2",
89+
args: args{
90+
targetId: "targ_0000000",
91+
address: "valid.address",
92+
},
93+
want: &target.Address{
94+
TargetAddress: &store.TargetAddress{
95+
TargetId: "targ_0000000",
96+
Address: "valid.address",
97+
},
98+
},
99+
},
100+
{
101+
name: "valid-dns-3",
102+
args: args{
103+
targetId: "targ_0000000",
104+
address: "valid-address",
105+
},
106+
want: &target.Address{
107+
TargetAddress: &store.TargetAddress{
108+
TargetId: "targ_0000000",
109+
Address: "valid-address",
110+
},
111+
},
112+
},
113+
{
114+
name: "valid-dns-4",
115+
args: args{
116+
targetId: "targ_0000000",
117+
address: "123-valid",
118+
},
119+
want: &target.Address{
120+
TargetAddress: &store.TargetAddress{
121+
TargetId: "targ_0000000",
122+
Address: "123-valid",
123+
},
124+
},
125+
},
126+
{
127+
name: "valid-dns-5",
128+
args: args{
129+
targetId: "targ_0000000",
130+
address: "xn--d1acufc.xn--p1ai",
131+
},
132+
want: &target.Address{
133+
TargetAddress: &store.TargetAddress{
134+
TargetId: "targ_0000000",
135+
Address: "xn--d1acufc.xn--p1ai",
136+
},
137+
},
138+
},
139+
{
140+
name: "valid-ipv4",
44141
args: args{
45142
targetId: "targ_0000000",
46143
address: "0.0.0.0",
@@ -52,6 +149,45 @@ func TestAddress_New(t *testing.T) {
52149
},
53150
},
54151
},
152+
{
153+
name: "valid-ipv4-port",
154+
args: args{
155+
targetId: "targ_0000000",
156+
address: "0.0.0.0:35",
157+
},
158+
want: &target.Address{
159+
TargetAddress: &store.TargetAddress{
160+
TargetId: "targ_0000000",
161+
Address: "0.0.0.0:35",
162+
},
163+
},
164+
},
165+
{
166+
name: "valid-ipv6",
167+
args: args{
168+
targetId: "targ_0000000",
169+
address: "0::0",
170+
},
171+
want: &target.Address{
172+
TargetAddress: &store.TargetAddress{
173+
TargetId: "targ_0000000",
174+
Address: "0::0",
175+
},
176+
},
177+
},
178+
{
179+
name: "valid-ipv6-port",
180+
args: args{
181+
targetId: "targ_0000000",
182+
address: "0::0:45",
183+
},
184+
want: &target.Address{
185+
TargetAddress: &store.TargetAddress{
186+
TargetId: "targ_0000000",
187+
Address: "0::0:45",
188+
},
189+
},
190+
},
55191
}
56192
for _, tt := range tests {
57193
tt := tt

0 commit comments

Comments
 (0)