Skip navigation links
A B C D E F G H I K M N P R S T U V W X 

A

AbstractCharAttributeValue - Class in com.ongres.scram.common.util
Construct and write generic CharAttribute-Value pairs.
AbstractCharAttributeValue(CharAttribute, String) - Constructor for class com.ongres.scram.common.util.AbstractCharAttributeValue
 
AbstractStringWritable - Class in com.ongres.scram.common.util
Basic implementation of the StringWritable interface, that overrides the toString() method.
AbstractStringWritable() - Constructor for class com.ongres.scram.common.util.AbstractStringWritable
 
algorithmKeyLength() - Method in interface com.ongres.scram.common.ScramMechanism
Returns the length of the key length of the algorithm.
algorithmKeyLength() - Method in enum com.ongres.scram.common.ScramMechanisms
 
attributeChar - Variable in enum com.ongres.scram.common.ScramAttributes
 
authMessage - Variable in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
authzid - Variable in class com.ongres.scram.common.gssapi.Gs2Header
 

B

BASE64_DECODER - Static variable in class com.ongres.scram.common.ScramStringFormatting
 
BASE64_ENCODER - Static variable in class com.ongres.scram.common.ScramStringFormatting
 
base64Decode(String) - Static method in class com.ongres.scram.common.ScramStringFormatting
 
base64Encode(byte[]) - Static method in class com.ongres.scram.common.ScramStringFormatting
 
base64Encode(String) - Static method in class com.ongres.scram.common.ScramStringFormatting
 
Builder(ScramClient.ChannelBinding, StringPreparation, Optional<ScramMechanism>, Optional<ScramMechanism>) - Constructor for class com.ongres.scram.client.ScramClient.Builder
 
BY_NAME_MAPPING - Static variable in enum com.ongres.scram.common.message.ServerFinalMessage.Error
 
BY_NAME_MAPPING - Static variable in enum com.ongres.scram.common.ScramMechanisms
 
byChar(char) - Static method in enum com.ongres.scram.common.gssapi.Gs2Attributes
 
byChar(char) - Static method in enum com.ongres.scram.common.gssapi.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.gssapi.Gs2Attributes
 
byName(String) - Static method in enum com.ongres.scram.common.ScramMechanisms
Gets a SCRAM mechanism, given its standard IANA name.

C

cbind - Variable in class com.ongres.scram.common.gssapi.Gs2Header
 
cbind - Variable in class com.ongres.scram.common.message.ClientFinalMessage
 
CHANNEL_BINDING_SUFFIX - Static variable in enum com.ongres.scram.common.ScramMechanisms
 
channelBinding - Variable in class com.ongres.scram.client.ScramClient
 
channelBinding(ScramClient.ChannelBinding) - Static method in class com.ongres.scram.client.ScramClient
Selects for the client whether to use channel binding.
ChannelBinding(Gs2CbindFlag) - Constructor for enum com.ongres.scram.client.ScramClient.ChannelBinding
 
channelBinding - Variable in class com.ongres.scram.client.ScramClient.PreBuilder1
 
channelBinding - Variable in enum com.ongres.scram.common.ScramMechanisms
 
channelBindingMechanism - Variable in class com.ongres.scram.client.ScramClient.Builder
 
channelBindingMechanism - Variable in class com.ongres.scram.client.ScramClient.PreBuilder2
 
charAttribute - Variable in class com.ongres.scram.common.util.AbstractCharAttributeValue
 
CharAttribute - Interface in com.ongres.scram.common.util
Represents an attribute (a key name) that is represented by a single char.
CharAttributeValue - Interface in com.ongres.scram.common.util
Augments a CharAttribute with a String value and the method(s) to write its data to a StringBuffer.
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.
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_KEY_HMAC_KEY - Static variable in class com.ongres.scram.common.ScramFunctions
 
