MySQL Connector/J 9.2.0 · com.mysql.cj.protocol.a.NativeAuthenticationProvider

Field Summary

Modifier and Type	Field and Description
private static final int	AUTH_411_OVERHEAD
private Map<String, AuthenticationPlugin<NativePacketPayload>>	authenticationPlugins Contains instances of authentication plugins that implements `AuthenticationPlugin` interface.
private MysqlCallbackHandler	callbackHandler A callback for updating the username from the authentication plugin.
private boolean	clientDefaultAuthenticationPluginExplicitelySet Was the client default authentication plugin explicitly set?
private String	clientDefaultAuthenticationPluginName Protocol name of default authentication plugin in client
private String	database
private ExceptionInterceptor	exceptionInterceptor
private static final String	NONE
private String	password
private PropertySet	propertySet
private Protocol<NativePacketPayload>	protocol
private String	seed
private String	serverDefaultAuthenticationPluginName Protocol name of default authentication plugin in server
private boolean	useConnectWithDb
private String	username

Constructor Summary

Access	Constructor and Description
public	NativeAuthenticationProvider()

Method Summary

Modifier and Type	Method and Description
private void	appendConnectionAttributes(NativePacketPayload buf, String attributes, String enc)
public void	changeUser(String user name user, String password pass, String database name db) Implements com.mysql.cj.protocol.AuthenticationProvider.changeUser. Re-authenticates as the given user and password
private void	checkConfidentiality(AuthenticationPlugin<?> `AuthenticationPlugin` plugin) Check if given plugin requires confidentiality, but connection is without SSL
public void	connect(String user name user, String password pass, String database name db) Implements com.mysql.cj.protocol.AuthenticationProvider.connect. Initialize communications with the MySQL server.
private NativePacketPayload	createChangeUserPacket(ServerSession serverSession, String pluginName, NativePacketPayload authData)
private NativePacketPayload	createHandshakeResponsePacket(ServerSession serverSession, String pluginName, NativePacketPayload authData)
private AuthenticationPlugin<NativePacketPayload>	Returns: null if plugin is not found or authentication plugin instance initialized with current connection properties getAuthenticationPlugin(String mysql protocol plugin names, for example "caching_sha2_password" and "mysql_native_password" for built-in plugins pluginName) Get an authentication plugin instance from the authentication plugins map by pluginName key.
private Map<String, String>	getConnectionAttributesMap(String attStr)
public ExceptionInterceptor	getExceptionInterceptor()
private String	getNthFactorPassword(int nthFactor)
public void	init(Protocol<NativePacketPayload> prot, PropertySet propSet, ExceptionInterceptor excInterceptor) Implements com.mysql.cj.protocol.AuthenticationProvider.init.
private void	loadAuthenticationPlugins() Fill the authentication plugins map.
private void	proceedHandshakeWithPluggableAuthentication(final NativePacketPayload the Auth Challenge Packet received from server if this method is used during the initial connection. Otherwise null. challenge) Performs an authentication handshake to authorize connection to a given database as a given MySQL user.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

AUTH_411_OVERHEAD	back to summary
private static final int AUTH_411_OVERHEAD

authenticationPlugins	back to summary
private Map<String, AuthenticationPlugin<NativePacketPayload>> authenticationPlugins Contains instances of authentication plugins that implements `AuthenticationPlugin` interface. Key values are MySQL protocol plugin names, for example "caching_sha2_password" and "mysql_native_password" for built-in plugins.

callbackHandler	back to summary
private MysqlCallbackHandler callbackHandler A callback for updating the username from the authentication plugin.

clientDefaultAuthenticationPluginExplicitelySet	back to summary
private boolean clientDefaultAuthenticationPluginExplicitelySet Was the client default authentication plugin explicitly set?

clientDefaultAuthenticationPluginName	back to summary
private String clientDefaultAuthenticationPluginName Protocol name of default authentication plugin in client

database	back to summary
private String database

exceptionInterceptor	back to summary
private ExceptionInterceptor exceptionInterceptor

NONE	back to summary
private static final String NONE

password	back to summary
private String password

propertySet	back to summary
private PropertySet propertySet

protocol	back to summary
private Protocol<NativePacketPayload> protocol

seed	back to summary
private String seed

serverDefaultAuthenticationPluginName	back to summary
private String serverDefaultAuthenticationPluginName Protocol name of default authentication plugin in server

useConnectWithDb	back to summary
private boolean useConnectWithDb

username	back to summary
private String username

Constructor Detail

NativeAuthenticationProvider	back to summary
public NativeAuthenticationProvider()

Method Detail

appendConnectionAttributes	back to summary
private void appendConnectionAttributes(NativePacketPayload buf, String attributes, String enc)

changeUser	back to summary
public void changeUser(String user, String pass, String db) Implements com.mysql.cj.protocol.AuthenticationProvider.changeUser. Re-authenticates as the given user and password Parameters user:String user name pass:String password db:String database name Annotations @Override

changeUser

back to summary

public void changeUser(String user, String pass, String db)

Implements com.mysql.cj.protocol.AuthenticationProvider.changeUser.

Re-authenticates as the given user and password

Parameters

user:String: user name
pass:String: password
db:String: database name

Annotations

@Override

checkConfidentiality back to summary

checkConfidentiality	back to summary
private void checkConfidentiality(AuthenticationPlugin<?> plugin) Check if given plugin requires confidentiality, but connection is without SSL Parameters plugin:AuthenticationPlugin<?> `AuthenticationPlugin`

private void checkConfidentiality(AuthenticationPlugin<?> plugin)

Check if given plugin requires confidentiality, but connection is without SSL

Parameters

plugin:AuthenticationPlugin<?>: AuthenticationPlugin

connect	back to summary
public void connect(String user, String pass, String db) Implements com.mysql.cj.protocol.AuthenticationProvider.connect. Initialize communications with the MySQL server. Handles logging on, and handling initial connection errors. Parameters user:String user name pass:String password db:String database name Annotations @Override

connect

back to summary

public void connect(String user, String pass, String db)

Implements com.mysql.cj.protocol.AuthenticationProvider.connect.

Initialize communications with the MySQL server. Handles logging on, and handling initial connection errors.

Parameters

user:String: user name
pass:String: password
db:String: database name

Annotations

@Override

createChangeUserPacket	back to summary
private NativePacketPayload createChangeUserPacket(ServerSession serverSession, String pluginName, NativePacketPayload authData)

createHandshakeResponsePacket	back to summary
private NativePacketPayload createHandshakeResponsePacket(ServerSession serverSession, String pluginName, NativePacketPayload authData)

getAuthenticationPlugin back to summary

getAuthenticationPlugin	back to summary
private AuthenticationPlugin<NativePacketPayload> getAuthenticationPlugin(String pluginName) Get an authentication plugin instance from the authentication plugins map by pluginName key. If such plugin is found, its method `AuthenticationPlugin#isReusable()` is called and if the value returned is `false` then a new instance of the plugin is returned otherwise the instance that already exists is returned. If plugin is not found method returns null, in such case the subsequent behavior of handshake process depends on type of last packet received from server: if it was Auth Challenge Packet then handshake will proceed with default plugin, if it was Auth Method Switch Request Packet then handshake will be interrupted with exception. Parameters pluginName:String mysql protocol plugin names, for example "caching_sha2_password" and "mysql_native_password" for built-in plugins Returns:AuthenticationPlugin<NativePacketPayload> null if plugin is not found or authentication plugin instance initialized with current connection properties Annotations @SuppressWarnings:unchecked

private AuthenticationPlugin<NativePacketPayload> getAuthenticationPlugin(String pluginName)

Get an authentication plugin instance from the authentication plugins map by pluginName key. If such plugin is found, its method AuthenticationPlugin#isReusable() is called and if the value returned is false then a new instance of the plugin is returned otherwise the instance that already exists is returned. If plugin is not found method returns null, in such case the subsequent behavior of handshake process depends on type of last packet received from server: if it was Auth Challenge Packet then handshake will proceed with default plugin, if it was Auth Method Switch Request Packet then handshake will be interrupted with exception.

Parameters

pluginName:String: mysql protocol plugin names, for example "caching_sha2_password" and "mysql_native_password" for built-in plugins

Returns:AuthenticationPlugin<NativePacketPayload>

null if plugin is not found or authentication plugin instance initialized with current connection properties

Annotations

@SuppressWarnings:unchecked

getConnectionAttributesMap	back to summary
private Map<String, String> getConnectionAttributesMap(String attStr)

getExceptionInterceptor	back to summary
public ExceptionInterceptor getExceptionInterceptor()

getNthFactorPassword	back to summary
private String getNthFactorPassword(int nthFactor)

init	back to summary
public void init(Protocol<NativePacketPayload> prot, PropertySet propSet, ExceptionInterceptor excInterceptor) Implements com.mysql.cj.protocol.AuthenticationProvider.init. Annotations @Override

init

back to summary

public void init(Protocol<NativePacketPayload> prot, PropertySet propSet, ExceptionInterceptor excInterceptor)

Implements com.mysql.cj.protocol.AuthenticationProvider.init.

Annotations

@Override

loadAuthenticationPlugins back to summary

loadAuthenticationPlugins	back to summary
private void loadAuthenticationPlugins() Fill the authentication plugins map. Starts by filling the map with instances of the built-in authentication plugins. Then creates instances of plugins listed in the "authenticationPlugins" connection property and adds them to the map too. The plugins map uses the plugin names as keys, which are obtained from `AuthenticationPlugin#getProtocolPluginName()` thus it is possible to replace built-in plugins with custom implementations as long as the implementations use the same MySQL authentication plugin client-side name, such as, "caching_sha2_password" and "mysql_native_password". Annotations @SuppressWarnings:unchecked

private void loadAuthenticationPlugins()

Fill the authentication plugins map. Starts by filling the map with instances of the built-in authentication plugins. Then creates instances of plugins listed in the "authenticationPlugins" connection property and adds them to the map too. The plugins map uses the plugin names as keys, which are obtained from AuthenticationPlugin#getProtocolPluginName() thus it is possible to replace built-in plugins with custom implementations as long as the implementations use the same MySQL authentication plugin client-side name, such as, "caching_sha2_password" and "mysql_native_password".

Annotations

@SuppressWarnings:unchecked

proceedHandshakeWithPluggableAuthentication	back to summary
private void proceedHandshakeWithPluggableAuthentication(final NativePacketPayload challenge) Performs an authentication handshake to authorize connection to a given database as a given MySQL user. This can happen upon initial connection to the server, after receiving Auth Challenge Packet, or at any moment during the connection life-time via a Change User request. This method will use registered authentication plugins as requested by the server. Parameters challenge:NativePacketPayload the Auth Challenge Packet received from server if this method is used during the initial connection. Otherwise null.

proceedHandshakeWithPluggableAuthentication

back to summary

private void proceedHandshakeWithPluggableAuthentication(final NativePacketPayload challenge)

Performs an authentication handshake to authorize connection to a given database as a given MySQL user. This can happen upon initial connection to the server, after receiving Auth Challenge Packet, or at any moment during the connection life-time via a Change User request. This method will use registered authentication plugins as requested by the server.

Parameters

challenge:NativePacketPayload: the Auth Challenge Packet received from server if this method is used during the initial connection. Otherwise null.

public Class NativeAuthenticationProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail