io.picodata.driver.auth

Interface TarantoolAuthenticator

All Known Implementing Classes:

ChapSha1TarantoolAuthenticator, MD5PicodataAuthenticator

public interface TarantoolAuthenticator

Prepares authentication data for passing to Tarantool

Method Summary

Modifier and Type	Method and Description
boolean	canAuthenticateWith(TarantoolCredentials credentials) Check if the passed instance of TarantoolCredentials can be used for authentication
boolean	canSkipAuth(TarantoolCredentials credentials) Сheck if we can connect to the Tarantool without authentication
AuthMechanism	getMechanism() Provides the authentication mechanism signature
byte[]	prepareUserAuthData(byte[] serverAuthData, TarantoolCredentials credentials) Takes the server auth data returned in response for the connect request and user auth data, performs the necessary transformations and writes the serialized authentication data to a byte array

Method Detail

getMechanism

AuthMechanism getMechanism()

Provides the authentication mechanism signature

Returns:

authentication mechanism instance

See Also:

AuthMechanism

canAuthenticateWith

boolean canAuthenticateWith(TarantoolCredentials credentials)

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

Parameters:

credentials - Tarantool user credentials

Returns:

true if the credentials data are sufficient for performing authentication

canSkipAuth

boolean canSkipAuth(TarantoolCredentials credentials)

Сheck if we can connect to the Tarantool without authentication

Parameters:

credentials - Tarantool user credentials

Returns:

true if the credentials are suitable so as not to use them for authentication

prepareUserAuthData

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

Takes the server auth data returned in response for the connect request and user auth data, performs the necessary transformations and writes the serialized authentication data to a byte array

Parameters:

serverAuthData - bytes with auth data from the Tarantool server greeting

credentials - Tarantool user credentials

Returns:

the auth data in the form of byte array, ready to be transferred in an authentication request to Tarantool server

Throws:

TarantoolAuthenticationException - id authentication failed

See Also:

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