com.ongres.scram.common

Class ServerFinalMessage

java.lang.Object

com.ongres.scram.common.ServerFinalMessage

public final class ServerFinalMessage
extends Object

Constructs and parses server-final-messages.

Formal Syntax:

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" ; Unrecognized errors should be treated as "other-error". ; In order to prevent information disclosure, the server ; may substitute the real reason with "other-error".
verifier	"v=" base64 ;; base-64 encoded ServerSignature.
server-final-message	(server-error / verifier) ["," extensions]

See Also:

[RFC5802] Section 7

Constructor Summary

Constructors

Constructor and Description
ServerFinalMessage(byte[] verifier) Constructs a server-final-message with no errors, and the provided server verifier.
ServerFinalMessage(@NotNull String serverError) Constructs a server-final-message which represents a SCRAM error.

Method Summary

Modifier and Type	Method and Description
@Nullable String	getServerError() Get the server-error-value from the "e=" server-final-message.
byte[]	getVerifier() Get the verifier value from the "v=" server-final-message.
boolean	isError() Whether this server-final-message contains an error.
static @NotNull ServerFinalMessage	parseFrom(@NotNull String serverFinalMessage) Parses a server-final-message from a String.
@NotNull String	toString() String representation of the SCRAM message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerFinalMessage

public ServerFinalMessage(byte[] verifier)

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

Parameters:

verifier - The bytes of the computed signature

Throws:

IllegalArgumentException - If the verifier is null

ServerFinalMessage

public ServerFinalMessage(@NotNull
                          @NotNull String serverError)

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

Parameters:

serverError - The error message

Throws:

IllegalArgumentException - If the error is null

Method Detail

isError

public boolean isError()

Whether this server-final-message contains an error.

Returns:

True if it contains an error, false if it contains a verifier

getVerifier

public byte[] getVerifier()

Get the verifier value from the "v=" server-final-message.

Returns:

the verifier

getServerError

@Nullable
public @Nullable String getServerError()

Get the server-error-value from the "e=" server-final-message.

Returns:

the server-error-value

parseFrom

@NotNull
public static @NotNull ServerFinalMessage parseFrom(@NotNull
                                                             @NotNull String serverFinalMessage)
                                                      throws ScramParseException

Parses a server-final-message from a String.

Parameters:

serverFinalMessage - The message

Returns:

A constructed server-final-message instance

Throws:

ScramParseException - If the argument is not a valid server-final-message

IllegalArgumentException - If the message is null or empty

toString

@NotNull
public final @NotNull String toString()

String representation of the SCRAM message.

Overrides:

toString in class Object