io.picodata.driver.auth

Class ChapSha1TarantoolAuthenticator

java.lang.Object

io.picodata.driver.auth.ChapSha1TarantoolAuthenticator

All Implemented Interfaces:

TarantoolAuthenticator

public final class ChapSha1TarantoolAuthenticator
extends Object
implements TarantoolAuthenticator

This authenticator performs authentication to the Tarantool server using default mechanism (chap-sha1) and the provided plain user credentials.

Field Summary

Fields

Modifier and Type	Field and Description
static ChapSha1TarantoolAuthenticator	INSTANCE Singleton instance of this authenticator

Method Summary

Modifier and Type	Method and Description
boolean	canAuthenticateWith(TarantoolCredentials credentials) Check if the passed instance of SimpleTarantoolCredentials can be used for authentication
boolean	canSkipAuth(TarantoolCredentials credentials) Check if the passed instance of SimpleTarantoolCredentials can be used for authentication
TarantoolAuthMechanism	getMechanism() Returns the supported TarantoolAuthMechanism
byte[]	prepareUserAuthData(byte[] serverAuthData, TarantoolCredentials credentials) Take the salt from the server connect response, write the authentication data based on the provided SimpleTarantoolCredentials.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final ChapSha1TarantoolAuthenticator INSTANCE

Singleton instance of this authenticator

Method Detail

getMechanism

public TarantoolAuthMechanism getMechanism()

Returns the supported TarantoolAuthMechanism

Specified by:

getMechanism in interface TarantoolAuthenticator

Returns:

TarantoolAuthMechanism.CHAPSHA1

See Also:

AuthMechanism

canAuthenticateWith

public boolean canAuthenticateWith(TarantoolCredentials credentials)

Check if the passed instance of SimpleTarantoolCredentials can be used for authentication

Specified by:

canAuthenticateWith in interface TarantoolAuthenticator

Parameters:

credentials - Tarantool user credentials

Returns:

true, if the username and password are not empty

canSkipAuth

public boolean canSkipAuth(TarantoolCredentials credentials)

Check if the passed instance of SimpleTarantoolCredentials can be used for authentication

Specified by:

canSkipAuth in interface TarantoolAuthenticator

Parameters:

credentials - Tarantool user credentials

Returns:

true, if the guest is implicit

prepareUserAuthData

public byte[] prepareUserAuthData(byte[] serverAuthData,
                                  TarantoolCredentials credentials)
                           throws TarantoolAuthenticationException

Take the salt from the server connect response, write the authentication data based on the provided SimpleTarantoolCredentials.

See https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/#binary-protocol-authentication

Specified by:

prepareUserAuthData in interface TarantoolAuthenticator

Parameters:

serverAuthData - the auth data responded by server to the connect request

credentials - Tarantool user credentials

Returns:

binary data for authentication request according to the chap-sha1 algorithm

Throws:

TarantoolAuthenticationException - id authentication failed

See Also:

https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/#binary-protocol-authentication