SCRAM - common 2.1 · com.ongres.scram.common.message.ClientFirstMessage

Modifier and Type	Field and Description
private final Gs2Header	gs2Header
private final String	nonce
private final String	user

Constructor Summary

Access	Constructor and Description
public	ClientFirstMessage(Gs2Header The GSS-API header gs2Header, String The SCRAM user user, String The nonce for this session nonce) Constructs a client-first-message for the given user, nonce and gs2Header.
public	ClientFirstMessage(Gs2CbindFlag The channel-binding flag gs2CbindFlag, String The optional authzid authzid, String The optional channel binding name cbindName, String The SCRAM user user, String The nonce for this session nonce) Constructs a client-first-message for the given parameters.
public	ClientFirstMessage(String The SCRAM user user, String The nonce for this session nonce) Constructs a client-first-message for the given parameters, with no channel binding nor authzid.

Method Summary

Modifier and Type	Method and Description
public String	getAuthzid()
public Gs2CbindFlag	getChannelBindingFlag()
public String	getChannelBindingName()
public Gs2Header	getGs2Header()
public String	getNonce()
public String	getUser()
private static Gs2Header	gs2Header(Gs2CbindFlag gs2CbindFlag, String authzid, String cbindName)
public boolean	isChannelBinding()
public static ClientFirstMessage	Returns: The instance parseFrom(String The String representing the client-first-message clientFirstMessage) Construct a `ClientFirstMessage` instance from a message (String)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public StringBuffer	writeTo(StringBuffer Where to write the data. sb) Implements com.ongres.scram.common.util.StringWritable.writeTo. Write the class information to the given StringBuffer.
public StringBuffer	Returns: The same StringBuffer writeToWithoutGs2Header(StringBuffer A StringBuffer where to write the data to. sb) Limited version of the `StringWritableCsv#toString()` method, that doesn't write the GS2 header.

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

Field Detail

gs2Header	back to summary
private final Gs2Header gs2Header

nonce	back to summary
private final String nonce

user	back to summary
private final String user

Constructor Detail

ClientFirstMessage	back to summary
public ClientFirstMessage(Gs2Header gs2Header, String user, String nonce) throws IllegalArgumentException Constructs a client-first-message for the given user, nonce and gs2Header. This constructor is intended to be instantiated by a scram client, and not directly. The client should be providing the header, and nonce (and probably the user too). Parameters gs2Header:Gs2Header The GSS-API header user:String The SCRAM user nonce:String The nonce for this session Exceptions IllegalArgumentException: If any of the arguments is null or empty

ClientFirstMessage

back to summary

public ClientFirstMessage(Gs2Header gs2Header, String user, String nonce) throws IllegalArgumentException

Constructs a client-first-message for the given user, nonce and gs2Header. This constructor is intended to be instantiated by a scram client, and not directly. The client should be providing the header, and nonce (and probably the user too).

Parameters

gs2Header:Gs2Header: The GSS-API header
user:String: The SCRAM user
nonce:String: The nonce for this session

Exceptions

IllegalArgumentException:: If any of the arguments is null or empty

ClientFirstMessage	back to summary
public ClientFirstMessage(Gs2CbindFlag gs2CbindFlag, String authzid, String cbindName, String user, String nonce) Constructs a client-first-message for the given parameters. Under normal operation, this constructor is intended to be instantiated by a scram client, and not directly. However, this constructor is more user- or test-friendly, as the arguments are easier to provide without building other indirect object parameters. Parameters gs2CbindFlag:Gs2CbindFlag The channel-binding flag authzid:String The optional authzid cbindName:String The optional channel binding name user:String The SCRAM user nonce:String The nonce for this session Exceptions IllegalArgumentException: If the flag, user or nonce are null or empty

ClientFirstMessage

back to summary

public ClientFirstMessage(Gs2CbindFlag gs2CbindFlag, String authzid, String cbindName, String user, String nonce)

Constructs a client-first-message for the given parameters. Under normal operation, this constructor is intended to be instantiated by a scram client, and not directly. However, this constructor is more user- or test-friendly, as the arguments are easier to provide without building other indirect object parameters.

Parameters

