mirror of
https://github.com/slackhq/nebula.git
synced 2026-11-16 12:36:52 +01:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c914ea30ed |
No files matched your search
@@ -7,23 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
### Changed
|
|
||||||
|
|
||||||
- Firewall rules are held as a flat list with a bitset of rule ids per port, instead of a tree of maps copied
|
|
||||||
into every port of a range. A rule like `port: 1024-65535` now costs kilobytes rather than tens of megabytes,
|
|
||||||
and matching is faster on every path.
|
|
||||||
- A firewall rule's `proto` can be `udplite`, `dccp`, `sctp`, `icmpv6`, or any IP protocol number. A rule with
|
|
||||||
a port or port range on a protocol that has no ports, such as `proto: 47`, is rejected rather than silently
|
|
||||||
never matching. `port: any` and `port: fragment` apply to every protocol.
|
|
||||||
- An ICMP non-first fragment is matched against `port: fragment` rules like a fragment of any other protocol.
|
|
||||||
It was only matched against `port: any` rules before.
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
|
|
||||||
- A firewall rule with `group: []`, `groups:` with no value, or a `groups` entry that isn't a string, such as
|
|
||||||
`groups: [1, 2]`, no longer crashes Nebula on startup or reload. An empty `group` array is rejected, a null
|
|
||||||
`groups` means no groups, and non-string entries are read as strings.
|
|
||||||
|
|
||||||
## [1.11.1] - 2026-08-21
|
## [1.11.1] - 2026-08-21
|
||||||
|
|
||||||
See the [v1.11.1](https://github.com/slackhq/nebula/milestone/30?closed=1) milestone for a complete list of changes.
|
See the [v1.11.1](https://github.com/slackhq/nebula/milestone/30?closed=1) milestone for a complete list of changes.
|
||||||
|
|||||||
+1
-6
@@ -449,9 +449,7 @@ firewall:
|
|||||||
#default_local_cidr_any: false
|
#default_local_cidr_any: false
|
||||||
|
|
||||||
conntrack:
|
conntrack:
|
||||||
# tcp_timeout also applies to sctp and dccp
|
|
||||||
tcp_timeout: 12m
|
tcp_timeout: 12m
|
||||||
# udp_timeout also applies to udplite
|
|
||||||
udp_timeout: 3m
|
udp_timeout: 3m
|
||||||
default_timeout: 10m
|
default_timeout: 10m
|
||||||
|
|
||||||
@@ -459,11 +457,8 @@ firewall:
|
|||||||
# Rules are comprised of a protocol, port, and one or more of host, group, or CIDR
|
# Rules are comprised of a protocol, port, and one or more of host, group, or CIDR
|
||||||
# Logical evaluation is roughly: port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND (local cidr)
|
# Logical evaluation is roughly: port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND (local cidr)
|
||||||
# - port: Takes `0` or `any` as any, a single number `80`, a range `200-901`, or `fragment` to match second and further fragments of fragmented packets (since there is no port available).
|
# - port: Takes `0` or `any` as any, a single number `80`, a range `200-901`, or `fragment` to match second and further fragments of fragmented packets (since there is no port available).
|
||||||
# proto: `any`, `tcp`, `udp`, `udplite`, `dccp`, `sctp`, `icmp`, or any other IP protocol number from 1 to 255, ie `47` for gre
|
# proto: `any`, `tcp`, `udp`, or `icmp`
|
||||||
# a port specification is ignored if proto is `icmp`
|
# a port specification is ignored if proto is `icmp`
|
||||||
# `icmp`, `1`, and `58` are the same, each matches both ICMP and ICMPv6
|
|
||||||
# Nebula only reads ports from tcp, udp, udplite, dccp, and sctp, so a proto `any` rule with a specific port or range only matches those protocols.
|
|
||||||
# Rules for other protocols (gre, esp, etc) need port `any`.
|
|
||||||
# host: `any` or a literal hostname, ie `test-host`
|
# host: `any` or a literal hostname, ie `test-host`
|
||||||
# group: `any` or a literal group name, ie `default-group`
|
# group: `any` or a literal group name, ie `default-group`
|
||||||
# groups: Same as group but accepts a list of values. Multiple values are AND'd together and a certificate would have to contain all groups to pass
|
# groups: Same as group but accepts a list of values. Multiple values are AND'd together and a certificate would have to contain all groups to pass
|
||||||
|
|||||||
+758
-39
@@ -2,10 +2,17 @@ package nebula
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"hash/fnv"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"reflect"
|
||||||
|
"slices"
|
||||||
"strconv"
|
"strconv"
|
||||||
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -17,6 +24,10 @@ import (
|
|||||||
"github.com/slackhq/nebula/iputil"
|
"github.com/slackhq/nebula/iputil"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
type FirewallInterface interface {
|
||||||
|
AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr string, caName string, caSha string) error
|
||||||
|
}
|
||||||
|
|
||||||
type conn struct {
|
type conn struct {
|
||||||
Expires time.Time // Time when this conntrack entry will expire
|
Expires time.Time // Time when this conntrack entry will expire
|
||||||
|
|
||||||
@@ -31,7 +42,8 @@ type conn struct {
|
|||||||
type Firewall struct {
|
type Firewall struct {
|
||||||
Conntrack *FirewallConntrack
|
Conntrack *FirewallConntrack
|
||||||
|
|
||||||
rules firewall.Rules
|
InRules *FirewallTable
|
||||||
|
OutRules *FirewallTable
|
||||||
|
|
||||||
InboundSendReject bool
|
InboundSendReject bool
|
||||||
OutboundSendReject bool
|
OutboundSendReject bool
|
||||||
@@ -51,10 +63,12 @@ type Firewall struct {
|
|||||||
// unsafeNetworks is the list of unsafe networks issued to us in the certificate
|
// unsafeNetworks is the list of unsafe networks issued to us in the certificate
|
||||||
unsafeNetworks []netip.Prefix
|
unsafeNetworks []netip.Prefix
|
||||||
|
|
||||||
|
rules string
|
||||||
rulesVersion uint16
|
rulesVersion uint16
|
||||||
|
|
||||||
incomingMetrics firewallMetrics
|
defaultLocalCIDRAny bool
|
||||||
outgoingMetrics firewallMetrics
|
incomingMetrics firewallMetrics
|
||||||
|
outgoingMetrics firewallMetrics
|
||||||
|
|
||||||
l *slog.Logger
|
l *slog.Logger
|
||||||
}
|
}
|
||||||
@@ -72,6 +86,52 @@ type FirewallConntrack struct {
|
|||||||
TimerWheel *TimerWheel[firewall.Packet]
|
TimerWheel *TimerWheel[firewall.Packet]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// FirewallTable is the entry point for a rule, the evaluation order is:
|
||||||
|
// Proto AND port AND (CA SHA or CA name) AND local CIDR AND (group OR groups OR name OR remote CIDR)
|
||||||
|
type FirewallTable struct {
|
||||||
|
TCP firewallPort
|
||||||
|
UDP firewallPort
|
||||||
|
ICMP firewallPort
|
||||||
|
AnyProto firewallPort
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFirewallTable() *FirewallTable {
|
||||||
|
return &FirewallTable{
|
||||||
|
TCP: firewallPort{},
|
||||||
|
UDP: firewallPort{},
|
||||||
|
ICMP: firewallPort{},
|
||||||
|
AnyProto: firewallPort{},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type FirewallCA struct {
|
||||||
|
Any *FirewallRule
|
||||||
|
CANames map[string]*FirewallRule
|
||||||
|
CAShas map[string]*FirewallRule
|
||||||
|
}
|
||||||
|
|
||||||
|
type FirewallRule struct {
|
||||||
|
// Any makes Hosts, Groups, and CIDR irrelevant
|
||||||
|
Any *firewallLocalCIDR
|
||||||
|
Hosts map[string]*firewallLocalCIDR
|
||||||
|
Groups []*firewallGroups
|
||||||
|
CIDR *bart.Table[*firewallLocalCIDR]
|
||||||
|
}
|
||||||
|
|
||||||
|
type firewallGroups struct {
|
||||||
|
Groups []string
|
||||||
|
LocalCIDR *firewallLocalCIDR
|
||||||
|
}
|
||||||
|
|
||||||
|
// Even though ports are uint16, int32 maps are faster for lookup
|
||||||
|
// Plus we can use `-1` for fragment rules
|
||||||
|
type firewallPort map[int32]*FirewallCA
|
||||||
|
|
||||||
|
type firewallLocalCIDR struct {
|
||||||
|
Any bool
|
||||||
|
LocalCIDR *bart.Lite
|
||||||
|
}
|
||||||
|
|
||||||
// NewFirewall creates a new Firewall object. A TimerWheel is created for you from the provided timeouts.
|
// NewFirewall creates a new Firewall object. A TimerWheel is created for you from the provided timeouts.
|
||||||
// The certificate provided should be the highest version loaded in memory.
|
// The certificate provided should be the highest version loaded in memory.
|
||||||
func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Duration, c cert.Certificate) *Firewall {
|
func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Duration, c cert.Certificate) *Firewall {
|
||||||
@@ -110,8 +170,8 @@ func NewFirewall(l *slog.Logger, tcpTimeout, UDPTimeout, defaultTimeout time.Dur
|
|||||||
Conns: make(map[firewall.Packet]*conn),
|
Conns: make(map[firewall.Packet]*conn),
|
||||||
TimerWheel: NewTimerWheel[firewall.Packet](tmin, tmax),
|
TimerWheel: NewTimerWheel[firewall.Packet](tmin, tmax),
|
||||||
},
|
},
|
||||||
// Nothing is allowed until there are rules
|
InRules: newFirewallTable(),
|
||||||
rules: firewall.NewRulesBuilder(l).Build(assignedNetworks, unsafeNetworks),
|
OutRules: newFirewallTable(),
|
||||||
TCPTimeout: tcpTimeout,
|
TCPTimeout: tcpTimeout,
|
||||||
UDPTimeout: UDPTimeout,
|
UDPTimeout: UDPTimeout,
|
||||||
DefaultTimeout: defaultTimeout,
|
DefaultTimeout: defaultTimeout,
|
||||||
@@ -152,6 +212,8 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
|||||||
//TODO: max_connections
|
//TODO: max_connections
|
||||||
)
|
)
|
||||||
|
|
||||||
|
fw.defaultLocalCIDRAny = c.GetBool("firewall.default_local_cidr_any", false)
|
||||||
|
|
||||||
inboundAction := c.GetString("firewall.inbound_action", "drop")
|
inboundAction := c.GetString("firewall.inbound_action", "drop")
|
||||||
switch inboundAction {
|
switch inboundAction {
|
||||||
case "reject":
|
case "reject":
|
||||||
@@ -174,23 +236,80 @@ func NewFirewallFromConfig(l *slog.Logger, cs *CertState, c *config.C) (*Firewal
|
|||||||
fw.OutboundSendReject = false
|
fw.OutboundSendReject = false
|
||||||
}
|
}
|
||||||
|
|
||||||
rules, err := firewall.RulesFromConfig(l, c, fw.assignedNetworks, fw.unsafeNetworks)
|
err := AddFirewallRulesFromConfig(l, false, c, fw)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
err = AddFirewallRulesFromConfig(l, true, c, fw)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
fw.rules = rules
|
|
||||||
|
|
||||||
return fw, nil
|
return fw, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AddRule properly creates the in memory rule structure for a firewall table.
|
||||||
|
func (f *Firewall) AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr, caName string, caSha string) error {
|
||||||
|
var (
|
||||||
|
ft *FirewallTable
|
||||||
|
fp firewallPort
|
||||||
|
)
|
||||||
|
|
||||||
|
if incoming {
|
||||||
|
ft = f.InRules
|
||||||
|
} else {
|
||||||
|
ft = f.OutRules
|
||||||
|
}
|
||||||
|
|
||||||
|
switch proto {
|
||||||
|
case iputil.IPProtocolTCP:
|
||||||
|
fp = ft.TCP
|
||||||
|
case iputil.IPProtocolUDP:
|
||||||
|
fp = ft.UDP
|
||||||
|
case iputil.IPProtocolICMP, iputil.IPProtocolICMPv6:
|
||||||
|
//ICMP traffic doesn't have ports, so we always coerce to "any", even if a value is provided
|
||||||
|
if startPort != firewall.PortAny {
|
||||||
|
f.l.Warn("ignoring port specification for ICMP firewall rule", "startPort", startPort)
|
||||||
|
}
|
||||||
|
startPort = firewall.PortAny
|
||||||
|
endPort = firewall.PortAny
|
||||||
|
fp = ft.ICMP
|
||||||
|
case firewall.ProtoAny:
|
||||||
|
fp = ft.AnyProto
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("unknown protocol %v", proto)
|
||||||
|
}
|
||||||
|
|
||||||
|
// We need this rule string because we generate a hash. Removing this will break firewall reload.
|
||||||
|
ruleString := fmt.Sprintf(
|
||||||
|
"incoming: %v, proto: %v, startPort: %v, endPort: %v, groups: %v, host: %v, ip: %v, localIp: %v, caName: %v, caSha: %s",
|
||||||
|
incoming, proto, startPort, endPort, groups, host, cidr, localCidr, caName, caSha,
|
||||||
|
)
|
||||||
|
f.rules += ruleString + "\n"
|
||||||
|
|
||||||
|
direction := "incoming"
|
||||||
|
if !incoming {
|
||||||
|
direction = "outgoing"
|
||||||
|
}
|
||||||
|
f.l.Info("Firewall rule added",
|
||||||
|
"firewallRule", m{"direction": direction, "proto": proto, "startPort": startPort, "endPort": endPort, "groups": groups, "host": host, "cidr": cidr, "localCidr": localCidr, "caName": caName, "caSha": caSha},
|
||||||
|
)
|
||||||
|
|
||||||
|
return fp.addRule(f, startPort, endPort, groups, host, cidr, localCidr, caName, caSha)
|
||||||
|
}
|
||||||
|
|
||||||
// GetRuleHash returns a hash representation of all inbound and outbound rules
|
// GetRuleHash returns a hash representation of all inbound and outbound rules
|
||||||
func (f *Firewall) GetRuleHash() string {
|
func (f *Firewall) GetRuleHash() string {
|
||||||
return f.rules.Hash
|
sum := sha256.Sum256([]byte(f.rules))
|
||||||
|
return hex.EncodeToString(sum[:])
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetRuleHashFNV returns a uint32 FNV-1 hash representation the rules, for use as a metric value
|
// GetRuleHashFNV returns a uint32 FNV-1 hash representation the rules, for use as a metric value
|
||||||
func (f *Firewall) GetRuleHashFNV() uint32 {
|
func (f *Firewall) GetRuleHashFNV() uint32 {
|
||||||
return f.rules.HashFNV
|
h := fnv.New32a()
|
||||||
|
h.Write([]byte(f.rules))
|
||||||
|
return h.Sum32()
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetRuleHashes returns both the sha256 and FNV-1 hashes, suitable for logging
|
// GetRuleHashes returns both the sha256 and FNV-1 hashes, suitable for logging
|
||||||
@@ -198,6 +317,104 @@ func (f *Firewall) GetRuleHashes() string {
|
|||||||
return "SHA:" + f.GetRuleHash() + ",FNV:" + strconv.FormatUint(uint64(f.GetRuleHashFNV()), 10)
|
return "SHA:" + f.GetRuleHash() + ",FNV:" + strconv.FormatUint(uint64(f.GetRuleHashFNV()), 10)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func AddFirewallRulesFromConfig(l *slog.Logger, inbound bool, c *config.C, fw FirewallInterface) error {
|
||||||
|
var table string
|
||||||
|
if inbound {
|
||||||
|
table = "firewall.inbound"
|
||||||
|
} else {
|
||||||
|
table = "firewall.outbound"
|
||||||
|
}
|
||||||
|
|
||||||
|
r := c.Get(table)
|
||||||
|
if r == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
rs, ok := r.([]any)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("%s failed to parse, should be an array of rules", table)
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, t := range rs {
|
||||||
|
r, err := convertRule(l, t, table, i)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; %s", table, i, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Code != "" && r.Port != "" {
|
||||||
|
return fmt.Errorf("%s rule #%v; only one of port or code should be provided", table, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Host == "" && len(r.Groups) == 0 && r.Cidr == "" && r.LocalCidr == "" && r.CAName == "" && r.CASha == "" {
|
||||||
|
return fmt.Errorf("%s rule #%v; at least one of host, group, cidr, local_cidr, ca_name, or ca_sha must be provided", table, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
var sPort, errPort string
|
||||||
|
if r.Code != "" {
|
||||||
|
errPort = "code"
|
||||||
|
sPort = r.Code
|
||||||
|
} else {
|
||||||
|
errPort = "port"
|
||||||
|
sPort = r.Port
|
||||||
|
}
|
||||||
|
|
||||||
|
var proto uint8
|
||||||
|
var startPort, endPort int32
|
||||||
|
switch r.Proto {
|
||||||
|
case "any":
|
||||||
|
proto = firewall.ProtoAny
|
||||||
|
startPort, endPort, err = parsePort(sPort)
|
||||||
|
case "tcp":
|
||||||
|
proto = iputil.IPProtocolTCP
|
||||||
|
startPort, endPort, err = parsePort(sPort)
|
||||||
|
case "udp":
|
||||||
|
proto = iputil.IPProtocolUDP
|
||||||
|
startPort, endPort, err = parsePort(sPort)
|
||||||
|
case "icmp":
|
||||||
|
proto = iputil.IPProtocolICMP
|
||||||
|
startPort = firewall.PortAny
|
||||||
|
endPort = firewall.PortAny
|
||||||
|
if sPort != "" {
|
||||||
|
l.Warn("ignoring port specification for ICMP firewall rule", "port", sPort)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("%s rule #%v; proto was not understood; `%s`", table, i, r.Proto)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; %s %s", table, i, errPort, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Cidr != "" && r.Cidr != "any" {
|
||||||
|
_, err = netip.ParsePrefix(r.Cidr)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; cidr did not parse; %s", table, i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.LocalCidr != "" && r.LocalCidr != "any" {
|
||||||
|
_, err = netip.ParsePrefix(r.LocalCidr)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; local_cidr did not parse; %s", table, i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if warning := r.sanity(); warning != nil {
|
||||||
|
l.Warn("firewall rule sanity check",
|
||||||
|
"table", table,
|
||||||
|
"rule", i,
|
||||||
|
"warning", warning,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = fw.AddRule(inbound, proto, startPort, endPort, r.Groups, r.Host, r.Cidr, r.LocalCidr, r.CAName, r.CASha)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s rule #%v; `%s`", table, i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
var ErrUnknownNetworkType = errors.New("unknown network type")
|
var ErrUnknownNetworkType = errors.New("unknown network type")
|
||||||
var ErrPeerRejected = errors.New("remote address is not within a network that we handle")
|
var ErrPeerRejected = errors.New("remote address is not within a network that we handle")
|
||||||
var ErrInvalidRemoteIP = errors.New("remote address is not in remote certificate networks")
|
var ErrInvalidRemoteIP = errors.New("remote address is not in remote certificate networks")
|
||||||
@@ -241,17 +458,23 @@ func (f *Firewall) Drop(fp firewall.Packet, incoming bool, h *HostInfo, caPool *
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Check if we spoke to this tuple, if we did then allow this packet
|
// Check if we spoke to this tuple, if we did then allow this packet
|
||||||
if f.inConns(&fp, h, caPool, localCache) {
|
if f.inConns(fp, h, caPool, localCache) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if !f.rules.Match(&fp, incoming, h.ConnectionState.peerCert, caPool) {
|
table := f.OutRules
|
||||||
|
if incoming {
|
||||||
|
table = f.InRules
|
||||||
|
}
|
||||||
|
|
||||||
|
// We now know which firewall table to check against
|
||||||
|
if !table.match(fp, incoming, h.ConnectionState.peerCert, caPool) {
|
||||||
f.metrics(incoming).droppedNoRule.Inc(1)
|
f.metrics(incoming).droppedNoRule.Inc(1)
|
||||||
return ErrNoMatchingRule
|
return ErrNoMatchingRule
|
||||||
}
|
}
|
||||||
|
|
||||||
// We always want to conntrack since it is a faster operation
|
// We always want to conntrack since it is a faster operation
|
||||||
f.addConn(&fp, incoming)
|
f.addConn(fp, incoming)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -280,9 +503,9 @@ func (f *Firewall) EmitStats() {
|
|||||||
metrics.GetOrRegisterGauge("firewall.rules.hash", nil).Update(int64(f.GetRuleHashFNV()))
|
metrics.GetOrRegisterGauge("firewall.rules.hash", nil).Update(int64(f.GetRuleHashFNV()))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Firewall) inConns(fp *firewall.Packet, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) bool {
|
func (f *Firewall) inConns(fp firewall.Packet, h *HostInfo, caPool *cert.CAPool, localCache firewall.ConntrackCache) bool {
|
||||||
if localCache != nil {
|
if localCache != nil {
|
||||||
if _, ok := localCache[*fp]; ok {
|
if _, ok := localCache[fp]; ok {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -295,7 +518,7 @@ func (f *Firewall) inConns(fp *firewall.Packet, h *HostInfo, caPool *cert.CAPool
|
|||||||
f.evict(ep)
|
f.evict(ep)
|
||||||
}
|
}
|
||||||
|
|
||||||
c, ok := conntrack.Conns[*fp]
|
c, ok := conntrack.Conns[fp]
|
||||||
|
|
||||||
if !ok {
|
if !ok {
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
@@ -305,23 +528,29 @@ func (f *Firewall) inConns(fp *firewall.Packet, h *HostInfo, caPool *cert.CAPool
|
|||||||
if c.rulesVersion != f.rulesVersion {
|
if c.rulesVersion != f.rulesVersion {
|
||||||
// This conntrack entry was for an older rule set, validate
|
// This conntrack entry was for an older rule set, validate
|
||||||
// it still passes with the current rule set
|
// it still passes with the current rule set
|
||||||
if !f.rules.Match(fp, c.incoming, h.ConnectionState.peerCert, caPool) {
|
table := f.OutRules
|
||||||
|
if c.incoming {
|
||||||
|
table = f.InRules
|
||||||
|
}
|
||||||
|
|
||||||
|
// We now know which firewall table to check against
|
||||||
|
if !table.match(fp, c.incoming, h.ConnectionState.peerCert, caPool) {
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
h.logger(f.l).Debug("dropping old conntrack entry, does not match new ruleset",
|
h.logger(f.l).Debug("dropping old conntrack entry, does not match new ruleset",
|
||||||
"fwPacket", *fp,
|
"fwPacket", fp,
|
||||||
"incoming", c.incoming,
|
"incoming", c.incoming,
|
||||||
"rulesVersion", f.rulesVersion,
|
"rulesVersion", f.rulesVersion,
|
||||||
"oldRulesVersion", c.rulesVersion,
|
"oldRulesVersion", c.rulesVersion,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
delete(conntrack.Conns, *fp)
|
delete(conntrack.Conns, fp)
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
if f.l.Enabled(context.Background(), slog.LevelDebug) {
|
||||||
h.logger(f.l).Debug("keeping old conntrack entry, does match new ruleset",
|
h.logger(f.l).Debug("keeping old conntrack entry, does match new ruleset",
|
||||||
"fwPacket", *fp,
|
"fwPacket", fp,
|
||||||
"incoming", c.incoming,
|
"incoming", c.incoming,
|
||||||
"rulesVersion", f.rulesVersion,
|
"rulesVersion", f.rulesVersion,
|
||||||
"oldRulesVersion", c.rulesVersion,
|
"oldRulesVersion", c.rulesVersion,
|
||||||
@@ -331,39 +560,42 @@ func (f *Firewall) inConns(fp *firewall.Packet, h *HostInfo, caPool *cert.CAPool
|
|||||||
c.rulesVersion = f.rulesVersion
|
c.rulesVersion = f.rulesVersion
|
||||||
}
|
}
|
||||||
|
|
||||||
c.Expires = time.Now().Add(f.conntrackTimeout(fp.Protocol))
|
switch fp.Protocol {
|
||||||
|
case iputil.IPProtocolTCP:
|
||||||
|
c.Expires = time.Now().Add(f.TCPTimeout)
|
||||||
|
case iputil.IPProtocolUDP:
|
||||||
|
c.Expires = time.Now().Add(f.UDPTimeout)
|
||||||
|
default:
|
||||||
|
c.Expires = time.Now().Add(f.DefaultTimeout)
|
||||||
|
}
|
||||||
|
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
|
|
||||||
if localCache != nil {
|
if localCache != nil {
|
||||||
localCache[*fp] = struct{}{}
|
localCache[fp] = struct{}{}
|
||||||
}
|
}
|
||||||
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// conntrackTimeout returns how long a conntrack entry for proto lives without traffic.
|
func (f *Firewall) addConn(fp firewall.Packet, incoming bool) {
|
||||||
// Connection oriented protocols share the tcp timeout, datagram protocols share the udp timeout.
|
var timeout time.Duration
|
||||||
func (f *Firewall) conntrackTimeout(proto uint8) time.Duration {
|
|
||||||
switch proto {
|
|
||||||
case iputil.IPProtocolTCP, iputil.IPProtocolSCTP, iputil.IPProtocolDCCP:
|
|
||||||
return f.TCPTimeout
|
|
||||||
case iputil.IPProtocolUDP, iputil.IPProtocolUDPLite:
|
|
||||||
return f.UDPTimeout
|
|
||||||
default:
|
|
||||||
return f.DefaultTimeout
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *Firewall) addConn(fp *firewall.Packet, incoming bool) {
|
|
||||||
timeout := f.conntrackTimeout(fp.Protocol)
|
|
||||||
c := &conn{}
|
c := &conn{}
|
||||||
|
|
||||||
|
switch fp.Protocol {
|
||||||
|
case iputil.IPProtocolTCP:
|
||||||
|
timeout = f.TCPTimeout
|
||||||
|
case iputil.IPProtocolUDP:
|
||||||
|
timeout = f.UDPTimeout
|
||||||
|
default:
|
||||||
|
timeout = f.DefaultTimeout
|
||||||
|
}
|
||||||
|
|
||||||
conntrack := f.Conntrack
|
conntrack := f.Conntrack
|
||||||
conntrack.Lock()
|
conntrack.Lock()
|
||||||
if _, ok := conntrack.Conns[*fp]; !ok {
|
if _, ok := conntrack.Conns[fp]; !ok {
|
||||||
conntrack.TimerWheel.Advance(time.Now())
|
conntrack.TimerWheel.Advance(time.Now())
|
||||||
conntrack.TimerWheel.Add(*fp, timeout)
|
conntrack.TimerWheel.Add(fp, timeout)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Record which rulesVersion allowed this connection, so we can retest after
|
// Record which rulesVersion allowed this connection, so we can retest after
|
||||||
@@ -371,7 +603,7 @@ func (f *Firewall) addConn(fp *firewall.Packet, incoming bool) {
|
|||||||
c.incoming = incoming
|
c.incoming = incoming
|
||||||
c.rulesVersion = f.rulesVersion
|
c.rulesVersion = f.rulesVersion
|
||||||
c.Expires = time.Now().Add(timeout)
|
c.Expires = time.Now().Add(timeout)
|
||||||
conntrack.Conns[*fp] = c
|
conntrack.Conns[fp] = c
|
||||||
conntrack.Unlock()
|
conntrack.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -397,3 +629,490 @@ func (f *Firewall) evict(p firewall.Packet) {
|
|||||||
// This conn is done
|
// This conn is done
|
||||||
delete(conntrack.Conns, p)
|
delete(conntrack.Conns, p)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (ft *FirewallTable) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
if ft.AnyProto.match(p, incoming, c, caPool) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
switch p.Protocol {
|
||||||
|
case iputil.IPProtocolTCP:
|
||||||
|
if ft.TCP.match(p, incoming, c, caPool) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
case iputil.IPProtocolUDP:
|
||||||
|
if ft.UDP.match(p, incoming, c, caPool) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
case iputil.IPProtocolICMP, iputil.IPProtocolICMPv6:
|
||||||
|
if ft.ICMP.match(p, incoming, c, caPool) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (fp firewallPort) addRule(f *Firewall, startPort int32, endPort int32, groups []string, host string, cidr, localCidr, caName string, caSha string) error {
|
||||||
|
if startPort > endPort {
|
||||||
|
return fmt.Errorf("start port was lower than end port")
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := startPort; i <= endPort; i++ {
|
||||||
|
if _, ok := fp[i]; !ok {
|
||||||
|
fp[i] = &FirewallCA{
|
||||||
|
CANames: make(map[string]*FirewallRule),
|
||||||
|
CAShas: make(map[string]*FirewallRule),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := fp[i].addRule(f, groups, host, cidr, localCidr, caName, caSha); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (fp firewallPort) match(p firewall.Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
// We don't have any allowed ports, bail
|
||||||
|
if fp == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// this branch is here to catch traffic from FirewallTable.Any.match and FirewallTable.ICMP.match
|
||||||
|
if p.Protocol == iputil.IPProtocolICMP || p.Protocol == iputil.IPProtocolICMPv6 {
|
||||||
|
// port numbers are re-used for connection tracking of ICMP,
|
||||||
|
// but we don't want to actually filter on them.
|
||||||
|
return fp[firewall.PortAny].match(p, c, caPool)
|
||||||
|
}
|
||||||
|
|
||||||
|
var port int32
|
||||||
|
|
||||||
|
if p.Fragment {
|
||||||
|
port = firewall.PortFragment
|
||||||
|
} else if incoming {
|
||||||
|
port = int32(p.LocalPort)
|
||||||
|
} else {
|
||||||
|
port = int32(p.RemotePort)
|
||||||
|
}
|
||||||
|
|
||||||
|
if fp[port].match(p, c, caPool) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return fp[firewall.PortAny].match(p, c, caPool)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (fc *FirewallCA) addRule(f *Firewall, groups []string, host string, cidr, localCidr, caName, caSha string) error {
|
||||||
|
fr := func() *FirewallRule {
|
||||||
|
return &FirewallRule{
|
||||||
|
Hosts: make(map[string]*firewallLocalCIDR),
|
||||||
|
Groups: make([]*firewallGroups, 0),
|
||||||
|
CIDR: new(bart.Table[*firewallLocalCIDR]),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if caSha == "" && caName == "" {
|
||||||
|
if fc.Any == nil {
|
||||||
|
fc.Any = fr()
|
||||||
|
}
|
||||||
|
|
||||||
|
return fc.Any.addRule(f, groups, host, cidr, localCidr)
|
||||||
|
}
|
||||||
|
|
||||||
|
if caSha != "" {
|
||||||
|
if _, ok := fc.CAShas[caSha]; !ok {
|
||||||
|
fc.CAShas[caSha] = fr()
|
||||||
|
}
|
||||||
|
err := fc.CAShas[caSha].addRule(f, groups, host, cidr, localCidr)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if caName != "" {
|
||||||
|
if _, ok := fc.CANames[caName]; !ok {
|
||||||
|
fc.CANames[caName] = fr()
|
||||||
|
}
|
||||||
|
err := fc.CANames[caName].addRule(f, groups, host, cidr, localCidr)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (fc *FirewallCA) match(p firewall.Packet, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
||||||
|
if fc == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if fc.Any.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if t, ok := fc.CAShas[c.Certificate.Issuer()]; ok {
|
||||||
|
if t.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
s, err := caPool.GetCAForCert(c.Certificate)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
return fc.CANames[s.Certificate.Name()].match(p, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (fr *FirewallRule) addRule(f *Firewall, groups []string, host, cidr, localCidr string) error {
|
||||||
|
flc := func() *firewallLocalCIDR {
|
||||||
|
return &firewallLocalCIDR{
|
||||||
|
LocalCIDR: new(bart.Lite),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if fr.isAny(groups, host, cidr) {
|
||||||
|
if fr.Any == nil {
|
||||||
|
fr.Any = flc()
|
||||||
|
}
|
||||||
|
|
||||||
|
return fr.Any.addRule(f, localCidr)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(groups) > 0 {
|
||||||
|
nlc := flc()
|
||||||
|
err := nlc.addRule(f, localCidr)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
fr.Groups = append(fr.Groups, &firewallGroups{
|
||||||
|
Groups: groups,
|
||||||
|
LocalCIDR: nlc,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if host != "" {
|
||||||
|
nlc := fr.Hosts[host]
|
||||||
|
if nlc == nil {
|
||||||
|
nlc = flc()
|
||||||
|
}
|
||||||
|
err := nlc.addRule(f, localCidr)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fr.Hosts[host] = nlc
|
||||||
|
}
|
||||||
|
|
||||||
|
if cidr != "" {
|
||||||
|
c, err := netip.ParsePrefix(cidr)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
nlc, _ := fr.CIDR.Get(c)
|
||||||
|
if nlc == nil {
|
||||||
|
nlc = flc()
|
||||||
|
}
|
||||||
|
err = nlc.addRule(f, localCidr)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fr.CIDR.Insert(c, nlc)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (fr *FirewallRule) isAny(groups []string, host string, cidr string) bool {
|
||||||
|
if len(groups) == 0 && host == "" && cidr == "" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if slices.Contains(groups, "any") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if host == "any" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
if cidr == "any" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (fr *FirewallRule) match(p firewall.Packet, c *cert.CachedCertificate) bool {
|
||||||
|
if fr == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Shortcut path for if groups, hosts, or cidr contained an `any`
|
||||||
|
if fr.Any.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Need any of group, host, or cidr to match
|
||||||
|
for _, sg := range fr.Groups {
|
||||||
|
found := false
|
||||||
|
|
||||||
|
for _, g := range sg.Groups {
|
||||||
|
if _, ok := c.InvertedGroups[g]; !ok {
|
||||||
|
found = false
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
|
||||||
|
if found && sg.LocalCIDR.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if fr.Hosts != nil {
|
||||||
|
if flc, ok := fr.Hosts[c.Certificate.Name()]; ok {
|
||||||
|
if flc.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, v := range fr.CIDR.Supernets(netip.PrefixFrom(p.RemoteAddr, p.RemoteAddr.BitLen())) {
|
||||||
|
if v.match(p, c) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (flc *firewallLocalCIDR) addRule(f *Firewall, localCidr string) error {
|
||||||
|
if localCidr == "any" {
|
||||||
|
flc.Any = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if localCidr == "" {
|
||||||
|
if len(f.unsafeNetworks) == 0 || f.defaultLocalCIDRAny {
|
||||||
|
flc.Any = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, network := range f.assignedNetworks {
|
||||||
|
flc.LocalCIDR.Insert(network)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
c, err := netip.ParsePrefix(localCidr)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
flc.LocalCIDR.Insert(c)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (flc *firewallLocalCIDR) match(p firewall.Packet, c *cert.CachedCertificate) bool {
|
||||||
|
if flc == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if flc.Any {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return flc.LocalCIDR.Contains(p.LocalAddr)
|
||||||
|
}
|
||||||
|
|
||||||
|
type rule struct {
|
||||||
|
Port string
|
||||||
|
Code string
|
||||||
|
Proto string
|
||||||
|
Host string
|
||||||
|
Groups []string
|
||||||
|
Cidr string
|
||||||
|
LocalCidr string
|
||||||
|
CAName string
|
||||||
|
CASha string
|
||||||
|
}
|
||||||
|
|
||||||
|
func convertRule(l *slog.Logger, p any, table string, i int) (rule, error) {
|
||||||
|
r := rule{}
|
||||||
|
|
||||||
|
m, ok := p.(map[string]any)
|
||||||
|
if !ok {
|
||||||
|
return r, errors.New("could not parse rule")
|
||||||
|
}
|
||||||
|
|
||||||
|
toString := func(k string, m map[string]any) string {
|
||||||
|
v, ok := m[k]
|
||||||
|
if !ok {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%v", v)
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Port = toString("port", m)
|
||||||
|
r.Code = toString("code", m)
|
||||||
|
r.Proto = toString("proto", m)
|
||||||
|
r.Host = toString("host", m)
|
||||||
|
r.Cidr = toString("cidr", m)
|
||||||
|
r.LocalCidr = toString("local_cidr", m)
|
||||||
|
r.CAName = toString("ca_name", m)
|
||||||
|
r.CASha = toString("ca_sha", m)
|
||||||
|
|
||||||
|
// Make sure group isn't an array
|
||||||
|
if v, ok := m["group"].([]any); ok {
|
||||||
|
if len(v) > 1 {
|
||||||
|
return r, errors.New("group should contain a single value, an array with more than one entry was provided")
|
||||||
|
}
|
||||||
|
|
||||||
|
l.Warn("group was an array with a single value, converting to simple value",
|
||||||
|
"table", table,
|
||||||
|
"rule", i,
|
||||||
|
)
|
||||||
|
m["group"] = v[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
singleGroup := toString("group", m)
|
||||||
|
|
||||||
|
if rg, ok := m["groups"]; ok {
|
||||||
|
switch reflect.TypeOf(rg).Kind() {
|
||||||
|
case reflect.Slice:
|
||||||
|
v := reflect.ValueOf(rg)
|
||||||
|
r.Groups = make([]string, v.Len())
|
||||||
|
for i := 0; i < v.Len(); i++ {
|
||||||
|
r.Groups[i] = v.Index(i).Interface().(string)
|
||||||
|
}
|
||||||
|
case reflect.String:
|
||||||
|
r.Groups = []string{rg.(string)}
|
||||||
|
default:
|
||||||
|
r.Groups = []string{fmt.Sprintf("%v", rg)}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//flatten group vs groups
|
||||||
|
if singleGroup != "" {
|
||||||
|
// Check if we have both groups and group provided in the rule config
|
||||||
|
if len(r.Groups) > 0 {
|
||||||
|
return r, fmt.Errorf("only one of group or groups should be defined, both provided")
|
||||||
|
}
|
||||||
|
r.Groups = []string{singleGroup}
|
||||||
|
}
|
||||||
|
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// sanity returns an error if the rule would be evaluated in a way that would short-circuit a configured check on a wildcard value
|
||||||
|
// rules are evaluated as "port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND local_cidr"
|
||||||
|
func (r *rule) sanity() error {
|
||||||
|
//port, proto, local_cidr are AND, no need to check here
|
||||||
|
//ca_sha and ca_name don't have a wildcard value, no need to check here
|
||||||
|
groupsEmpty := len(r.Groups) == 0
|
||||||
|
hostEmpty := r.Host == ""
|
||||||
|
cidrEmpty := r.Cidr == ""
|
||||||
|
|
||||||
|
if (groupsEmpty && hostEmpty && cidrEmpty) == true {
|
||||||
|
return nil //no content!
|
||||||
|
}
|
||||||
|
|
||||||
|
groupsHasAny := slices.Contains(r.Groups, "any")
|
||||||
|
if groupsHasAny && len(r.Groups) > 1 {
|
||||||
|
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the other groups specified", r.Groups)
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Host == "any" {
|
||||||
|
if !groupsEmpty {
|
||||||
|
return fmt.Errorf("groups specified as %s, but host=any will match any host, regardless of groups", r.Groups)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !cidrEmpty {
|
||||||
|
return fmt.Errorf("cidr specified as %s, but host=any will match any host, regardless of cidr", r.Cidr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if groupsHasAny {
|
||||||
|
if !hostEmpty && r.Host != "any" {
|
||||||
|
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified host %s", r.Groups, r.Host)
|
||||||
|
}
|
||||||
|
if !cidrEmpty {
|
||||||
|
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified cidr %s", r.Groups, r.Cidr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Code != "" {
|
||||||
|
return fmt.Errorf("code specified as [%s]. Support for 'code' will be dropped in a future release, as it has never been functional", r.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
//todo alert on cidr-any
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parsePort(s string) (int32, int32, error) {
|
||||||
|
const notAPort int32 = -2
|
||||||
|
if s == "any" {
|
||||||
|
return firewall.PortAny, firewall.PortAny, nil
|
||||||
|
}
|
||||||
|
if s == "fragment" {
|
||||||
|
return firewall.PortFragment, firewall.PortFragment, nil
|
||||||
|
}
|
||||||
|
if !strings.Contains(s, `-`) {
|
||||||
|
rPort, err := parsePortValue("", s)
|
||||||
|
if err != nil {
|
||||||
|
return notAPort, notAPort, err
|
||||||
|
}
|
||||||
|
return rPort, rPort, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
sPorts := strings.SplitN(s, `-`, 2)
|
||||||
|
for i := range sPorts {
|
||||||
|
sPorts[i] = strings.Trim(sPorts[i], " ")
|
||||||
|
}
|
||||||
|
if len(sPorts) != 2 || sPorts[0] == "" || sPorts[1] == "" {
|
||||||
|
return notAPort, notAPort, fmt.Errorf("appears to be a range but could not be parsed; `%s`", s)
|
||||||
|
}
|
||||||
|
|
||||||
|
startPort, err := parsePortValue("beginning range ", sPorts[0])
|
||||||
|
if err != nil {
|
||||||
|
return notAPort, notAPort, err
|
||||||
|
}
|
||||||
|
|
||||||
|
endPort, err := parsePortValue("ending range ", sPorts[1])
|
||||||
|
if err != nil {
|
||||||
|
return notAPort, notAPort, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if startPort == firewall.PortAny {
|
||||||
|
endPort = firewall.PortAny
|
||||||
|
}
|
||||||
|
|
||||||
|
return startPort, endPort, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parsePortValue accepts a base-10 decimal in [0, 65535] and returns it
|
||||||
|
// widened to int32. Using strconv.ParseUint with bitSize 16 rejects
|
||||||
|
// negative input, out-of-range input (>65535), and any non-decimal byte
|
||||||
|
// by construction, so the int32 widening that follows is provably safe
|
||||||
|
// and cannot collide with firewall.PortAny (0) or firewall.PortFragment
|
||||||
|
// (-1) via integer truncation.
|
||||||
|
//
|
||||||
|
// prefix is prepended to both error messages so callers can disambiguate
|
||||||
|
// the single-port path (prefix="") from the range bounds (prefix="beginning
|
||||||
|
// range " / "ending range "), preserving the historical error strings.
|
||||||
|
func parsePortValue(prefix, s string) (int32, error) {
|
||||||
|
n, err := strconv.ParseUint(s, 10, 16)
|
||||||
|
if err == nil {
|
||||||
|
return int32(n), nil
|
||||||
|
}
|
||||||
|
if errors.Is(err, strconv.ErrRange) {
|
||||||
|
return 0, fmt.Errorf("%sout of range [0,65535]; `%s`", prefix, s)
|
||||||
|
}
|
||||||
|
return 0, fmt.Errorf("%swas not a number; `%s`", prefix, s)
|
||||||
|
}
|
||||||
@@ -1,310 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"log/slog"
|
|
||||||
"net/netip"
|
|
||||||
"reflect"
|
|
||||||
"slices"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
|
||||||
"github.com/slackhq/nebula/iputil"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ruleAdder takes firewall rules, it lets tests see what addRulesFromConfig adds
|
|
||||||
type ruleAdder interface {
|
|
||||||
AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr string, caName string, caSha string) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// RulesFromConfig reads the inbound and outbound firewall rules from c and builds them, see RulesBuilder.Build
|
|
||||||
func RulesFromConfig(l *slog.Logger, c *config.C, vpnNetworks, unsafeNetworks []netip.Prefix) (Rules, error) {
|
|
||||||
b := NewRulesBuilder(l)
|
|
||||||
b.defaultLocalCIDRAny = c.GetBool("firewall.default_local_cidr_any", false)
|
|
||||||
|
|
||||||
if err := addRulesFromConfig(l, false, c, b); err != nil {
|
|
||||||
return Rules{}, err
|
|
||||||
}
|
|
||||||
if err := addRulesFromConfig(l, true, c, b); err != nil {
|
|
||||||
return Rules{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return b.Build(vpnNetworks, unsafeNetworks), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func addRulesFromConfig(l *slog.Logger, inbound bool, c *config.C, ra ruleAdder) error {
|
|
||||||
var table string
|
|
||||||
if inbound {
|
|
||||||
table = "firewall.inbound"
|
|
||||||
} else {
|
|
||||||
table = "firewall.outbound"
|
|
||||||
}
|
|
||||||
|
|
||||||
r := c.Get(table)
|
|
||||||
if r == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
rs, ok := r.([]any)
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("%s failed to parse, should be an array of rules", table)
|
|
||||||
}
|
|
||||||
|
|
||||||
for i, t := range rs {
|
|
||||||
r, err := yamlToConfigRule(l, t, table, i)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; %s", table, i, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Code != "" && r.Port != "" {
|
|
||||||
return fmt.Errorf("%s rule #%v; only one of port or code should be provided", table, i)
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Host == "" && len(r.Groups) == 0 && r.Cidr == "" && r.LocalCidr == "" && r.CAName == "" && r.CASha == "" {
|
|
||||||
return fmt.Errorf("%s rule #%v; at least one of host, group, cidr, local_cidr, ca_name, or ca_sha must be provided", table, i)
|
|
||||||
}
|
|
||||||
|
|
||||||
var sPort, errPort string
|
|
||||||
if r.Code != "" {
|
|
||||||
errPort = "code"
|
|
||||||
sPort = r.Code
|
|
||||||
} else {
|
|
||||||
errPort = "port"
|
|
||||||
sPort = r.Port
|
|
||||||
}
|
|
||||||
|
|
||||||
proto, ok := protoByName(r.Proto)
|
|
||||||
if !ok {
|
|
||||||
// Any other protocol by number. 0 is reserved for `any`.
|
|
||||||
n, perr := strconv.ParseUint(r.Proto, 10, 8)
|
|
||||||
if perr != nil || n == 0 {
|
|
||||||
return fmt.Errorf("%s rule #%v; proto was not understood; `%s`", table, i, r.Proto)
|
|
||||||
}
|
|
||||||
proto = uint8(n)
|
|
||||||
}
|
|
||||||
var startPort, endPort int32
|
|
||||||
if proto == iputil.IPProtocolICMP || proto == iputil.IPProtocolICMPv6 {
|
|
||||||
// RulesBuilder.AddRule coerces ICMP ports to `any` as well. This copy stays so that an ICMP rule's
|
|
||||||
// port is warned about rather than parsed, whatever it holds.
|
|
||||||
startPort = PortAny
|
|
||||||
endPort = PortAny
|
|
||||||
if sPort != "" {
|
|
||||||
l.Warn("ignoring port specification for ICMP firewall rule", "port", sPort)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
startPort, endPort, err = parsePort(sPort)
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; %s %s", table, i, errPort, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if warning := r.sanity(); warning != nil {
|
|
||||||
l.Warn("firewall rule sanity check",
|
|
||||||
"table", table,
|
|
||||||
"rule", i,
|
|
||||||
"warning", warning,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = ra.AddRule(inbound, proto, startPort, endPort, r.Groups, r.Host, r.Cidr, r.LocalCidr, r.CAName, r.CASha)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%s rule #%v; %s", table, i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type configRule struct {
|
|
||||||
Port string
|
|
||||||
Code string
|
|
||||||
Proto string
|
|
||||||
Host string
|
|
||||||
Groups []string
|
|
||||||
Cidr string
|
|
||||||
LocalCidr string
|
|
||||||
CAName string
|
|
||||||
CASha string
|
|
||||||
}
|
|
||||||
|
|
||||||
func yamlToConfigRule(l *slog.Logger, p any, table string, i int) (configRule, error) {
|
|
||||||
r := configRule{}
|
|
||||||
|
|
||||||
m, ok := p.(map[string]any)
|
|
||||||
if !ok {
|
|
||||||
return r, errors.New("could not parse rule")
|
|
||||||
}
|
|
||||||
|
|
||||||
toString := func(k string, m map[string]any) string {
|
|
||||||
v, ok := m[k]
|
|
||||||
if !ok {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return fmt.Sprintf("%v", v)
|
|
||||||
}
|
|
||||||
|
|
||||||
r.Port = toString("port", m)
|
|
||||||
r.Code = toString("code", m)
|
|
||||||
r.Proto = toString("proto", m)
|
|
||||||
r.Host = toString("host", m)
|
|
||||||
r.Cidr = toString("cidr", m)
|
|
||||||
r.LocalCidr = toString("local_cidr", m)
|
|
||||||
r.CAName = toString("ca_name", m)
|
|
||||||
r.CASha = toString("ca_sha", m)
|
|
||||||
|
|
||||||
// Make sure group isn't an array
|
|
||||||
if v, ok := m["group"].([]any); ok {
|
|
||||||
if len(v) > 1 {
|
|
||||||
return r, errors.New("group should contain a single value, an array with more than one entry was provided")
|
|
||||||
}
|
|
||||||
if len(v) == 0 {
|
|
||||||
return r, errors.New("group should contain a single value, an empty array was provided")
|
|
||||||
}
|
|
||||||
|
|
||||||
l.Warn("group was an array with a single value, converting to simple value",
|
|
||||||
"table", table,
|
|
||||||
"rule", i,
|
|
||||||
)
|
|
||||||
m["group"] = v[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
singleGroup := toString("group", m)
|
|
||||||
|
|
||||||
// A null value, `groups:` with nothing after it, is the same as no groups
|
|
||||||
if rg, ok := m["groups"]; ok && rg != nil {
|
|
||||||
switch reflect.TypeOf(rg).Kind() {
|
|
||||||
case reflect.Slice:
|
|
||||||
// Every entry is read as a string, as the other fields are, so `groups: [1, 2]` is the groups "1" and "2"
|
|
||||||
v := reflect.ValueOf(rg)
|
|
||||||
r.Groups = make([]string, v.Len())
|
|
||||||
for i := 0; i < v.Len(); i++ {
|
|
||||||
r.Groups[i] = fmt.Sprintf("%v", v.Index(i).Interface())
|
|
||||||
}
|
|
||||||
case reflect.String:
|
|
||||||
r.Groups = []string{rg.(string)}
|
|
||||||
default:
|
|
||||||
r.Groups = []string{fmt.Sprintf("%v", rg)}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
//flatten group vs groups
|
|
||||||
if singleGroup != "" {
|
|
||||||
// Check if we have both groups and group provided in the rule config
|
|
||||||
if len(r.Groups) > 0 {
|
|
||||||
return r, fmt.Errorf("only one of group or groups should be defined, both provided")
|
|
||||||
}
|
|
||||||
r.Groups = []string{singleGroup}
|
|
||||||
}
|
|
||||||
|
|
||||||
return r, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// sanity returns an error if the rule would be evaluated in a way that would short-circuit a configured check on a wildcard value
|
|
||||||
// rules are evaluated as "port AND proto AND (ca_sha OR ca_name) AND (host OR group OR groups OR cidr) AND local_cidr"
|
|
||||||
func (r *configRule) sanity() error {
|
|
||||||
//port, proto, local_cidr are AND, no need to check here
|
|
||||||
//ca_sha and ca_name don't have a wildcard value, no need to check here
|
|
||||||
groupsEmpty := len(r.Groups) == 0
|
|
||||||
hostEmpty := r.Host == ""
|
|
||||||
cidrEmpty := r.Cidr == ""
|
|
||||||
|
|
||||||
if (groupsEmpty && hostEmpty && cidrEmpty) == true {
|
|
||||||
return nil //no content!
|
|
||||||
}
|
|
||||||
|
|
||||||
groupsHasAny := slices.Contains(r.Groups, "any")
|
|
||||||
if groupsHasAny && len(r.Groups) > 1 {
|
|
||||||
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the other groups specified", r.Groups)
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Host == "any" {
|
|
||||||
if !groupsEmpty {
|
|
||||||
return fmt.Errorf("groups specified as %s, but host=any will match any host, regardless of groups", r.Groups)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !cidrEmpty {
|
|
||||||
return fmt.Errorf("cidr specified as %s, but host=any will match any host, regardless of cidr", r.Cidr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if groupsHasAny {
|
|
||||||
if !hostEmpty && r.Host != "any" {
|
|
||||||
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified host %s", r.Groups, r.Host)
|
|
||||||
}
|
|
||||||
if !cidrEmpty {
|
|
||||||
return fmt.Errorf("groups spec [%s] contains the group '\"any\". This rule will ignore the specified cidr %s", r.Groups, r.Cidr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.Code != "" {
|
|
||||||
return fmt.Errorf("code specified as [%s]. Support for 'code' will be dropped in a future release, as it has never been functional", r.Code)
|
|
||||||
}
|
|
||||||
|
|
||||||
//todo alert on cidr-any
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parsePort(s string) (int32, int32, error) {
|
|
||||||
const notAPort int32 = -2
|
|
||||||
if s == "any" {
|
|
||||||
return PortAny, PortAny, nil
|
|
||||||
}
|
|
||||||
if s == "fragment" {
|
|
||||||
return PortFragment, PortFragment, nil
|
|
||||||
}
|
|
||||||
if !strings.Contains(s, `-`) {
|
|
||||||
rPort, err := parsePortValue("", s)
|
|
||||||
if err != nil {
|
|
||||||
return notAPort, notAPort, err
|
|
||||||
}
|
|
||||||
return rPort, rPort, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
sPorts := strings.SplitN(s, `-`, 2)
|
|
||||||
for i := range sPorts {
|
|
||||||
sPorts[i] = strings.Trim(sPorts[i], " ")
|
|
||||||
}
|
|
||||||
if len(sPorts) != 2 || sPorts[0] == "" || sPorts[1] == "" {
|
|
||||||
return notAPort, notAPort, fmt.Errorf("appears to be a range but could not be parsed; `%s`", s)
|
|
||||||
}
|
|
||||||
|
|
||||||
startPort, err := parsePortValue("beginning range ", sPorts[0])
|
|
||||||
if err != nil {
|
|
||||||
return notAPort, notAPort, err
|
|
||||||
}
|
|
||||||
|
|
||||||
endPort, err := parsePortValue("ending range ", sPorts[1])
|
|
||||||
if err != nil {
|
|
||||||
return notAPort, notAPort, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if startPort == PortAny {
|
|
||||||
endPort = PortAny
|
|
||||||
}
|
|
||||||
|
|
||||||
return startPort, endPort, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parsePortValue accepts a base-10 decimal in [0, 65535] and returns it
|
|
||||||
// widened to int32. Using strconv.ParseUint with bitSize 16 rejects
|
|
||||||
// negative input, out-of-range input (>65535), and any non-decimal byte
|
|
||||||
// by construction, so the int32 widening that follows is provably safe
|
|
||||||
// and cannot collide with PortAny (0) or PortFragment
|
|
||||||
// (-1) via integer truncation.
|
|
||||||
//
|
|
||||||
// prefix is prepended to both error messages so callers can disambiguate
|
|
||||||
// the single-port path (prefix="") from the range bounds (prefix="beginning
|
|
||||||
// range " / "ending range "), preserving the historical error strings.
|
|
||||||
func parsePortValue(prefix, s string) (int32, error) {
|
|
||||||
n, err := strconv.ParseUint(s, 10, 16)
|
|
||||||
if err == nil {
|
|
||||||
return int32(n), nil
|
|
||||||
}
|
|
||||||
if errors.Is(err, strconv.ErrRange) {
|
|
||||||
return 0, fmt.Errorf("%sout of range [0,65535]; `%s`", prefix, s)
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("%swas not a number; `%s`", prefix, s)
|
|
||||||
}
|
|
||||||
@@ -1,516 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"errors"
|
|
||||||
"net/netip"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/config"
|
|
||||||
"github.com/slackhq/nebula/iputil"
|
|
||||||
"github.com/slackhq/nebula/test"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Test_parsePort(t *testing.T) {
|
|
||||||
_, _, err := parsePort("")
|
|
||||||
require.EqualError(t, err, "was not a number; ``")
|
|
||||||
|
|
||||||
_, _, err = parsePort(" ")
|
|
||||||
require.EqualError(t, err, "was not a number; ` `")
|
|
||||||
|
|
||||||
_, _, err = parsePort("-")
|
|
||||||
require.EqualError(t, err, "appears to be a range but could not be parsed; `-`")
|
|
||||||
|
|
||||||
_, _, err = parsePort(" - ")
|
|
||||||
require.EqualError(t, err, "appears to be a range but could not be parsed; ` - `")
|
|
||||||
|
|
||||||
_, _, err = parsePort("a-b")
|
|
||||||
require.EqualError(t, err, "beginning range was not a number; `a`")
|
|
||||||
|
|
||||||
_, _, err = parsePort("1-b")
|
|
||||||
require.EqualError(t, err, "ending range was not a number; `b`")
|
|
||||||
|
|
||||||
s, e, err := parsePort(" 1 - 2 ")
|
|
||||||
assert.Equal(t, int32(1), s)
|
|
||||||
assert.Equal(t, int32(2), e)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s, e, err = parsePort("0-1")
|
|
||||||
assert.Equal(t, int32(0), s)
|
|
||||||
assert.Equal(t, int32(0), e)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s, e, err = parsePort("9919")
|
|
||||||
assert.Equal(t, int32(9919), s)
|
|
||||||
assert.Equal(t, int32(9919), e)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
s, e, err = parsePort("any")
|
|
||||||
assert.Equal(t, int32(0), s)
|
|
||||||
assert.Equal(t, int32(0), e)
|
|
||||||
require.NoError(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test_parsePort_invalid covers inputs that must error. The named bug is
|
|
||||||
// that int32(strconv.Atoi("4294967296")) truncates to 0 == PortAny,
|
|
||||||
// silently turning a typo into a match-all-ports rule; the rest are
|
|
||||||
// representative syntax/range probes.
|
|
||||||
func Test_parsePort_invalid(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
input string
|
|
||||||
wantErrContains string
|
|
||||||
}{
|
|
||||||
// Numeric overflow (the named bug + boundary).
|
|
||||||
{"named bug: 2^32 truncates to PortAny", "4294967296", "out of range"},
|
|
||||||
{"just above max real port", "65536", "out of range"},
|
|
||||||
|
|
||||||
// Negatives route through the range branch and hit the empty-half
|
|
||||||
// guard; included as defense in depth so a future refactor cannot
|
|
||||||
// accidentally reach the int32 cast.
|
|
||||||
{"negative", "-1", "could not be parsed"},
|
|
||||||
|
|
||||||
// Syntax probes.
|
|
||||||
{"NUL between digits", "4\x002", "was not a number"},
|
|
||||||
{"hex notation", "0x10", "was not a number"},
|
|
||||||
{"scientific notation", "1e3", "was not a number"},
|
|
||||||
{"leading whitespace", " 42", "was not a number"},
|
|
||||||
{"fullwidth digits", "42", "was not a number"},
|
|
||||||
|
|
||||||
// Range branch.
|
|
||||||
{"range upper out of range", "1-65536", "ending range out of range"},
|
|
||||||
{"range lower out of range", "65536-65537", "beginning range out of range"},
|
|
||||||
{"range with negative upper", "1--1", "ending range was not a number"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
_, _, err := parsePort(tc.input)
|
|
||||||
require.Error(t, err, "input %q must error", tc.input)
|
|
||||||
require.ErrorContains(t, err, tc.wantErrContains)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test_parsePort_valid_boundaries locks in success cases at 0, 1, and 65535
|
|
||||||
// so a future refactor cannot regress the boundaries.
|
|
||||||
func Test_parsePort_valid_boundaries(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
input string
|
|
||||||
wantStart int32
|
|
||||||
wantEnd int32
|
|
||||||
}{
|
|
||||||
{"zero is PortAny", "0", 0, 0},
|
|
||||||
{"min real port", "1", 1, 1},
|
|
||||||
{"max real port", "65535", 65535, 65535},
|
|
||||||
{"range zero to max forces end to zero", "0-65535", 0, 0},
|
|
||||||
{"range max to max", "65535-65535", 65535, 65535},
|
|
||||||
{"range one to max", "1-65535", 1, 65535},
|
|
||||||
{"range with whitespace inside", " 1 - 2 ", 1, 2},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
s, e, err := parsePort(tc.input)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, tc.wantStart, s, "start port")
|
|
||||||
assert.Equal(t, tc.wantEnd, e, "end port")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAddRulesFromConfig(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
// Test adding tcp rule
|
|
||||||
conf := config.NewC(test.NewLogger())
|
|
||||||
mf := &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": "tcp", "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolTCP, startPort: 1, endPort: 1, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding udp rule
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": "udp", "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolUDP, startPort: 1, endPort: 1, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding udplite, dccp, and sctp rules
|
|
||||||
for name, proto := range map[string]uint8{"udplite": iputil.IPProtocolUDPLite, "dccp": iputil.IPProtocolDCCP, "sctp": iputil.IPProtocolSCTP} {
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1-2", "proto": name, "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, false, conf, mf), name)
|
|
||||||
assert.Equal(t, addRuleCall{incoming: false, proto: proto, startPort: 1, endPort: 2, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall, name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test adding icmp rule
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": "icmp", "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolICMP, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding icmp rule no port
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"proto": "icmp", "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, false, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: false, proto: iputil.IPProtocolICMP, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rules by protocol number, as yaml would give a string or an int
|
|
||||||
for _, proto := range []any{"47", 47} {
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "any", "proto": proto, "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, false, conf, mf), proto)
|
|
||||||
assert.Equal(t, addRuleCall{incoming: false, proto: 47, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall, proto)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test ICMP and ICMPv6, by name and by number, still ignore ports
|
|
||||||
for _, tc := range []struct {
|
|
||||||
given any
|
|
||||||
want uint8
|
|
||||||
}{
|
|
||||||
{"icmp", iputil.IPProtocolICMP},
|
|
||||||
{"icmpv6", iputil.IPProtocolICMPv6},
|
|
||||||
{iputil.IPProtocolICMP, iputil.IPProtocolICMP},
|
|
||||||
{iputil.IPProtocolICMPv6, iputil.IPProtocolICMPv6},
|
|
||||||
} {
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "1", "proto": tc.given, "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, false, conf, mf), tc.given)
|
|
||||||
assert.Equal(t, addRuleCall{incoming: false, proto: tc.want, startPort: PortAny, endPort: PortAny, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall, tc.given)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test protocols that aren't a known name or a number from 1 to 255
|
|
||||||
for _, proto := range []string{"0", "256", "-1", "gre"} {
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"outbound": []any{map[string]any{"port": "any", "proto": proto, "host": "a"}}}
|
|
||||||
require.EqualError(t, addRulesFromConfig(l, false, conf, mf), "firewall.outbound rule #0; proto was not understood; `"+proto+"`")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test adding any rule
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, host: "a", ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with cidr
|
|
||||||
cidr := netip.MustParsePrefix("10.0.0.0/8")
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": cidr.String()}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: cidr.String(), localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with local_cidr
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": cidr.String()}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: cidr.String()}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with cidr ipv6
|
|
||||||
cidr6 := netip.MustParsePrefix("fd00::/8")
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": cidr6.String()}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: cidr6.String(), localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with any cidr
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": "any"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "any", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with junk cidr, which RulesBuilder rejects
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "cidr": "junk/junk"}}}
|
|
||||||
require.EqualError(t, addRulesFromConfig(l, true, conf, NewRulesBuilder(l)), "firewall.inbound rule #0; cidr did not parse; netip.ParsePrefix(\"junk/junk\"): ParseAddr(\"junk\"): unable to parse IP")
|
|
||||||
|
|
||||||
// Test adding rule with local_cidr ipv6
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": cidr6.String()}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: cidr6.String()}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with any local_cidr
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": "any"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, localIp: "any"}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with junk local_cidr, which RulesBuilder rejects
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "local_cidr": "junk/junk"}}}
|
|
||||||
require.EqualError(t, addRulesFromConfig(l, true, conf, NewRulesBuilder(l)), "firewall.inbound rule #0; local_cidr did not parse; netip.ParsePrefix(\"junk/junk\"): ParseAddr(\"junk\"): unable to parse IP")
|
|
||||||
|
|
||||||
// Test adding rule with ca_sha
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "ca_sha": "12312313123"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: "", caSha: "12312313123"}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test adding rule with ca_name
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "ca_name": "root01"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: nil, ip: "", localIp: "", caName: "root01"}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test single group
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "group": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: []string{"a"}, ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test single groups
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "groups": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: []string{"a"}, ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test multiple AND groups
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "groups": []string{"a", "b"}}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, addRuleCall{incoming: true, proto: ProtoAny, startPort: 1, endPort: 1, groups: []string{"a", "b"}, ip: "", localIp: ""}, mf.lastCall)
|
|
||||||
|
|
||||||
// Test group and groups values that used to crash: an empty group array is rejected, groups entries that
|
|
||||||
// aren't strings are read as strings, and a null groups is no groups
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "group": []any{}}}}
|
|
||||||
require.EqualError(t, addRulesFromConfig(l, true, conf, mf), "firewall.inbound rule #0; group should contain a single value, an empty array was provided")
|
|
||||||
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "groups": []any{1, 2}}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Equal(t, []string{"1", "2"}, mf.lastCall.groups)
|
|
||||||
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "groups": nil, "host": "a"}}}
|
|
||||||
require.NoError(t, addRulesFromConfig(l, true, conf, mf))
|
|
||||||
assert.Empty(t, mf.lastCall.groups)
|
|
||||||
assert.Equal(t, "a", mf.lastCall.host)
|
|
||||||
|
|
||||||
// Test Add error
|
|
||||||
conf = config.NewC(test.NewLogger())
|
|
||||||
mf = &mockFirewall{}
|
|
||||||
mf.nextCallReturn = errors.New("test error")
|
|
||||||
conf.Settings["firewall"] = map[string]any{"inbound": []any{map[string]any{"port": "1", "proto": "any", "host": "a"}}}
|
|
||||||
require.EqualError(t, addRulesFromConfig(l, true, conf, mf), "firewall.inbound rule #0; test error")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRulesFromConfig_defaultLocalCIDR ensures rules without a local_cidr allow only the vpn networks when there are
|
|
||||||
// unsafe networks, unless default_local_cidr_any is set, and that a rule's own local_cidr is kept either way
|
|
||||||
func TestRulesFromConfig_defaultLocalCIDR(t *testing.T) {
|
|
||||||
vpnNetworks := []netip.Prefix{netip.MustParsePrefix("10.1.0.5/16")}
|
|
||||||
unsafeNetworks := []netip.Prefix{netip.MustParsePrefix("192.168.0.0/24")}
|
|
||||||
vpnAddr := netip.MustParseAddr("10.1.9.9")
|
|
||||||
unsafeAddr := netip.MustParseAddr("192.168.0.3")
|
|
||||||
|
|
||||||
// ruleOnPort returns the rule on proto whose port clause is exactly port, chosen from the rules that a packet
|
|
||||||
// on port is checked against.
|
|
||||||
ruleOnPort := func(t *testing.T, table *Table, proto uint8, port int32) *rule {
|
|
||||||
t.Helper()
|
|
||||||
for _, r := range table.rulesAt(proto, port) {
|
|
||||||
if r.startPort == port {
|
|
||||||
return r
|
|
||||||
}
|
|
||||||
}
|
|
||||||
require.Failf(t, "no rule found", "proto %d port %d", proto, port)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range []struct {
|
|
||||||
name string
|
|
||||||
unsafeNetworks []netip.Prefix
|
|
||||||
defaultLocalCIDRAny bool
|
|
||||||
wantUnsafe bool
|
|
||||||
}{
|
|
||||||
{"no unsafe networks", nil, false, true},
|
|
||||||
{"unsafe networks", unsafeNetworks, false, false},
|
|
||||||
{"unsafe networks and default_local_cidr_any", unsafeNetworks, true, true},
|
|
||||||
} {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
conf := config.NewC(test.NewLogger())
|
|
||||||
conf.Settings["firewall"] = map[string]any{
|
|
||||||
"default_local_cidr_any": tc.defaultLocalCIDRAny,
|
|
||||||
"inbound": []any{
|
|
||||||
map[string]any{"port": "any", "proto": "any", "host": "any"},
|
|
||||||
map[string]any{"port": "22", "proto": "tcp", "host": "any"},
|
|
||||||
map[string]any{"port": "80", "proto": "tcp", "host": "any", "local_cidr": "192.168.0.0/24"},
|
|
||||||
map[string]any{"port": "443", "proto": "tcp", "host": "any", "local_cidr": "any"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
rules, err := RulesFromConfig(test.NewLogger(), conf, vpnNetworks, tc.unsafeNetworks)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// The proto `any` rule, as indexed by a protocol with rules of its own and as shared by one without.
|
|
||||||
for _, proto := range []uint8{iputil.IPProtocolTCP, 47} {
|
|
||||||
r := ruleOnPort(t, rules.In, proto, PortAny)
|
|
||||||
assert.True(t, r.matchLocal(vpnAddr), "proto %d", proto)
|
|
||||||
assert.Equal(t, tc.wantUnsafe, r.matchLocal(unsafeAddr), "proto %d", proto)
|
|
||||||
}
|
|
||||||
|
|
||||||
r := ruleOnPort(t, rules.In, iputil.IPProtocolTCP, 22)
|
|
||||||
assert.True(t, r.matchLocal(vpnAddr))
|
|
||||||
assert.Equal(t, tc.wantUnsafe, r.matchLocal(unsafeAddr))
|
|
||||||
|
|
||||||
r = ruleOnPort(t, rules.In, iputil.IPProtocolTCP, 80)
|
|
||||||
assert.False(t, r.matchLocal(vpnAddr))
|
|
||||||
assert.True(t, r.matchLocal(unsafeAddr))
|
|
||||||
|
|
||||||
r = ruleOnPort(t, rules.In, iputil.IPProtocolTCP, 443)
|
|
||||||
assert.True(t, r.matchLocal(vpnAddr))
|
|
||||||
assert.True(t, r.matchLocal(unsafeAddr))
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func Test_convertRule(t *testing.T) {
|
|
||||||
ob := &bytes.Buffer{}
|
|
||||||
l := test.NewLoggerWithOutput(ob)
|
|
||||||
|
|
||||||
// Ensure group array of 1 is converted and a warning is printed
|
|
||||||
c := map[string]any{
|
|
||||||
"group": []any{"group1"},
|
|
||||||
}
|
|
||||||
|
|
||||||
r, err := yamlToConfigRule(l, c, "test", 1)
|
|
||||||
assert.Contains(t, ob.String(), "group was an array with a single value, converting to simple value")
|
|
||||||
assert.Contains(t, ob.String(), "table=test")
|
|
||||||
assert.Contains(t, ob.String(), "rule=1")
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, []string{"group1"}, r.Groups)
|
|
||||||
|
|
||||||
// Ensure group array of > 1 is errord
|
|
||||||
ob.Reset()
|
|
||||||
c = map[string]any{
|
|
||||||
"group": []any{"group1", "group2"},
|
|
||||||
}
|
|
||||||
|
|
||||||
r, err = yamlToConfigRule(l, c, "test", 1)
|
|
||||||
assert.Empty(t, ob.String())
|
|
||||||
require.Error(t, err, "group should contain a single value, an array with more than one entry was provided")
|
|
||||||
|
|
||||||
// Make sure a well formed group is alright
|
|
||||||
ob.Reset()
|
|
||||||
c = map[string]any{
|
|
||||||
"group": "group1",
|
|
||||||
}
|
|
||||||
|
|
||||||
r, err = yamlToConfigRule(l, c, "test", 1)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, []string{"group1"}, r.Groups)
|
|
||||||
}
|
|
||||||
|
|
||||||
func Test_convertRuleSanity(t *testing.T) {
|
|
||||||
ob := &bytes.Buffer{}
|
|
||||||
l := test.NewLoggerWithOutput(ob)
|
|
||||||
|
|
||||||
noWarningPlease := []map[string]any{
|
|
||||||
{"group": "group1"},
|
|
||||||
{"groups": []any{"group2"}},
|
|
||||||
{"host": "bob"},
|
|
||||||
{"cidr": "1.1.1.1/1"},
|
|
||||||
{"groups": []any{"group2"}, "host": "bob"},
|
|
||||||
{"cidr": "1.1.1.1/1", "host": "bob"},
|
|
||||||
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1"},
|
|
||||||
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1", "host": "bob"},
|
|
||||||
}
|
|
||||||
for _, c := range noWarningPlease {
|
|
||||||
r, err := yamlToConfigRule(l, c, "test", 1)
|
|
||||||
require.NoError(t, err)
|
|
||||||
require.NoError(t, r.sanity(), "should not generate a sanity warning, %+v", c)
|
|
||||||
}
|
|
||||||
|
|
||||||
yesWarningPlease := []map[string]any{
|
|
||||||
{"group": "group1"},
|
|
||||||
{"groups": []any{"group2"}},
|
|
||||||
{"cidr": "1.1.1.1/1"},
|
|
||||||
{"groups": []any{"group2"}, "host": "bob"},
|
|
||||||
{"cidr": "1.1.1.1/1", "host": "bob"},
|
|
||||||
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1"},
|
|
||||||
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1", "host": "bob"},
|
|
||||||
}
|
|
||||||
for _, c := range yesWarningPlease {
|
|
||||||
c["host"] = "any"
|
|
||||||
r, err := yamlToConfigRule(l, c, "test", 1)
|
|
||||||
require.NoError(t, err)
|
|
||||||
err = r.sanity()
|
|
||||||
require.Error(t, err, "I wanted a warning: %+v", c)
|
|
||||||
}
|
|
||||||
//reset the list
|
|
||||||
yesWarningPlease = []map[string]any{
|
|
||||||
{"group": "group1"},
|
|
||||||
{"groups": []any{"group2"}},
|
|
||||||
{"cidr": "1.1.1.1/1"},
|
|
||||||
{"groups": []any{"group2"}, "host": "bob"},
|
|
||||||
{"cidr": "1.1.1.1/1", "host": "bob"},
|
|
||||||
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1"},
|
|
||||||
{"groups": []any{"group2"}, "cidr": "1.1.1.1/1", "host": "bob"},
|
|
||||||
}
|
|
||||||
for _, c := range yesWarningPlease {
|
|
||||||
r, err := yamlToConfigRule(l, c, "test", 1)
|
|
||||||
require.NoError(t, err)
|
|
||||||
r.Groups = append(r.Groups, "any")
|
|
||||||
err = r.sanity()
|
|
||||||
require.Error(t, err, "I wanted a warning: %+v", c)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type addRuleCall struct {
|
|
||||||
incoming bool
|
|
||||||
proto uint8
|
|
||||||
startPort int32
|
|
||||||
endPort int32
|
|
||||||
groups []string
|
|
||||||
host string
|
|
||||||
ip string
|
|
||||||
localIp string
|
|
||||||
caName string
|
|
||||||
caSha string
|
|
||||||
}
|
|
||||||
|
|
||||||
type mockFirewall struct {
|
|
||||||
lastCall addRuleCall
|
|
||||||
nextCallReturn error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (mf *mockFirewall) AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, ip, localIp, caName string, caSha string) error {
|
|
||||||
mf.lastCall = addRuleCall{
|
|
||||||
incoming: incoming,
|
|
||||||
proto: proto,
|
|
||||||
startPort: startPort,
|
|
||||||
endPort: endPort,
|
|
||||||
groups: groups,
|
|
||||||
host: host,
|
|
||||||
ip: ip,
|
|
||||||
localIp: localIp,
|
|
||||||
caName: caName,
|
|
||||||
caSha: caSha,
|
|
||||||
}
|
|
||||||
|
|
||||||
err := mf.nextCallReturn
|
|
||||||
mf.nextCallReturn = nil
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
+14
-40
@@ -40,55 +40,29 @@ func (fp *Packet) Copy() *Packet {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (fp Packet) MarshalJSON() ([]byte, error) {
|
func (fp Packet) MarshalJSON() ([]byte, error) {
|
||||||
|
var proto string
|
||||||
|
switch fp.Protocol {
|
||||||
|
case iputil.IPProtocolTCP:
|
||||||
|
proto = "tcp"
|
||||||
|
case iputil.IPProtocolICMP:
|
||||||
|
proto = "icmp"
|
||||||
|
case iputil.IPProtocolICMPv6:
|
||||||
|
proto = "icmpv6"
|
||||||
|
case iputil.IPProtocolUDP:
|
||||||
|
proto = "udp"
|
||||||
|
default:
|
||||||
|
proto = fmt.Sprintf("unknown %v", fp.Protocol)
|
||||||
|
}
|
||||||
return json.Marshal(m{
|
return json.Marshal(m{
|
||||||
"LocalAddr": fp.LocalAddr.String(),
|
"LocalAddr": fp.LocalAddr.String(),
|
||||||
"RemoteAddr": fp.RemoteAddr.String(),
|
"RemoteAddr": fp.RemoteAddr.String(),
|
||||||
"LocalPort": fp.LocalPort,
|
"LocalPort": fp.LocalPort,
|
||||||
"RemotePort": fp.RemotePort,
|
"RemotePort": fp.RemotePort,
|
||||||
"Protocol": protoName(fp.Protocol),
|
"Protocol": proto,
|
||||||
"Fragment": fp.Fragment,
|
"Fragment": fp.Fragment,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// protoNames are the protocol names that rules accept and packets report, and their numbers. Any other protocol
|
|
||||||
// is given by number.
|
|
||||||
var protoNames = []struct {
|
|
||||||
name string
|
|
||||||
proto uint8
|
|
||||||
}{
|
|
||||||
{"any", ProtoAny},
|
|
||||||
{"tcp", iputil.IPProtocolTCP},
|
|
||||||
{"udp", iputil.IPProtocolUDP},
|
|
||||||
{"udplite", iputil.IPProtocolUDPLite},
|
|
||||||
{"dccp", iputil.IPProtocolDCCP},
|
|
||||||
{"sctp", iputil.IPProtocolSCTP},
|
|
||||||
{"icmp", iputil.IPProtocolICMP},
|
|
||||||
{"icmpv6", iputil.IPProtocolICMPv6},
|
|
||||||
}
|
|
||||||
|
|
||||||
// protoByName returns the number of a protocol named in protoNames.
|
|
||||||
func protoByName(name string) (uint8, bool) {
|
|
||||||
for _, p := range protoNames {
|
|
||||||
if p.name == name {
|
|
||||||
return p.proto, true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return 0, false
|
|
||||||
}
|
|
||||||
|
|
||||||
// protoName returns the name in protoNames of a packet's protocol, or "unknown" and its number. `any` is only
|
|
||||||
// a rule's protocol, so a packet's protocol 0 is unknown.
|
|
||||||
func protoName(proto uint8) string {
|
|
||||||
if proto != ProtoAny {
|
|
||||||
for _, p := range protoNames {
|
|
||||||
if p.proto == proto {
|
|
||||||
return p.name
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return fmt.Sprintf("unknown %v", proto)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParsedPacket is a Packet plus the parse byproducts the RX path reuses
|
// ParsedPacket is a Packet plus the parse byproducts the RX path reuses
|
||||||
type ParsedPacket struct {
|
type ParsedPacket struct {
|
||||||
Packet
|
Packet
|
||||||
|
|||||||
@@ -1,258 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"fmt"
|
|
||||||
"hash/fnv"
|
|
||||||
"log/slog"
|
|
||||||
"math"
|
|
||||||
"net/netip"
|
|
||||||
"slices"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/iputil"
|
|
||||||
)
|
|
||||||
|
|
||||||
// RulesBuilder collects the inbound and outbound rules, Build turns them into a Table for each direction
|
|
||||||
type RulesBuilder struct {
|
|
||||||
// in and out are each direction's rules in the order they were added
|
|
||||||
in, out []rule
|
|
||||||
|
|
||||||
// defaultLocalCIDRAny makes rules without a local cidr allow any local address, even with unsafe networks
|
|
||||||
defaultLocalCIDRAny bool
|
|
||||||
|
|
||||||
// ruleText describes every rule as it is added, one line each. Build hashes it; see Rules.
|
|
||||||
ruleText strings.Builder
|
|
||||||
|
|
||||||
l *slog.Logger
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewRulesBuilder(l *slog.Logger) *RulesBuilder {
|
|
||||||
return &RulesBuilder{l: l}
|
|
||||||
}
|
|
||||||
|
|
||||||
// AddRule adds a rule for incoming or outgoing traffic, on proto or on every protocol when proto is ProtoAny.
|
|
||||||
// The rule is parsed now, so a bad rule is reported when it's added rather than when the Tables are built.
|
|
||||||
func (b *RulesBuilder) AddRule(incoming bool, proto uint8, startPort int32, endPort int32, groups []string, host string, cidr, localCidr, caName string, caSha string) error {
|
|
||||||
// ICMPv6 rules are ICMP rules, and a packet of either protocol is checked against both
|
|
||||||
if proto == iputil.IPProtocolICMPv6 {
|
|
||||||
proto = iputil.IPProtocolICMP
|
|
||||||
}
|
|
||||||
|
|
||||||
if proto == iputil.IPProtocolICMP {
|
|
||||||
//ICMP traffic doesn't have ports, so we always coerce to "any", even if a value is provided
|
|
||||||
if startPort != PortAny {
|
|
||||||
b.l.Warn("ignoring port specification for ICMP firewall rule", "startPort", startPort)
|
|
||||||
}
|
|
||||||
startPort = PortAny
|
|
||||||
endPort = PortAny
|
|
||||||
}
|
|
||||||
|
|
||||||
r, err := parseRule(proto, startPort, endPort, groups, host, cidr, localCidr, caName, caSha)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if incoming {
|
|
||||||
b.in = append(b.in, r)
|
|
||||||
} else {
|
|
||||||
b.out = append(b.out, r)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The rule hashes are of these lines, changing them changes every hash
|
|
||||||
fmt.Fprintf(&b.ruleText,
|
|
||||||
"incoming: %v, proto: %v, startPort: %v, endPort: %v, groups: %v, host: %v, ip: %v, localIp: %v, caName: %v, caSha: %s\n",
|
|
||||||
incoming, proto, startPort, endPort, groups, host, cidr, localCidr, caName, caSha,
|
|
||||||
)
|
|
||||||
|
|
||||||
direction := "incoming"
|
|
||||||
if !incoming {
|
|
||||||
direction = "outgoing"
|
|
||||||
}
|
|
||||||
b.l.Info("Firewall rule added",
|
|
||||||
"firewallRule", m{"direction": direction, "proto": proto, "startPort": startPort, "endPort": endPort, "groups": groups, "host": host, "cidr": cidr, "localCidr": localCidr, "caName": caName, "caSha": caSha},
|
|
||||||
)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Build turns the rules into a Table for each direction, and hashes them. Rules without a local cidr allow
|
|
||||||
// vpnNetworks when there are unsafe networks, otherwise any local address.
|
|
||||||
func (b *RulesBuilder) Build(vpnNetworks, unsafeNetworks []netip.Prefix) Rules {
|
|
||||||
var defaultLocal []netip.Prefix
|
|
||||||
if len(unsafeNetworks) > 0 && !b.defaultLocalCIDRAny {
|
|
||||||
// Never nil, even when there are no vpn networks, so that the rules allow nothing rather than everything.
|
|
||||||
defaultLocal = append([]netip.Prefix{}, vpnNetworks...)
|
|
||||||
}
|
|
||||||
|
|
||||||
text := []byte(b.ruleText.String())
|
|
||||||
sha := sha256.Sum256(text)
|
|
||||||
h := fnv.New32a()
|
|
||||||
h.Write(text)
|
|
||||||
|
|
||||||
return Rules{
|
|
||||||
In: buildTable(b.in, defaultLocal),
|
|
||||||
Out: buildTable(b.out, defaultLocal),
|
|
||||||
Hash: hex.EncodeToString(sha[:]),
|
|
||||||
HashFNV: h.Sum32(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseRule(proto uint8, startPort, endPort int32, groups []string, host, cidr, localCidr, caName, caSha string) (rule, error) {
|
|
||||||
if startPort > endPort {
|
|
||||||
return rule{}, fmt.Errorf("start port was lower than end port")
|
|
||||||
}
|
|
||||||
if startPort < PortFragment || endPort > math.MaxUint16 {
|
|
||||||
return rule{}, fmt.Errorf("port range %d-%d is outside of %d-%d", startPort, endPort, PortFragment, math.MaxUint16)
|
|
||||||
}
|
|
||||||
// A range that includes port 0 is port `any`.
|
|
||||||
if startPort <= PortAny && PortAny <= endPort {
|
|
||||||
startPort, endPort = PortAny, PortAny
|
|
||||||
}
|
|
||||||
// A port rule on a protocol without ports could never match. ICMP rules were coerced to `any` by AddRule,
|
|
||||||
// and a proto `any` rule with a port applies to the protocols that have them.
|
|
||||||
if startPort > PortAny && proto != ProtoAny && !iputil.HasPorts(proto) {
|
|
||||||
return rule{}, fmt.Errorf("protocol %d has no ports, port must be any or fragment", proto)
|
|
||||||
}
|
|
||||||
|
|
||||||
r := rule{
|
|
||||||
proto: proto,
|
|
||||||
startPort: startPort,
|
|
||||||
endPort: endPort,
|
|
||||||
groups: groups,
|
|
||||||
host: host,
|
|
||||||
caName: caName,
|
|
||||||
caSha: caSha,
|
|
||||||
}
|
|
||||||
|
|
||||||
var anyCIDR bool
|
|
||||||
var err error
|
|
||||||
r.cidr, anyCIDR, err = parseCIDR(cidr)
|
|
||||||
if err != nil {
|
|
||||||
return rule{}, fmt.Errorf("cidr did not parse; %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// A rule with no group, host, or cidr allows any host, as does a rule with `any` for one of them.
|
|
||||||
r.remoteAny = anyCIDR || host == "any" || slices.Contains(groups, "any") ||
|
|
||||||
(len(groups) == 0 && host == "" && !r.cidr.IsValid())
|
|
||||||
|
|
||||||
var localCIDR netip.Prefix
|
|
||||||
localCIDR, r.localAny, err = parseCIDR(localCidr)
|
|
||||||
if err != nil {
|
|
||||||
return rule{}, fmt.Errorf("local_cidr did not parse; %w", err)
|
|
||||||
}
|
|
||||||
if localCIDR.IsValid() {
|
|
||||||
r.local = []netip.Prefix{localCIDR}
|
|
||||||
}
|
|
||||||
|
|
||||||
return r, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// buildTable turns one direction's rules into a Table. Rules without a local cidr allow defaultLocal,
|
|
||||||
// or any local address when defaultLocal is nil.
|
|
||||||
func buildTable(rules []rule, defaultLocal []netip.Prefix) *Table {
|
|
||||||
t := &Table{rules: make([]rule, len(rules))}
|
|
||||||
var hasOwn [256]bool
|
|
||||||
for id, r := range rules {
|
|
||||||
t.rules[id] = r.withDefaultLocal(defaultLocal)
|
|
||||||
if r.proto != ProtoAny {
|
|
||||||
hasOwn[r.proto] = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// A protocol with rules of its own gets an index of those rules plus the proto `any` rules, so a packet
|
|
||||||
// checks a single index. The other protocols share an index of the proto `any` rules, one for protocols with
|
|
||||||
// ports and one for protocols without.
|
|
||||||
anyPorts := newProtoIndex(true, t.rules, ProtoAny)
|
|
||||||
anyNoPorts := newProtoIndex(false, t.rules, ProtoAny)
|
|
||||||
for proto := range t.protos {
|
|
||||||
switch {
|
|
||||||
case hasOwn[proto]:
|
|
||||||
t.protos[proto] = newProtoIndex(iputil.HasPorts(uint8(proto)), t.rules, uint8(proto))
|
|
||||||
case iputil.HasPorts(uint8(proto)):
|
|
||||||
t.protos[proto] = anyPorts
|
|
||||||
default:
|
|
||||||
t.protos[proto] = anyNoPorts
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ICMPv6 rules are ICMP rules, see AddRule, so ICMPv6 packets are checked against the ICMP index
|
|
||||||
t.protos[iputil.IPProtocolICMPv6] = t.protos[iputil.IPProtocolICMP]
|
|
||||||
|
|
||||||
return t
|
|
||||||
}
|
|
||||||
|
|
||||||
// newProtoIndex builds an index of the proto `any` rules and proto's own rules, for a protocol with or without
|
|
||||||
// ports, or returns nil when there are none. With ProtoAny, it indexes only the proto `any` rules.
|
|
||||||
func newProtoIndex(hasPorts bool, rules []rule, proto uint8) *protoIndex {
|
|
||||||
var pi *protoIndex
|
|
||||||
for id := range rules {
|
|
||||||
r := &rules[id]
|
|
||||||
if r.proto != ProtoAny && r.proto != proto {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if pi == nil {
|
|
||||||
pi = &protoIndex{hasPorts: hasPorts, fragment: newRuleSet(len(rules))}
|
|
||||||
if hasPorts {
|
|
||||||
pi.byPort = newRuleSets(math.MaxUint16+1, len(rules))
|
|
||||||
} else {
|
|
||||||
pi.packet = newRuleSet(len(rules))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
pi.add(r, id)
|
|
||||||
}
|
|
||||||
return pi
|
|
||||||
}
|
|
||||||
|
|
||||||
// add puts id in every set that r's port clause covers.
|
|
||||||
func (pi *protoIndex) add(r *rule, id int) {
|
|
||||||
switch r.startPort {
|
|
||||||
case PortAny:
|
|
||||||
pi.fragment.add(id)
|
|
||||||
if pi.hasPorts {
|
|
||||||
pi.addPorts(0, math.MaxUint16, id)
|
|
||||||
} else {
|
|
||||||
pi.packet.add(id)
|
|
||||||
}
|
|
||||||
case PortFragment:
|
|
||||||
pi.fragment.add(id)
|
|
||||||
default:
|
|
||||||
// A proto `any` rule with a port is indexed for the protocols that have ports, parseRule rejects a port on
|
|
||||||
// a protocol without them.
|
|
||||||
if pi.hasPorts {
|
|
||||||
pi.addPorts(int(r.startPort), int(r.endPort), id)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// addPorts puts id in the set of every port from lo through hi.
|
|
||||||
func (pi *protoIndex) addPorts(lo, hi, id int) {
|
|
||||||
for port := lo; port <= hi; port++ {
|
|
||||||
pi.byPort.at(port).add(id)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseCIDR parses a rule's cidr, which is empty, `any`, or a prefix
|
|
||||||
func parseCIDR(s string) (prefix netip.Prefix, isAny bool, err error) {
|
|
||||||
switch s {
|
|
||||||
case "":
|
|
||||||
return netip.Prefix{}, false, nil
|
|
||||||
case "any":
|
|
||||||
return netip.Prefix{}, true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
prefix, err = netip.ParsePrefix(s)
|
|
||||||
return prefix, false, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// withDefaultLocal returns r allowing defaultLocal, or any local address when defaultLocal is nil,
|
|
||||||
// unless r has a local cidr of its own
|
|
||||||
func (r rule) withDefaultLocal(defaultLocal []netip.Prefix) rule {
|
|
||||||
if !r.localAny && r.local == nil {
|
|
||||||
r.localAny = defaultLocal == nil
|
|
||||||
r.local = defaultLocal
|
|
||||||
}
|
|
||||||
return r
|
|
||||||
}
|
|
||||||
@@ -1,367 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"math"
|
|
||||||
"net/netip"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/cert"
|
|
||||||
"github.com/slackhq/nebula/cert_test"
|
|
||||||
"github.com/slackhq/nebula/iputil"
|
|
||||||
"github.com/slackhq/nebula/test"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// rulesAt returns the rules that a packet on proto with the given port is checked against, in id order.
|
|
||||||
// port may also be PortAny or PortFragment.
|
|
||||||
func (t *Table) rulesAt(proto uint8, port int32) []*rule {
|
|
||||||
pi := t.protos[proto]
|
|
||||||
if pi == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
p := &Packet{Protocol: proto, Fragment: port == PortFragment}
|
|
||||||
if port > 0 {
|
|
||||||
p.LocalPort = uint16(port)
|
|
||||||
}
|
|
||||||
|
|
||||||
var rules []*rule
|
|
||||||
for id := range pi.whichMatch(p, true).all() {
|
|
||||||
rules = append(rules, &t.rules[id])
|
|
||||||
}
|
|
||||||
return rules
|
|
||||||
}
|
|
||||||
|
|
||||||
// oneRuleAt returns the single rule that rulesAt finds, and fails the test when there is not exactly one.
|
|
||||||
func oneRuleAt(t *testing.T, table *Table, proto uint8, key int32) *rule {
|
|
||||||
t.Helper()
|
|
||||||
rules := table.rulesAt(proto, key)
|
|
||||||
require.Len(t, rules, 1)
|
|
||||||
return rules[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRulesBuilder_AddRule(t *testing.T) {
|
|
||||||
l := test.NewLogger()
|
|
||||||
|
|
||||||
ti := netip.MustParsePrefix("1.2.3.4/32")
|
|
||||||
ti6 := netip.MustParsePrefix("fd12::34/128")
|
|
||||||
|
|
||||||
rb := NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, []string{}, "", "", "", "", ""))
|
|
||||||
rules := rb.Build(nil, nil)
|
|
||||||
// An empty rule is any
|
|
||||||
r := oneRuleAt(t, rules.In, iputil.IPProtocolTCP, 1)
|
|
||||||
assert.True(t, r.remoteAny)
|
|
||||||
assert.Empty(t, r.groups)
|
|
||||||
assert.Empty(t, r.host)
|
|
||||||
// It applies only to its own port.
|
|
||||||
assert.Empty(t, rules.In.rulesAt(iputil.IPProtocolTCP, 2))
|
|
||||||
assert.Empty(t, rules.In.rulesAt(iputil.IPProtocolTCP, PortAny))
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolUDP, 1, 1, []string{"g1"}, "", "", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.In, iputil.IPProtocolUDP, 1)
|
|
||||||
assert.False(t, r.remoteAny)
|
|
||||||
assert.Equal(t, []string{"g1"}, r.groups)
|
|
||||||
assert.Empty(t, r.host)
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolICMP, 1, 1, []string{}, "h1", "", "", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolICMPv6, 1, 1, []string{}, "h2", "", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
// An ICMP rule is port `any` regardless of the port given, and ICMP and ICMPv6 share one set of rules.
|
|
||||||
for _, proto := range []uint8{iputil.IPProtocolICMP, iputil.IPProtocolICMPv6} {
|
|
||||||
rs := rules.In.rulesAt(proto, PortAny)
|
|
||||||
require.Len(t, rs, 2, "proto %d", proto)
|
|
||||||
assert.False(t, rs[0].remoteAny)
|
|
||||||
assert.Equal(t, "h1", rs[0].host)
|
|
||||||
assert.Equal(t, "h2", rs[1].host)
|
|
||||||
}
|
|
||||||
assert.Same(t, rules.In.protos[iputil.IPProtocolICMP], rules.In.protos[iputil.IPProtocolICMPv6])
|
|
||||||
|
|
||||||
// Any other protocol number gets its own rules
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, 47, 0, 0, []string{"g1"}, "", "", "", "", "")) // GRE
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.Equal(t, []string{"g1"}, oneRuleAt(t, rules.In, 47, PortAny).groups)
|
|
||||||
assert.Nil(t, rules.In.protos[iputil.IPProtocolTCP])
|
|
||||||
|
|
||||||
// A proto `any` rule with a port applies to every protocol with ports, and ProtoAny itself has none.
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", ti.String(), "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.Empty(t, rules.Out.rulesAt(ProtoAny, 1))
|
|
||||||
r = oneRuleAt(t, rules.Out, iputil.IPProtocolTCP, 1)
|
|
||||||
assert.False(t, r.remoteAny)
|
|
||||||
assert.Equal(t, ti, r.cidr)
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", ti6.String(), "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.Out, iputil.IPProtocolTCP, 1)
|
|
||||||
assert.False(t, r.remoteAny)
|
|
||||||
assert.Equal(t, ti6, r.cidr)
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", "", ti.String(), "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.Out, iputil.IPProtocolTCP, 1)
|
|
||||||
assert.True(t, r.remoteAny)
|
|
||||||
assert.False(t, r.localAny)
|
|
||||||
assert.Equal(t, []netip.Prefix{ti}, r.local)
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 1, 1, []string{}, "", "", ti6.String(), "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.Out, iputil.IPProtocolTCP, 1)
|
|
||||||
assert.True(t, r.remoteAny)
|
|
||||||
assert.False(t, r.localAny)
|
|
||||||
assert.Equal(t, []netip.Prefix{ti6}, r.local)
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolUDP, 1, 1, []string{"g1"}, "", "", "", "ca-name", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.Equal(t, "ca-name", oneRuleAt(t, rules.In, iputil.IPProtocolUDP, 1).caName)
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolUDP, 1, 1, []string{"g1"}, "", "", "", "", "ca-sha"))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.Equal(t, "ca-sha", oneRuleAt(t, rules.In, iputil.IPProtocolUDP, 1).caSha)
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "any", "", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.True(t, oneRuleAt(t, rules.Out, ProtoAny, 0).remoteAny)
|
|
||||||
|
|
||||||
// 0.0.0.0/0 allows any IPv4 address, but no IPv6 address.
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "0.0.0.0/0", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.Out, ProtoAny, 0)
|
|
||||||
assert.False(t, r.remoteAny)
|
|
||||||
assert.True(t, r.matchRemote(netip.MustParseAddr("1.1.1.1"), nil))
|
|
||||||
assert.False(t, r.matchRemote(netip.MustParseAddr("9::9"), nil))
|
|
||||||
|
|
||||||
// ::/0 allows any IPv6 address, but no IPv4 address.
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "::/0", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.Out, ProtoAny, 0)
|
|
||||||
assert.False(t, r.remoteAny)
|
|
||||||
assert.True(t, r.matchRemote(netip.MustParseAddr("9::9"), nil))
|
|
||||||
assert.False(t, r.matchRemote(netip.MustParseAddr("1.1.1.1"), nil))
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "any", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.True(t, oneRuleAt(t, rules.Out, ProtoAny, 0).remoteAny)
|
|
||||||
|
|
||||||
// A local cidr is likewise limited to its own address family.
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "", "0.0.0.0/0", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.Out, ProtoAny, 0)
|
|
||||||
assert.False(t, r.localAny)
|
|
||||||
assert.True(t, r.matchLocal(netip.MustParseAddr("1.1.1.1")))
|
|
||||||
assert.False(t, r.matchLocal(netip.MustParseAddr("9::9")))
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "", "::/0", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
r = oneRuleAt(t, rules.Out, ProtoAny, 0)
|
|
||||||
assert.False(t, r.localAny)
|
|
||||||
assert.True(t, r.matchLocal(netip.MustParseAddr("9::9")))
|
|
||||||
assert.False(t, r.matchLocal(netip.MustParseAddr("1.1.1.1")))
|
|
||||||
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(false, ProtoAny, 0, 0, []string{}, "", "", "any", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.True(t, oneRuleAt(t, rules.Out, ProtoAny, 0).localAny)
|
|
||||||
|
|
||||||
// Every protocol number is accepted
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, math.MaxUint8, 0, 0, []string{}, "", "", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.True(t, oneRuleAt(t, rules.In, math.MaxUint8, PortAny).remoteAny)
|
|
||||||
|
|
||||||
// Test error conditions, a bad rule is reported when it's added
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.Error(t, rb.AddRule(true, ProtoAny, 10, 0, []string{}, "", "", "", "", ""))
|
|
||||||
require.Error(t, rb.AddRule(true, ProtoAny, PortFragment-1, 0, []string{}, "", "", "", "", ""))
|
|
||||||
require.Error(t, rb.AddRule(true, ProtoAny, 1, math.MaxUint16+1, []string{}, "", "", "", "", ""))
|
|
||||||
require.Error(t, rb.AddRule(true, ProtoAny, 0, 0, []string{}, "", "junk", "", "", ""))
|
|
||||||
require.Error(t, rb.AddRule(true, ProtoAny, 0, 0, []string{}, "", "", "junk", "", ""))
|
|
||||||
|
|
||||||
// ICMP and ICMPv6 share one copy of each proto `any` rule
|
|
||||||
rb = NewRulesBuilder(l)
|
|
||||||
require.NoError(t, rb.AddRule(true, ProtoAny, PortAny, PortAny, []string{"default-group"}, "", "", "", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolICMPv6, PortAny, PortAny, []string{"nope"}, "", "", "", "", ""))
|
|
||||||
rules = rb.Build(nil, nil)
|
|
||||||
assert.Len(t, rules.In.rules, 2)
|
|
||||||
assert.Len(t, rules.In.rulesAt(iputil.IPProtocolICMP, PortAny), 2)
|
|
||||||
assert.Len(t, rules.In.rulesAt(iputil.IPProtocolICMPv6, PortAny), 2)
|
|
||||||
|
|
||||||
// No rules allow nothing
|
|
||||||
rules = NewRulesBuilder(l).Build(nil, nil)
|
|
||||||
for proto := range rules.In.protos {
|
|
||||||
assert.Nil(t, rules.In.protos[proto], "proto %d", proto)
|
|
||||||
assert.Nil(t, rules.Out.protos[proto], "proto %d", proto)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRulesBuilder_protoIndex checks which packets each kind of port clause covers, and which protocols
|
|
||||||
// share an index.
|
|
||||||
func TestRulesBuilder_protoIndex(t *testing.T) {
|
|
||||||
rb := NewRulesBuilder(test.NewLogger())
|
|
||||||
require.NoError(t, rb.AddRule(true, ProtoAny, PortAny, PortAny, nil, "any", "", "", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 22, 22, nil, "port", "", "", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1024, math.MaxUint16, nil, "range", "", "", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, PortFragment, PortFragment, nil, "fragment", "", "", "", ""))
|
|
||||||
// A range that includes port 0 is port `any`.
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolUDP, 0, 100, nil, "zero", "", "", "", ""))
|
|
||||||
// GRE has no ports, so a port rule on it is rejected rather than never applying, and `any` and `fragment` apply
|
|
||||||
require.Error(t, rb.AddRule(true, 47, 22, 22, nil, "gre", "", "", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, 47, PortFragment, PortFragment, nil, "gre", "", "", "", ""))
|
|
||||||
rules := rb.Build(nil, nil)
|
|
||||||
|
|
||||||
hosts := func(proto uint8, key int32) []string {
|
|
||||||
var hosts []string
|
|
||||||
for _, r := range rules.In.rulesAt(proto, key) {
|
|
||||||
hosts = append(hosts, r.host)
|
|
||||||
}
|
|
||||||
return hosts
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.Equal(t, []string{"any", "fragment"}, hosts(iputil.IPProtocolTCP, PortFragment))
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(iputil.IPProtocolTCP, PortAny))
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(iputil.IPProtocolTCP, 21))
|
|
||||||
assert.Equal(t, []string{"any", "port"}, hosts(iputil.IPProtocolTCP, 22))
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(iputil.IPProtocolTCP, 23))
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(iputil.IPProtocolTCP, 1023))
|
|
||||||
assert.Equal(t, []string{"any", "range"}, hosts(iputil.IPProtocolTCP, 1024))
|
|
||||||
assert.Equal(t, []string{"any", "range"}, hosts(iputil.IPProtocolTCP, math.MaxUint16))
|
|
||||||
|
|
||||||
assert.Equal(t, []string{"any", "zero"}, hosts(iputil.IPProtocolUDP, PortFragment))
|
|
||||||
assert.Equal(t, []string{"any", "zero"}, hosts(iputil.IPProtocolUDP, PortAny))
|
|
||||||
assert.Equal(t, []string{"any", "zero"}, hosts(iputil.IPProtocolUDP, math.MaxUint16))
|
|
||||||
|
|
||||||
// A protocol without ports sees only the port `any` rules, and the port `fragment` rules for a fragment.
|
|
||||||
assert.False(t, rules.In.protos[47].hasPorts)
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(47, PortAny))
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(47, 22))
|
|
||||||
assert.Equal(t, []string{"any", "gre"}, hosts(47, PortFragment))
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(iputil.IPProtocolICMP, PortFragment))
|
|
||||||
|
|
||||||
// Protocols without rules of their own share an index of the proto `any` rules: one for protocols with
|
|
||||||
// ports and one for protocols without.
|
|
||||||
assert.True(t, rules.In.protos[iputil.IPProtocolSCTP].hasPorts)
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(iputil.IPProtocolSCTP, 5000))
|
|
||||||
assert.Same(t, rules.In.protos[iputil.IPProtocolSCTP], rules.In.protos[iputil.IPProtocolDCCP])
|
|
||||||
assert.NotSame(t, rules.In.protos[iputil.IPProtocolSCTP], rules.In.protos[iputil.IPProtocolTCP])
|
|
||||||
assert.Equal(t, []string{"any"}, hosts(50, PortAny))
|
|
||||||
assert.Same(t, rules.In.protos[ProtoAny], rules.In.protos[50])
|
|
||||||
assert.Same(t, rules.In.protos[ProtoAny], rules.In.protos[iputil.IPProtocolICMP])
|
|
||||||
assert.NotSame(t, rules.In.protos[ProtoAny], rules.In.protos[iputil.IPProtocolSCTP])
|
|
||||||
assert.Nil(t, rules.Out.protos[iputil.IPProtocolTCP])
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRulesBuilder_manyRules checks that rule ids beyond the first byte of a rule set are indexed correctly.
|
|
||||||
func TestRulesBuilder_manyRules(t *testing.T) {
|
|
||||||
rb := NewRulesBuilder(test.NewLogger())
|
|
||||||
const n = 130
|
|
||||||
for i := range n {
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, int32(i+1), int32(i+1), nil, fmt.Sprintf("h%d", i), "", "", "", ""))
|
|
||||||
}
|
|
||||||
require.NoError(t, rb.AddRule(true, ProtoAny, PortAny, PortAny, nil, "any", "", "", "", ""))
|
|
||||||
rules := rb.Build(nil, nil)
|
|
||||||
|
|
||||||
assert.Equal(t, ruleSetLen(n+1), rules.In.protos[iputil.IPProtocolTCP].byPort.setLen)
|
|
||||||
// Ids are the order the rules were added in, so the proto `any` rule comes last
|
|
||||||
for i := range n {
|
|
||||||
rs := rules.In.rulesAt(iputil.IPProtocolTCP, int32(i+1))
|
|
||||||
require.Len(t, rs, 2, "port %d", i+1)
|
|
||||||
assert.Equal(t, fmt.Sprintf("h%d", i), rs[0].host)
|
|
||||||
assert.Equal(t, "any", rs[1].host)
|
|
||||||
}
|
|
||||||
assert.Len(t, rules.In.rulesAt(iputil.IPProtocolTCP, n+1), 1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRulesBuilder_defaultLocalCIDR checks which local addresses rules allow when there are unsafe networks.
|
|
||||||
// A rule without a local cidr allows only the vpn networks, and a rule with one allows only that cidr.
|
|
||||||
func TestRulesBuilder_defaultLocalCIDR(t *testing.T) {
|
|
||||||
vpnNetworks := []netip.Prefix{
|
|
||||||
netip.MustParsePrefix("10.1.0.5/16"),
|
|
||||||
netip.MustParsePrefix("10.2.0.5/16"),
|
|
||||||
netip.MustParsePrefix("fd00:1::5/64"),
|
|
||||||
}
|
|
||||||
unsafeNetworks := []netip.Prefix{netip.MustParsePrefix("192.168.0.0/24")}
|
|
||||||
vpn1 := netip.MustParseAddr("10.1.9.9")
|
|
||||||
vpn2 := netip.MustParseAddr("10.2.9.9")
|
|
||||||
vpn6 := netip.MustParseAddr("fd00:1::9")
|
|
||||||
h1Extra := netip.MustParseAddr("10.3.0.1")
|
|
||||||
h1Extra6 := netip.MustParseAddr("fd00:2::1")
|
|
||||||
h2Own := netip.MustParseAddr("10.4.0.1")
|
|
||||||
|
|
||||||
rb := NewRulesBuilder(test.NewLogger())
|
|
||||||
// h1 allows the vpn networks by default on ports 1 and 2, and 10.3.0.0/16 and fd00:2::/64 as well on port 1
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 2, nil, "h1", "", "", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, nil, "h1", "", "10.3.0.0/16", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, nil, "h1", "", "fd00:2::/64", "", ""))
|
|
||||||
// h2 allows 10.4.0.0/16 on ports 1 and 2, and the vpn networks by default as well on port 1
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 2, nil, "h2", "", "10.4.0.0/16", "", ""))
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 1, 1, nil, "h2", "", "", "", ""))
|
|
||||||
// h3 only has the default
|
|
||||||
require.NoError(t, rb.AddRule(true, iputil.IPProtocolTCP, 3, 3, nil, "h3", "", "", "", ""))
|
|
||||||
rules := rb.Build(vpnNetworks, unsafeNetworks)
|
|
||||||
|
|
||||||
ca, _, caKey, _ := cert_test.NewTestCaCert(cert.Version2, cert.Curve_CURVE25519, time.Time{}, time.Time{}, nil, nil, nil)
|
|
||||||
caPool := cert.NewCAPool()
|
|
||||||
require.NoError(t, caPool.AddCA(ca))
|
|
||||||
certs := map[string]*cert.CachedCertificate{}
|
|
||||||
for _, name := range []string{"h1", "h2", "h3"} {
|
|
||||||
crt, _, _, _ := cert_test.NewTestCert(cert.Version2, cert.Curve_CURVE25519, ca, caKey, name, time.Time{}, time.Time{}, []netip.Prefix{netip.MustParsePrefix("10.1.0.9/16")}, nil, nil)
|
|
||||||
c, err := caPool.VerifyCertificate(time.Now(), crt)
|
|
||||||
require.NoError(t, err)
|
|
||||||
certs[name] = c
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range []struct {
|
|
||||||
port uint16
|
|
||||||
host string
|
|
||||||
addr netip.Addr
|
|
||||||
want bool
|
|
||||||
}{
|
|
||||||
{1, "h1", vpn1, true},
|
|
||||||
{1, "h1", vpn2, true},
|
|
||||||
{1, "h1", vpn6, true},
|
|
||||||
{1, "h1", h1Extra, true},
|
|
||||||
{1, "h1", h1Extra6, true},
|
|
||||||
{1, "h1", h2Own, false},
|
|
||||||
{2, "h1", vpn1, true},
|
|
||||||
{2, "h1", h1Extra, false},
|
|
||||||
{2, "h1", h1Extra6, false},
|
|
||||||
{1, "h2", h2Own, true},
|
|
||||||
{1, "h2", vpn1, true},
|
|
||||||
{1, "h2", vpn2, true},
|
|
||||||
{1, "h2", vpn6, true},
|
|
||||||
{1, "h2", h1Extra, false},
|
|
||||||
{2, "h2", h2Own, true},
|
|
||||||
{2, "h2", vpn1, false},
|
|
||||||
{2, "h2", vpn6, false},
|
|
||||||
{3, "h3", vpn1, true},
|
|
||||||
{3, "h3", vpn2, true},
|
|
||||||
{3, "h3", vpn6, true},
|
|
||||||
{3, "h3", h1Extra, false},
|
|
||||||
{3, "h3", h1Extra6, false},
|
|
||||||
{3, "h3", h2Own, false},
|
|
||||||
// Only h3 is allowed on port 3.
|
|
||||||
{3, "h1", vpn1, false},
|
|
||||||
} {
|
|
||||||
p := &Packet{Protocol: iputil.IPProtocolTCP, LocalPort: tc.port, LocalAddr: tc.addr, RemoteAddr: netip.MustParseAddr("10.1.0.9")}
|
|
||||||
assert.Equal(t, tc.want, rules.In.Match(p, true, certs[tc.host], caPool), "port %d, %s, %s", tc.port, tc.host, tc.addr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"iter"
|
|
||||||
"math/bits"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ruleSet is a set of rule ids, stored as a bitset. s[i] holds ids i*8 through i*8+7, one per bit.
|
|
||||||
// Bytes rather than words keep a set to the size the rule count needs, which matters when there is a set for
|
|
||||||
// every port number.
|
|
||||||
type ruleSet []uint8
|
|
||||||
|
|
||||||
// ruleSetLen returns the length of a ruleSet that can hold ids below n.
|
|
||||||
func ruleSetLen(n int) int {
|
|
||||||
return (n + 7) / 8
|
|
||||||
}
|
|
||||||
|
|
||||||
// newRuleSet returns an empty set that can hold ids below idLimit.
|
|
||||||
func newRuleSet(idLimit int) ruleSet {
|
|
||||||
return make(ruleSet, ruleSetLen(idLimit))
|
|
||||||
}
|
|
||||||
|
|
||||||
// add puts id in s.
|
|
||||||
func (s ruleSet) add(id int) {
|
|
||||||
s[id/8] |= 1 << (id % 8)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ruleSets holds several ruleSet objects of the same length in a single allocation.
|
|
||||||
type ruleSets struct {
|
|
||||||
// setLen is the number of bytes needed to represent one set
|
|
||||||
setLen int
|
|
||||||
// bits holds the sets in order. Set i starts at i*setLen.
|
|
||||||
bits []uint8
|
|
||||||
}
|
|
||||||
|
|
||||||
// newRuleSets returns n empty sets, each of which can hold ids below idLimit.
|
|
||||||
func newRuleSets(n, idLimit int) ruleSets {
|
|
||||||
setLen := ruleSetLen(idLimit)
|
|
||||||
return ruleSets{setLen: setLen, bits: make([]uint8, n*setLen)}
|
|
||||||
}
|
|
||||||
|
|
||||||
// at returns set i.
|
|
||||||
func (s ruleSets) at(i int) ruleSet {
|
|
||||||
return s.bits[i*s.setLen : (i+1)*s.setLen]
|
|
||||||
}
|
|
||||||
|
|
||||||
// all returns an iterator over the ids in s, in ascending order.
|
|
||||||
func (s ruleSet) all() iter.Seq[int] {
|
|
||||||
return func(yield func(int) bool) {
|
|
||||||
for i, ids := range s {
|
|
||||||
for ids != 0 {
|
|
||||||
id := i*8 + bits.TrailingZeros8(ids)
|
|
||||||
ids &= ids - 1 // Clear the lowest set bit, which is id's.
|
|
||||||
if !yield(id) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,189 +0,0 @@
|
|||||||
package firewall
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/netip"
|
|
||||||
|
|
||||||
"github.com/slackhq/nebula/cert"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Rules are the Tables built for each direction, with hashes of the rules they were built from
|
|
||||||
type Rules struct {
|
|
||||||
In, Out *Table
|
|
||||||
|
|
||||||
// Hash is a sha256 of the rules, HashFNV is an FNV-1a of them for use as a metric value.
|
|
||||||
// Rule sets with the same rules have the same hashes.
|
|
||||||
Hash string
|
|
||||||
HashFNV uint32
|
|
||||||
}
|
|
||||||
|
|
||||||
// Table holds the rules for one direction. A packet is allowed when every clause of a single rule allows it:
|
|
||||||
// proto AND port AND (CA SHA or CA name) AND local CIDR AND (group OR groups OR name OR remote CIDR).
|
|
||||||
// A Table does not change once built; see RulesBuilder.
|
|
||||||
type Table struct {
|
|
||||||
// rules holds every rule for the direction, in the order they were added. A rule's index in this slice is
|
|
||||||
// its id in the ruleSets.
|
|
||||||
rules []rule
|
|
||||||
|
|
||||||
// protos holds the index for each IP protocol number, so a packet is checked against a single index.
|
|
||||||
// A protocol with rules of its own has an index that also includes every proto `any` rule. The remaining
|
|
||||||
// protocols share an index of only the proto `any` rules: one for protocols with ports and one for
|
|
||||||
// protocols without; see hasPorts. An entry is nil when the protocol has no rules at all.
|
|
||||||
// ICMP and ICMPv6 share one index.
|
|
||||||
protos [256]*protoIndex
|
|
||||||
}
|
|
||||||
|
|
||||||
// protoIndex holds the rules that can apply to one protocol, in a set for each kind of packet. Rule ids are
|
|
||||||
// indexes into the direction's rules, so every set is sized by the direction's rule count, not the protocol's:
|
|
||||||
// byPort costs 64 KB per 8 rules in the direction.
|
|
||||||
type protoIndex struct {
|
|
||||||
// hasPorts reports whether the protocol has ports; see iputil.HasPorts.
|
|
||||||
hasPorts bool
|
|
||||||
// byPort has a set for every port number of a protocol with ports. Port 0 is covered only by port `any`
|
|
||||||
// rules, since a range starts at 1.
|
|
||||||
byPort ruleSets
|
|
||||||
// packet holds the rules for a packet of a protocol without ports: the port `any` rules.
|
|
||||||
packet ruleSet
|
|
||||||
// fragment holds the rules for a fragment of any protocol: the port `any` and port `fragment` rules.
|
|
||||||
fragment ruleSet
|
|
||||||
}
|
|
||||||
|
|
||||||
// whichMatch returns the set of rules whose proto and port clauses allow p.
|
|
||||||
func (pi *protoIndex) whichMatch(p *Packet, incoming bool) ruleSet {
|
|
||||||
switch {
|
|
||||||
case p.Fragment:
|
|
||||||
// The ports of a fragmented packet are in its first fragment, and this is a later one.
|
|
||||||
return pi.fragment
|
|
||||||
case !pi.hasPorts:
|
|
||||||
// The port fields are zero, or for ICMP the identifier, which is only for connection tracking.
|
|
||||||
return pi.packet
|
|
||||||
case incoming:
|
|
||||||
return pi.byPort.at(int(p.LocalPort))
|
|
||||||
default:
|
|
||||||
return pi.byPort.at(int(p.RemotePort))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// rule is a parsed rule. A packet is allowed by the rule when its port, certificate, and address clauses all pass.
|
|
||||||
type rule struct {
|
|
||||||
// proto is the IP protocol number the rule applies to, or ProtoAny for every protocol. ICMPv6 rules are kept
|
|
||||||
// as ICMP. The protoIndex checks it, so match does not.
|
|
||||||
proto uint8
|
|
||||||
|
|
||||||
// startPort and endPort are the port clause. A startPort of PortAny covers every port, every packet of a
|
|
||||||
// protocol without ports, and every fragment. PortFragment covers only fragments. A range covers the ports
|
|
||||||
// in it, so it never applies to a protocol without ports.
|
|
||||||
startPort, endPort int32
|
|
||||||
|
|
||||||
// caSha and caName pass a certificate issued by either CA. When neither is set, any CA passes.
|
|
||||||
caSha, caName string
|
|
||||||
|
|
||||||
// remoteAny makes host, groups, and cidr irrelevant. Otherwise, the peer passes when any one of them matches.
|
|
||||||
remoteAny bool
|
|
||||||
host string
|
|
||||||
groups []string
|
|
||||||
cidr netip.Prefix // Invalid when the rule has no cidr.
|
|
||||||
|
|
||||||
// localAny allows any local address. Otherwise, local must contain the address. Neither is set for a rule
|
|
||||||
// without a local cidr until the Table is built and the rule gets the default; see withDefaultLocal.
|
|
||||||
localAny bool
|
|
||||||
local []netip.Prefix
|
|
||||||
}
|
|
||||||
|
|
||||||
// Match reports whether a rule for the direction p is going allows it
|
|
||||||
func (r *Rules) Match(p *Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
|
||||||
t := r.Out
|
|
||||||
if incoming {
|
|
||||||
t = r.In
|
|
||||||
}
|
|
||||||
return t.Match(p, incoming, c, caPool)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Match reports whether a rule allows p
|
|
||||||
func (t *Table) Match(p *Packet, incoming bool, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
|
||||||
proto := t.protos[p.Protocol]
|
|
||||||
if proto == nil {
|
|
||||||
// The protocol has no rules of its own, and there are no proto `any` rules.
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// The index yields every rule whose proto and port clauses allow p.
|
|
||||||
// The packet is allowed when the remaining clauses of any of those rules allow it as well.
|
|
||||||
for id := range proto.whichMatch(p, incoming).all() {
|
|
||||||
if t.rules[id].match(p, c, caPool) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// match reports whether r allows p from the peer with certificate c. The port clause is not checked here; the
|
|
||||||
// protoIndex has already done so.
|
|
||||||
func (r *rule) match(p *Packet, c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
|
||||||
return r.matchLocal(p.LocalAddr) && r.matchRemote(p.RemoteAddr, c) && r.matchCA(c, caPool)
|
|
||||||
}
|
|
||||||
|
|
||||||
// matchLocal reports whether r allows the local address addr.
|
|
||||||
func (r *rule) matchLocal(addr netip.Addr) bool {
|
|
||||||
if r.localAny {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, prefix := range r.local {
|
|
||||||
if prefix.Contains(addr) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// matchRemote reports whether r allows the peer with certificate c, sending from addr. The cidr is checked with
|
|
||||||
// Prefix.Contains, so 0.0.0.0/0 allows any IPv4 address and ::/0 allows any IPv6 address; neither allows the
|
|
||||||
// other family.
|
|
||||||
func (r *rule) matchRemote(addr netip.Addr, c *cert.CachedCertificate) bool {
|
|
||||||
if r.remoteAny {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.cidr.IsValid() && r.cidr.Contains(addr) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.host != "" && r.host == c.Certificate.Name() {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Every group must be present.
|
|
||||||
if len(r.groups) == 0 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
for _, g := range r.groups {
|
|
||||||
if _, ok := c.InvertedGroups[g]; !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// matchCA reports whether c was issued by a CA that r allows.
|
|
||||||
func (r *rule) matchCA(c *cert.CachedCertificate, caPool *cert.CAPool) bool {
|
|
||||||
if r.caSha == "" && r.caName == "" {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.caSha != "" && r.caSha == c.Certificate.Issuer() {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
if r.caName != "" {
|
|
||||||
s, err := caPool.GetCAForCert(c.Certificate)
|
|
||||||
if err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return r.caName == s.Certificate.Name()
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
+549
-333
File diff suppressed because it is too large.
Load diff
@@ -32,23 +32,10 @@ const (
|
|||||||
IPProtocolICMPv6 = 58
|
IPProtocolICMPv6 = 58
|
||||||
IPProtocolTCP = 6
|
IPProtocolTCP = 6
|
||||||
IPProtocolUDP = 17
|
IPProtocolUDP = 17
|
||||||
IPProtocolUDPLite = 136
|
|
||||||
IPProtocolDCCP = 33
|
|
||||||
IPProtocolSCTP = 132
|
|
||||||
ICMPv6TypeEchoRequest = 128
|
ICMPv6TypeEchoRequest = 128
|
||||||
ICMPv6TypeEchoReply = 129
|
ICMPv6TypeEchoReply = 129
|
||||||
)
|
)
|
||||||
|
|
||||||
// HasPorts reports whether packets of proto carry port numbers that the packet parsers read: TCP, UDP, UDPLite,
|
|
||||||
// DCCP, and SCTP. Firewall rules with a port or a port range only apply to these protocols.
|
|
||||||
func HasPorts(proto uint8) bool {
|
|
||||||
switch proto {
|
|
||||||
case IPProtocolTCP, IPProtocolUDP, IPProtocolUDPLite, IPProtocolDCCP, IPProtocolSCTP:
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
func CreateRejectPacket(packet []byte, out []byte) []byte {
|
func CreateRejectPacket(packet []byte, out []byte) []byte {
|
||||||
if len(packet) < 1 {
|
if len(packet) < 1 {
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
+25
-25
@@ -361,29 +361,31 @@ func parseV6(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
|||||||
fp.Fragment = isFragment
|
fp.Fragment = isFragment
|
||||||
fp.FragAny = anyFragment
|
fp.FragAny = anyFragment
|
||||||
fp.IPHdrLen = offset
|
fp.IPHdrLen = offset
|
||||||
// fp is reused, so the ports are cleared for the packets that have none: fragments, protocols Nebula
|
|
||||||
// doesn't inspect, and ICMPv6 other than echo. Only the cases below set them.
|
|
||||||
fp.RemotePort, fp.LocalPort = 0, 0
|
|
||||||
if isFragment {
|
if isFragment {
|
||||||
// Non-first fragments carry no transport header, so we have no ports to read
|
// Non-first fragments carry no transport header, so we have no ports to read
|
||||||
|
fp.RemotePort = 0
|
||||||
|
fp.LocalPort = 0
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
switch {
|
switch proto {
|
||||||
case proto == iputil.IPProtocolICMPv6:
|
case iputil.IPProtocolICMPv6:
|
||||||
// An ICMPv6 message is at least type, code and checksum, 4 bytes. Only echo carries more than we read.
|
// An ICMPv6 message is at least type, code and checksum, 4 bytes. Only echo carries more than we read.
|
||||||
if dataLen < offset+4 {
|
if dataLen < offset+4 {
|
||||||
return ErrIPv6PacketTooShort
|
return ErrIPv6PacketTooShort
|
||||||
}
|
}
|
||||||
|
fp.LocalPort = 0 //incoming vs outgoing doesn't matter for icmpv6
|
||||||
switch data[offset] { //icmp type
|
switch data[offset] { //icmp type
|
||||||
case iputil.ICMPv6TypeEchoRequest, iputil.ICMPv6TypeEchoReply:
|
case iputil.ICMPv6TypeEchoRequest, iputil.ICMPv6TypeEchoReply:
|
||||||
if dataLen < offset+6 {
|
if dataLen < offset+6 {
|
||||||
return ErrIPv6PacketTooShort
|
return ErrIPv6PacketTooShort
|
||||||
}
|
}
|
||||||
fp.RemotePort = binary.BigEndian.Uint16(data[offset+4 : offset+6]) //identifier, orientation doesn't matter
|
fp.RemotePort = binary.BigEndian.Uint16(data[offset+4 : offset+6]) //identifier
|
||||||
|
default:
|
||||||
|
fp.RemotePort = 0
|
||||||
}
|
}
|
||||||
|
|
||||||
case iputil.HasPorts(proto):
|
case iputil.IPProtocolTCP, iputil.IPProtocolUDP:
|
||||||
if dataLen < offset+4 {
|
if dataLen < offset+4 {
|
||||||
return ErrIPv6PacketTooShort
|
return ErrIPv6PacketTooShort
|
||||||
}
|
}
|
||||||
@@ -394,6 +396,11 @@ func parseV6(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
|||||||
fp.LocalPort = binary.BigEndian.Uint16(data[offset : offset+2])
|
fp.LocalPort = binary.BigEndian.Uint16(data[offset : offset+2])
|
||||||
fp.RemotePort = binary.BigEndian.Uint16(data[offset+2 : offset+4])
|
fp.RemotePort = binary.BigEndian.Uint16(data[offset+2 : offset+4])
|
||||||
}
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
// don't set ports for protocols Nebula doesn't inspect
|
||||||
|
fp.RemotePort = 0
|
||||||
|
fp.LocalPort = 0
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -446,25 +453,18 @@ func parseV4(data []byte, incoming bool, fp *firewall.ParsedPacket) error {
|
|||||||
fp.RemoteAddr, _ = netip.AddrFromSlice(data[16:20])
|
fp.RemoteAddr, _ = netip.AddrFromSlice(data[16:20])
|
||||||
}
|
}
|
||||||
|
|
||||||
// fp is reused, so the ports are cleared for the packets that have none: fragments, and protocols Nebula
|
|
||||||
// doesn't inspect, whose first 4 bytes (GRE, IPIP, AH, etc.) are not ports. Only the cases below set them.
|
|
||||||
fp.RemotePort, fp.LocalPort = 0, 0
|
|
||||||
if fp.Fragment {
|
if fp.Fragment {
|
||||||
return nil
|
fp.RemotePort = 0
|
||||||
}
|
fp.LocalPort = 0
|
||||||
|
} else if fp.Protocol == iputil.IPProtocolICMP { //note that orientation doesn't matter on ICMP
|
||||||
switch {
|
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+4 : ihl+6]) //identifier
|
||||||
case fp.Protocol == iputil.IPProtocolICMP: //note that orientation doesn't matter on ICMP
|
fp.LocalPort = 0 //code would be uint16(data[ihl+1])
|
||||||
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+4 : ihl+6]) //identifier, LocalPort stays 0 but could be the code, data[ihl+1]
|
} else if incoming {
|
||||||
|
fp.RemotePort = binary.BigEndian.Uint16(data[ihl : ihl+2]) //src port
|
||||||
case iputil.HasPorts(fp.Protocol):
|
fp.LocalPort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
||||||
if incoming {
|
} else {
|
||||||
fp.RemotePort = binary.BigEndian.Uint16(data[ihl : ihl+2]) //src port
|
fp.LocalPort = binary.BigEndian.Uint16(data[ihl : ihl+2]) //src port
|
||||||
fp.LocalPort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
||||||
} else {
|
|
||||||
fp.LocalPort = binary.BigEndian.Uint16(data[ihl : ihl+2]) //src port
|
|
||||||
fp.RemotePort = binary.BigEndian.Uint16(data[ihl+2 : ihl+4]) //dst port
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
+21
-86
@@ -77,7 +77,7 @@ func Test_newPacket(t *testing.T) {
|
|||||||
// account for variable ip header length - outgoing
|
// account for variable ip header length - outgoing
|
||||||
h = ipv4.Header{
|
h = ipv4.Header{
|
||||||
Version: 1,
|
Version: 1,
|
||||||
Protocol: iputil.IPProtocolUDP,
|
Protocol: 2,
|
||||||
Len: 100,
|
Len: 100,
|
||||||
Src: net.IPv4(10, 0, 0, 1),
|
Src: net.IPv4(10, 0, 0, 1),
|
||||||
Dst: net.IPv4(10, 0, 0, 2),
|
Dst: net.IPv4(10, 0, 0, 2),
|
||||||
@@ -89,7 +89,7 @@ func Test_newPacket(t *testing.T) {
|
|||||||
err = newPacket(b, false, p)
|
err = newPacket(b, false, p)
|
||||||
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Equal(t, uint8(iputil.IPProtocolUDP), p.Protocol)
|
assert.Equal(t, uint8(2), p.Protocol)
|
||||||
assert.Equal(t, netip.MustParseAddr("10.0.0.1"), p.LocalAddr)
|
assert.Equal(t, netip.MustParseAddr("10.0.0.1"), p.LocalAddr)
|
||||||
assert.Equal(t, netip.MustParseAddr("10.0.0.2"), p.RemoteAddr)
|
assert.Equal(t, netip.MustParseAddr("10.0.0.2"), p.RemoteAddr)
|
||||||
assert.Equal(t, uint16(6), p.RemotePort)
|
assert.Equal(t, uint16(6), p.RemotePort)
|
||||||
@@ -97,71 +97,6 @@ func Test_newPacket(t *testing.T) {
|
|||||||
assert.False(t, p.Fragment)
|
assert.False(t, p.Fragment)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Test_newPacket_v4NoPorts ensures only protocols that lead with src/dst ports report them. The first 4 bytes of other protocols are not ports,
|
|
||||||
// and are often chosen by the sender: a GRE header's protocol type, an IPIP inner total length, a 6in4 flow label.
|
|
||||||
// Reading them as ports would let a `proto: any` rule with a port match tunneled traffic.
|
|
||||||
func Test_newPacket_v4NoPorts(t *testing.T) {
|
|
||||||
p := &firewall.ParsedPacket{}
|
|
||||||
|
|
||||||
for _, proto := range []uint8{4, 41, 47, 50, 51} { // IPIP, 6in4, GRE, ESP, AH
|
|
||||||
h := ipv4.Header{
|
|
||||||
Version: 4,
|
|
||||||
Len: ipv4.HeaderLen,
|
|
||||||
Protocol: int(proto),
|
|
||||||
Src: net.IPv4(10, 0, 0, 1),
|
|
||||||
Dst: net.IPv4(10, 0, 0, 2),
|
|
||||||
}
|
|
||||||
b, err := h.Marshal()
|
|
||||||
require.NoError(t, err)
|
|
||||||
b = append(b, []byte{0x00, 0x00, 0x86, 0xdd}...) // a GRE header carrying IPv6 would read as port 34525
|
|
||||||
|
|
||||||
for _, incoming := range []bool{true, false} {
|
|
||||||
require.NoError(t, newPacket(b, incoming, p))
|
|
||||||
assert.Equal(t, proto, p.Protocol)
|
|
||||||
assert.Equal(t, uint16(0), p.RemotePort)
|
|
||||||
assert.Equal(t, uint16(0), p.LocalPort)
|
|
||||||
assert.False(t, p.Fragment)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test_newPacket_portedProtocols ensures UDP-Lite, DCCP, and SCTP report ports from the same leading
|
|
||||||
// src/dst port words as TCP and UDP, oriented the same way.
|
|
||||||
func Test_newPacket_portedProtocols(t *testing.T) {
|
|
||||||
p := &firewall.ParsedPacket{}
|
|
||||||
ports := []byte{0x13, 0x88, 0x00, 0x50} // src 5000, dst 80
|
|
||||||
|
|
||||||
for _, proto := range []uint8{iputil.IPProtocolUDPLite, iputil.IPProtocolDCCP, iputil.IPProtocolSCTP} {
|
|
||||||
h := ipv4.Header{
|
|
||||||
Version: 4,
|
|
||||||
Len: ipv4.HeaderLen,
|
|
||||||
Protocol: int(proto),
|
|
||||||
Src: net.IPv4(10, 0, 0, 1),
|
|
||||||
Dst: net.IPv4(10, 0, 0, 2),
|
|
||||||
}
|
|
||||||
v4, err := h.Marshal()
|
|
||||||
require.NoError(t, err)
|
|
||||||
v4 = append(v4, ports...)
|
|
||||||
|
|
||||||
v6 := make([]byte, 40, 44)
|
|
||||||
v6[0] = 0x60
|
|
||||||
v6[6] = proto
|
|
||||||
v6[7] = 64
|
|
||||||
v6 = append(v6, ports...)
|
|
||||||
|
|
||||||
for _, b := range [][]byte{v4, v6} {
|
|
||||||
require.NoError(t, newPacket(b, true, p))
|
|
||||||
assert.Equal(t, proto, p.Protocol)
|
|
||||||
assert.Equal(t, uint16(5000), p.RemotePort)
|
|
||||||
assert.Equal(t, uint16(80), p.LocalPort)
|
|
||||||
|
|
||||||
require.NoError(t, newPacket(b, false, p))
|
|
||||||
assert.Equal(t, uint16(5000), p.LocalPort)
|
|
||||||
assert.Equal(t, uint16(80), p.RemotePort)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func Test_newPacket_v6(t *testing.T) {
|
func Test_newPacket_v6(t *testing.T) {
|
||||||
p := &firewall.ParsedPacket{}
|
p := &firewall.ParsedPacket{}
|
||||||
|
|
||||||
@@ -777,46 +712,46 @@ func Test_newPacket_v6ExtHeaderPastBuffer(t *testing.T) {
|
|||||||
|
|
||||||
// Test_newPacket_v6ExtHeaderConfusion is a regression test for parseV6 walking any unrecognized
|
// Test_newPacket_v6ExtHeaderConfusion is a regression test for parseV6 walking any unrecognized
|
||||||
// Next Header as if it were an ipv6 extension header. A real upper layer protocol Nebula doesn't
|
// Next Header as if it were an ipv6 extension header. A real upper layer protocol Nebula doesn't
|
||||||
// dissect (GRE here) is not walkable, so applying the (len+1)*8 formula marched into the GRE
|
// dissect (SCTP here) is not walkable, so applying the (len+1)*8 formula marched into the SCTP
|
||||||
// payload and landed on a byte that looked like UDP, forging a protocol/port pair the firewall
|
// payload and landed on a byte that looked like UDP, forging a protocol/port pair the firewall
|
||||||
// would trust while the host delivered the real GRE packet. The fix fails closed: the packet
|
// would trust while the host delivered the real SCTP datagram. The fix fails closed: the packet
|
||||||
// is classified as its true protocol with no ports, so it only matches an `any` rule.
|
// is classified as its true protocol with no ports, so it only matches an `any` rule.
|
||||||
func Test_newPacket_v6ExtHeaderConfusion(t *testing.T) {
|
func Test_newPacket_v6ExtHeaderConfusion(t *testing.T) {
|
||||||
p := &firewall.ParsedPacket{}
|
p := &firewall.ParsedPacket{}
|
||||||
|
|
||||||
pkt := make([]byte, 52)
|
pkt := make([]byte, 52)
|
||||||
pkt[0] = 0x60 // version 6
|
pkt[0] = 0x60 // version 6
|
||||||
pkt[6] = byte(layers.IPProtocolGRE) // NextHeader = GRE, a real protocol, not an extension header
|
pkt[6] = byte(layers.IPProtocolSCTP) // NextHeader = SCTP, a real protocol, not an extension header
|
||||||
pkt[7] = 64 // hop limit
|
pkt[7] = 64 // hop limit
|
||||||
|
|
||||||
// Real GRE header at offset 40. Pre-fix parseV6 walked GRE as an extension header: byte 41 (0x00, the
|
// Real SCTP header at offset 40. Pre-fix parseV6 walked SCTP as an extension header: byte 41 (0x00, the
|
||||||
// low byte of the flags/version word below) was read as the header length, giving next=(0+1)*8=8, which
|
// low byte of the src port below) was read as the header length, giving next=(0+1)*8=8, which landed the
|
||||||
// landed the walk on byte 40 (0x11), misread as NextHeader=UDP, then bytes 48-51 as ports.
|
// walk on byte 40 (0x11), misread as NextHeader=UDP, then bytes 48-51 as ports.
|
||||||
binary.BigEndian.PutUint16(pkt[40:42], 0x1100) // GRE flags/version; byte 40=0x11, byte 41=0x00
|
binary.BigEndian.PutUint16(pkt[40:42], 0x1100) // SCTP src port; byte 40=0x11, byte 41=0x00
|
||||||
binary.BigEndian.PutUint16(pkt[42:44], 0x86dd) // GRE protocol type, never read by parseV6
|
binary.BigEndian.PutUint16(pkt[42:44], 445) // SCTP dst port, never read by parseV6
|
||||||
binary.BigEndian.PutUint16(pkt[48:50], 53) // GRE payload, pre-fix forged RemotePort
|
binary.BigEndian.PutUint16(pkt[48:50], 53) // SCTP checksum bytes, pre-fix forged RemotePort
|
||||||
binary.BigEndian.PutUint16(pkt[50:52], 53) // pre-fix forged LocalPort
|
binary.BigEndian.PutUint16(pkt[50:52], 53) // pre-fix forged LocalPort
|
||||||
|
|
||||||
require.NoError(t, newPacket(pkt, true, p))
|
require.NoError(t, newPacket(pkt, true, p))
|
||||||
assert.Equal(t, uint8(layers.IPProtocolGRE), p.Protocol, "must classify as the true protocol, not the forged UDP")
|
assert.Equal(t, uint8(layers.IPProtocolSCTP), p.Protocol, "must classify as the true protocol, not the forged UDP")
|
||||||
assert.Equal(t, uint16(0), p.RemotePort)
|
assert.Equal(t, uint16(0), p.RemotePort)
|
||||||
assert.Equal(t, uint16(0), p.LocalPort)
|
assert.Equal(t, uint16(0), p.LocalPort)
|
||||||
assert.False(t, p.Fragment)
|
assert.False(t, p.Fragment)
|
||||||
|
|
||||||
// Same confusion, but the unknown protocol sits after a real extension header. The HopByHop is walked
|
// Same confusion, but the unknown protocol sits after a real extension header. The HopByHop is walked
|
||||||
// correctly, then GRE must still fail closed instead of being walked into its own payload. Protocol is
|
// correctly, then SCTP must still fail closed instead of being walked into its own payload. Protocol is
|
||||||
// the only assertion that discriminates the fix here, a regression that walked GRE would misclassify it.
|
// the only assertion that discriminates the fix here, a regression that walked SCTP would misclassify it.
|
||||||
chained := make([]byte, 60)
|
chained := make([]byte, 60)
|
||||||
chained[0] = 0x60 // version 6
|
chained[0] = 0x60 // version 6
|
||||||
chained[6] = byte(layers.IPProtocolIPv6HopByHop) // NextHeader = HopByHop extension
|
chained[6] = byte(layers.IPProtocolIPv6HopByHop) // NextHeader = HopByHop extension
|
||||||
chained[7] = 64 // hop limit
|
chained[7] = 64 // hop limit
|
||||||
chained[40] = byte(layers.IPProtocolGRE) // HopByHop NextHeader = GRE
|
chained[40] = byte(layers.IPProtocolSCTP) // HopByHop NextHeader = SCTP
|
||||||
chained[41] = 0 // HopByHop length 0 -> 8 bytes, GRE begins at offset 48
|
chained[41] = 0 // HopByHop length 0 -> 8 bytes, SCTP begins at offset 48
|
||||||
binary.BigEndian.PutUint16(chained[48:50], 0x1100) // GRE flags/version, pre-fix forged NextHeader/length bait
|
binary.BigEndian.PutUint16(chained[48:50], 0x1100) // SCTP src port, pre-fix forged NextHeader/length bait
|
||||||
binary.BigEndian.PutUint16(chained[50:52], 0x86dd) // GRE protocol type, never read by parseV6
|
binary.BigEndian.PutUint16(chained[50:52], 445) // SCTP dst port, never read by parseV6
|
||||||
|
|
||||||
require.NoError(t, newPacket(chained, true, p))
|
require.NoError(t, newPacket(chained, true, p))
|
||||||
assert.Equal(t, uint8(layers.IPProtocolGRE), p.Protocol, "must fail closed on the unknown protocol after the extension header")
|
assert.Equal(t, uint8(layers.IPProtocolSCTP), p.Protocol, "must fail closed on the unknown protocol after the extension header")
|
||||||
assert.Equal(t, uint16(0), p.RemotePort)
|
assert.Equal(t, uint16(0), p.RemotePort)
|
||||||
assert.Equal(t, uint16(0), p.LocalPort)
|
assert.Equal(t, uint16(0), p.LocalPort)
|
||||||
assert.False(t, p.Fragment)
|
assert.False(t, p.Fragment)
|
||||||
|
|||||||
+67
-1
@@ -607,6 +607,72 @@ func (t *tun) Read(to []byte) (int, error) {
|
|||||||
return n - 4, nil
|
return n - 4, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// tunReadBatch is the most packets one tunQueue.Read returns.
|
||||||
|
const tunReadBatch = 64
|
||||||
|
|
||||||
|
// tunReadArena is tunQueue's receive buffer. Draining stops once less than defaultBatchBufSize of it
|
||||||
|
// is left, so every readv has room for the largest packet utun can return at any device MTU.
|
||||||
|
const tunReadArena = 4 * defaultBatchBufSize
|
||||||
|
|
||||||
|
// tunQueue is the darwin tun's Queue. Read drains every packet already queued on the utun, up to
|
||||||
|
// tunReadBatch, so the caller encrypts and sends them as one batch rather than one per wakeup.
|
||||||
|
type tunQueue struct {
|
||||||
|
t *tun
|
||||||
|
buf []byte
|
||||||
|
pkts [tunReadBatch]tio.Packet
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read waits for the utun to become readable, then reads packets until it would block. An error after
|
||||||
|
// at least one packet is dropped in favor of returning those packets; a persistent one recurs on the
|
||||||
|
// next Read.
|
||||||
|
func (q *tunQueue) Read() ([]tio.Packet, error) {
|
||||||
|
rc, err := q.t.f.SyscallConn()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var head [4]byte
|
||||||
|
n, off := 0, 0
|
||||||
|
var callErr error
|
||||||
|
err = rc.Read(func(fd uintptr) bool {
|
||||||
|
for n < tunReadBatch && len(q.buf)-off >= defaultBatchBufSize {
|
||||||
|
iovecs := [2]unix.Iovec{
|
||||||
|
{Base: &head[0], Len: 4},
|
||||||
|
{Base: &q.buf[off], Len: uint64(len(q.buf) - off)},
|
||||||
|
}
|
||||||
|
l, e := tunReadv(int(fd), iovecs[:])
|
||||||
|
if e != nil {
|
||||||
|
if errno, ok := e.(syscall.Errno); ok && errno.Temporary() {
|
||||||
|
// Park on the poller only while there is nothing to hand back.
|
||||||
|
return n > 0
|
||||||
|
}
|
||||||
|
callErr = e
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if l < 4 {
|
||||||
|
// A datagram too short to carry the AF prefix, or end of file; stop rather than spin on it.
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
end := off + l - 4
|
||||||
|
q.pkts[n] = tio.Packet{Bytes: q.buf[off:end:end]}
|
||||||
|
n++
|
||||||
|
off = end
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
if n > 0 {
|
||||||
|
return q.pkts[:n], nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return nil, callErr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *tunQueue) Write(p []byte) (int, error) { return q.t.Write(p) }
|
||||||
|
|
||||||
|
func (q *tunQueue) Close() error { return q.t.Close() }
|
||||||
|
|
||||||
// Write pushes one IP packet onto the utun device. Safe for concurrent use:
|
// Write pushes one IP packet onto the utun device. Safe for concurrent use:
|
||||||
// the AF prefix and iovecs are per-call stack state, and the fd write itself
|
// the AF prefix and iovecs are per-call stack state, and the fd write itself
|
||||||
// serializes on the runtime's fd mutex (see the Queue contract in tio.go).
|
// serializes on the runtime's fd mutex (see the Queue contract in tio.go).
|
||||||
@@ -666,5 +732,5 @@ func (t *tun) Name() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *tun) Queues(int) ([]tio.Queue, error) {
|
func (t *tun) Queues(int) ([]tio.Queue, error) {
|
||||||
return []tio.Queue{tio.NewSingleQueue(t, defaultBatchBufSize)}, nil
|
return []tio.Queue{&tunQueue{t: t, buf: make([]byte, tunReadArena)}}, nil
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
//go:build !ios && !e2e_testing
|
||||||
|
|
||||||
|
package overlay
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/slackhq/nebula/test"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
|
)
|
||||||
|
|
||||||
|
// newSocketpairTun returns a tun on one end of a connected AF_UNIX datagram socketpair, which keeps
|
||||||
|
// datagram boundaries the way a utun control socket does, and the other end's fd.
|
||||||
|
// sndbuf is the tun end's send buffer, which caps the largest datagram it accepts.
|
||||||
|
func newSocketpairTun(t *testing.T, sndbuf int) (*tun, int) {
|
||||||
|
t.Helper()
|
||||||
|
fds, err := unix.Socketpair(unix.AF_UNIX, unix.SOCK_DGRAM, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, unix.SetsockoptInt(fds[0], unix.SOL_SOCKET, unix.SO_SNDBUF, sndbuf))
|
||||||
|
require.NoError(t, unix.SetsockoptInt(fds[1], unix.SOL_SOCKET, unix.SO_RCVBUF, 1<<20))
|
||||||
|
// A dropped datagram fails the read-back instead of hanging it.
|
||||||
|
require.NoError(t, unix.SetsockoptTimeval(fds[1], unix.SOL_SOCKET, unix.SO_RCVTIMEO, &unix.Timeval{Sec: 2}))
|
||||||
|
require.NoError(t, unix.SetNonblock(fds[0], true))
|
||||||
|
f := os.NewFile(uintptr(fds[0]), "socketpair")
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_ = f.Close()
|
||||||
|
_ = unix.Close(fds[1])
|
||||||
|
})
|
||||||
|
return &tun{f: f, l: test.NewLogger()}, fds[1]
|
||||||
|
}
|
||||||
|
|
||||||
|
// testTunPkt returns packet i of size bytes, alternating IPv4 and IPv6, and the same packet as a utun
|
||||||
|
// datagram, behind its AF prefix.
|
||||||
|
func testTunPkt(i, size int) (pkt, wire []byte) {
|
||||||
|
pkt = make([]byte, size)
|
||||||
|
pkt[0] = 0x45
|
||||||
|
af := byte(syscall.AF_INET)
|
||||||
|
if i%2 == 1 {
|
||||||
|
pkt[0] = 0x60
|
||||||
|
af = syscall.AF_INET6
|
||||||
|
}
|
||||||
|
pkt[1] = byte(i)
|
||||||
|
pkt[2] = byte(i >> 8)
|
||||||
|
return pkt, append([]byte{0, 0, 0, af}, pkt...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTunQueueReadDrains pins that Read hands back every queued packet, AF prefix stripped and in
|
||||||
|
// order, capped at tunReadBatch per call, and doesn't wait for more once the queue is empty.
|
||||||
|
func TestTunQueueReadDrains(t *testing.T) {
|
||||||
|
tn, w := newSocketpairTun(t, 1<<20)
|
||||||
|
// An AF_UNIX datagram send is bounded by the receiver's buffer, here the tun's end.
|
||||||
|
rc, err := tn.f.SyscallConn()
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, rc.Control(func(fd uintptr) {
|
||||||
|
require.NoError(t, unix.SetsockoptInt(int(fd), unix.SOL_SOCKET, unix.SO_RCVBUF, 1<<20))
|
||||||
|
}))
|
||||||
|
q := &tunQueue{t: tn, buf: make([]byte, tunReadArena)}
|
||||||
|
total := tunReadBatch + 3
|
||||||
|
var want [][]byte
|
||||||
|
for i := range total {
|
||||||
|
pkt, wire := testTunPkt(i, 60+i)
|
||||||
|
_, err := unix.Write(w, wire)
|
||||||
|
require.NoError(t, err)
|
||||||
|
want = append(want, pkt)
|
||||||
|
}
|
||||||
|
|
||||||
|
var got [][]byte
|
||||||
|
for _, size := range []int{tunReadBatch, 3} {
|
||||||
|
pkts, err := q.Read()
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Len(t, pkts, size)
|
||||||
|
for _, p := range pkts {
|
||||||
|
got = append(got, p.Clone().Bytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert.Equal(t, want, got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTunQueueReadClipsPackets pins that each returned packet's capacity ends at its own bytes, so
|
||||||
|
// appending to one can't overwrite the next.
|
||||||
|
func TestTunQueueReadClipsPackets(t *testing.T) {
|
||||||
|
tn, w := newSocketpairTun(t, 1<<20)
|
||||||
|
q := &tunQueue{t: tn, buf: make([]byte, tunReadArena)}
|
||||||
|
for i := range 2 {
|
||||||
|
_, wire := testTunPkt(i, 100)
|
||||||
|
_, err := unix.Write(w, wire)
|
||||||
|
require.NoError(t, err)
|
||||||
|
}
|
||||||
|
pkts, err := q.Read()
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Len(t, pkts, 2)
|
||||||
|
assert.Equal(t, len(pkts[0].Bytes), cap(pkts[0].Bytes))
|
||||||
|
}
|
||||||
Reference in new issue
Block a user