Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NET-9376] Fix Issue with multiple APIGW's roles/policy #4001

Merged
merged 2 commits into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/4001.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
api-gateway: fix bug where multiple logical APIGateways would share the same ACL policy.
```
39 changes: 34 additions & 5 deletions control-plane/api-gateway/cache/consul.go
Original file line number Diff line number Diff line change
Expand Up @@ -415,9 +415,27 @@ func (c *Cache) ensureRole(client *api.Client, gatewayName string) (string, erro
}

_, _, err = client.ACL().RoleCreate(role, &api.WriteOptions{})
if err != nil {
if err != nil && !isRoleExistsErr(err, aclRoleName) {
// don't error out in the case that the role already exists.
return "", err
}

if err != nil && isRoleExistsErr(err, aclRoleName) {
role, _, err := client.ACL().RoleReadByName(role.Name, &api.QueryOptions{})
if err != nil {
return "", err
}

role.Policies = []*api.ACLLink{{ID: policyID}}
role, _, err = client.ACL().RoleUpdate(role, &api.WriteOptions{})
if err != nil {
return "", err
}

c.gatewayNameToRole[gatewayName] = role
return aclRoleName, err
}

c.gatewayNameToRole[gatewayName] = role
return aclRoleName, err
}
Expand Down Expand Up @@ -453,7 +471,7 @@ func (c *Cache) gatewayPolicy(gatewayName string) api.ACLPolicy {
}

return api.ACLPolicy{
Name: "api-gateway-token-policy",
Name: fmt.Sprint("api-gateway-policy-for-", gatewayName),
Description: "API Gateway token Policy",
Rules: data.String(),
}
Expand Down Expand Up @@ -589,10 +607,21 @@ func ignoreACLsDisabled(err error) error {
return err
}

// isExistsErr returns true if err is due to trying to call an API for a given type and it already exists.
func isExistsErr(err error, typeName, name string) bool {
return err != nil &&
strings.Contains(err.Error(), "Unexpected response code: 500") &&
strings.Contains(err.Error(), fmt.Sprintf("Invalid %s: A %s with Name %q already exists", typeName, typeName, name))
}

// isRoleExistsErr returns true if err is due to trying to call the
// role create API when the role already exists.
func isRoleExistsErr(err error, roleName string) bool {
return isExistsErr(err, "Role", roleName)
}

// isPolicyExistsErr returns true if err is due to trying to call the
// policy create API when the policy already exists.
func isPolicyExistsErr(err error, policyName string) bool {
return err != nil &&
strings.Contains(err.Error(), "Unexpected response code: 500") &&
strings.Contains(err.Error(), fmt.Sprintf("Invalid Policy: A Policy with Name %q already exists", policyName))
return isExistsErr(err, "Policy", policyName)
}
Loading