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.

Sign up for GitHub

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

feat: Vault tokens are now identity-based instead of anonymous #4327

Merged
merged 1 commit into from
Feb 8, 2023
+458 −270
Merged

feat: Vault tokens are now identity-based instead of anonymous #4327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
96 changes: 77 additions & 19 deletions cmd/security-file-token-provider/res/token-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,61 @@
"support-scheduler": {
"edgex_use_defaults": true
},
"security-secretstore-setup": {
"security-proxy-auth": {
"edgex_use_defaults": true
},
"security-proxy-setup": {
"edgex_use_defaults": true,
"custom_policy": {
"path": {
"secret/edgex/security-proxy-setup/kong-tls": {
"identity/entity/name": {
"capabilities": [
"list"
]
},
"identity/entity/name/*": {
"capabilities": [
"list",
"read",
"create",
"update",
"delete"
]
},
"secret/edgex/redis/*": {
"identity/entity-alias": {
"capabilities": [
"create",
"update"
]
},
"identity/oidc/role": {
"capabilities": [
"list"
]
},
"identity/oidc/role/*": {
"capabilities": [
"create",
"update"
]
},
"auth/userpass/users/*": {
"capabilities": [
"create",
"update"
]
},
"sys/auth": {
"capabilities": [
"read"
]
},
"sys/policies/acl": {
"capabilities": [
"list"
]
},
"sys/policies/acl/edgex-user-*": {
"capabilities": [
"list",
"read",
"create",
"update",
Expand All @@ -57,35 +96,54 @@
}
}
},
"security-proxy-setup": {
"edgex_use_defaults": true
},
"security-file-token-provider": {
"edgex_use_defaults": true
},
"security-spiffe-token-provider": {
"edgex_use_defaults": true,
"custom_policy": {
"path": {
"auth/token/create": {
"identity/entity/name": {
"capabilities": [
"list"
]
},
"identity/entity/name/*": {
"capabilities": [
"read",
"create",
"update",
"sudo"
"delete"
]
},
"auth/token/create-orphan": {
"identity/entity-alias": {
"capabilities": [
"create",
"update",
"sudo"
"update"
]
},
"identity/oidc/role": {
"capabilities": [
"list"
]
},
"auth/token/create/*": {
"identity/oidc/role/*": {
"capabilities": [
"create",
"update",
"sudo"
"update"
]
},
"auth/userpass/users/*": {
"capabilities": [
"create",
"update"
]
},
"sys/auth": {
"capabilities": [
"read"
]
},
"sys/policies/acl": {
"capabilities": [
"list"
]
},
"sys/policies/acl/edgex-service-*": {
Expand Down
2 changes: 2 additions & 0 deletions cmd/security-secretstore-setup/res-file-token-provider/configuration.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ ConfigFile = "res-file-token-provider/token-config.json"
OutputDir = "/tmp/edgex/secrets"
OutputFilename = "secrets-token.json"
DefaultTokenTTL = "1h"
DefaultJWTTTL = "15m"
UserPassMountPoint = "userpass"
11 changes: 11 additions & 0 deletions cmd/security-spiffe-token-provider/res/configuration.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@ Port = 6379
Timeout = 5000
Type = "redisdb"


[TokenConfig]
#PrivilegedTokenPath = "UNUSED"
#ConfigFile = "UNUSED"
#OutputDir = "UNUSED"
#OutputFilename = "UNUSED"
Comment on lines +43 to +46
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we remove this, shouldn't it become breaking changes in terms of update pov?

Copy link
Collaborator Author

@bnevis-i bnevis-i Feb 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What this is actually doing is reusing the configuration.toml snippet from security-file-token-provider except that we don't need all of the parameters, just some of them (like the TTL on the vault token and JWT). I'm just making it clear that we don't use these parameters in spiffe-token-provider.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

DefaultTokenTTL = "1h"
DefaultJWTTTL = "15m"
UserPassMountPoint = "userpass"


[SPIFFE]
EndpointSocket = "/tmp/edgex/secrets/spiffe/public/api.sock"
TrustDomain = "edgexfoundry.org"
43 changes: 23 additions & 20 deletions internal/security/fileprovider/defaults.go → internal/security/common/tokenpolicy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (c) 2019 Intel Corporation
// Copyright (c) 2019-2023 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
Expand All @@ -11,23 +11,30 @@
// or implied. See the License for the specific language governing permissions and limitations under
// the License.
//
// SPDX-License-Identifier: Apache-2.0'
// SPDX-License-Identifier: Apache-2.0
//

package fileprovider
package common

func makeDefaultTokenPolicy(serviceName string) map[string]interface{} {
func MakeDefaultTokenPolicy(serviceName string) map[string]interface{} {
// protected path for secret/
protectedPath := "secret/edgex/" + serviceName + "/*"
capabilities := []string{"create", "update", "delete", "list", "read"}
acl := map[string]interface{}{"capabilities": capabilities}
secretsPath := "secret/edgex/" + serviceName + "/*"
secretsAcl := map[string]interface{}{"capabilities": []string{"create", "update", "delete", "list", "read"}}
// path for consul tokens
registryCredsPath := "consul/creds/" + serviceName
registryCredsCapabilities := []string{"read"}
registryCredsACL := map[string]interface{}{"capabilities": registryCredsCapabilities}
registryCredsACL := map[string]interface{}{"capabilities": []string{"read"}}
// allow request identity JWT
jwtRequestPath := "identity/oidc/token/" + serviceName
jwtRequestACL := map[string]interface{}{"capabilities": []string{"read"}}
// allow introspect JWT
jwtIntrospectPath := "identity/oidc/introspect"
jwtIntrospectACL := map[string]interface{}{"capabilities": []string{"create", "update"}}
// access spec
pathObject := map[string]interface{}{
protectedPath: acl,
secretsPath: secretsAcl,
registryCredsPath: registryCredsACL,
jwtRequestPath: jwtRequestACL,
jwtIntrospectPath: jwtIntrospectACL,
}
retval := map[string]interface{}{"path": pathObject}
return retval
Expand All @@ -40,18 +47,14 @@ func makeDefaultTokenPolicy(serviceName string) map[string]interface{} {
},
"consul/creds/service-name": {
"capabilities": [ "read" ]
},
"identity/oidc/token/service-name": {
"capabilities": [ "read" ]
},
"identity/oidc/introspect": {
"capabilities": [ "create", "update" ]
}
}
}
*/
}

func makeDefaultTokenParameters(serviceName string, defaultTTL string, defaultPeriod string) map[string]interface{} {
return map[string]interface{}{
"display_name": serviceName,
"no_parent": true,
"ttl": defaultTTL,
"period": defaultPeriod,
"policies": []string{"edgex-service-" + serviceName},
}
}
27 changes: 10 additions & 17 deletions ...al/security/fileprovider/defaults_test.go → internal/security/common/tokenpolicy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (c) 2019 Intel Corporation
// Copyright (c) 2019-2023 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
Expand All @@ -11,9 +11,9 @@
// or implied. See the License for the specific language governing permissions and limitations under
// the License.
//
// SPDX-License-Identifier: Apache-2.0'
// SPDX-License-Identifier: Apache-2.0
//
package fileprovider
package common

import (
"encoding/json"
Expand All @@ -24,7 +24,7 @@ import (

func TestDefaultTokenPolicy(t *testing.T) {
// Act
policies := makeDefaultTokenPolicy("service-name")
policies := MakeDefaultTokenPolicy("service-name")

// Assert
bytes, err := json.Marshal(policies)
Expand All @@ -39,21 +39,14 @@ func TestDefaultTokenPolicy(t *testing.T) {
"consul/creds/service-name": map[string]interface{}{
"capabilities": []string{"read"},
},
"identity/oidc/token/service-name": map[string]interface{}{
"capabilities": []string{"read"},
},
"identity/oidc/introspect": map[string]interface{}{
"capabilities": []string{"create", "update"},
},
},
}

require.Equal(t, expected, policies)
}

func TestDefaultTokenParameters(t *testing.T) {
// Act
parameters := makeDefaultTokenParameters("service-name", "1h", "1h")

// Assert
bytes, err := json.Marshal(parameters)
require.NoError(t, err)

expected := `{"display_name":"service-name","no_parent":true,"period":"1h","policies":["edgex-service-service-name"],"ttl":"1h"}`
actual := string(bytes)
require.Equal(t, expected, actual)
}
Loading