1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
|
package device
import (
"errors"
"fmt"
"net"
"slices"
"strings"
deviceConfig "github.com/lxc/incus/v6/internal/server/device/config"
"github.com/lxc/incus/v6/internal/server/instance"
"github.com/lxc/incus/v6/internal/server/instance/instancetype"
"github.com/lxc/incus/v6/internal/server/ip"
"github.com/lxc/incus/v6/internal/server/network"
localUtil "github.com/lxc/incus/v6/internal/server/util"
"github.com/lxc/incus/v6/shared/revert"
"github.com/lxc/incus/v6/shared/util"
"github.com/lxc/incus/v6/shared/validate"
)
const (
ipvlanModeL3S = "l3s"
ipvlanModeL2 = "l2"
)
type nicIPVLAN struct {
deviceCommon
}
// CanHotPlug returns whether the device can be managed whilst the instance is running,.
func (d *nicIPVLAN) CanHotPlug() bool {
return false
}
// validateConfig checks the supplied config for correctness.
func (d *nicIPVLAN) validateConfig(instConf instance.ConfigReader) error {
if !instanceSupported(instConf.Type(), instancetype.Container) {
return ErrUnsupportedDevType
}
requiredFields := []string{"parent"}
optionalFields := []string{
// gendoc:generate(entity=devices, group=nic_ipvlan, key=name)
//
// ---
// type: string
// default: kernel assigned
// shortdesc: The name of the interface inside the instance
"name",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=mtu)
//
// ---
// type: integer
// default: MTU of the parent device
// shortdesc: The Maximum Transmit Unit (MTU) of the new interface
"mtu",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=hwaddr)
//
// ---
// type: string
// default: randomly assigned
// shortdesc: The MAC address of the new interface
"hwaddr",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=vlan)
//
// ---
// type: integer
// shortdesc: The VLAN ID to attach to
"vlan",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=ipv4.gateway)
//
// ---
// type: string
// default: `auto` (in `l3s` mode), `-` (in `l2` mode)
// shortdesc: In `l3s` mode, whether to add an automatic default IPv4 gateway (can be `auto` or `none`). In `l2` mode, the IPv4 address of the gateway
"ipv4.gateway",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=ipv6.gateway)
//
// ---
// type: string
// default: `auto` (in `l3s` mode), `-` (in `l2` mode)
// shortdesc: In `l3s` mode, whether to add an automatic default IPv6 gateway (can be `auto` or `none`). In `l2` mode, the IPv6 address of the gateway
"ipv6.gateway",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=ipv4.host_table)
//
// ---
// type: integer
// shortdesc: The custom policy routing table ID to add IPv4 static routes to (in addition to the main routing table)
"ipv4.host_table",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=ipv6.host_table)
//
// ---
// type: integer
// shortdesc: The custom policy routing table ID to add IPv6 static routes to (in addition to the main routing table)
"ipv6.host_table",
// gendoc:generate(entity=devices, group=nic_ipvlan, key=gvrp)
//
// ---
// type: bool
// default: false
// shortdesc: Register VLAN using GARP VLAN Registration Protocol
"gvrp",
}
rules := nicValidationRules(requiredFields, optionalFields, instConf)
rules["gvrp"] = validate.Optional(validate.IsBool)
// gendoc:generate(entity=devices, group=nic_ipvlan, key=ipv4.address)
//
// ---
// type: string
// shortdesc: Comma-delimited list of IPv4 static addresses to add to the instance (in l2 mode, these can be specified as CIDR values or singular addresses using a subnet of /24)
rules["ipv4.address"] = func(value string) error {
if value == "" {
return nil
}
if d.config["mode"] == ipvlanModeL2 {
for _, v := range strings.Split(value, ",") {
v = strings.TrimSpace(v)
// If valid non-CIDR address specified, append a /24 subnet.
if validate.IsNetworkAddressV4(v) == nil {
v = fmt.Sprintf("%s/24", v)
}
ip, _, err := net.ParseCIDR(v)
if err != nil {
return err
}
if ip.To4() == nil {
return fmt.Errorf("Not an IPv4 CIDR address: %s", v)
}
}
return nil
}
return validate.IsListOf(validate.IsNetworkAddressV4)(value)
}
// gendoc:generate(entity=devices, group=nic_ipvlan, key=ipv6.address)
//
// ---
// type: string
// shortdesc: Comma-delimited list of IPv6 static addresses to add to the instance (in `l2` mode, these can be specified as CIDR values or singular addresses using a subnet of /64)
rules["ipv6.address"] = func(value string) error {
if value == "" {
return nil
}
if d.config["mode"] == ipvlanModeL2 {
for _, v := range strings.Split(value, ",") {
v = strings.TrimSpace(v)
// If valid non-CIDR address specified, append a /64 subnet.
if validate.IsNetworkAddressV6(v) == nil {
v = fmt.Sprintf("%s/64", v)
}
ip, _, err := net.ParseCIDR(v)
if err != nil {
return err
}
if ip == nil || ip.To4() != nil {
return fmt.Errorf("Not an IPv6 CIDR address: %s", v)
}
}
return nil
}
return validate.IsListOf(validate.IsNetworkAddressV6)(value)
}
// gendoc:generate(entity=devices, group=nic_ipvlan, key=mode)
//
// ---
// type: string
// default: `l3s`
// shortdesc: The IPVLAN mode (either `l2` or `l3s`)
rules["mode"] = func(value string) error {
if value == "" {
return nil
}
validModes := []string{ipvlanModeL3S, ipvlanModeL2}
if !slices.Contains(validModes, value) {
return fmt.Errorf("Must be one of: %v", strings.Join(validModes, ", "))
}
return nil
}
if d.config["mode"] == ipvlanModeL2 {
rules["ipv4.gateway"] = validate.Optional(validate.IsNetworkAddressV4)
rules["ipv6.gateway"] = validate.Optional(validate.IsNetworkAddressV6)
}
err := d.config.Validate(rules)
if err != nil {
return err
}
if d.config["mode"] == ipvlanModeL2 && d.config["host_table"] != "" {
return errors.New("host_table option cannot be used in l2 mode")
}
return nil
}
// validateEnvironment checks the runtime environment for correctness.
func (d *nicIPVLAN) validateEnvironment() error {
if d.inst.Type() == instancetype.Container && d.config["name"] == "" {
return errors.New("Requires name property to start")
}
extensions := d.state.OS.LXCFeatures
if !extensions["network_ipvlan"] || !extensions["network_l2proxy"] || !extensions["network_gateway_device_route"] {
return errors.New("Requires liblxc has following API extensions: network_ipvlan, network_l2proxy, network_gateway_device_route")
}
// gendoc:generate(entity=devices, group=nic_ipvlan, key=parent)
//
// ---
// type: string
// shortdesc: The name of the host device (required)
if !network.InterfaceExists(d.config["parent"]) {
return fmt.Errorf("Parent device '%s' doesn't exist", d.config["parent"])
}
if d.config["parent"] == "" && d.config["vlan"] != "" {
return errors.New("The vlan setting can only be used when combined with a parent interface")
}
// Only check sysctls for l2proxy if mode is l3s.
if d.mode() != ipvlanModeL3S {
return nil
}
// Generate effective parent name, including the VLAN part if option used.
effectiveParentName := network.GetHostDevice(d.config["parent"], d.config["vlan"])
// If the effective parent doesn't exist and the vlan option is specified, it means we are going to create
// the VLAN parent at start, and we will configure the needed sysctls so don't need to check them yet.
if d.config["vlan"] != "" && !network.InterfaceExists(effectiveParentName) {
return nil
}
if d.config["ipv4.address"] != "" {
// Check necessary sysctls are configured for use with l2proxy parent in IPVLAN l3s mode.
ipv4FwdPath := fmt.Sprintf("net/ipv4/conf/%s/forwarding", effectiveParentName)
sysctlVal, err := localUtil.SysctlGet(ipv4FwdPath)
if err != nil {
return fmt.Errorf("Error reading net sysctl %s: %w", ipv4FwdPath, err)
}
if sysctlVal != "1\n" {
// Replace . in parent name with / for sysctl formatting.
return fmt.Errorf("IPVLAN in L3S mode requires sysctl net.ipv4.conf.%s.forwarding=1", strings.ReplaceAll(effectiveParentName, ".", "/"))
}
}
if d.config["ipv6.address"] != "" {
// Check necessary sysctls are configured for use with l2proxy parent in IPVLAN l3s mode.
ipv6FwdPath := fmt.Sprintf("net/ipv6/conf/%s/forwarding", effectiveParentName)
sysctlVal, err := localUtil.SysctlGet(ipv6FwdPath)
if err != nil {
return fmt.Errorf("Error reading net sysctl %s: %w", ipv6FwdPath, err)
}
if sysctlVal != "1\n" {
// Replace . in parent name with / for sysctl formatting.
return fmt.Errorf("IPVLAN in L3S mode requires sysctl net.ipv6.conf.%s.forwarding=1", strings.ReplaceAll(effectiveParentName, ".", "/"))
}
ipv6ProxyNdpPath := fmt.Sprintf("net/ipv6/conf/%s/proxy_ndp", effectiveParentName)
sysctlVal, err = localUtil.SysctlGet(ipv6ProxyNdpPath)
if err != nil {
return fmt.Errorf("Error reading net sysctl %s: %w", ipv6ProxyNdpPath, err)
}
if sysctlVal != "1\n" {
// Replace . in parent name with / for sysctl formatting.
return fmt.Errorf("IPVLAN in L3S mode requires sysctl net.ipv6.conf.%s.proxy_ndp=1", strings.ReplaceAll(effectiveParentName, ".", "/"))
}
}
return nil
}
// Start is run when the instance is starting up (IPVLAN doesn't support hot plugging).
func (d *nicIPVLAN) Start() (*deviceConfig.RunConfig, error) {
err := d.validateEnvironment()
if err != nil {
return nil, err
}
// Lock to avoid issues with containers starting in parallel.
networkCreateSharedDeviceLock.Lock()
defer networkCreateSharedDeviceLock.Unlock()
reverter := revert.New()
defer reverter.Fail()
saveData := make(map[string]string)
// Record a random host name to use to detach the ipvlan interface back onto the host at stop time so we
// can remove it and not have to rely on the kernel to do it when the namespace is destroyed, as this is
// not always reliable.
saveData["host_name"], err = d.generateHostName("inc", d.config["hwaddr"])
if err != nil {
return nil, err
}
// Decide which parent we should use based on VLAN setting.
parentName := network.GetHostDevice(d.config["parent"], d.config["vlan"])
statusDev, err := networkCreateVlanDeviceIfNeeded(d.state, d.config["parent"], parentName, d.config["vlan"], util.IsTrue(d.config["gvrp"]))
if err != nil {
return nil, err
}
// Record whether we created this device or not so it can be removed on stop.
saveData["last_state.created"] = fmt.Sprintf("%t", statusDev != "existing")
mode := d.mode()
// If we created a VLAN interface, we need to setup the sysctls on that interface for l3s mode l2proxy.
if statusDev == "created" && mode == ipvlanModeL3S {
err := d.setupParentSysctls(parentName)
if err != nil {
return nil, err
}
}
err = d.volatileSet(saveData)
if err != nil {
return nil, err
}
runConf := deviceConfig.RunConfig{}
nic := []deviceConfig.RunConfigItem{
{Key: "name", Value: d.config["name"]},
{Key: "type", Value: "ipvlan"},
{Key: "flags", Value: "up"},
{Key: "ipvlan.mode", Value: mode},
{Key: "ipvlan.isolation", Value: "bridge"},
{Key: "link", Value: parentName},
}
if d.config["mtu"] != "" {
nic = append(nic, deviceConfig.RunConfigItem{Key: "mtu", Value: d.config["mtu"]})
}
// Perform network configuration.
for _, keyPrefix := range []string{"ipv4", "ipv6"} {
var ipFamily ip.Family
switch keyPrefix {
case "ipv4":
ipFamily = ip.FamilyV4
case "ipv6":
ipFamily = ip.FamilyV6
}
addresses := util.SplitNTrimSpace(d.config[fmt.Sprintf("%s.address", keyPrefix)], ",", -1, true)
// Setup address configuration.
for _, addr := range addresses {
addr, err := d.parseAddress(addr, keyPrefix, mode)
if err != nil {
return nil, err
}
nic = append(nic, deviceConfig.RunConfigItem{
Key: fmt.Sprintf("%s.address", keyPrefix),
Value: addr.String(),
})
// Perform host-side address configuration.
if mode == ipvlanModeL3S {
// Apply host-side static routes to main routing table to allow neighbour proxy.
r := ip.Route{
DevName: "lo",
Route: addr,
Table: "main",
Family: ipFamily,
}
err = r.Add()
if err != nil {
return nil, fmt.Errorf("Failed adding host route %q: %w", r.Route, err)
}
reverter.Add(func() { _ = r.Delete() })
// Add static routes to instance IPs from custom routing tables if specified.
hostTableKey := fmt.Sprintf("%s.host_table", keyPrefix)
if d.config[hostTableKey] != "" {
r := &ip.Route{
DevName: "lo",
Route: addr,
Table: d.config[hostTableKey],
Family: ipFamily,
}
err := r.Add()
if err != nil {
return nil, fmt.Errorf("Failed adding host route %q: %w", r.Route, err)
}
reverter.Add(func() { _ = r.Delete() })
}
// Add neighbour proxy entries on the host for l3s mode.
np := ip.NeighProxy{
DevName: parentName,
Addr: addr.IP,
}
err = np.Add()
if err != nil {
return nil, fmt.Errorf("Failed adding neighbour proxy %q to %q: %w", np.Addr.String(), np.DevName, err)
}
reverter.Add(func() { _ = np.Delete() })
}
}
// Setup gateway configuration.
if len(addresses) > 0 {
gwKeyName := fmt.Sprintf("%s.gateway", keyPrefix)
if mode == ipvlanModeL3S && nicHasAutoGateway(d.config[gwKeyName]) {
nic = append(nic, deviceConfig.RunConfigItem{
Key: gwKeyName,
Value: "dev",
})
}
if mode == ipvlanModeL2 && d.config[gwKeyName] != "" {
nic = append(nic, deviceConfig.RunConfigItem{
Key: gwKeyName,
Value: d.config[gwKeyName],
})
}
}
}
runConf.NetworkInterface = nic
reverter.Success()
return &runConf, nil
}
// setupParentSysctls configures the required sysctls on the parent to allow l2proxy to work.
// Because of our policy not to modify sysctls on existing interfaces, this should only be called
// if we created the parent interface.
func (d *nicIPVLAN) setupParentSysctls(parentName string) error {
if d.config["ipv4.address"] != "" {
// Set necessary sysctls for use with l2proxy parent in IPVLAN l3s mode.
ipv4FwdPath := fmt.Sprintf("net/ipv4/conf/%s/forwarding", parentName)
err := localUtil.SysctlSet(ipv4FwdPath, "1")
if err != nil {
return fmt.Errorf("Error setting net sysctl %s: %w", ipv4FwdPath, err)
}
}
if d.config["ipv6.address"] != "" {
// Set necessary sysctls use with l2proxy parent in IPVLAN l3s mode.
ipv6FwdPath := fmt.Sprintf("net/ipv6/conf/%s/forwarding", parentName)
err := localUtil.SysctlSet(ipv6FwdPath, "1")
if err != nil {
return fmt.Errorf("Error setting net sysctl %s: %w", ipv6FwdPath, err)
}
ipv6ProxyNdpPath := fmt.Sprintf("net/ipv6/conf/%s/proxy_ndp", parentName)
err = localUtil.SysctlSet(ipv6ProxyNdpPath, "1")
if err != nil {
return fmt.Errorf("Error setting net sysctl %s: %w", ipv6ProxyNdpPath, err)
}
}
return nil
}
// Stop is run when the device is removed from the instance.
func (d *nicIPVLAN) Stop() (*deviceConfig.RunConfig, error) {
v := d.volatileGet()
runConf := deviceConfig.RunConfig{
PostHooks: []func() error{d.postStop},
}
// Add instruction for removal of ipvlan interface back to host if set.
if v["host_name"] != "" {
runConf.NetworkInterface = []deviceConfig.RunConfigItem{
{Key: "link", Value: v["host_name"]},
}
}
return &runConf, nil
}
// postStop is run after the device is removed from the instance.
func (d *nicIPVLAN) postStop() error {
defer func() {
_ = d.volatileSet(map[string]string{
"last_state.created": "",
"host_name": "",
})
}()
v := d.volatileGet()
networkVethFillFromVolatile(d.config, v)
errs := []error{}
// Delete host-side detached interface if not removed by liblxc.
if network.InterfaceExists(d.config["host_name"]) {
err := network.InterfaceRemove(d.config["host_name"])
if err != nil {
errs = append(errs, fmt.Errorf("Failed to remove interface %q: %w", d.config["host_name"], err))
}
}
mode := d.mode()
parentName := network.GetHostDevice(d.config["parent"], d.config["vlan"])
// Clean up host-side network configuration.
for _, keyPrefix := range []string{"ipv4", "ipv6"} {
var ipFamily ip.Family
switch keyPrefix {
case "ipv4":
ipFamily = ip.FamilyV4
case "ipv6":
ipFamily = ip.FamilyV6
}
addresses := util.SplitNTrimSpace(d.config[fmt.Sprintf("%s.address", keyPrefix)], ",", -1, true)
// Remove host-side address configuration.
for _, addr := range addresses {
addr, err := d.parseAddress(addr, keyPrefix, mode)
if err != nil {
errs = append(errs, err)
continue
}
// Remove static routes and neighbour proxy rules to instance IPs from main routing table.
if mode == ipvlanModeL3S {
r := ip.Route{
DevName: "lo",
Route: addr,
Table: "main",
Family: ipFamily,
}
err := r.Delete()
if err != nil {
errs = append(errs, err)
}
np := ip.NeighProxy{
DevName: parentName,
Addr: addr.IP,
}
err = np.Delete()
if err != nil {
errs = append(errs, err)
}
// Remove static routes to instance IPs from custom routing tables if specified.
hostTableKey := fmt.Sprintf("%s.host_table", keyPrefix)
if d.config[hostTableKey] != "" {
r := &ip.Route{
DevName: "lo",
Route: addr,
Table: d.config[hostTableKey],
Family: ipFamily,
}
err := r.Delete()
if err != nil {
errs = append(errs, err)
}
}
}
}
}
// This will delete the parent interface if we created it for VLAN parent.
if util.IsTrue(v["last_state.created"]) {
err := networkRemoveInterfaceIfNeeded(d.state, parentName, d.inst, d.config["parent"], d.config["vlan"])
if err != nil {
errs = append(errs, err)
}
}
if len(errs) > 0 {
return fmt.Errorf("%v", errs)
}
return nil
}
// mode returns the ipvlan mode to use.
func (d *nicIPVLAN) mode() string {
if d.config["mode"] == ipvlanModeL2 {
return ipvlanModeL2
}
return ipvlanModeL3S
}
// parseAddress converts the specified address into a CIDR based on the IP family and mode.
func (d *nicIPVLAN) parseAddress(addr string, ipFamily string, mode string) (*net.IPNet, error) {
// If singular IP specified then convert to appropriate CIDR value for family and mode.
if !strings.Contains(addr, "/") {
var defaultSubnetSize int
switch mode {
case ipvlanModeL3S:
switch ipFamily {
case "ipv4":
defaultSubnetSize = 32
case "ipv6":
defaultSubnetSize = 128
}
case ipvlanModeL2:
switch ipFamily {
case "ipv4":
defaultSubnetSize = 24
case "ipv6":
defaultSubnetSize = 64
}
default:
return nil, fmt.Errorf("Invalid mode %q", mode)
}
addr = fmt.Sprintf("%s/%d", addr, defaultSubnetSize)
}
cidr, err := network.ParseIPCIDRToNet(addr)
if err != nil {
return nil, fmt.Errorf("Invalid address %q", addr)
}
return cidr, nil
}
|