io.aeron.security

Interface Authenticator

All Known Implementing Classes:

SampleAuthenticator, SimpleAuthenticator, SimpleAuthenticator

public interface Authenticator

Interface for an Authenticator to handle authentication of clients to a system.

The session-id refers to the authentication session and not the Aeron transport session assigned to a publication.

See Also:

SessionProxy, AuthenticatorSupplier

Method Summary

Modifier and Type	Method and Description
void	onChallengedSession(SessionProxy sessionProxy, long nowMs) Called when a challenged client should be able to accept a response from the authenticator.
void	onChallengeResponse(long sessionId, byte[] encodedCredentials, long nowMs) Called upon reception of a Challenge Response from an unauthenticated client.
void	onConnectedSession(SessionProxy sessionProxy, long nowMs) Called when a client's response channel has been connected.
void	onConnectRequest(long sessionId, byte[] encodedCredentials, long nowMs) Called upon reception of a Connect Request and will be followed up by multiple calls to onConnectedSession(SessionProxy, long) once the response channel is connected.

Method Detail

onConnectRequest

void onConnectRequest(long sessionId,
                      byte[] encodedCredentials,
                      long nowMs)

Called upon reception of a Connect Request and will be followed up by multiple calls to onConnectedSession(SessionProxy, long) once the response channel is connected.

Parameters:

sessionId - to identify the client session connecting.

encodedCredentials - from the Connect Request. Will not be null, but may be 0 length.

nowMs - current epoch time in milliseconds.

onChallengeResponse

void onChallengeResponse(long sessionId,
                         byte[] encodedCredentials,
                         long nowMs)

Called upon reception of a Challenge Response from an unauthenticated client.

Parameters:

sessionId - to identify the client session connecting.

encodedCredentials - from the Challenge Response. Will not be null, but may be 0 length.

nowMs - current epoch time in milliseconds.

onConnectedSession

void onConnectedSession(SessionProxy sessionProxy,
                        long nowMs)

Called when a client's response channel has been connected. This method may be called multiple times until the session timeouts, is challenged, authenticated, or rejected.

Parameters:

sessionProxy - to use to update authentication status. Proxy is only valid for the duration of the call.

nowMs - current epoch time in milliseconds.

See Also:

SessionProxy

onChallengedSession

void onChallengedSession(SessionProxy sessionProxy,
                         long nowMs)

Called when a challenged client should be able to accept a response from the authenticator.

When this is called, there is no assumption that a Challenge Response has been received, plus this method may be called multiple times.

It is up to the concrete class to provide any timeout management.

Parameters:

sessionProxy - to use to update authentication status. Proxy is only valid for the duration of the call.

nowMs - current epoch time in milliseconds.

See Also:

SessionProxy