org.neo4j.server.security.enterprise.auth.plugin.spi

Interface CacheableAuthenticationInfo

All Superinterfaces:

AuthenticationInfo, Serializable

public interface CacheableAuthenticationInfo
extends AuthenticationInfo

A cacheable object that can be returned as the result of successful authentication by an AuthenticationPlugin.

This object can be cached by the Neo4j authentication cache.

This is an alternative to CustomCacheableAuthenticationInfo if you want Neo4j to manage secure hashing and matching of cached credentials.

NOTE: Caching only occurs if it is explicitly enabled by the plugin.

See Also:

AuthenticationPlugin.authenticate(AuthToken), AuthProviderOperations.setAuthenticationCachingEnabled(boolean), CustomCacheableAuthenticationInfo

Method Summary

Modifier and Type	Method and Description
byte[]	credentials() Should return credentials that can be cached, so that successive authentication attempts could be performed against the cached authentication info from a previous successful authentication attempt, without having to call AuthenticationInfo.getAuthenticationInfo() again.
static CacheableAuthenticationInfo	of(Object principal, byte[] credentials) Creates a new CacheableAuthenticationInfo
Object	principal() Should return a principal that uniquely identifies the authenticated subject within this authentication provider.

Methods inherited from interface org.neo4j.server.security.enterprise.auth.plugin.spi.AuthenticationInfo

of

Method Detail

principal

Object principal()

Should return a principal that uniquely identifies the authenticated subject within this authentication provider. This will be used as the cache key, and needs to be matcheable against a principal within the auth token map.

Typically this is the same as the principal within the auth token map.

Specified by:

principal in interface AuthenticationInfo

Returns:

a principal that uniquely identifies the authenticated subject within this authentication provider

See Also:

AuthToken.principal()

credentials

byte[] credentials()

Should return credentials that can be cached, so that successive authentication attempts could be performed against the cached authentication info from a previous successful authentication attempt, without having to call AuthenticationInfo.getAuthenticationInfo() again.

NOTE: The returned credentials will be hashed using a cryptographic hash function together with a random salt (generated with a secure random number generator) before being stored.

Returns:

credentials that can be cached

See Also:

AuthToken.credentials(), AuthenticationPlugin.authenticate(AuthToken)

of

static CacheableAuthenticationInfo of(Object principal,
                                      byte[] credentials)

Creates a new CacheableAuthenticationInfo

Parameters:

principal - a principal that uniquely identifies the authenticated subject within this authentication provider

credentials - credentials that can be cached

Returns:

a new CacheableAuthenticationInfo containing the given parameters