Index (SCRAM - Aggregator 3.0 API)

A B C G H I N P S T U V

A

advertisedMechanisms(Collection<String>) - Method in interface com.ongres.scram.client.ScramClient.MechanismsBuildStage: List of the advertised mechanisms that will be negotiated between the server and the client.
authMessage(ClientFirstMessage, ServerFirstMessage, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: The AuthMessage is computed by concatenating messages from the authentication exchange.
authzid(String) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage: Sets the authzid.

B

build() - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage: Returns the fully contructed ScramClient ready to start the message flow with the server.
builder() - Static method in class com.ongres.scram.client.ScramClient: Creates a builder for ScramClient instances.
byName(String) - Static method in enum com.ongres.scram.common.ScramMechanism: Gets a SCRAM mechanism given its standard IANA name, supported by the Java security provider.

C

castNonNull(T) - Static method in class com.ongres.scram.common.util.Preconditions
channelBinding(String, byte[]) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage: If the client supports channel binding negotiation, this method sets the type and data used for channel binding.
checkArgument(boolean, String) - Static method in class com.ongres.scram.common.util.Preconditions: Checks that the argument is valid, based in a check boolean condition.
checkArgument(boolean, String, String) - Static method in class com.ongres.scram.common.util.Preconditions: Checks that the argument is valid, based in a check boolean condition.
checkNotEmpty(String, String) - Static method in class com.ongres.scram.common.util.Preconditions: Checks that the String is not null and not empty.
checkNotEmpty(char[], String) - Static method in class com.ongres.scram.common.util.Preconditions: Checks that the char[] is not null and not empty.
checkNotNull(T, String) - Static method in class com.ongres.scram.common.util.Preconditions: Checks that the argument is not null.
clientAndServerKey(byte[], byte[]) - Method in interface com.ongres.scram.client.ScramClient.PasswordBuildStage: Sets the ClientKey/ServerKey.
clientFinalMessage() - Method in class com.ongres.scram.client.ScramClient: Returns the text representation of a SCRAM client-final-message.
ClientFinalMessage - Class in com.ongres.scram.common: Constructs and parses client-final-messages.
ClientFinalMessage(Gs2Header, byte[], String, byte[]) - Constructor for class com.ongres.scram.common.ClientFinalMessage: Constructus a client-final-message with the provided gs2Header (the same one used in the client-first-message), optionally the channel binding data, and the nonce.
clientFirstMessage() - Method in class com.ongres.scram.client.ScramClient: Returns the text representation of a SCRAM client-first-message.
ClientFirstMessage - Class in com.ongres.scram.common: Constructs and parses client-first-messages.
ClientFirstMessage(Gs2Header, String, String) - Constructor for class com.ongres.scram.common.ClientFirstMessage: Constructs a client-first-message for the given user, nonce and gs2Header.
ClientFirstMessage(Gs2CbindFlag, String, String, String, String) - Constructor for class com.ongres.scram.common.ClientFirstMessage: Constructs a client-first-message for the given parameters.
ClientFirstMessage(String, String) - Constructor for class com.ongres.scram.common.ClientFirstMessage: Constructs a client-first-message for the given parameters, with no channel binding nor authzid.
clientKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: Generates a client key, from the salted password.
clientProof(byte[], byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: Computes the SCRAM client proof to be sent to the server on the client-final-message.
clientSignature(ScramMechanism, byte[], String) - Static method in class com.ongres.scram.common.ScramFunctions: Computes the SCRAM client signature.
com.ongres.scram.client - package com.ongres.scram.client: This module expose the client implementation of Salted Challenge Response Authentication Mechanism (SCRAM).
com.ongres.scram.common - package com.ongres.scram.common: This package expose the messages used to implement a client/server of Salted Challenge Response Authentication Mechanism (SCRAM).
com.ongres.scram.common.exception - package com.ongres.scram.common.exception: This package expose the exceptions that can be throw by the client/server implementations of SCRAM.
com.ongres.scram.common.util - package com.ongres.scram.common.util

G

getAuthzid() - Method in class com.ongres.scram.common.Gs2Header: Return the authzid.
getCbindInput() - Method in class com.ongres.scram.common.ClientFinalMessage: Return the channel-binding "c=" base64 encoding of cbind-input.
getChannelBindingData(X509Certificate) - Static method in class com.ongres.scram.common.util.TlsServerEndpoint: The hash of the TLS server's certificate [RFC5280] as it appears, octet for octet, in the server's Certificate message.
getChannelBindingFlag() - Method in class com.ongres.scram.common.Gs2Header: Return the channel binding flag.
getChannelBindingName() - Method in class com.ongres.scram.common.Gs2Header: Return the channel binding type.
getChar() - Method in enum com.ongres.scram.common.Gs2CbindFlag
getClientNonce() - Method in class com.ongres.scram.common.ClientFirstMessage: Return the client nonce.
getClientNonce() - Method in class com.ongres.scram.common.ServerFirstMessage: The client nonce.
getErrorMessage(String) - Static method in class com.ongres.scram.common.exception.ServerErrorValue: This get the error message used in a ScramServerErrorException.
getGs2Header() - Method in class com.ongres.scram.common.ClientFirstMessage: Return the Gs2Header.
getIterationCount() - Method in class com.ongres.scram.common.ServerFirstMessage: The number of iterations.
getName() - Method in enum com.ongres.scram.common.ScramMechanism: The name of the mechanism.
getNonce() - Method in class com.ongres.scram.common.ClientFinalMessage: Return the nonce.
getNonce() - Method in class com.ongres.scram.common.ServerFirstMessage: The concatenation of the client nonce and the server nonce: c-nonce [s-nonce].
getProof() - Method in class com.ongres.scram.common.ClientFinalMessage: Return the proof.
getSalt() - Method in class com.ongres.scram.common.ServerFirstMessage: The salt in base64.
getScramMechanism() - Method in class com.ongres.scram.client.ScramClient: Returns the scram mechanism negotiated by this SASL client.
getServerError() - Method in exception com.ongres.scram.common.exception.ScramServerErrorException: Return the "e=" server-error-value from the server-final-message.
getServerError() - Method in class com.ongres.scram.common.ServerFinalMessage: Get the server-error-value from the "e=" server-final-message.
getServerNonce() - Method in class com.ongres.scram.common.ServerFirstMessage: The server nonce.
getUsername() - Method in class com.ongres.scram.common.ClientFirstMessage: Return the username.
getVerifier() - Method in class com.ongres.scram.common.ServerFinalMessage: Get the verifier value from the "v=" server-final-message.
Gs2CbindFlag - Enum in com.ongres.scram.common: Possible values of a GS2 Cbind Flag (channel binding; part of GS2 header).
Gs2Header - Class in com.ongres.scram.common: GS2 header for SCRAM.
Gs2Header(Gs2CbindFlag, String, String) - Constructor for class com.ongres.scram.common.Gs2Header: Construct and validates a Gs2Header.
Gs2Header(Gs2CbindFlag, String) - Constructor for class com.ongres.scram.common.Gs2Header: Construct and validates a Gs2Header with no authzid.
Gs2Header(Gs2CbindFlag) - Constructor for class com.ongres.scram.common.Gs2Header: Construct and validates a Gs2Header with no authzid nor channel binding.
gt0(int, String) - Static method in class com.ongres.scram.common.util.Preconditions: Checks that the integer argument is positive.

H

hash(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: Computes the hash function of a given value, based on the SCRAM mechanism hash function.
hmac(ScramMechanism, byte[], byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: Computes the HMAC of the message and key, using the given SCRAM mechanism.

I

isChannelBindingRequired() - Method in class com.ongres.scram.common.ClientFirstMessage: Check to probe if gs2-cbind-flag is set to "p=".
isError() - Method in class com.ongres.scram.common.ServerFinalMessage: Whether this server-final-message contains an error.
isNullOrEmpty(String) - Static method in class com.ongres.scram.common.util.Preconditions: Returns true if the given string is null or is the empty string.
isPlus() - Method in enum com.ongres.scram.common.ScramMechanism: The mechanism -PLUS require channel binding.

N

nonce(int, SecureRandom) - Static method in class com.ongres.scram.common.ScramFunctions: Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (',').
nonceLength(int) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage: Sets a non-default length for the nonce generation.
nonceSupplier(Supplier<String>) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage: The client will use a default nonce generator, unless an external one is provided by this method.
normalize(char[]) - Method in enum com.ongres.scram.common.StringPreparation: Normalize acording the selected preparation.

P

parseFrom(String) - Static method in class com.ongres.scram.common.ClientFirstMessage: Construct a ClientFirstMessage instance from a message (String).
parseFrom(String) - Static method in class com.ongres.scram.common.Gs2Header: Read a Gs2Header from a String.
parseFrom(String) - Static method in class com.ongres.scram.common.ServerFinalMessage: Parses a server-final-message from a String.
parseFrom(String, String) - Static method in class com.ongres.scram.common.ServerFirstMessage: Parses a server-first-message from a String.
password(char[]) - Method in interface com.ongres.scram.client.ScramClient.PasswordBuildStage: Sets the password.
Preconditions - Class in com.ongres.scram.common.util: Generic utility methods used to validate data.

S

salt(int, SecureRandom) - Static method in class com.ongres.scram.common.ScramFunctions: Generates a random salt that can be used to generate a salted password.
saltedPassword(byte[]) - Method in interface com.ongres.scram.client.ScramClient.PasswordBuildStage: Sets the SaltedPassword.
saltedPassword(ScramMechanism, StringPreparation, char[], byte[], int) - Static method in class com.ongres.scram.common.ScramFunctions: Compute the salted password, based on the given SCRAM mechanism, the String preparation algorithm, the provided salt and the number of iterations.
ScramClient - Class in com.ongres.scram.client: A class that represents a SCRAM client.
ScramClient.FinalBuildStage - Interface in com.ongres.scram.client: Builder stage for the optional atributes and the final build() call.
ScramClient.MechanismsBuildStage - Interface in com.ongres.scram.client: Builder stage for the advertised mechanisms.
ScramClient.PasswordBuildStage - Interface in com.ongres.scram.client: Builder stage for the password (or a ClientKey/ServerKey, or SaltedPassword).
ScramClient.UsernameBuildStage - Interface in com.ongres.scram.client: Builder stage for the required username.
ScramException - Exception in com.ongres.scram.common.exception: This class represents an generic error when using SCRAM, which is a SASL method.
ScramException(String) - Constructor for exception com.ongres.scram.common.exception.ScramException: Constructs a new instance of ScramException with a detailed message.
ScramException(String, Throwable) - Constructor for exception com.ongres.scram.common.exception.ScramException: Constructs a new instance of ScramException with a detailed message and a root cause.
ScramFunctions - Class in com.ongres.scram.common: Utility functions (mostly crypto) for SCRAM.
ScramInvalidServerSignatureException - Exception in com.ongres.scram.common.exception: This class represents an error when verifying the a base64-encoded ServerSignature in a server-final-message.
ScramInvalidServerSignatureException(String) - Constructor for exception com.ongres.scram.common.exception.ScramInvalidServerSignatureException: Constructs a new instance of ScramInvalidServerSignatureException with a detailed message.
ScramInvalidServerSignatureException(String, Throwable) - Constructor for exception com.ongres.scram.common.exception.ScramInvalidServerSignatureException: Constructs a new instance of ScramInvalidServerSignatureException with a detailed message and a root cause.
ScramMechanism - Enum in com.ongres.scram.common: SCRAM Mechanisms supported by this library.
ScramParseException - Exception in com.ongres.scram.common.exception: This class represents an error when parsing SCRAM messages.
ScramParseException(String) - Constructor for exception com.ongres.scram.common.exception.ScramParseException: Constructs a new instance of ScramParseException with a detailed message.
ScramParseException(String, Throwable) - Constructor for exception com.ongres.scram.common.exception.ScramParseException: Constructs a new instance of ScramParseException with a detailed message and a root cause.
ScramRuntimeException - Exception in com.ongres.scram.common.exception: This class represents an error when using SCRAM, which is a SASL method.
ScramRuntimeException(String) - Constructor for exception com.ongres.scram.common.exception.ScramRuntimeException: Constructs a new instance of ScramRuntimeException with a detailed message.
ScramRuntimeException(String, Throwable) - Constructor for exception com.ongres.scram.common.exception.ScramRuntimeException: Constructs a new instance of ScramRuntimeException with a detailed message and a root cause.
ScramServerErrorException - Exception in com.ongres.scram.common.exception: This class specifies an error that occurred during authentication exchange in a server-final-message.
ScramServerErrorException(String) - Constructor for exception com.ongres.scram.common.exception.ScramServerErrorException: Constructs a new instance of ScramServerErrorException with a detailed message.
ScramServerErrorException(String, Throwable) - Constructor for exception com.ongres.scram.common.exception.ScramServerErrorException: Constructs a new instance of ScramServerErrorException with a detailed message and a root cause.
secureRandomAlgorithmProvider(String, String) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage: Selects a non-default SecureRandom instance, based on the given algorithm and optionally provider.
ServerErrorValue - Class in com.ongres.scram.common.exception: This attribute specifies an error that occurred during authentication exchange.
serverFinalMessage(String) - Method in class com.ongres.scram.client.ScramClient: Process and verify the server-final-message, from its String representation.
ServerFinalMessage - Class in com.ongres.scram.common: Constructs and parses server-final-messages.
ServerFinalMessage(byte[]) - Constructor for class com.ongres.scram.common.ServerFinalMessage: Constructs a server-final-message with no errors, and the provided server verifier.
ServerFinalMessage(String) - Constructor for class com.ongres.scram.common.ServerFinalMessage: Constructs a server-final-message which represents a SCRAM error.
serverFirstMessage(String) - Method in class com.ongres.scram.client.ScramClient: Process the server-first-message, from its String representation.
ServerFirstMessage - Class in com.ongres.scram.common: Constructs and parses server-first-messages.
ServerFirstMessage(String, String, String, int) - Constructor for class com.ongres.scram.common.ServerFirstMessage: Constructs a server-first-message from a client-first-message and the additional required data.
serverKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: Generates a server key, from the salted password.
serverSignature(ScramMechanism, byte[], String) - Static method in class com.ongres.scram.common.ScramFunctions: Compute the SCRAM server signature.
storedKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: Generates a stored key, from the salted password.
stringPreparation(StringPreparation) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage: Sets the StringPreparation, is recommended to leave the default SASL_PREPARATION.
StringPreparation - Enum in com.ongres.scram.common: StringPreparations enumerations to use in SCRAM.
supportedMechanisms() - Static method in enum com.ongres.scram.common.ScramMechanism: List all the supported SCRAM mechanisms by this client implementation.

T

TLS_SERVER_END_POINT - Static variable in class com.ongres.scram.common.util.TlsServerEndpoint: The "tls-server-end-point" Channel Binding Type.
TlsServerEndpoint - Class in com.ongres.scram.common.util: Utilitiy for extracting the "tls-server-end-point" channel binding data.

U

username(String) - Method in interface com.ongres.scram.client.ScramClient.UsernameBuildStage: Sets the username.

V

valueOf(String) - Static method in enum com.ongres.scram.common.Gs2CbindFlag: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ongres.scram.common.ScramMechanism: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ongres.scram.common.StringPreparation: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ongres.scram.common.Gs2CbindFlag: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ongres.scram.common.ScramMechanism: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ongres.scram.common.StringPreparation: Returns an array containing the constants of this enum type, in the order they are declared.
verifyClientProof(ScramMechanism, byte[], byte[], String) - Static method in class com.ongres.scram.common.ScramFunctions: Verifies that a provided client proof is correct.
verifyServerSignature(ScramMechanism, byte[], String, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions: Verifies that a provided server proof is correct.

A B C G H I N P S T U V