Package org.wildfly.security.mechanism.scram

Class ScramInitialClientMessage

java.lang.Object

org.wildfly.security.mechanism.scram.ScramInitialClientMessage

public final class ScramInitialClientMessage
extends Object

Initial client message for the SCRAM authentication.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method	Description
String	getAuthenticationName()	Returns the name of the user that is authenticated.
String	getAuthorizationId()	Returns the ID of the user to be authorized.
byte[]	getBindingData()	Returns a copy of the binding data for the "PLUS" channel binding option.
String	getBindingType()	Returns the binding type for the "PLUS" channel binding option.
byte[]	getInitialPart()	Returns the initial part of the message.
ScramMechanism	getMechanism()	Returns the SCRAM mechanism used for the authentication.
byte[]	getMessageBytes()	Returns a copy of the byte array of the message.
byte[]	getNonce()	Returns a copy of a unique value generated by the client to the server.
boolean	isBinding()	Returns whether the client supports channel binding.

Methods inherited from class java.lang.Object

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

Method Details

getMechanism

public ScramMechanism getMechanism()

Returns the SCRAM mechanism used for the authentication.

Returns:

the SCRAM mechanism used for the authentication.

getAuthenticationName

public String getAuthenticationName()

Returns the name of the user that is authenticated.

Returns:

the name of the user that is authenticated.

getNonce

public byte[] getNonce()

Returns a copy of a unique value generated by the client to the server.

Returns:

a copy of a unique value generated by the client to the server.

getInitialPart

public byte[] getInitialPart()

Returns the initial part of the message.

Returns:

the initial part of the message up to the length of initialPartIndex.

getMessageBytes

public byte[] getMessageBytes()

Returns a copy of the byte array of the message.

Returns:

a copy of the byte array of the message.

getAuthorizationId

public String getAuthorizationId()

Returns the ID of the user to be authorized.

Returns:

the ID of the user to be authorized.

isBinding

public boolean isBinding()

Returns whether the client supports channel binding.

Returns:

true if the client supports channel binding, false otherwise.

getBindingType

public String getBindingType()

Returns the binding type for the "PLUS" channel binding option.

Returns:

the binding type for the "PLUS" channel binding option.

getBindingData

public byte[] getBindingData()

Returns a copy of the binding data for the "PLUS" channel binding option.

Returns:

a copy of the binding data for the "PLUS" channel binding option.