gs2CbindFlag:Gs2CbindFlag: The channel-binding flag
authzid:String: The optional authzid
cbindName:String: The optional channel binding name
user:String: The SCRAM user
nonce:String: The nonce for this session

Exceptions

IllegalArgumentException:: If the flag, user or nonce are null or empty

ClientFirstMessage	back to summary
public ClientFirstMessage(String user, String nonce) Constructs a client-first-message for the given parameters, with no channel binding nor authzid. Under normal operation, this constructor is intended to be instantiated by a scram client, and not directly. However, this constructor is more user- or test-friendly, as the arguments are easier to provide without building other indirect object parameters. Parameters user:String The SCRAM user nonce:String The nonce for this session Exceptions IllegalArgumentException: If the user or nonce are null or empty

ClientFirstMessage

back to summary

public ClientFirstMessage(String user, String nonce)

Constructs a client-first-message for the given parameters, with no channel binding nor authzid. Under normal operation, this constructor is intended to be instantiated by a scram client, and not directly. However, this constructor is more user- or test-friendly, as the arguments are easier to provide without building other indirect object parameters.

Parameters

user:String: The SCRAM user
nonce:String: The nonce for this session

Exceptions

IllegalArgumentException:: If the user or nonce are null or empty

Method Detail

getAuthzid	back to summary
public String getAuthzid()

getChannelBindingFlag	back to summary
public Gs2CbindFlag getChannelBindingFlag()

getChannelBindingName	back to summary
public String getChannelBindingName()

getGs2Header	back to summary
public Gs2Header getGs2Header()

getNonce	back to summary
public String getNonce()

getUser	back to summary
public String getUser()

gs2Header	back to summary
private static Gs2Header gs2Header(Gs2CbindFlag gs2CbindFlag, String authzid, String cbindName)

isChannelBinding	back to summary
public boolean isChannelBinding()

parseFrom back to summary

parseFrom	back to summary
public static ClientFirstMessage parseFrom(String clientFirstMessage) throws ScramParseException, IllegalArgumentException Construct a `ClientFirstMessage` instance from a message (String) Parameters clientFirstMessage:String The String representing the client-first-message Returns:ClientFirstMessage The instance Exceptions ScramParseException: If the message is not a valid client-first-message IllegalArgumentException: If the message is null or empty

public static ClientFirstMessage parseFrom(String clientFirstMessage) throws ScramParseException, IllegalArgumentException

Construct a ClientFirstMessage instance from a message (String)

Parameters

clientFirstMessage:String: The String representing the client-first-message

Returns:ClientFirstMessage

The instance

Exceptions

ScramParseException:: If the message is not a valid client-first-message
IllegalArgumentException:: If the message is null or empty

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

writeTo	back to summary
public StringBuffer writeTo(StringBuffer sb) Implements com.ongres.scram.common.util.StringWritable.writeTo. Doc from com.ongres.scram.common.util.StringWritable.writeTo. Write the class information to the given StringBuffer. Parameters sb:StringBuffer Where to write the data. Returns:StringBuffer The same StringBuffer. Annotations @Override

writeTo

back to summary

public StringBuffer writeTo(StringBuffer sb)

Implements com.ongres.scram.common.util.StringWritable.writeTo.

Doc from com.ongres.scram.common.util.StringWritable.writeTo.

Write the class information to the given StringBuffer.

Parameters

sb:StringBuffer: Where to write the data.

Returns:StringBuffer

The same StringBuffer.

Annotations

@Override

writeToWithoutGs2Header back to summary

writeToWithoutGs2Header	back to summary
public StringBuffer writeToWithoutGs2Header(StringBuffer sb) Limited version of the `StringWritableCsv#toString()` method, that doesn't write the GS2 header. This method is useful to construct the auth message used as part of the SCRAM algorithm. Parameters sb:StringBuffer A StringBuffer where to write the data to. Returns:StringBuffer The same StringBuffer

public StringBuffer writeToWithoutGs2Header(StringBuffer sb)

Limited version of the StringWritableCsv#toString() method, that doesn't write the GS2 header. This method is useful to construct the auth message used as part of the SCRAM algorithm.

Parameters

sb:StringBuffer: A StringBuffer where to write the data to.

Returns:StringBuffer

The same StringBuffer

public Class ClientFirstMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail