Documentation
¶
Index ¶
- Constants
- func IsServiceAccountToken(secret *api.Secret, sa *api.ServiceAccount) bool
- func JWTTokenAuthenticator(keys []interface{}, lookup bool, getter ServiceAccountTokenGetter) authenticator.Token
- func MakeGroupNames(namespace, name string) []string
- func MakeNamespaceGroupName(namespace string) string
- func MakeUsername(namespace, name string) string
- func ReadPrivateKey(file string) (interface{}, error)
- func ReadPrivateKeyFromPEM(data []byte) (interface{}, error)
- func ReadPublicKeys(file string) ([]interface{}, error)
- func ReadPublicKeysFromPEM(data []byte) ([]interface{}, error)
- func SplitUsername(username string) (string, string, error)
- func UserInfo(namespace, name, uid string) user.Info
- type ServiceAccountTokenGetter
- type TokenGenerator
Constants ¶
const ( Issuer = "kubernetes/serviceaccount" SubjectClaim = "sub" IssuerClaim = "iss" ServiceAccountNameClaim = "kubernetes.io/serviceaccount/service-account.name" ServiceAccountUIDClaim = "kubernetes.io/serviceaccount/service-account.uid" SecretNameClaim = "kubernetes.io/serviceaccount/secret.name" NamespaceClaim = "kubernetes.io/serviceaccount/namespace" )
const ( ServiceAccountUsernamePrefix = "system:serviceaccount:" ServiceAccountUsernameSeparator = ":" ServiceAccountGroupPrefix = "system:serviceaccounts:" AllServiceAccountsGroup = "system:serviceaccounts" )
Variables ¶
This section is empty.
Functions ¶
func IsServiceAccountToken ¶ added in v1.2.3
func IsServiceAccountToken(secret *api.Secret, sa *api.ServiceAccount) bool
IsServiceAccountToken returns true if the secret is a valid api token for the service account
func JWTTokenAuthenticator ¶
func JWTTokenAuthenticator(keys []interface{}, lookup bool, getter ServiceAccountTokenGetter) authenticator.Token
JWTTokenAuthenticator authenticates tokens as JWT tokens produced by JWTTokenGenerator Token signatures are verified using each of the given public keys until one works (allowing key rotation) If lookup is true, the service account and secret referenced as claims inside the token are retrieved and verified with the provided ServiceAccountTokenGetter
func MakeGroupNames ¶ added in v1.2.3
MakeGroupNames generates service account group names for the given namespace and ServiceAccount name
func MakeNamespaceGroupName ¶ added in v1.2.3
MakeNamespaceGroupName returns the name of the group all service accounts in the namespace are included in
func MakeUsername ¶
MakeUsername generates a username from the given namespace and ServiceAccount name. The resulting username can be passed to SplitUsername to extract the original namespace and ServiceAccount name.
func ReadPrivateKey ¶
ReadPrivateKey is a helper function for reading a private key from a PEM-encoded file
func ReadPrivateKeyFromPEM ¶ added in v1.5.1
ReadPrivateKeyFromPEM is a helper function for reading a private key from a PEM-encoded file
func ReadPublicKeys ¶ added in v1.5.1
ReadPublicKeys is a helper function for reading an array of rsa.PublicKey or ecdsa.PublicKey from a PEM-encoded file. Reads public keys from both public and private key files.
func ReadPublicKeysFromPEM ¶ added in v1.5.1
ReadPublicKeysFromPEM is a helper function for reading an array of rsa.PublicKey or ecdsa.PublicKey from a PEM-encoded byte array. Reads public keys from both public and private key files.
func SplitUsername ¶
SplitUsername returns the namespace and ServiceAccount name embedded in the given username, or an error if the username is not a valid name produced by MakeUsername
Types ¶
type ServiceAccountTokenGetter ¶
type ServiceAccountTokenGetter interface { GetServiceAccount(namespace, name string) (*api.ServiceAccount, error) GetSecret(namespace, name string) (*api.Secret, error) }
ServiceAccountTokenGetter defines functions to retrieve a named service account and secret
type TokenGenerator ¶
type TokenGenerator interface { // GenerateToken generates a token which will identify the given ServiceAccount. // The returned token will be stored in the given (and yet-unpersisted) Secret. GenerateToken(serviceAccount api.ServiceAccount, secret api.Secret) (string, error) }
func JWTTokenGenerator ¶
func JWTTokenGenerator(privateKey interface{}) TokenGenerator
JWTTokenGenerator returns a TokenGenerator that generates signed JWT tokens, using the given privateKey. privateKey is a PEM-encoded byte array of a private RSA key. JWTTokenAuthenticator()