Package co.cask.cdap.security.auth

Classes related to authentication of clients and daemons.

See: Description

Interface Summary

Interface	Description
KeyManager	Maintains secret keys used to sign and validate authentication tokens.
Signed<T>	Represents a message signed by a secret key.
TokenValidator	Interface TokenValidator to validate the access token.

Class Summary

Class	Description
AbstractKeyManager	AbstractKeyManager that provides the basic functionality that all key managers share.
AccessToken	Represents a verified identity used for client authentication.
AccessTokenCodec	Utility to encode and decode AccessToken and AccessTokenIdentifier instances to and from byte array representations.
AccessTokenIdentifier	Represents a verified user identity.
AccessTokenIdentifierCodec	Utility to handle serialization and deserialization of AccessTokenIdentifier objects.
AccessTokenTransformer	It takes the access token and transforms it to Access Token Identifier.
AccessTokenValidator	This class validates the accessToken and returns the different states of accessToken validation.
DistributedKeyManager	KeyManager implementation that distributes shared secret keys via ZooKeeper to all instances, so that all distributed instances maintain the same local cache of keys.
FileBasedKeyManager	Maintains secret keys used to sign and validate authentication tokens.
InMemoryKeyManager	Maintains secret keys in memory and uses them to sign and validate authentication tokens.
KeyIdentifier	Represents a secret key to use for message signing, plus a unique random number identifying it.
KeyIdentifierCodec	Utility to encode and decode keys that are shared between keyManagers.
KeyManager.DigestId	Represents the combination of a digest computed on a message using a secret key, and the ID of the secret key used to compute the digest.
MapBackedKeyManager	Abstract base class for KeyManager implementations that store all secret keys in an in-memory Map.
TokenManager	Provides a simple interface to generate and validate AccessTokens.

Enum Summary

Enum	Description
TokenState	Different states attained after validating the token MISSING - the access token is missing in the request INVALID - the token digest did not match the expected value EXPIRED - the token is past the expiration timestamp INTERNAL - another error occurred in processing (represented by the exception "cause") VALID - the token is valid

Exception Summary

Exception	Description
InvalidDigestException	Exception thrown if an asserted message digest does not match the recomputed value, using the same secret key.
InvalidTokenException	This exception indicates a failure to validate an issued AccessToken, for example due to token expiration or an invalid token digest.

Package co.cask.cdap.security.auth Description

Classes related to authentication of clients and daemons.