Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 37 additions & 12 deletions client.go
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,35 @@ func getRequestedAddressFamily(
return proto.RequestedFamilyIPv4
}

// appendRequestedAddressFamilyOrReservation adds either RESERVATION-TOKEN or
// REQUESTED-ADDRESS-FAMILY to the provided setters slice, respecting mutual
// exclusivity rules from RFC 6156.
// The REQUESTED-ADDRESS-FAMILY attribute is
// only included when IPv6 is desired.
func appendRequestedAddressFamilyOrReservation(
setters []stun.Setter,
requestedFamily proto.RequestedAddressFamily,
reservationToken []byte,
) []stun.Setter {
// Clients MUST NOT include a REQUESTED-ADDRESS-FAMILY attribute in an
// Allocate request that contains a RESERVATION-TOKEN attribute.
// https://www.rfc-editor.org/rfc/rfc6156#section-4.1
if len(reservationToken) != 0 {
return append(setters, proto.ReservationToken(reservationToken))
}

// Only include the attribute when IPv6 is explicitly requested.
// This indirectly implied by the specification:
// If the REQUESTED-ADDRESS-FAMILY attribute is absent, the server MUST
// allocate an IPv4-relayed transport address for the TURN client.
// https://www.rfc-editor.org/rfc/rfc6156#section-4.2
if requestedFamily == proto.RequestedFamilyIPv6 {
return append(setters, requestedFamily)
}

return setters
}

// NewClient returns a new Client instance. listeningAddress is the address and port to listen on,
// default "0.0.0.0:0".
func NewClient(config *ClientConfig) (*Client, error) { //nolint:gocyclo,cyclop
Expand Down Expand Up @@ -341,12 +370,10 @@ func (c *Client) sendAllocateRequest(protocol proto.Protocol) ( //nolint:cyclop
proto.RequestedTransport{Protocol: protocol},
stun.Fingerprint,
}
// RFC 6156: REQUESTED-ADDRESS-FAMILY and RESERVATION-TOKEN are mutually exclusive.
if len(c.reservationToken) != 0 {
allocationSetters = append(allocationSetters, proto.ReservationToken(c.reservationToken))
} else {
allocationSetters = append(allocationSetters, c.requestedAddressFamily)
}

allocationSetters = appendRequestedAddressFamilyOrReservation(
allocationSetters, c.requestedAddressFamily, c.reservationToken,
)
if c.evenPort {
allocationSetters = append(allocationSetters, proto.EvenPort{ReservePort: true})
}
Expand Down Expand Up @@ -385,12 +412,10 @@ func (c *Client) sendAllocateRequest(protocol proto.Protocol) ( //nolint:cyclop
&c.integrity,
stun.Fingerprint,
}
// RFC 6156: REQUESTED-ADDRESS-FAMILY and RESERVATION-TOKEN are mutually exclusive.
if len(c.reservationToken) != 0 {
allocationSetters = append(allocationSetters, proto.ReservationToken(c.reservationToken))
} else {
allocationSetters = append(allocationSetters, c.requestedAddressFamily)
}

allocationSetters = appendRequestedAddressFamilyOrReservation(
allocationSetters, c.requestedAddressFamily, c.reservationToken,
)
if c.evenPort {
allocationSetters = append(allocationSetters, proto.EvenPort{ReservePort: true})
}
Expand Down
47 changes: 47 additions & 0 deletions client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -793,6 +793,53 @@ func TestGetRequestedAddressFamily(t *testing.T) {
})
}

func TestAppendRequestedAddressFamilyOrReservation(t *testing.T) {
t.Run("IPv4 omits attribute", func(t *testing.T) {
setters := appendRequestedAddressFamilyOrReservation(
[]stun.Setter{stun.TransactionID, stun.NewType(stun.MethodAllocate, stun.ClassRequest)},
proto.RequestedFamilyIPv4,
nil,
)

msg, err := stun.Build(setters...)
require.NoError(t, err)

assert.False(t, msg.Contains(stun.AttrRequestedAddressFamily))
})

t.Run("IPv6 includes attribute", func(t *testing.T) {
setters := appendRequestedAddressFamilyOrReservation(
[]stun.Setter{stun.TransactionID, stun.NewType(stun.MethodAllocate, stun.ClassRequest)},
proto.RequestedFamilyIPv6,
nil,
)

msg, err := stun.Build(setters...)
require.NoError(t, err)

var raf proto.RequestedAddressFamily
require.NoError(t, raf.GetFrom(msg))
assert.Equal(t, proto.RequestedFamilyIPv6, raf)
})

t.Run("Reservation token takes precedence", func(t *testing.T) {
token := proto.ReservationToken{1, 2, 3, 4, 5, 6, 7, 8}
setters := appendRequestedAddressFamilyOrReservation(
[]stun.Setter{stun.TransactionID, stun.NewType(stun.MethodAllocate, stun.ClassRequest)},
proto.RequestedFamilyIPv6,
token,
)

msg, err := stun.Build(setters...)
require.NoError(t, err)

var parsedToken proto.ReservationToken
require.NoError(t, parsedToken.GetFrom(msg))
assert.Equal(t, token, parsedToken)
assert.False(t, msg.Contains(stun.AttrRequestedAddressFamily))
})
}

type channelBindFilterConn struct {
net.PacketConn

Expand Down
Loading