clientFinalMessage(Optional<byte[]>) - Method in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
clientFinalMessage(byte[]) - Method in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
Generates the SCRAM representation of the client-final-message, including the given channel-binding data.
clientFinalMessage() - Method in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
Generates the SCRAM representation of the client-final-message.
ClientFinalMessage - Class in com.ongres.scram.common.message
Constructs and parses client-final-messages.
ClientFinalMessage(Gs2Header, Optional<byte[]>, String, byte[]) - Constructor for class com.ongres.scram.common.message.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(String, byte[], byte[], byte[]) - Constructor for class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
ClientFinalProcessor(String, byte[], byte[]) - Constructor for class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
ClientFinalProcessor(String, byte[]) - Constructor for class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
ClientFinalProcessor(String, String, String, int) - Constructor for class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
clientFinalProcessor(String) - Method in class com.ongres.scram.client.ScramSession.ServerFirstProcessor
Generates a ScramSession.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.ScramSession.ServerFirstProcessor
Generates a ScramSession.ClientFinalProcessor, that allows to generate the client-final-message and also receive and parse the server-first-message.
clientFirstMessage - Variable in class com.ongres.scram.client.ScramSession
 
clientFirstMessage(Gs2CbindFlag, String, String) - Method in class com.ongres.scram.client.ScramSession
Returns the text representation of a SCRAM client-first-message, with the GSS-API header values indicated.
clientFirstMessage() - Method in class com.ongres.scram.client.ScramSession
Returns the text representation of a SCRAM client-first-message, with no channel binding nor authzid.
ClientFirstMessage - Class in com.ongres.scram.common.message
Constructs and parses client-first-messages.
ClientFirstMessage(Gs2Header, String, String) - Constructor for class com.ongres.scram.common.message.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.message.ClientFirstMessage
Constructs a client-first-message for the given parameters.
ClientFirstMessage(String, String) - Constructor for class com.ongres.scram.common.message.ClientFirstMessage
Constructs a client-first-message for the given parameters, with no channel binding nor authzid.
clientKey - Variable in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
clientKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions
Generates a client key, from the salted password.
clientKey(ScramMechanism, StringPreparation, String, byte[], int) - Static method in class com.ongres.scram.common.ScramFunctions
Generates a client key from the password and salt.
clientNonce - Variable in class com.ongres.scram.common.message.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
 
com.ongres.scram.common - package com.ongres.scram.common
 
com.ongres.scram.common.exception - package com.ongres.scram.common.exception
 
com.ongres.scram.common.gssapi - package com.ongres.scram.common.gssapi
 
com.ongres.scram.common.message - package com.ongres.scram.common.message
 
com.ongres.scram.common.stringprep - package com.ongres.scram.common.stringprep
 
com.ongres.scram.common.util - package com.ongres.scram.common.util
 
CryptoUtil - Class in com.ongres.scram.common.util
Utility static methods for cryptography related tasks.
CryptoUtil() - Constructor for class com.ongres.scram.common.util.CryptoUtil
 
CryptoUtil.SecureRandomHolder - Class in com.ongres.scram.common.util
 

D

DEFAULT_NONCE_LENGTH - Static variable in class com.ongres.scram.client.ScramClient
Length (in characters, bytes) of the nonce generated by default (if no nonce supplier is provided)
doNormalize(String) - Method in enum com.ongres.scram.common.stringprep.StringPreparations
 

E

error - Variable in exception com.ongres.scram.common.exception.ScramServerErrorException
 
error - Variable in class com.ongres.scram.common.message.ServerFinalMessage
 
Error(String) - Constructor for enum com.ongres.scram.common.message.ServerFinalMessage.Error
 
errorMessage - Variable in enum com.ongres.scram.common.message.ServerFinalMessage.Error
 
EXCLUDED_CHAR - Static variable in class com.ongres.scram.common.util.CryptoUtil
 

F

flag - Variable in enum com.ongres.scram.common.gssapi.Gs2Attributes
 
flag - Variable in enum com.ongres.scram.common.gssapi.Gs2CbindFlag
 
fromSaslName(String) - Static method in class com.ongres.scram.common.ScramStringFormatting
Given a saslName, return a non-escaped String.

G

generateAndCacheAuthMessage(Optional<byte[]>) - Method in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
generateCBind(Gs2Header, Optional<byte[]>) - Static method in class com.ongres.scram.common.message.ClientFinalMessage
 
getAuthzid() - Method in class com.ongres.scram.common.gssapi.Gs2Header
 
getAuthzid() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
getByErrorMessage(String) - Static method in enum com.ongres.scram.common.message.ServerFinalMessage.Error
 
getChannelBindingFlag() - Method in class com.ongres.scram.common.gssapi.Gs2Header
 
getChannelBindingFlag() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
getChannelBindingName() - Method in class com.ongres.scram.common.gssapi.Gs2Header
 
getChannelBindingName() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
getChar() - Method in enum com.ongres.scram.common.gssapi.Gs2Attributes
 
getChar() - Method in enum com.ongres.scram.common.gssapi.Gs2CbindFlag
 
getChar() - Method in enum com.ongres.scram.common.ScramAttributes
 
getChar() - Method in class com.ongres.scram.common.util.AbstractCharAttributeValue
 
getChar() - Method in interface com.ongres.scram.common.util.CharAttribute
Return the char used to represent this attribute
getClientNonce() - Method in class com.ongres.scram.common.message.ServerFirstMessage
 
getError() - Method in exception com.ongres.scram.common.exception.ScramServerErrorException
 
getError() - Method in class com.ongres.scram.common.message.ServerFinalMessage
 
getErrorMessage() - Method in enum com.ongres.scram.common.message.ServerFinalMessage.Error
 
getGs2Header() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
getHashAlgorithmName() - Method in enum com.ongres.scram.common.ScramMechanisms
Method that returns the name of the hash algorithm.
getHmacAlgorithmName() - Method in enum com.ongres.scram.common.ScramMechanisms
Method that returns the name of the HMAC algorithm.
getIteration() - Method in class com.ongres.scram.client.ScramSession.ServerFirstProcessor
 
getIteration() - Method in class com.ongres.scram.common.message.ServerFirstMessage
 
getMacInstance() - Method in interface com.ongres.scram.common.ScramMechanism
Gets a constructed Mac instance, according to the algorithm of the SCRAM mechanism.
getMacInstance() - Method in enum com.ongres.scram.common.ScramMechanisms
 
getMessageDigestInstance() - Method in interface com.ongres.scram.common.ScramMechanism
Gets a constructed MessageDigest instance, according to the algorithm of the SCRAM mechanism.
getMessageDigestInstance() - Method in enum com.ongres.scram.common.ScramMechanisms
 
getName() - Method in interface com.ongres.scram.common.ScramMechanism
The name of the mechanism, which must be a value registered under IANA: SASL SCRAM Family Mechanisms
getName() - Method in enum com.ongres.scram.common.ScramMechanisms
 
getNonce() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
getNonce() - Method in class com.ongres.scram.common.message.ServerFirstMessage
 
getSalt() - Method in class com.ongres.scram.client.ScramSession.ServerFirstProcessor
 
getSalt() - Method in class com.ongres.scram.common.message.ServerFirstMessage
 
getScramMechanism() - Method in class com.ongres.scram.client.ScramClient
 
getServerNonce() - Method in class com.ongres.scram.common.message.ServerFirstMessage
 
getStringPreparation() - Method in class com.ongres.scram.client.ScramClient
 
getUser() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
getValue() - Method in class com.ongres.scram.common.util.AbstractCharAttributeValue
 
getValue() - Method in interface com.ongres.scram.common.util.CharAttributeValue
Returns the value associated with the CharAttribute
getVerifier() - Method in class com.ongres.scram.common.message.ServerFinalMessage
 
Gs2Attributes - Enum in com.ongres.scram.common.gssapi
Possible values of a GS2 Attribute.
Gs2Attributes(char) - Constructor for enum com.ongres.scram.common.gssapi.Gs2Attributes
 
Gs2AttributeValue - Class in com.ongres.scram.common.gssapi
Parse and write GS2 Attribute-Value pairs.
Gs2AttributeValue(Gs2Attributes, String) - Constructor for class com.ongres.scram.common.gssapi.Gs2AttributeValue
 
gs2CbindFlag - Variable in enum com.ongres.scram.client.ScramClient.ChannelBinding
 
gs2CbindFlag() - Method in enum com.ongres.scram.client.ScramClient.ChannelBinding
 
Gs2CbindFlag - Enum in com.ongres.scram.common.gssapi
Possible values of a GS2 Cbind Flag (channel binding; part of GS2 header).
Gs2CbindFlag(char) - Constructor for enum com.ongres.scram.common.gssapi.Gs2CbindFlag
 
Gs2Header - Class in com.ongres.scram.common.gssapi
GSS Header.
Gs2Header(Gs2CbindFlag, String, String) - Constructor for class com.ongres.scram.common.gssapi.Gs2Header
Construct and validates a Gs2Header.
Gs2Header(Gs2CbindFlag, String) - Constructor for class com.ongres.scram.common.gssapi.Gs2Header
Construct and validates a Gs2Header with no authzid.
Gs2Header(Gs2CbindFlag) - Constructor for class com.ongres.scram.common.gssapi.Gs2Header
Construct and validates a Gs2Header with no authzid nor channel binding.
gs2Header - Variable in class com.ongres.scram.common.message.ClientFirstMessage
 
