A B C D E F G H I K M N P R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractCharAttributeValue<T extends CharSupplier> - Class in com.ongres.scram.common
-
Construct and write generic CharAttribute-Value pairs.
- AbstractCharAttributeValue(T, String) - Constructor for class com.ongres.scram.common.AbstractCharAttributeValue
- AbstractScramMessage - Class in com.ongres.scram.common
-
Basic implementation of the StringWritable interface, that overrides the toString() method.
- AbstractScramMessage() - Constructor for class com.ongres.scram.common.AbstractScramMessage
- advertisedMechanisms(Collection<String>) - Method in class com.ongres.scram.client.ScramClient.Builder
- 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.
- attributeChar - Variable in enum com.ongres.scram.common.ScramAttributes
- authMessage - Variable in class com.ongres.scram.client.ClientFinalProcessor
- 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 - Variable in class com.ongres.scram.client.ScramClient
- authzid - Variable in class com.ongres.scram.client.ScramClient.Builder
- authzid - Variable in class com.ongres.scram.common.Gs2Header
- authzid(String) - Method in class com.ongres.scram.client.ScramClient.Builder
- authzid(String) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage
-
Sets the authzid.
- AUTHZID - com.ongres.scram.common.Gs2Attributes
-
SCRAM attribute.
- AUTHZID - com.ongres.scram.common.ScramAttributes
-
This is an optional attribute, and is part of the GS2 [RFC5801] bridge between the GSS-API and SASL.
B
- base64Decode(String) - Static method in class com.ongres.scram.common.ScramStringFormatting
- base64Encode(byte[]) - Static method in class com.ongres.scram.common.ScramStringFormatting
- build() - Method in class com.ongres.scram.client.ScramClient.Builder
- 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. - Builder() - Constructor for class com.ongres.scram.client.ScramClient.Builder
- BY_NAME_MAPPING - Static variable in enum com.ongres.scram.common.ScramMechanism
- byChar(char) - Static method in enum com.ongres.scram.common.Gs2Attributes
- byChar(char) - Static method in enum com.ongres.scram.common.Gs2CbindFlag
- byChar(char) - Static method in enum com.ongres.scram.common.ScramAttributes
-
Find a SCRAMAttribute by its character.
- byGs2CbindFlag(Gs2CbindFlag) - Static method in enum com.ongres.scram.common.Gs2Attributes
- 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
- cbindData - Variable in class com.ongres.scram.client.ScramClient.Builder
- cbindData - Variable in class com.ongres.scram.client.ScramClient
- cbindInput - Variable in class com.ongres.scram.common.ClientFinalMessage
-
channel-binding = "c=" base64 encoding of cbind-input.
- cbindType - Variable in class com.ongres.scram.client.ScramClient.Builder
- cbindType - Variable in class com.ongres.scram.client.ScramClient
- CHANNEL_BINDING - com.ongres.scram.common.ScramAttributes
-
This REQUIRED attribute specifies the base64-encoded GS2 header and channel binding data.
- CHANNEL_BINDING_REQUIRED - com.ongres.scram.common.Gs2Attributes
-
Channel binding attribute.
- CHANNEL_BINDING_REQUIRED - com.ongres.scram.common.Gs2CbindFlag
-
Client requires channel binding.
- channelBinding - Variable in class com.ongres.scram.client.ScramClient.Builder
- channelBinding - Variable in class com.ongres.scram.client.ScramClient
- channelBinding - Variable in enum com.ongres.scram.common.ScramMechanism
- channelBinding(String, byte[]) - Method in class com.ongres.scram.client.ScramClient.Builder
- 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.
- charAttribute - Variable in class com.ongres.scram.common.AbstractCharAttributeValue
- CharSupplier - Interface in com.ongres.scram.common
-
Represents an attribute (a key name) that is represented by a single char.
- 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.
- checkChannelBinding(Gs2CbindFlag, String) - Static method in class com.ongres.scram.common.Gs2Header
- checkChannelBinding(Gs2Header, byte[]) - Static method in class com.ongres.scram.common.ClientFinalMessage
- checkNotEmpty(char[], String) - Static method in class com.ongres.scram.common.util.Preconditions
-
Checks that the char[] is not null and not empty.
- checkNotEmpty(String, String) - Static method in class com.ongres.scram.common.util.Preconditions
-
Checks that the String 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.
- CLIENT_FINAL - com.ongres.scram.client.MessageFlow.Stage
- CLIENT_FIRST - com.ongres.scram.client.MessageFlow.Stage
- CLIENT_KEY_HMAC_MESSAGE - Static variable in class com.ongres.scram.common.ScramFunctions
- CLIENT_NOT - com.ongres.scram.common.Gs2Attributes
-
Channel binding attribute.
- CLIENT_NOT - com.ongres.scram.common.Gs2CbindFlag
-
Client doesn't support channel binding.
- CLIENT_PROOF - com.ongres.scram.common.ScramAttributes
-
This attribute specifies a base64-encoded ClientProof.
- CLIENT_YES_SERVER_NOT - com.ongres.scram.common.Gs2Attributes
-
Channel binding attribute.
- CLIENT_YES_SERVER_NOT - com.ongres.scram.common.Gs2CbindFlag
-
Client does support channel binding but thinks the server does not.
- clientAndServerKey(byte[], byte[]) - Method in class com.ongres.scram.client.ScramClient.Builder
- clientAndServerKey(byte[], byte[]) - Method in interface com.ongres.scram.client.ScramClient.PasswordBuildStage
-
Sets the ClientKey/ServerKey.
- clientFinalMessage() - Method in interface com.ongres.scram.client.MessageFlow
- clientFinalMessage() - Method in class com.ongres.scram.client.ScramClient
-
Returns the text representation of a SCRAM
client-final-message
. - clientFinalMessage(byte[]) - Method in class com.ongres.scram.client.ClientFinalProcessor
-
Generates the SCRAM representation of the client-final-message, including the given channel-binding data.
- 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.
- clientFinalProcessor - Variable in class com.ongres.scram.client.ScramClient
- clientFinalProcessor(byte[]) - Method in class com.ongres.scram.client.ServerFirstProcessor
-
Generates a
ClientFinalProcessor
, that allows to generate the client-final-message and also receive and parse the server-first-message. - clientFinalProcessor(byte[], byte[]) - Method in class com.ongres.scram.client.ServerFirstProcessor
-
Generates a
ClientFinalProcessor
, that allows to generate the client-final-message and also receive and parse the server-first-message. - clientFinalProcessor(char[]) - Method in class com.ongres.scram.client.ServerFirstProcessor
-
Generates a
ClientFinalProcessor
, that allows to generate the client-final-message and also receive and parse the server-first-message. - ClientFinalProcessor - Class in com.ongres.scram.client
-
Processor that allows to generate the client-final-message, as well as process the server-final-message and verify server's signature.
- ClientFinalProcessor(ScramMechanism, byte[], byte[], byte[], ClientFirstMessage, ServerFirstMessage) - Constructor for class com.ongres.scram.client.ClientFinalProcessor
- ClientFinalProcessor(ScramMechanism, byte[], byte[], ClientFirstMessage, ServerFirstMessage) - Constructor for class com.ongres.scram.client.ClientFinalProcessor
- ClientFinalProcessor(ScramMechanism, byte[], ClientFirstMessage, ServerFirstMessage) - Constructor for class com.ongres.scram.client.ClientFinalProcessor
- ClientFinalProcessor(ScramMechanism, StringPreparation, char[], byte[], ClientFirstMessage, ServerFirstMessage) - Constructor for class com.ongres.scram.client.ClientFinalProcessor
- clientFirstMessage - Variable in class com.ongres.scram.client.ClientFinalProcessor
- clientFirstMessage - Variable in class com.ongres.scram.client.ScramClient
- clientFirstMessage - Variable in class com.ongres.scram.client.ServerFirstProcessor
- clientFirstMessage() - Method in interface com.ongres.scram.client.MessageFlow
- 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(Gs2CbindFlag, String, String, String, String) - Constructor for class com.ongres.scram.common.ClientFirstMessage
-
Constructs a client-first-message for the given parameters.
- 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(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.
- clientFirstMessageBare(StringBuilder) - Method in class com.ongres.scram.common.ClientFirstMessage
-
Limited version of the StringWritableCsv method, that doesn't write the GS2 header.
- clientKey - Variable in class com.ongres.scram.client.ClientFinalProcessor
- clientKey - Variable in class com.ongres.scram.client.ScramClient.Builder
- clientKey - Variable in class com.ongres.scram.client.ScramClient
- clientKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions
-
Generates a client key, from the salted password.
- clientNonce - Variable in class com.ongres.scram.common.ClientFirstMessage
-
nonce= "r=" c-nonce [s-nonce].
- clientNonce - Variable in class com.ongres.scram.common.ServerFirstMessage
- 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
- CryptoUtil - Class in com.ongres.scram.common
-
Utility static methods for cryptography related tasks.
- CryptoUtil() - Constructor for class com.ongres.scram.common.CryptoUtil
- currentState - Variable in class com.ongres.scram.client.ScramClient
D
- digest(byte[]) - Method in enum com.ongres.scram.common.ScramMechanism
-
Calculate a message digest, according to the algorithm of the SCRAM mechanism.
- doNormalize(char[]) - Method in enum com.ongres.scram.common.StringPreparation
E
- ERROR - com.ongres.scram.common.ScramAttributes
-
This attribute specifies an error that occurred during authentication exchange.
- ERROR_MESSAGE - Static variable in class com.ongres.scram.common.exception.ServerErrorValue
F
- flag - Variable in enum com.ongres.scram.common.Gs2Attributes
- flag - Variable in enum com.ongres.scram.common.Gs2CbindFlag
- fromSaslName(String) - Static method in class com.ongres.scram.common.ScramStringFormatting
-
Given a saslName, return a non-escaped String.
G
- generateAndCacheAuthMessage(byte[]) - Method in class com.ongres.scram.client.ClientFinalProcessor
- generateCBindInput(Gs2Header, byte[]) - Static method in class com.ongres.scram.common.ClientFinalMessage
- 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 class com.ongres.scram.common.AbstractCharAttributeValue
- getChar() - Method in interface com.ongres.scram.common.CharSupplier
-
Return the char used to represent this attribute.
- getChar() - Method in enum com.ongres.scram.common.Gs2Attributes
- getChar() - Method in enum com.ongres.scram.common.Gs2CbindFlag
- getChar() - Method in enum com.ongres.scram.common.ScramAttributes
- 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.
- getDigestAlgorithm(String) - Static method in class com.ongres.scram.common.util.TlsServerEndpoint
-
Get the digest algorithm that would be used for a given signature algorithm name.
- 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.
- getHashAlgorithmName() - Method in enum com.ongres.scram.common.ScramMechanism
-
Method that returns the name of the hash algorithm.
- getHmacAlgorithmName() - Method in enum com.ongres.scram.common.ScramMechanism
-
Method that returns the name of the HMAC algorithm.
- getIterationCount() - Method in enum com.ongres.scram.common.ScramMechanism
- getIterationCount() - Method in class com.ongres.scram.common.ServerFirstMessage
-
The number of iterations.
- getKeyLength() - Method in enum com.ongres.scram.common.ScramMechanism
-
Returns the length of the key length of the algorithm.
- 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.
- getServerFirstMessage() - Method in class com.ongres.scram.client.ServerFirstProcessor
- getServerNonce() - Method in class com.ongres.scram.common.ServerFirstMessage
-
The server nonce.
- getUsername() - Method in class com.ongres.scram.common.ClientFirstMessage
-
Return the username.
- getValue() - Method in class com.ongres.scram.common.AbstractCharAttributeValue
- getValue() - Method in class com.ongres.scram.common.ScramAttributeValue
- getVerifier() - Method in class com.ongres.scram.common.ServerFinalMessage
-
Get the verifier value from the "v=" server-final-message.
- Gs2Attributes - Enum in com.ongres.scram.common
-
Possible values of a GS2 Attribute.
- Gs2Attributes(char, boolean) - Constructor for enum com.ongres.scram.common.Gs2Attributes
- Gs2AttributeValue - Class in com.ongres.scram.common
-
Parse and write GS2 Attribute-Value pairs.
- Gs2AttributeValue(Gs2Attributes, String) - Constructor for class com.ongres.scram.common.Gs2AttributeValue
- gs2CbindFlag - Variable in class com.ongres.scram.common.Gs2Header
- Gs2CbindFlag - Enum in com.ongres.scram.common
-
Possible values of a GS2 Cbind Flag (channel binding; part of GS2 header).
- Gs2CbindFlag(char) - Constructor for enum com.ongres.scram.common.Gs2CbindFlag
- gs2Header - Variable in class com.ongres.scram.common.ClientFirstMessage
-
gs2-header = gs2-cbind-flag "," [ authzid ] ",".
- Gs2Header - Class in com.ongres.scram.common
-
GS2 header for SCRAM.
- Gs2Header(Gs2CbindFlag) - Constructor for class com.ongres.scram.common.Gs2Header
-
Construct and validates a Gs2Header with no authzid nor channel binding.
- Gs2Header(Gs2CbindFlag, String) - Constructor for class com.ongres.scram.common.Gs2Header
-
Construct and validates a Gs2Header with no authzid.
- Gs2Header(Gs2CbindFlag, String, String) - Constructor for class com.ongres.scram.common.Gs2Header
-
Construct and validates a Gs2Header.
- 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.
- hashAlgorithmName - Variable in enum com.ongres.scram.common.ScramMechanism
- hi(SecretKeyFactory, int, char[], byte[], int) - Static method in class com.ongres.scram.common.CryptoUtil
-
Compute the "Hi" function for SCRAM.
- hmac(byte[], byte[]) - Method in enum com.ongres.scram.common.ScramMechanism
-
Calculate the hmac of a key and a message, according to the algorithm of the SCRAM mechanism.
- 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.
- hmac(SecretKeySpec, Mac, byte[]) - Static method in class com.ongres.scram.common.CryptoUtil
-
Computes the HMAC of a given message.
- hmacAlgorithmName - Variable in enum com.ongres.scram.common.ScramMechanism
I
- initServerErrorValue() - Static method in class com.ongres.scram.common.exception.ServerErrorValue
- isAlgorithmSupported(ScramMechanism) - Static method in enum com.ongres.scram.common.ScramMechanism
- 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. - isRequiredValue() - Method in enum com.ongres.scram.common.Gs2Attributes
- ITERATION - com.ongres.scram.common.ScramAttributes
-
This attribute specifies an iteration count for the selected hash function and user.
- iterationCount - Variable in enum com.ongres.scram.common.ScramMechanism
- iterationCount - Variable in class com.ongres.scram.common.ServerFirstMessage
K
- keyFactoryAlgorithmName - Variable in enum com.ongres.scram.common.ScramMechanism
- keyLength - Variable in enum com.ongres.scram.common.ScramMechanism
M
- mechanismName - Variable in enum com.ongres.scram.common.ScramMechanism
- mechanismNegotiation() - Method in class com.ongres.scram.client.ScramClient.Builder
- MessageFlow - Interface in com.ongres.scram.client
- MessageFlow.Stage - Enum in com.ongres.scram.client
N
- NO_PREPARATION - com.ongres.scram.common.StringPreparation
-
Implementation of StringPreparation that performs no preparation.
- nonce - Variable in class com.ongres.scram.client.ScramClient.Builder
- nonce - Variable in class com.ongres.scram.client.ScramClient
- nonce - Variable in class com.ongres.scram.common.ClientFinalMessage
-
nonce = "r=" c-nonce [s-nonce].
- 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 (',').
- NONCE - com.ongres.scram.common.ScramAttributes
-
This attribute specifies a sequence of random printable ASCII characters excluding ',' (which forms the nonce used as input to the hash function).
- nonceLength - Variable in class com.ongres.scram.client.ScramClient.Builder
- nonceLength(int) - Method in class com.ongres.scram.client.ScramClient.Builder
- nonceLength(int) - Method in interface com.ongres.scram.client.ScramClient.FinalBuildStage
-
Sets a non-default length for the nonce generation.
- nonceSupplier - Variable in class com.ongres.scram.client.ScramClient.Builder
- nonceSupplier(Supplier<String>) - Method in class com.ongres.scram.client.ScramClient.Builder
- 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.
- NONE - com.ongres.scram.client.MessageFlow.Stage
- normalize(char[]) - Method in enum com.ongres.scram.common.StringPreparation
-
Normalize acording the selected preparation.
P
- parse(String) - Static method in class com.ongres.scram.common.Gs2AttributeValue
-
Parses a potential Gs2AttributeValue String.
- parse(String) - Static method in class com.ongres.scram.common.ScramAttributeValue
-
Parses a potential ScramAttributeValue String.
- 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) - Static method in class com.ongres.scram.common.StringWritableCsv
-
Parse a String with a StringWritableCsv into its composing Strings represented as Strings.
- parseFrom(String, int) - Static method in class com.ongres.scram.common.StringWritableCsv
-
Parse a String with a StringWritableCsv into its composing Strings represented as Strings.
- parseFrom(String, int, int) - Static method in class com.ongres.scram.common.StringWritableCsv
-
Parse a String with a StringWritableCsv into its composing Strings represented as Strings.
- parseFrom(String, String) - Static method in class com.ongres.scram.common.ServerFirstMessage
-
Parses a server-first-message from a String.
- password - Variable in class com.ongres.scram.client.ScramClient.Builder
- password - Variable in class com.ongres.scram.client.ScramClient
- password(char[]) - Method in class com.ongres.scram.client.ScramClient.Builder
- password(char[]) - Method in interface com.ongres.scram.client.ScramClient.PasswordBuildStage
-
Sets the password.
- POSTGRESQL_PREPARATION - com.ongres.scram.common.StringPreparation
-
Implementation of StringPreparation that performs
SASLprep
preparation for PostgreSQL. - Preconditions - Class in com.ongres.scram.common.util
-
Generic utility methods used to validate data.
- Preconditions() - Constructor for class com.ongres.scram.common.util.Preconditions
- proof - Variable in class com.ongres.scram.common.ClientFinalMessage
-
proof = "p=" base64.
R
- receiveServerFinalMessage(String) - Method in class com.ongres.scram.client.ClientFinalProcessor
-
Receive and process the server-final-message.
- requiredValue - Variable in enum com.ongres.scram.common.Gs2Attributes
S
- salt - Variable in class com.ongres.scram.common.ServerFirstMessage
- salt(int, SecureRandom) - Static method in class com.ongres.scram.common.CryptoUtil
-
Generates a random salt.
- 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.
- SALT - com.ongres.scram.common.ScramAttributes
-
This attribute specifies the base64-encoded salt used by the server for this user.
- saltedPassword - Variable in class com.ongres.scram.client.ScramClient.Builder
- saltedPassword - Variable in class com.ongres.scram.client.ScramClient
- saltedPassword(byte[]) - Method in class com.ongres.scram.client.ScramClient.Builder
- 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.
- saltedPassword(StringPreparation, char[], byte[], int) - Method in enum com.ongres.scram.common.ScramMechanism
-
Compute the salted password.
- SASL_PREP - Static variable in class com.ongres.scram.common.ScramStringFormatting
- SASL_PREPARATION - com.ongres.scram.common.StringPreparation
-
Implementation of StringPreparation that performs
SASLprep
preparation. - SCRAM_SHA_1 - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-1 mechanism, defined in RFC-5802.
- SCRAM_SHA_1_PLUS - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-1-PLUS mechanism, defined in RFC-5802.
- SCRAM_SHA_224 - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-224 mechanism, not defined in an RFC.
- SCRAM_SHA_224_PLUS - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-224-PLUS mechanism, not defined in an RFC.
- SCRAM_SHA_256 - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-256 mechanism, defined in RFC-7677.
- SCRAM_SHA_256_PLUS - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-256-PLUS mechanism, defined in RFC-7677.
- SCRAM_SHA_384 - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-384 mechanism, not defined in an RFC.
- SCRAM_SHA_384_PLUS - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-384-PLUS mechanism, not defined in an RFC.
- SCRAM_SHA_512 - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-512 mechanism.
- SCRAM_SHA_512_PLUS - com.ongres.scram.common.ScramMechanism
-
SCRAM-SHA-512-PLUS mechanism.
- ScramAttributes - Enum in com.ongres.scram.common
-
SCRAM Attributes as defined in Section 5.1 of the RFC.
- ScramAttributes(char) - Constructor for enum com.ongres.scram.common.ScramAttributes
- ScramAttributeValue - Class in com.ongres.scram.common
-
Parse and write SCRAM Attribute-Value pairs.
- ScramAttributeValue(ScramAttributes, String) - Constructor for class com.ongres.scram.common.ScramAttributeValue
- ScramClient - Class in com.ongres.scram.client
-
A class that represents a SCRAM client.
- ScramClient(ScramClient.Builder) - Constructor for class com.ongres.scram.client.ScramClient
-
Constructs a SCRAM client, to perform an authentication for a given user.
- ScramClient.Builder - Class in com.ongres.scram.client
-
Builds instances of type
ScramClient
. - 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.
- ScramFunctions() - Constructor for class com.ongres.scram.common.ScramFunctions
- 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 - Variable in class com.ongres.scram.client.ClientFinalProcessor
- scramMechanism - Variable in class com.ongres.scram.client.ScramClient
- scramMechanism - Variable in class com.ongres.scram.client.ServerFirstProcessor
- ScramMechanism - Enum in com.ongres.scram.common
-
SCRAM Mechanisms supported by this library.
- ScramMechanism(String, String, int, String, int) - Constructor for enum com.ongres.scram.common.ScramMechanism
- scramMechanisms - Variable in class com.ongres.scram.client.ScramClient.Builder
- 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.
- ScramStringFormatting - Class in com.ongres.scram.common
-
Class with static methods that provide support for converting to/from salNames.
- ScramStringFormatting() - Constructor for class com.ongres.scram.common.ScramStringFormatting
- secureRandom - Variable in class com.ongres.scram.client.ScramClient.Builder
- secureRandomAlgorithmProvider(String, String) - Method in class com.ongres.scram.client.ScramClient.Builder
- 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.
- selectedScramMechanism - Variable in class com.ongres.scram.client.ScramClient.Builder
- selectMechanism(Collection<String>, boolean) - Static method in class com.ongres.scram.client.ScramClient.Builder
-
This method classifies SCRAM mechanisms by two properties: whether they support channel binding; and a priority, which is higher for safer algorithms (like SHA-256 vs SHA-1).
- serialVersionUID - Static variable in exception com.ongres.scram.common.exception.ScramException
- serialVersionUID - Static variable in exception com.ongres.scram.common.exception.ScramInvalidServerSignatureException
- serialVersionUID - Static variable in exception com.ongres.scram.common.exception.ScramParseException
- serialVersionUID - Static variable in exception com.ongres.scram.common.exception.ScramRuntimeException
- serialVersionUID - Static variable in exception com.ongres.scram.common.exception.ScramServerErrorException
- SERVER_FINAL - com.ongres.scram.client.MessageFlow.Stage
- SERVER_FIRST - com.ongres.scram.client.MessageFlow.Stage
- SERVER_KEY_HMAC_MESSAGE - Static variable in class com.ongres.scram.common.ScramFunctions
- SERVER_SIGNATURE - com.ongres.scram.common.ScramAttributes
-
This attribute specifies a base64-encoded ServerSignature.
- serverError - Variable in exception com.ongres.scram.common.exception.ScramServerErrorException
-
server-error-value
. - serverError - Variable in class com.ongres.scram.common.ServerFinalMessage
- ServerErrorValue - Class in com.ongres.scram.common.exception
-
This attribute specifies an error that occurred during authentication exchange.
- ServerErrorValue() - Constructor for class com.ongres.scram.common.exception.ServerErrorValue
- serverFinalMessage(String) - Method in interface com.ongres.scram.client.MessageFlow
- 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 - Variable in class com.ongres.scram.client.ClientFinalProcessor
- serverFirstMessage - Variable in class com.ongres.scram.client.ServerFirstProcessor
- serverFirstMessage(String) - Method in interface com.ongres.scram.client.MessageFlow
- 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.
- serverFirstProcessor - Variable in class com.ongres.scram.client.ScramClient
- ServerFirstProcessor - Class in com.ongres.scram.client
-
Process a received server-first-message.
- ServerFirstProcessor(ScramMechanism, StringPreparation, String, String, ClientFirstMessage) - Constructor for class com.ongres.scram.client.ServerFirstProcessor
- serverKey - Variable in class com.ongres.scram.client.ClientFinalProcessor
- serverKey - Variable in class com.ongres.scram.client.ScramClient.Builder
- serverKey - Variable in class com.ongres.scram.client.ScramClient
- serverKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions
-
Generates a server key, from the salted password.
- serverNonce - Variable in class com.ongres.scram.common.ServerFirstMessage
- serverSignature(ScramMechanism, byte[], String) - Static method in class com.ongres.scram.common.ScramFunctions
-
Compute the SCRAM server signature.
- Stage() - Constructor for enum com.ongres.scram.client.MessageFlow.Stage
- storedKey - Variable in class com.ongres.scram.client.ClientFinalProcessor
- storedKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions
-
Generates a stored key, from the salted password.
- stringPreparation - Variable in class com.ongres.scram.client.ScramClient.Builder
- stringPreparation - Variable in class com.ongres.scram.client.ScramClient
- stringPreparation - Variable in class com.ongres.scram.client.ServerFirstProcessor
- stringPreparation(StringPreparation) - Method in class com.ongres.scram.client.ScramClient.Builder
- 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.
- StringPreparation() - Constructor for enum com.ongres.scram.common.StringPreparation
- StringWritable - Class in com.ongres.scram.common
-
Abstract class to denote classes which can write to a StringBuffer.
- StringWritable() - Constructor for class com.ongres.scram.common.StringWritable
- StringWritableCsv - Class in com.ongres.scram.common
-
Helper class to generate Comma Separated Values of StringWritables.
- StringWritableCsv() - Constructor for class com.ongres.scram.common.StringWritableCsv
- SUPPORTED_MECHANISMS - Static variable in enum com.ongres.scram.common.ScramMechanism
- 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. - TlsServerEndpoint() - Constructor for class com.ongres.scram.common.util.TlsServerEndpoint
- toPrintable(char[]) - Static method in class com.ongres.scram.common.UsAsciiUtils
-
Removes non-printable characters from the US-ASCII String.
- toPrintable(String) - Static method in class com.ongres.scram.common.UsAsciiUtils
-
Removes non-printable characters from the US-ASCII String.
- toSaslName(String) - Static method in class com.ongres.scram.common.ScramStringFormatting
-
Given a value-safe-char (normalized UTF-8 String), return one where characters ',' and '=' are represented by '=2C' or '=3D', respectively.
- toString() - Method in class com.ongres.scram.common.AbstractScramMessage
-
String representation of the SCRAM message.
U
- UsAsciiUtils - Class in com.ongres.scram.common
-
Utility to remove non-printable characters from the US-ASCII String.
- UsAsciiUtils() - Constructor for class com.ongres.scram.common.UsAsciiUtils
- username - Variable in class com.ongres.scram.client.ScramClient.Builder
- username - Variable in class com.ongres.scram.client.ScramClient
- username - Variable in class com.ongres.scram.common.ClientFirstMessage
-
username = "n=" saslname.
- username(String) - Method in class com.ongres.scram.client.ScramClient.Builder
- username(String) - Method in interface com.ongres.scram.client.ScramClient.UsernameBuildStage
-
Sets the username.
- USERNAME - com.ongres.scram.common.ScramAttributes
-
This attribute specifies the name of the user whose password is used for authentication (a.k.a.
V
- validateChannelBindingType(String) - Static method in class com.ongres.scram.common.Gs2Header
-
Checks that the channel binding name is valid.
- validateServerErrorType(String) - Static method in class com.ongres.scram.common.ServerFinalMessage
- value - Variable in class com.ongres.scram.common.AbstractCharAttributeValue
- valueOf(String) - Static method in enum com.ongres.scram.client.MessageFlow.Stage
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.ongres.scram.common.Gs2Attributes
-
Returns the enum constant of this type with the specified name.
- 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.ScramAttributes
-
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.client.MessageFlow.Stage
-
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.Gs2Attributes
-
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.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.ScramAttributes
-
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.
- verifier - Variable in class com.ongres.scram.common.ServerFinalMessage
- 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.
W
- withoutProof(StringBuilder, Gs2Header, byte[], String) - Static method in class com.ongres.scram.common.ClientFinalMessage
- writeTo(StringBuilder) - Method in class com.ongres.scram.common.StringWritable
-
Write the class information to the given StringBuffer.
- writeTo(StringBuilder, StringWritable...) - Static method in class com.ongres.scram.common.StringWritableCsv
-
Write a sequence of StringWritableCsv to a StringBuffer.
- writeTo(StringBuilder) - Method in class com.ongres.scram.common.AbstractCharAttributeValue
- writeTo(StringBuilder) - Method in class com.ongres.scram.common.ClientFinalMessage
- writeTo(StringBuilder) - Method in class com.ongres.scram.common.ClientFirstMessage
- writeTo(StringBuilder) - Method in class com.ongres.scram.common.Gs2Header
- writeTo(StringBuilder) - Method in class com.ongres.scram.common.ServerFinalMessage
- writeTo(StringBuilder) - Method in class com.ongres.scram.common.ServerFirstMessage
- writeToWithoutProof(StringBuilder) - Method in class com.ongres.scram.common.ClientFinalMessage
X
- xor(byte[], byte[]) - Static method in class com.ongres.scram.common.CryptoUtil
-
Computes a byte-by-byte xor operation.
All Classes All Packages