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
|
package acl
import (
"context"
"fmt"
"slices"
"github.com/lxc/incus/v6/internal/server/db"
"github.com/lxc/incus/v6/internal/server/db/cluster"
deviceConfig "github.com/lxc/incus/v6/internal/server/device/config"
"github.com/lxc/incus/v6/internal/server/project"
"github.com/lxc/incus/v6/internal/server/response"
"github.com/lxc/incus/v6/internal/server/state"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/util"
)
// LoadByName loads and initializes a Network ACL from the database by project and name.
func LoadByName(s *state.State, projectName string, name string) (NetworkACL, error) {
var id int
var aclInfo *api.NetworkACL
err := s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
var err error
id, aclInfo, err = cluster.GetNetworkACLAPI(ctx, tx.Tx(), projectName, name)
return err
})
if err != nil {
return nil, err
}
var acl NetworkACL = &common{} // Only a single driver currently.
acl.init(s, int64(id), projectName, aclInfo)
return acl, nil
}
// Create validates supplied record and creates new Network ACL record in the database.
func Create(s *state.State, projectName string, aclInfo *api.NetworkACLsPost) error {
var acl NetworkACL = &common{} // Only a single driver currently.
acl.init(s, -1, projectName, nil)
err := acl.validateName(aclInfo.Name)
if err != nil {
return err
}
err = acl.validateConfig(&aclInfo.NetworkACLPut)
if err != nil {
return err
}
err = s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
// Insert DB record.
acl := cluster.NetworkACL{
Project: projectName,
Name: aclInfo.Name,
Description: aclInfo.Description,
Ingress: aclInfo.Ingress,
Egress: aclInfo.Egress,
}
id, err := cluster.CreateNetworkACL(ctx, tx.Tx(), acl)
if err != nil {
return err
}
if aclInfo.Config != nil {
err := cluster.CreateNetworkACLConfig(ctx, tx.Tx(), id, aclInfo.Config)
if err != nil {
return err
}
}
return nil
})
if err != nil {
return err
}
return nil
}
// Exists checks the ACL name(s) provided exists in the project.
// If multiple names are provided, also checks that duplicate names aren't specified in the list.
func Exists(s *state.State, projectName string, name ...string) error {
var existingACLNames []string
err := s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
acls, err := cluster.GetNetworkACLs(ctx, tx.Tx(), cluster.NetworkACLFilter{Project: &projectName})
if err != nil {
return err
}
existingACLNames = make([]string, len(acls))
for i, acl := range acls {
existingACLNames[i] = acl.Name
}
return nil
})
if err != nil {
return err
}
checkedACLNames := make(map[string]struct{}, len(name))
for _, aclName := range name {
if !slices.Contains(existingACLNames, aclName) {
return fmt.Errorf("Network ACL %q does not exist", aclName)
}
_, found := checkedACLNames[aclName]
if found {
return fmt.Errorf("Network ACL %q specified multiple times", aclName)
}
checkedACLNames[aclName] = struct{}{}
}
return nil
}
// UsedBy finds all networks, profiles and instance NICs that use any of the specified ACLs and executes usageFunc
// once for each resource using one or more of the ACLs with info about the resource and matched ACLs being used.
func UsedBy(s *state.State, aclProjectName string, usageFunc func(ctx context.Context, tx *db.ClusterTx, matchedACLNames []string, usageType any, nicName string, nicConfig map[string]string) error, matchACLNames ...string) error {
if len(matchACLNames) <= 0 {
return nil
}
var profiles []cluster.Profile
profileDevices := map[string]map[string]cluster.Device{}
err := s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
// Find networks using the ACLs. Cheapest to do.
networkNames, err := tx.GetCreatedNetworkNamesByProject(ctx, aclProjectName)
if err != nil && !response.IsNotFoundError(err) {
return fmt.Errorf("Failed loading networks for project %q: %w", aclProjectName, err)
}
for _, networkName := range networkNames {
_, network, _, err := tx.GetNetworkInAnyState(ctx, aclProjectName, networkName)
if err != nil {
return fmt.Errorf("Failed to get network config for %q: %w", networkName, err)
}
netACLNames := util.SplitNTrimSpace(network.Config["security.acls"], ",", -1, true)
matchedACLNames := []string{}
for _, netACLName := range netACLNames {
if slices.Contains(matchACLNames, netACLName) {
matchedACLNames = append(matchedACLNames, netACLName)
}
}
if len(matchedACLNames) > 0 {
// Call usageFunc with a list of matched ACLs and info about the network.
err := usageFunc(ctx, tx, matchedACLNames, network, "", nil)
if err != nil {
return err
}
}
}
// Look for profiles. Next cheapest to do.
profiles, err = cluster.GetProfiles(ctx, tx.Tx())
if err != nil {
return err
}
// Get all the profile devices.
profileDevicesByID, err := cluster.GetAllProfileDevices(ctx, tx.Tx())
if err != nil {
return err
}
for _, profile := range profiles {
devices := map[string]cluster.Device{}
for _, dev := range profileDevicesByID[profile.ID] {
devices[dev.Name] = dev
}
profileDevices[profile.Name] = devices
}
return nil
})
if err != nil {
return err
}
for _, profile := range profiles {
// Get the profiles's effective network project name.
profileNetworkProjectName, _, err := project.NetworkProject(s.DB.Cluster, profile.Project)
if err != nil {
return err
}
// Skip profiles who's effective network project doesn't match this Network ACL's project.
if profileNetworkProjectName != aclProjectName {
continue
}
// Iterate through each of the instance's devices, looking for NICs that are using any of the ACLs.
for devName, devConfig := range deviceConfig.NewDevices(cluster.DevicesToAPI(profileDevices[profile.Name])) {
matchedACLNames := isInUseByDevice(devConfig, matchACLNames...)
if len(matchedACLNames) > 0 {
// Call usageFunc with a list of matched ACLs and info about the instance NIC.
err = s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
return usageFunc(ctx, tx, matchedACLNames, profile, devName, devConfig)
})
if err != nil {
return err
}
}
}
}
var aclNames []string
err = s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
acls, err := cluster.GetNetworkACLs(ctx, tx.Tx(), cluster.NetworkACLFilter{Project: &aclProjectName})
if err != nil {
return err
}
aclNames = make([]string, len(acls))
for i, acl := range acls {
aclNames[i] = acl.Name
}
return nil
})
if err != nil {
return err
}
err = s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
for _, aclName := range aclNames {
_, aclInfo, err := cluster.GetNetworkACLAPI(ctx, tx.Tx(), aclProjectName, aclName)
if err != nil {
return err
}
matchedACLNames := []string{}
// Ingress rules can specify ACL names in their Source subjects.
for _, rule := range aclInfo.Ingress {
for _, subject := range util.SplitNTrimSpace(rule.Source, ",", -1, true) {
// Look for new matching ACLs, but ignore our own ACL reference in our own rules.
if slices.Contains(matchACLNames, subject) && !slices.Contains(matchedACLNames, subject) && subject != aclInfo.Name {
matchedACLNames = append(matchedACLNames, subject)
}
}
}
// Egress rules can specify ACL names in their Destination subjects.
for _, rule := range aclInfo.Egress {
for _, subject := range util.SplitNTrimSpace(rule.Destination, ",", -1, true) {
// Look for new matching ACLs, but ignore our own ACL reference in our own rules.
if slices.Contains(matchACLNames, subject) && !slices.Contains(matchedACLNames, subject) && subject != aclInfo.Name {
matchedACLNames = append(matchedACLNames, subject)
}
}
}
if len(matchedACLNames) > 0 {
// Call usageFunc with a list of matched ACLs and info about the ACL.
err = usageFunc(ctx, tx, matchedACLNames, aclInfo, "", nil)
if err != nil {
return err
}
}
}
// Find instances using the ACLs. Most expensive to do.
err = tx.InstanceList(ctx, func(inst db.InstanceArgs, p api.Project) error {
// Get the instance's effective network project name.
instNetworkProject := project.NetworkProjectFromRecord(&p)
// Skip instances who's effective network project doesn't match this Network ACL's project.
if instNetworkProject != aclProjectName {
return nil
}
devices := db.ExpandInstanceDevices(inst.Devices.Clone(), inst.Profiles)
// Iterate through each of the instance's devices, looking for NICs that are using any of the ACLs.
for devName, devConfig := range devices {
matchedACLNames := isInUseByDevice(devConfig, matchACLNames...)
if len(matchedACLNames) > 0 {
// Call usageFunc with a list of matched ACLs and info about the instance NIC.
err := usageFunc(ctx, tx, matchedACLNames, inst, devName, devConfig)
if err != nil {
return err
}
}
}
return nil
})
if err != nil {
return err
}
return nil
})
if err != nil {
return err
}
return nil
}
// isInUseByDevice returns any of the supplied matching ACL names found referenced by the NIC device.
func isInUseByDevice(d deviceConfig.Device, matchACLNames ...string) []string {
matchedACLNames := []string{}
// Only NICs linked to managed networks can use network ACLs.
if d["type"] != "nic" || d["network"] == "" {
return matchedACLNames
}
for _, nicACLName := range util.SplitNTrimSpace(d["security.acls"], ",", -1, true) {
if slices.Contains(matchACLNames, nicACLName) {
matchedACLNames = append(matchedACLNames, nicACLName)
}
}
return matchedACLNames
}
// NetworkACLUsage info about a network and what ACL it uses.
type NetworkACLUsage struct {
ID int64
Name string
Type string
Config map[string]string
InstanceName string
DeviceName string
}
// NetworkUsage populates the provided aclNets map with networks that are using any of the specified ACLs.
func NetworkUsage(s *state.State, aclProjectName string, aclNames []string, aclNets map[string]NetworkACLUsage) error {
supportedNetTypes := []string{"bridge", "ovn"}
// Find all networks and instance/profile NICs that use any of the specified Network ACLs.
err := UsedBy(s, aclProjectName, func(ctx context.Context, tx *db.ClusterTx, matchedACLNames []string, usageType any, devName string, nicConfig map[string]string) error {
switch u := usageType.(type) {
case cluster.Profile:
networkID, network, _, err := tx.GetNetworkInAnyState(ctx, aclProjectName, nicConfig["network"])
if err != nil {
return fmt.Errorf("Failed to load network %q: %w", nicConfig["network"], err)
}
if slices.Contains(supportedNetTypes, network.Type) {
_, found := aclNets[network.Name]
if !found {
aclNets[network.Name] = NetworkACLUsage{
ID: networkID,
Name: network.Name,
Type: network.Type,
Config: network.Config,
}
}
}
case db.InstanceArgs:
networkID, network, _, err := tx.GetNetworkInAnyState(ctx, aclProjectName, nicConfig["network"])
if err != nil {
return fmt.Errorf("Failed to load network %q: %w", nicConfig["network"], err)
}
if slices.Contains(supportedNetTypes, network.Type) {
if network.Type == "bridge" && devName != "" {
// Use different key for the usage by bridge NICs to avoid overwriting the usage by the bridge network itself.
key := fmt.Sprintf("%s/%s/%s", network.Name, u.Name, devName)
_, found := aclNets[key]
if !found {
aclNets[key] = NetworkACLUsage{
ID: networkID,
Name: network.Name,
Type: network.Type,
Config: network.Config,
InstanceName: u.Name,
DeviceName: devName,
}
}
} else {
_, found := aclNets[network.Name]
if !found {
aclNets[network.Name] = NetworkACLUsage{
ID: networkID,
Name: network.Name,
Type: network.Type,
Config: network.Config,
}
}
}
}
case *api.Network:
if slices.Contains(supportedNetTypes, u.Type) {
_, found := aclNets[u.Name]
if !found {
networkID, network, _, err := tx.GetNetworkInAnyState(ctx, aclProjectName, u.Name)
if err != nil {
return fmt.Errorf("Failed to load network %q: %w", u.Name, err)
}
aclNets[u.Name] = NetworkACLUsage{
ID: networkID,
Name: network.Name,
Type: network.Type,
Config: network.Config,
}
}
}
case *api.NetworkACL:
return nil // Nothing to do for ACL rules referencing us.
default:
return fmt.Errorf("Unrecognised usage type %T", u)
}
return nil
}, aclNames...)
if err != nil {
return err
}
return nil
}
|