gs2Header(Gs2CbindFlag, String, String) - Static method in class com.ongres.scram.common.message.ClientFirstMessage
 
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.ScramMechanisms
 
hi(SecretKeyFactory, int, String, byte[], int) - Static method in class com.ongres.scram.common.util.CryptoUtil
Compute the "Hi" function for SCRAM.
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.util.CryptoUtil
Computes the HMAC of a given message.
hmacAlgorithmName - Variable in enum com.ongres.scram.common.ScramMechanisms
 

I

INSTANCE - Static variable in class com.ongres.scram.common.util.CryptoUtil.SecureRandomHolder
 
isChannelBinding() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
isError() - Method in class com.ongres.scram.common.message.ServerFinalMessage
Whether this server-final-message contains an error
iteration - Variable in class com.ongres.scram.common.message.ServerFirstMessage
 
ITERATION_MIN_VALUE - Static variable in class com.ongres.scram.common.message.ServerFirstMessage
Minimum allowed value for the iteration, as per the RFC.

K

keyLength - Variable in enum com.ongres.scram.common.ScramMechanisms
 

M

MAX_ASCII_PRINTABLE_RANGE - Static variable in class com.ongres.scram.common.util.CryptoUtil
 
mechanismName - Variable in enum com.ongres.scram.common.ScramMechanisms
 
MIN_ASCII_PRINTABLE_RANGE - Static variable in class com.ongres.scram.common.util.CryptoUtil
 

N

nonce - Variable in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
nonce - Variable in class com.ongres.scram.client.ScramSession
 
nonce - Variable in class com.ongres.scram.common.message.ClientFinalMessage
 
nonce - Variable in class com.ongres.scram.common.message.ClientFirstMessage
 
nonce(int, SecureRandom) - Static method in class com.ongres.scram.common.util.CryptoUtil
Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (',').
nonce(int) - Static method in class com.ongres.scram.common.util.CryptoUtil
Generates a random string (called a 'nonce'), composed of ASCII printable characters, except comma (',').
nonceLength - Variable in class com.ongres.scram.client.ScramClient.Builder
 
nonceLength(int) - Method in class com.ongres.scram.client.ScramClient.Builder
Sets a non-default (ScramClient.DEFAULT_NONCE_LENGTH) length for the nonce generation, if no alternate nonceSupplier is provided via ScramClient.Builder.nonceSupplier(Supplier).
nonceSupplier - Variable in class com.ongres.scram.client.ScramClient.Builder
 
nonceSupplier(Supplier<String>) - Method in class com.ongres.scram.client.ScramClient.Builder
Optional call.
nonceSupplier - Variable in class com.ongres.scram.client.ScramClient
 
nonChannelBindingMechanism - Variable in class com.ongres.scram.client.ScramClient.Builder
 
nonChannelBindingMechanism - Variable in class com.ongres.scram.client.ScramClient.PreBuilder2
 
normalize(String) - Method in interface com.ongres.scram.common.stringprep.StringPreparation
Normalize a UTF-8 String according to this String Preparation rules.
normalize(String) - Method in enum com.ongres.scram.common.stringprep.StringPreparations
 

P

parse(String) - Static method in class com.ongres.scram.common.gssapi.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.gssapi.Gs2Header
Read a Gs2Header from a String.
parseFrom(String) - Static method in class com.ongres.scram.common.message.ClientFirstMessage
Construct a ClientFirstMessage instance from a message (String)
parseFrom(String) - Static method in class com.ongres.scram.common.message.ServerFinalMessage
Parses a server-final-message from a String.
parseFrom(String, String) - Static method in class com.ongres.scram.common.message.ServerFirstMessage
Parses a server-first-message from a String.
parseFrom(String, int, int) - Static method in class com.ongres.scram.common.util.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.util.StringWritableCsv
Parse a String with a StringWritableCsv into its composing Strings represented as Strings.
parseFrom(String) - Static method in class com.ongres.scram.common.util.StringWritableCsv
Parse a String with a StringWritableCsv into its composing Strings represented as Strings.
PBKDF2_PREFIX_ALGORITHM_NAME - Static variable in enum com.ongres.scram.common.ScramMechanisms
 
