Constructs and parses server-final-messages. Formal syntax is:

server-error = "e=" server-error-value

   server-error-value = "invalid-encoding" /
                  "extensions-not-supported" /  ; unrecognized 'm' value
                  "invalid-proof" /
                  "channel-bindings-dont-match" /
                  "server-does-support-channel-binding" /
                    ; server does not support channel binding
                  "channel-binding-not-supported" /
                  "unsupported-channel-binding-type" /
                  "unknown-user" /
                  "invalid-username-encoding" /
                    ; invalid username encoding (invalid UTF-8 or
                    ; SASLprep failed)
                  "no-resources" /
                  "other-error" /
                  server-error-value-ext
           ; Unrecognized errors should be treated as "other-error".
           ; In order to prevent information disclosure, the server
           ; may substitute the real reason with "other-error".

   server-error-value-ext = value
           ; Additional error reasons added by extensions
           ; to this document.

   verifier        = "v=" base64
                     ;; base-64 encoded ServerSignature.

   server-final-errorMessage = (server-error / verifier)
                     ["," extensions]

Note that extensions are not supported (and, consequently, error message extensions).

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ServerFinalMessage.Error Possible error messages sent on a server-final-message.

Modifier and Type	Field and Description
private final ServerFinalMessage.Error	error
private final byte[]	verifier

Constructor Summary

Access	Constructor and Description
public	ServerFinalMessage(byte[] The bytes of the computed signature verifier) Constructs a server-final-message with no errors, and the provided server verifier
public	ServerFinalMessage(ServerFinalMessage.Error The error error) Constructs a server-final-message which represents a SCRAM error.

Method Summary

Modifier and Type	Method and Description
public ServerFinalMessage.Error	getError()
public byte[]	getVerifier()
public boolean	Returns: True if it contains an error, false if it contains a verifier isError() Whether this server-final-message contains an error
public static ServerFinalMessage	Returns: A constructed server-final-message instance parseFrom(String The message serverFinalMessage) Parses a server-final-message from a 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.

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

error	back to summary
private final ServerFinalMessage.Error error

verifier	back to summary
private final byte[] verifier

Constructor Detail

ServerFinalMessage	back to summary
public ServerFinalMessage(byte[] verifier) throws IllegalArgumentException Constructs a server-final-message with no errors, and the provided server verifier Parameters verifier:byte[] The bytes of the computed signature Exceptions IllegalArgumentException: If the verifier is null

ServerFinalMessage

back to summary

public ServerFinalMessage(byte[] verifier) throws IllegalArgumentException

Constructs a server-final-message with no errors, and the provided server verifier

Parameters

verifier:byte[]: The bytes of the computed signature

Exceptions

IllegalArgumentException:: If the verifier is null

ServerFinalMessage	back to summary
public ServerFinalMessage(ServerFinalMessage.Error error) throws IllegalArgumentException Constructs a server-final-message which represents a SCRAM error. Parameters error:ServerFinalMessage.Error The error Exceptions IllegalArgumentException: If the error is null

ServerFinalMessage

back to summary

public ServerFinalMessage(ServerFinalMessage.Error error) throws IllegalArgumentException

Constructs a server-final-message which represents a SCRAM error.

Parameters

error:ServerFinalMessage.Error: The error

Exceptions

IllegalArgumentException:: If the error is null

Method Detail

getError	back to summary
public ServerFinalMessage.Error getError()

getVerifier	back to summary
public byte[] getVerifier() Annotations @SuppressFBWarnings:EI_EXPOSE_REP

isError	back to summary
public boolean isError() Whether this server-final-message contains an error Returns:boolean True if it contains an error, false if it contains a verifier

isError

back to summary

public boolean isError()

Whether this server-final-message contains an error

Returns:boolean: True if it contains an error, false if it contains a verifier

parseFrom	back to summary
public static ServerFinalMessage parseFrom(String serverFinalMessage) throws ScramParseException, IllegalArgumentException Parses a server-final-message from a String. Parameters serverFinalMessage:String The message Returns:ServerFinalMessage A constructed server-final-message instance Exceptions ScramParseException: If the argument is not a valid server-final-message IllegalArgumentException: If the message is null or empty

parseFrom

back to summary

public static ServerFinalMessage parseFrom(String serverFinalMessage) throws ScramParseException, IllegalArgumentException

Parses a server-final-message from a String.

Parameters

serverFinalMessage:String: The message

Returns:ServerFinalMessage

A constructed server-final-message instance

Exceptions

ScramParseException:: If the argument is not a valid server-final-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

com.ongres.scram.common.message back to summary

public final Enum ServerFinalMessage.Error

Class Inheritance

extends Enum<ServerFinalMessage.Error>

java.lang.Object
java.lang.Enum
com.ongres.scram.common.message.ServerFinalMessage.Error

Possible error messages sent on a server-final-message.

Field Summary

Modifier and Type	Field and Description
private static final Map<String, ServerFinalMessage.Error>	BY_NAME_MAPPING
public static final ServerFinalMessage.Error	CHANNEL_BINDING_NOT_SUPPORTED
public static final ServerFinalMessage.Error	CHANNEL_BINDINGS_DONT_MATCH
private final String	errorMessage
public static final ServerFinalMessage.Error	EXTENSIONS_NOT_SUPPORTED
public static final ServerFinalMessage.Error	INVALID_ENCODING
public static final ServerFinalMessage.Error	INVALID_PROOF
public static final ServerFinalMessage.Error	INVALID_USERNAME_ENCODING
public static final ServerFinalMessage.Error	NO_RESOURCES
public static final ServerFinalMessage.Error	OTHER_ERROR
public static final ServerFinalMessage.Error	SERVER_DOES_SUPPORT_CHANNEL_BINDING
public static final ServerFinalMessage.Error	UNKNOWN_USER
public static final ServerFinalMessage.Error	UNSUPPORTED_CHANNEL_BINDING_TYPE

Constructor Summary

Access	Constructor and Description
private	Error(String errorMessage)

Method Summary

Modifier and Type	Method and Description
public static ServerFinalMessage.Error	getByErrorMessage(String errorMessage)
public String	getErrorMessage()
public static ServerFinalMessage.Error	valueOf(String name)
public static ServerFinalMessage.Error[]	values()
private static Map<String, ServerFinalMessage.Error>	valuesAsMap()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BY_NAME_MAPPING	back to summary
private static final Map<String, ServerFinalMessage.Error> BY_NAME_MAPPING

CHANNEL_BINDING_NOT_SUPPORTED	back to summary
public static final ServerFinalMessage.Error CHANNEL_BINDING_NOT_SUPPORTED

CHANNEL_BINDINGS_DONT_MATCH	back to summary
public static final ServerFinalMessage.Error CHANNEL_BINDINGS_DONT_MATCH

errorMessage	back to summary
private final String errorMessage

EXTENSIONS_NOT_SUPPORTED	back to summary
public static final ServerFinalMessage.Error EXTENSIONS_NOT_SUPPORTED

INVALID_ENCODING	back to summary
public static final ServerFinalMessage.Error INVALID_ENCODING

INVALID_PROOF	back to summary
public static final ServerFinalMessage.Error INVALID_PROOF

INVALID_USERNAME_ENCODING	back to summary
public static final ServerFinalMessage.Error INVALID_USERNAME_ENCODING

NO_RESOURCES	back to summary
public static final ServerFinalMessage.Error NO_RESOURCES

OTHER_ERROR	back to summary
public static final ServerFinalMessage.Error OTHER_ERROR

SERVER_DOES_SUPPORT_CHANNEL_BINDING	back to summary
public static final ServerFinalMessage.Error SERVER_DOES_SUPPORT_CHANNEL_BINDING

UNKNOWN_USER	back to summary
public static final ServerFinalMessage.Error UNKNOWN_USER

UNSUPPORTED_CHANNEL_BINDING_TYPE	back to summary
public static final ServerFinalMessage.Error UNSUPPORTED_CHANNEL_BINDING_TYPE

Constructor Detail

Error	back to summary
private Error(String errorMessage)

Method Detail

getByErrorMessage	back to summary
public static ServerFinalMessage.Error getByErrorMessage(String errorMessage) throws IllegalArgumentException

getErrorMessage	back to summary
public String getErrorMessage()

valueOf	back to summary
public static ServerFinalMessage.Error valueOf(String name)

values	back to summary
public static ServerFinalMessage.Error[] values()

valuesAsMap	back to summary
private static Map<String, ServerFinalMessage.Error> valuesAsMap()

public Class ServerFinalMessage

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ServerFinalMessage.Error

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail