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

Modifier and Type	Field and Description
protected String	password
public static String	PLUGIN_NAME
protected Protocol<NativePacketPayload>	protocol
protected boolean	publicKeyRequested
protected String	publicKeyString
protected String	seed
protected RuntimeProperty<String>	serverRSAPublicKeyFile
protected MysqlCallbackHandler	usernameCallbackHandler

Access	Constructor and Description
public	Sha256PasswordPlugin()

Method Summary

Modifier and Type	Method and Description
public void	destroy() Overrides default com.mysql.cj.protocol.AuthenticationPlugin.destroy. Called by the driver when this extension should release any resources it is holding and cleanup internally before the connection is closed.
protected byte[]	encryptPassword()
protected byte[]	encryptPassword(String transformation)
public String	getProtocolPluginName() Implements com.mysql.cj.protocol.AuthenticationPlugin.getProtocolPluginName. Returns the client-side name that the MySQL server uses on the wire for this plugin.
public void	init(Protocol<NativePacketPayload> the protocol instance prot, MysqlCallbackHandler a callback handler to provide additional information to the authentication provider cbh) Overrides default com.mysql.cj.protocol.AuthenticationPlugin.init. Initializes this plugin with a direct Protocol reference and a generic `MysqlCallbackHandler` that can be used to pass over information back to the authentication provider.
public boolean	isReusable() Implements com.mysql.cj.protocol.AuthenticationPlugin.isReusable.
public boolean	nextAuthenticationStep(NativePacketPayload a buffer containing handshake data payload from server (can be empty). fromServer, List<NativePacketPayload> list of buffers with data to be sent to the server (the list can be empty, but buffers in the list should contain data). toServer) Implements com.mysql.cj.protocol.AuthenticationPlugin.nextAuthenticationStep. Process authentication handshake data from server and optionally produce data to be sent back to the server.
protected static String	readRSAKey(String pkPath, PropertySet propertySet, ExceptionInterceptor exceptionInterceptor)
public boolean	requiresConfidentiality() Implements com.mysql.cj.protocol.AuthenticationPlugin.requiresConfidentiality. Does this plugin require the connection itself to be confidential (i.e. tls/ssl)...Highly recommended to return "true" for plugins that return the credentials in the clear.
public void	setAuthenticationParameters(String user name user, String user password password) Implements com.mysql.cj.protocol.AuthenticationPlugin.setAuthenticationParameters. This method called from Connector/J before first nextAuthenticationStep call.

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

password	back to summary
protected String password

PLUGIN_NAME	back to summary
public static String PLUGIN_NAME

protocol	back to summary
protected Protocol<NativePacketPayload> protocol

publicKeyRequested	back to summary
protected boolean publicKeyRequested

publicKeyString	back to summary
protected String publicKeyString

seed	back to summary
protected String seed

serverRSAPublicKeyFile	back to summary
protected RuntimeProperty<String> serverRSAPublicKeyFile

usernameCallbackHandler	back to summary
protected MysqlCallbackHandler usernameCallbackHandler

Sha256PasswordPlugin	back to summary
public Sha256PasswordPlugin()

Method Detail

destroy	back to summary
public void destroy() Overrides default com.mysql.cj.protocol.AuthenticationPlugin.destroy. Doc from com.mysql.cj.protocol.AuthenticationPlugin.destroy. Called by the driver when this extension should release any resources it is holding and cleanup internally before the connection is closed. Annotations @Override

destroy

back to summary

public void destroy()

Overrides default com.mysql.cj.protocol.AuthenticationPlugin.destroy.

Doc from com.mysql.cj.protocol.AuthenticationPlugin.destroy.

Called by the driver when this extension should release any resources it is holding and cleanup internally before the connection is closed.

Annotations

@Override

encryptPassword	back to summary
protected byte[] encryptPassword()

encryptPassword	back to summary
protected byte[] encryptPassword(String transformation)

getProtocolPluginName	back to summary
public String getProtocolPluginName() Implements com.mysql.cj.protocol.AuthenticationPlugin.getProtocolPluginName. Doc from com.mysql.cj.protocol.AuthenticationPlugin.getProtocolPluginName. Returns the client-side name that the MySQL server uses on the wire for this plugin. Returns:String plugin name Annotations @Override

getProtocolPluginName

back to summary

public String getProtocolPluginName()

Implements com.mysql.cj.protocol.AuthenticationPlugin.getProtocolPluginName.

Doc from com.mysql.cj.protocol.AuthenticationPlugin.getProtocolPluginName.

Returns the client-side name that the MySQL server uses on the wire for this plugin.

Returns:String

plugin name

Annotations

@Override

init back to summary

init	back to summary
public void init(Protocol<NativePacketPayload> prot, MysqlCallbackHandler cbh) Overrides default com.mysql.cj.protocol.AuthenticationPlugin.init. Doc from com.mysql.cj.protocol.AuthenticationPlugin.init. Initializes this plugin with a direct Protocol reference and a generic `MysqlCallbackHandler` that can be used to pass over information back to the authentication provider. For example an authentication plugin may accept `null` usernames and use that information to obtain them from some external source, such as the system login. Parameters prot:Protocol<NativePacketPayload> the protocol instance cbh:MysqlCallbackHandler a callback handler to provide additional information to the authentication provider Annotations @Override

public void init(Protocol<NativePacketPayload> prot, MysqlCallbackHandler cbh)

Overrides default com.mysql.cj.protocol.AuthenticationPlugin.init.

Doc from com.mysql.cj.protocol.AuthenticationPlugin.init.

Initializes this plugin with a direct Protocol reference and a generic MysqlCallbackHandler that can be used to pass over information back to the authentication provider. For example an authentication plugin may accept null usernames and use that information to obtain them from some external source, such as the system login.

Parameters

prot:Protocol<NativePacketPayload>: the protocol instance
cbh:MysqlCallbackHandler: a callback handler to provide additional information to the authentication provider

Annotations

@Override

isReusable	back to summary
public boolean isReusable() Implements com.mysql.cj.protocol.AuthenticationPlugin.isReusable. Returns:boolean Doc from com.mysql.cj.protocol.AuthenticationPlugin.isReusable. true if plugin instance may be reused, false otherwise Annotations @Override

isReusable

back to summary

public boolean isReusable()

Implements com.mysql.cj.protocol.AuthenticationPlugin.isReusable.

Returns:boolean

Doc from com.mysql.cj.protocol.AuthenticationPlugin.isReusable.

true if plugin instance may be reused, false otherwise

Annotations

@Override

nextAuthenticationStep	back to summary
public boolean nextAuthenticationStep(NativePacketPayload fromServer, List<NativePacketPayload> toServer) Implements com.mysql.cj.protocol.AuthenticationPlugin.nextAuthenticationStep. Doc from com.mysql.cj.protocol.AuthenticationPlugin.nextAuthenticationStep. Process authentication handshake data from server and optionally produce data to be sent back to the server. The driver will keep calling this method on each new server packet arrival until either an Exception is thrown (authentication failure, please use appropriate SQLStates) or the number of exchange iterations exceeded max limit or an OK packet is sent by server indicating that the connection has been approved. If, on return from this method, toServer is a non-empty list of buffers, then these buffers will be sent to the server in the same order and without any reads in between them. If toServer is an empty list, no data will be sent to server, driver immediately reads the next packet from server. In case of errors the method should throw Exception. Parameters fromServer:NativePacketPayload a buffer containing handshake data payload from server (can be empty). toServer:List<NativePacketPayload> list of buffers with data to be sent to the server (the list can be empty, but buffers in the list should contain data). Returns:boolean return value is ignored. Annotations @Override

nextAuthenticationStep

back to summary

public boolean nextAuthenticationStep(NativePacketPayload fromServer, List<NativePacketPayload> toServer)

Implements com.mysql.cj.protocol.AuthenticationPlugin.nextAuthenticationStep.

Doc from com.mysql.cj.protocol.AuthenticationPlugin.nextAuthenticationStep.

Process authentication handshake data from server and optionally produce data to be sent back to the server. The driver will keep calling this method on each new server packet arrival until either an Exception is thrown (authentication failure, please use appropriate SQLStates) or the number of exchange iterations exceeded max limit or an OK packet is sent by server indicating that the connection has been approved. If, on return from this method, toServer is a non-empty list of buffers, then these buffers will be sent to the server in the same order and without any reads in between them. If toServer is an empty list, no data will be sent to server, driver immediately reads the next packet from server. In case of errors the method should throw Exception.

Parameters

fromServer:NativePacketPayload: a buffer containing handshake data payload from server (can be empty).
toServer:List<NativePacketPayload>: list of buffers with data to be sent to the server (the list can be empty, but buffers in the list should contain data).

Returns:boolean

return value is ignored.

Annotations

@Override

readRSAKey	back to summary
protected static String readRSAKey(String pkPath, PropertySet propertySet, ExceptionInterceptor exceptionInterceptor)

requiresConfidentiality	back to summary
public boolean requiresConfidentiality() Implements com.mysql.cj.protocol.AuthenticationPlugin.requiresConfidentiality. Doc from com.mysql.cj.protocol.AuthenticationPlugin.requiresConfidentiality. Does this plugin require the connection itself to be confidential (i.e. tls/ssl)...Highly recommended to return "true" for plugins that return the credentials in the clear. Returns:boolean true if secure connection is required Annotations @Override

requiresConfidentiality

back to summary

public boolean requiresConfidentiality()

Implements com.mysql.cj.protocol.AuthenticationPlugin.requiresConfidentiality.

Doc from com.mysql.cj.protocol.AuthenticationPlugin.requiresConfidentiality.

Does this plugin require the connection itself to be confidential (i.e. tls/ssl)...Highly recommended to return "true" for plugins that return the credentials in the clear.

Returns:boolean

true if secure connection is required

Annotations

@Override

setAuthenticationParameters	back to summary
public void setAuthenticationParameters(String user, String password) Implements com.mysql.cj.protocol.AuthenticationPlugin.setAuthenticationParameters. Doc from com.mysql.cj.protocol.AuthenticationPlugin.setAuthenticationParameters. This method called from Connector/J before first nextAuthenticationStep call. Values of user and password parameters are passed from those in NativeAuthenticationProvider#changeUser() or NativeAuthenticationProvider#connect(). Plugin should use these values instead of values from connection properties because parent method may be a changeUser call which saves user and password into connection only after successful handshake. Parameters user:String user name password:String user password Annotations @Override

setAuthenticationParameters

back to summary

public void setAuthenticationParameters(String user, String password)

Implements com.mysql.cj.protocol.AuthenticationPlugin.setAuthenticationParameters.

Doc from com.mysql.cj.protocol.AuthenticationPlugin.setAuthenticationParameters.

This method called from Connector/J before first nextAuthenticationStep call. Values of user and password parameters are passed from those in NativeAuthenticationProvider#changeUser() or NativeAuthenticationProvider#connect(). Plugin should use these values instead of values from connection properties because parent method may be a changeUser call which saves user and password into connection only after successful handshake.

Parameters

user:String: user name
password:String: user password

Annotations

@Override

public Class Sha256PasswordPlugin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail