Package io.aeron.security

Basic security infrastructure for authenticating sessions by delegating to a supplied instance of an Authenticator.

See: Description

Interface Summary

Interface	Description
Authenticator	Interface for an Authenticator to handle authentication of clients to a system.
AuthenticatorSupplier	Used to supply instances of Authenticator.
AuthorisationService	Interface for an authorisation service to handle authorisation checks of clients performing actions on a system.
AuthorisationServiceSupplier	Used to supply instances of AuthorisationService.
CredentialsSupplier	Supplier of credentials for authentication with a system.
SessionProxy	Representation of a session during the authentication process from the perspective of an Authenticator.

Class Summary

Class	Description
DefaultAuthenticatorSupplier	Default Authenticator which authenticates all connection requests immediately.
NullCredentialsSupplier	Null provider of credentials when no authentication is required.
SimpleAuthenticator	An authenticator that works off a simple principal/credential pair constructed by a builder.
SimpleAuthenticator.Builder	Builder to create instances of SimpleAuthenticator
SimpleAuthorisationService	Authorisation service that supports setting general and per-principal rules as well as scoping to protocol, action and type.
SimpleAuthorisationService.Builder	Builder to create the authorisation service.

Exception Summary

Exception	Description
AuthenticationException	Used to indicate a failed authentication attempt when connecting to a system.

Package io.aeron.security Description

Basic security infrastructure for authenticating sessions by delegating to a supplied instance of an Authenticator.

New connection requests will be allocated a unique 64-bit session identity which is first passed to Authenticator.onConnectRequest(long, byte[], long). Once the response stream to the client is connected then the system will make periodic calls to Authenticator.onConnectedSession(io.aeron.security.SessionProxy, long) until the Authenticator updates the status of the SessionProxy to indicate if the session is authenticated, needs to be challenged, or is rejected.