PreBuilder1(ScramClient.ChannelBinding) - Constructor for class com.ongres.scram.client.ScramClient.PreBuilder1
 
PreBuilder2(ScramClient.ChannelBinding, StringPreparation) - Constructor for class com.ongres.scram.client.ScramClient.PreBuilder2
 
Preconditions - Class in com.ongres.scram.common.util
Simple methods similar to Precondition class.
Preconditions() - Constructor for class com.ongres.scram.common.util.Preconditions
 
priority - Variable in enum com.ongres.scram.common.ScramMechanisms
 
proof - Variable in class com.ongres.scram.common.message.ClientFinalMessage
 

R

receiveServerFinalMessage(String) - Method in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
Receive and process the server-final-message.
receiveServerFirstMessage(String) - Method in class com.ongres.scram.client.ScramSession
Constructs a handler for the server-first-message, from its String representation.
REVERSE_MAPPING - Static variable in enum com.ongres.scram.common.ScramAttributes
 

S

salt - Variable in class com.ongres.scram.common.message.ServerFirstMessage
 
saltedPassword(ScramMechanism, StringPreparation, String, 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.
SCRAM_MECHANISM_NAME_PREFIX - Static variable in enum com.ongres.scram.common.ScramMechanisms
 
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 can be parametrized to generate ScramSessions.
ScramClient(ScramClient.ChannelBinding, StringPreparation, Optional<ScramMechanism>, Optional<ScramMechanism>, SecureRandom, Supplier<String>) - Constructor for class com.ongres.scram.client.ScramClient
 
ScramClient.Builder - Class in com.ongres.scram.client
This class is not meant to be used directly.
ScramClient.ChannelBinding - Enum in com.ongres.scram.client
Select whether this client will support channel binding or not
ScramClient.PreBuilder1 - Class in com.ongres.scram.client
This class is not meant to be used directly.
ScramClient.PreBuilder2 - Class in com.ongres.scram.client
This class is not meant to be used directly.
ScramException - Exception in com.ongres.scram.common.exception
This class represents an 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 (e.g.
ScramFunctions() - Constructor for class com.ongres.scram.common.ScramFunctions
 
ScramInvalidServerSignatureException - Exception in com.ongres.scram.common.exception
This class represents an error when parsing SCRAM messages
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.ScramClient
 
scramMechanism - Variable in class com.ongres.scram.client.ScramSession
 
ScramMechanism - Interface in com.ongres.scram.common
Definition of the functionality to be provided by every ScramMechanism.
ScramMechanisms - Enum in com.ongres.scram.common
SCRAM Mechanisms supported by this library.
ScramMechanisms(String, String, int, String, boolean, int) - Constructor for enum com.ongres.scram.common.ScramMechanisms
 
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.
ScramServerErrorException - Exception in com.ongres.scram.common.exception
This class represents an error when parsing SCRAM messages
ScramServerErrorException(ServerFinalMessage.Error) - Constructor for exception com.ongres.scram.common.exception.ScramServerErrorException
Constructs a new instance of ScramServerErrorException with a detailed message.
ScramServerErrorException(ServerFinalMessage.Error, Throwable) - Constructor for exception com.ongres.scram.common.exception.ScramServerErrorException
Constructs a new instance of ScramServerErrorException with a detailed message and a root cause.
scramSession(String) - Method in class com.ongres.scram.client.ScramClient
Instantiates a ScramSession for the specified user and this parametrized generator.
ScramSession - Class in com.ongres.scram.client
A class that represents a SCRAM client.
ScramSession(ScramMechanism, StringPreparation, String, String) - Constructor for class com.ongres.scram.client.ScramSession
Constructs a SCRAM client, to perform an authentication for a given user.
ScramSession.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.
ScramSession.ServerFirstProcessor - Class in com.ongres.scram.client
Process a received server-first-message.
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
 
secretKeyFactory() - Method in interface com.ongres.scram.common.ScramMechanism
Gets a SecretKeyFactory for the given algorithm.
secretKeyFactory() - Method in enum com.ongres.scram.common.ScramMechanisms
 
secretKeySpec(byte[]) - Method in interface com.ongres.scram.common.ScramMechanism
Generates a key of the algorith used, based on the key given.
secretKeySpec(byte[]) - Method in enum com.ongres.scram.common.ScramMechanisms
 
secureRandom - Variable in class com.ongres.scram.client.ScramClient.Builder
 
secureRandom - Variable in class com.ongres.scram.client.ScramClient
 
secureRandomAlgorithmProvider(String, String) - Method in class com.ongres.scram.client.ScramClient.Builder
Optional call.
SecureRandomHolder() - Constructor for class com.ongres.scram.common.util.CryptoUtil.SecureRandomHolder
 
selectClientMechanism(ScramMechanism) - Method in class com.ongres.scram.client.ScramClient.PreBuilder2
Select a fixed client mechanism.
selectMatchingMechanism(boolean, String...) - Static method in enum com.ongres.scram.common.ScramMechanisms
This class 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).
selectMechanismBasedOnServerAdvertised(String...) - Method in class com.ongres.scram.client.ScramClient.PreBuilder2
Inform the client of the SCRAM mechanisms supported by the server.
selectMechanismBasedOnServerAdvertisedCsv(String) - Method in class com.ongres.scram.client.ScramClient.PreBuilder2
Inform the client of the SCRAM mechanisms supported by the server.
SERVER_KEY_HMAC_KEY - Static variable in class com.ongres.scram.common.ScramFunctions
 
ServerFinalMessage - Class in com.ongres.scram.common.message
Constructs and parses server-final-messages.
ServerFinalMessage(byte[]) - Constructor for class com.ongres.scram.common.message.ServerFinalMessage
Constructs a server-final-message with no errors, and the provided server verifier
ServerFinalMessage(ServerFinalMessage.Error) - Constructor for class com.ongres.scram.common.message.ServerFinalMessage
Constructs a server-final-message which represents a SCRAM error.
ServerFinalMessage.Error - Enum in com.ongres.scram.common.message
Possible error messages sent on a server-final-message.
serverFirstMessage - Variable in class com.ongres.scram.client.ScramSession.ServerFirstProcessor
 
ServerFirstMessage - Class in com.ongres.scram.common.message
Constructs and parses server-first-messages.
ServerFirstMessage(String, String, String, int) - Constructor for class com.ongres.scram.common.message.ServerFirstMessage
Constructs a server-first-message from a client-first-message and the additional required data.
serverFirstMessageString - Variable in class com.ongres.scram.client.ScramSession
 
ServerFirstProcessor(String) - Constructor for class com.ongres.scram.client.ScramSession.ServerFirstProcessor
 
serverKey - Variable in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
serverKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions
Generates a server key, from the salted password.
serverKey(ScramMechanism, StringPreparation, String, byte[], int) - Static method in class com.ongres.scram.common.ScramFunctions
Generates a server key from the password and salt.
serverNonce - Variable in class com.ongres.scram.common.message.ServerFirstMessage
 
serverSignature(ScramMechanism, byte[], String) - Static method in class com.ongres.scram.common.ScramFunctions
Compute the SCRAM server signature.
setAndReturnClientFirstMessage(ClientFirstMessage) - Method in class com.ongres.scram.client.ScramSession
 
setup() - Method in class com.ongres.scram.client.ScramClient.Builder
Gets the client, fully constructed and configured, with the provided channel binding, string preparation properties, and the selected SCRAM mechanism based on server supported mechanisms.
storedKey - Variable in class com.ongres.scram.client.ScramSession.ClientFinalProcessor
 
storedKey(ScramMechanism, byte[]) - Static method in class com.ongres.scram.common.ScramFunctions
Generates a stored key, from the salted password.
stringPreparation(StringPreparation) - Method in class com.ongres.scram.client.ScramClient.PreBuilder1
Selects the string preparation algorithm to use by the client.
stringPreparation - Variable in class com.ongres.scram.client.ScramClient.PreBuilder2
 
stringPreparation - Variable in class com.ongres.scram.client.ScramClient
 
stringPreparation - Variable in class com.ongres.scram.client.ScramSession
 
StringPreparation - Interface in com.ongres.scram.common.stringprep
Interface for all possible String Preparations mechanisms.
StringPreparations - Enum in com.ongres.scram.common.stringprep
 
StringPreparations() - Constructor for enum com.ongres.scram.common.stringprep.StringPreparations
 
StringWritable - Interface in com.ongres.scram.common.util
Interface to denote classes which can write to a StringBuffer.
StringWritableCsv - Class in com.ongres.scram.common.util
Helper class to generate Comma Separated Values of StringWritables
StringWritableCsv() - Constructor for class com.ongres.scram.common.util.StringWritableCsv
 
supportedMechanisms() - Static method in class com.ongres.scram.client.ScramClient
List all the supported SCRAM mechanisms by this client implementation
supportsChannelBinding() - Method in interface com.ongres.scram.common.ScramMechanism
Whether this mechanism supports channel binding
supportsChannelBinding() - Method in enum com.ongres.scram.common.ScramMechanisms
 

T

toPrintable(String) - Static method in class com.ongres.scram.common.util.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(ServerFinalMessage.Error) - Static method in exception com.ongres.scram.common.exception.ScramServerErrorException
 
toString() - Method in class com.ongres.scram.common.message.ClientFinalMessage
 
toString() - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
toString() - Method in class com.ongres.scram.common.message.ServerFinalMessage
 
toString() - Method in class com.ongres.scram.common.message.ServerFirstMessage
 
toString() - Method in class com.ongres.scram.common.util.AbstractStringWritable
 

U

UsAsciiUtils - Class in com.ongres.scram.common.util
 
UsAsciiUtils() - Constructor for class com.ongres.scram.common.util.UsAsciiUtils
 
user - Variable in class com.ongres.scram.client.ScramSession
 
user - Variable in class com.ongres.scram.common.message.ClientFirstMessage
 

V

value - Variable in class com.ongres.scram.common.util.AbstractCharAttributeValue
 
valueOf(String) - Static method in enum com.ongres.scram.client.ScramClient.ChannelBinding
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ongres.scram.common.gssapi.Gs2Attributes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ongres.scram.common.gssapi.Gs2CbindFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ongres.scram.common.message.ServerFinalMessage.Error
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.ScramMechanisms
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ongres.scram.common.stringprep.StringPreparations
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ongres.scram.client.ScramClient.ChannelBinding
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.gssapi.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.gssapi.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.message.ServerFinalMessage.Error
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.ScramMechanisms
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.stringprep.StringPreparations
Returns an array containing the constants of this enum type, in the order they are declared.
verifier - Variable in class com.ongres.scram.common.message.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

writeStringWritableToStringBuffer(StringWritable, StringBuffer) - Static method in class com.ongres.scram.common.util.StringWritableCsv
 
writeTo(StringBuffer, Gs2Attributes, String) - Static method in class com.ongres.scram.common.gssapi.Gs2AttributeValue
 
writeTo(StringBuffer) - Method in class com.ongres.scram.common.gssapi.Gs2Header
 
writeTo(StringBuffer) - Method in class com.ongres.scram.common.message.ClientFinalMessage
 
writeTo(StringBuffer) - Method in class com.ongres.scram.common.message.ClientFirstMessage
 
writeTo(StringBuffer) - Method in class com.ongres.scram.common.message.ServerFinalMessage
 
writeTo(StringBuffer) - Method in class com.ongres.scram.common.message.ServerFirstMessage
 
writeTo(StringBuffer, ScramAttributes, String) - Static method in class com.ongres.scram.common.ScramAttributeValue
 
writeTo(StringBuffer) - Method in class com.ongres.scram.common.util.AbstractCharAttributeValue
 
writeTo(StringBuffer) - Method in interface com.ongres.scram.common.util.StringWritable
Write the class information to the given StringBuffer.
writeTo(StringBuffer, StringWritable...) - Static method in class com.ongres.scram.common.util.StringWritableCsv
Write a sequence of StringWritableCsvs to a StringBuffer.
writeToWithoutGs2Header(StringBuffer) - Method in class com.ongres.scram.common.message.ClientFirstMessage
Limited version of the Object.toString() method, that doesn't write the GS2 header.
writeToWithoutProof(StringBuffer, String, String) - Static method in class com.ongres.scram.common.message.ClientFinalMessage
 
writeToWithoutProof(StringBuffer, Gs2Header, Optional<byte[]>, String) - Static method in class com.ongres.scram.common.message.ClientFinalMessage
 
writeToWithoutProof(Gs2Header, Optional<byte[]>, String) - Static method in class com.ongres.scram.common.message.ClientFinalMessage
Returns a StringBuffer filled in with the formatted output of a client-first-message without the proof value.

X

xor(byte[], byte[]) - Static method in class com.ongres.scram.common.util.CryptoUtil
Computes a byte-by-byte xor operation.
A B C D E F G H I K M N P R S T U V W X 
Skip navigation links