Index (Apache Shiro :: Cryptography

A B C D E F G H I L M N O P S T V
All Classes All Packages

A

AbstractHash - Class in org.apache.shiro.crypto.hash: Deprecated.
in Shiro 1.1 in favor of using the concrete SimpleHash implementation directly.
AbstractHash() - Constructor for class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Creates an new instance without any of its properties set (no hashing is performed).
AbstractHash(Object) - Constructor for class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Creates a hash of the specified source with no salt using a single hash iteration.
AbstractHash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Creates a hash of the specified source using the given salt using a single hash iteration.
AbstractHash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Creates a hash of the specified source using the given salt a total of hashIterations times.
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Md2Hash
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Md5Hash
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha1Hash
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha256Hash
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha384Hash
ALGORITHM_NAME - Static variable in class org.apache.shiro.crypto.hash.Sha512Hash
assertHashFormatImpl(Class) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory

B

BASE64 - org.apache.shiro.crypto.hash.format.ProvidedHashFormat: Value representing the Base64Format implementation.
Base64Format - Class in org.apache.shiro.crypto.hash.format: HashFormat that outputs only the hash's digest bytes in Base64 format.
Base64Format() - Constructor for class org.apache.shiro.crypto.hash.format.Base64Format
build() - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder: Builds a HashRequest instance reflecting the specified configuration.
Builder() - Constructor for class org.apache.shiro.crypto.hash.HashRequest.Builder: Default no-arg constructor.
byId(String) - Static method in enum org.apache.shiro.crypto.hash.format.ProvidedHashFormat

C

combine(ByteSource, ByteSource) - Method in class org.apache.shiro.crypto.hash.DefaultHashService: Combines the specified 'private' salt bytes with the specified additional extra bytes to use as the total salt during hash computation.
computeHash(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService: Computes and responds with a hash based on the specified request.
computeHash(HashRequest) - Method in interface org.apache.shiro.crypto.hash.HashService: Computes a hash based on the given request.
ConfigurableHashService - Interface in org.apache.shiro.crypto.hash: A HashService that allows configuration of its strategy via JavaBeans-compatible setter methods.
convertSaltToBytes(Object) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Acquires the specified salt argument's bytes and returns them in the form of a ByteSource instance.
convertSourceToBytes(Object) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Acquires the specified source argument's bytes and returns them in the form of a ByteSource instance.

D

DefaultHashFormatFactory - Class in org.apache.shiro.crypto.hash.format: This default HashFormatFactory implementation heuristically determines a HashFormat class to instantiate based on the input argument and returns a new instance of the discovered class.
DefaultHashFormatFactory() - Constructor for class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
DefaultHashService - Class in org.apache.shiro.crypto.hash: Default implementation of the HashService interface, supporting a customizable hash algorithm name, secure-random salt generation, multiple hash iterations and an optional internal privateSalt.
DefaultHashService() - Constructor for class org.apache.shiro.crypto.hash.DefaultHashService: Constructs a new DefaultHashService instance with the following defaults: hashAlgorithmName = SHA-512 hashIterations = 1 randomNumberGenerator = new SecureRandomNumberGenerator() generatePublicSalt = false

E

equals(Object) - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Returns true if the specified object is a Hash and its byte array is identical to this Hash's byte array, false otherwise.
equals(Object) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Returns true if the specified object is a Hash and its byte array is identical to this Hash's byte array, false otherwise.

F

format(Hash) - Method in class org.apache.shiro.crypto.hash.format.Base64Format: Returns hash != null ? hash.toBase64() : null.
format(Hash) - Method in interface org.apache.shiro.crypto.hash.format.HashFormat: Returns a formatted string representing the specified Hash instance.
format(Hash) - Method in class org.apache.shiro.crypto.hash.format.HexFormat: Returns hash != null ? hash.toHex() : null.
format(Hash) - Method in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Md2Hash
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Md5Hash
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha1Hash
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha256Hash
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha384Hash
fromBase64String(String) - Static method in class org.apache.shiro.crypto.hash.Sha512Hash
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Md2Hash
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Md5Hash
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha1Hash
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha256Hash
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha384Hash
fromHexString(String) - Static method in class org.apache.shiro.crypto.hash.Sha512Hash

G

getAlgorithmName() - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Implemented by subclasses, this specifies the MessageDigest algorithm name to use when performing the hash.
getAlgorithmName() - Method in interface org.apache.shiro.crypto.hash.Hash: Returns the name of the algorithm used to hash the input source, for example, SHA-256, MD5, etc.
getAlgorithmName() - Method in interface org.apache.shiro.crypto.hash.HashRequest: Returns the name of the hash algorithm the HashService should use when computing the Hash, or null if the default algorithm configuration of the HashService should be used.
getAlgorithmName() - Method in class org.apache.shiro.crypto.hash.SimpleHash: Returns the MessageDigest algorithm name to use when performing the hash.
getAlgorithmName() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest
getAlgorithmName(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
getBytes() - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.
getBytes() - Method in class org.apache.shiro.crypto.hash.SimpleHash
getDigest(String) - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Returns the JDK MessageDigest instance to use for executing the hash.
getDigest(String) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Returns the JDK MessageDigest instance to use for executing the hash.
getFormatClassNames() - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory: Returns a hashFormatAlias-to-fullyQualifiedHashFormatClassNameImplementation map.
getHashAlgorithmName() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
getHashFormatClass(String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory: Heuristically determine the fully qualified HashFormat implementation class name based on the specified token.
getHashFormatClass(String, String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory: Heuristically determine the fully qualified HashFormat implementation class name in the specified package based on the provided token.
getHashIterations() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
getId() - Method in interface org.apache.shiro.crypto.hash.format.ModularCryptFormat: Returns the Modular Crypt Format identifier that indicates how the formatted String should be parsed.
getId() - Method in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
getInstance(String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory
getInstance(String) - Method in interface org.apache.shiro.crypto.hash.format.HashFormatFactory
getIterations() - Method in interface org.apache.shiro.crypto.hash.Hash: Returns the number of hash iterations used to compute the hash.
getIterations() - Method in interface org.apache.shiro.crypto.hash.HashRequest: Returns the number of requested hash iterations to be performed when computing the final Hash result.
getIterations() - Method in class org.apache.shiro.crypto.hash.SimpleHash
getIterations() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest
getIterations(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
getPrivateSalt() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
getPublicSalt(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService: Returns the public salt that should be used to compute a hash based on the specified request or null if no public salt should be used.
getRandomNumberGenerator() - Method in class org.apache.shiro.crypto.hash.DefaultHashService
getSalt() - Method in interface org.apache.shiro.crypto.hash.Hash: Returns a salt used to compute the hash or null if no salt was used.
getSalt() - Method in interface org.apache.shiro.crypto.hash.HashRequest: Returns a salt to be used by the HashService during hash computation, or null if no salt is provided as part of the request.
getSalt() - Method in class org.apache.shiro.crypto.hash.SimpleHash
getSalt() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest
getSearchPackages() - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory: Returns a set of package names that can be searched for HashFormat implementations according to heuristics defined in the getHashFormat(packageName, token) JavaDoc.
getSource() - Method in interface org.apache.shiro.crypto.hash.HashRequest: Returns the source data that will be hashed by a HashService.
getSource() - Method in class org.apache.shiro.crypto.hash.SimpleHashRequest

H

hash(byte[]) - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Hashes the specified byte array without a salt for a single iteration.
hash(byte[]) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Hashes the specified byte array without a salt for a single iteration.
hash(byte[], byte[]) - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Hashes the specified byte array using the given salt for a single iteration.
hash(byte[], byte[]) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Hashes the specified byte array using the given salt for a single iteration.
hash(byte[], byte[], int) - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Hashes the specified byte array using the given salt for the specified number of iterations.
hash(byte[], byte[], int) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Hashes the specified byte array using the given salt for the specified number of iterations.
Hash - Interface in org.apache.shiro.crypto.hash: A Cryptographic Hash represents a one-way conversion algorithm that transforms an input source to an underlying byte array.
hashCode() - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Simply returns toHex().hashCode();
hashCode() - Method in class org.apache.shiro.crypto.hash.SimpleHash: Simply returns toHex().hashCode();
HashFormat - Interface in org.apache.shiro.crypto.hash.format: A HashFormat is able to format a Hash instance into a well-defined formatted String.
HashFormatFactory - Interface in org.apache.shiro.crypto.hash.format
HashRequest - Interface in org.apache.shiro.crypto.hash: A HashRequest is composed of data that will be used by a HashService to compute a hash (aka 'digest').
HashRequest.Builder - Class in org.apache.shiro.crypto.hash: A Builder class representing the Builder design pattern for constructing HashRequest instances.
HashService - Interface in org.apache.shiro.crypto.hash: A HashService hashes input sources utilizing a particular hashing strategy.
HEX - org.apache.shiro.crypto.hash.format.ProvidedHashFormat: Value representing the HexFormat implementation.
HexFormat - Class in org.apache.shiro.crypto.hash.format: HashFormat that outputs only The hash's digest bytes in hex format.
HexFormat() - Constructor for class org.apache.shiro.crypto.hash.format.HexFormat

I

ID - Static variable in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
isEmpty() - Method in class org.apache.shiro.crypto.hash.SimpleHash
isGeneratePublicSalt() - Method in class org.apache.shiro.crypto.hash.DefaultHashService: Returns true if a public salt should be randomly generated and used to compute a hash if a HashRequest does not specify a salt, false otherwise.

L

lookupHashFormatClass(String) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory

M

MCF_PREFIX - Static variable in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
Md2Hash - Class in org.apache.shiro.crypto.hash: Generates an MD2 Hash (RFC 1319) from a given input source with an optional salt and hash iterations.
Md2Hash() - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
Md2Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
Md2Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
Md2Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Md2Hash
Md5Hash - Class in org.apache.shiro.crypto.hash: Generates an MD5 Hash (RFC 1321) from a given input source with an optional salt and hash iterations.
Md5Hash() - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
Md5Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
Md5Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
Md5Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Md5Hash
ModularCryptFormat - Interface in org.apache.shiro.crypto.hash.format: A HashFormat that supports Modular Crypt Format token rules.

N

newHashFormatInstance(Class) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory

O

org.apache.shiro.crypto.hash - package org.apache.shiro.crypto.hash: Cryptographic Hashing components that greatly simplify one-way data hashing in an application.
org.apache.shiro.crypto.hash.format - package org.apache.shiro.crypto.hash.format

P

ParsableHashFormat - Interface in org.apache.shiro.crypto.hash.format: A ParsableHashFormat is able to parse a formatted string and convert it into a Hash instance.
parse(String) - Method in interface org.apache.shiro.crypto.hash.format.ParsableHashFormat: Parses the specified formatted string and returns the corresponding Hash instance.
parse(String) - Method in class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
ProvidedHashFormat - Enum in org.apache.shiro.crypto.hash.format: An enum representing Shiro's default provided HashFormat implementations.

S

setAlgorithmName(String) - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder: Sets the name of the hash algorithm the HashService should use when computing the Hash.
setBytes(byte[]) - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Sets the raw bytes stored by this hash instance.
setBytes(byte[]) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Sets the raw bytes stored by this hash instance.
setFormatClassNames(Map<String, String>) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory: Sets the hash-format-alias-to-fullyQualifiedHashFormatClassNameImplementation map to be used in the DefaultHashFormatFactory.getInstance(String) implementation.
setGeneratePublicSalt(boolean) - Method in class org.apache.shiro.crypto.hash.DefaultHashService: Sets whether or not a public salt should be randomly generated and used to compute a hash if a HashRequest does not specify a salt.
setHashAlgorithmName(String) - Method in interface org.apache.shiro.crypto.hash.ConfigurableHashService: Sets the name of the MessageDigest algorithm that will be used to compute hashes.
setHashAlgorithmName(String) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
setHashIterations(int) - Method in interface org.apache.shiro.crypto.hash.ConfigurableHashService: Sets the number of hash iterations that will be performed during hash computation.
setHashIterations(int) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
setIterations(int) - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder: Sets the number of requested hash iterations to be performed when computing the final Hash result.
setIterations(int) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Sets the iterations used to previously compute AN ALREADY GENERATED HASH.
setPrivateSalt(ByteSource) - Method in interface org.apache.shiro.crypto.hash.ConfigurableHashService: Sets the 'private' (internal) salt to be paired with a 'public' (random or supplied) salt during hash computation.
setPrivateSalt(ByteSource) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
setRandomNumberGenerator(RandomNumberGenerator) - Method in interface org.apache.shiro.crypto.hash.ConfigurableHashService: Sets a source of randomness used to generate public salts that will in turn be used during hash computation.
setRandomNumberGenerator(RandomNumberGenerator) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
setSalt(Object) - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder: Sets a salt to be used by the HashService during hash computation.
setSalt(ByteSource) - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder: Sets a salt to be used by the HashService during hash computation.
setSalt(ByteSource) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Sets the salt used to previously compute AN ALREADY GENERATED HASH.
setSearchPackages(Set<String>) - Method in class org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory: Sets a set of package names that can be searched for HashFormat implementations according to heuristics defined in the getHashFormat(packageName, token) JavaDoc.
setSource(Object) - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder: Sets the source data that will be hashed by a HashService.
setSource(ByteSource) - Method in class org.apache.shiro.crypto.hash.HashRequest.Builder: Sets the source data that will be hashed by a HashService.
Sha1Hash - Class in org.apache.shiro.crypto.hash: Generates an SHA-1 Hash (Secure Hash Standard, NIST FIPS 180-1) from a given input source with an optional salt and hash iterations.
Sha1Hash() - Constructor for class org.apache.shiro.crypto.hash.Sha1Hash
Sha1Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Sha1Hash
Sha1Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Sha1Hash
Sha1Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Sha1Hash
Sha256Hash - Class in org.apache.shiro.crypto.hash: Generates an SHA-256 Hash from a given input source with an optional salt and hash iterations.
Sha256Hash() - Constructor for class org.apache.shiro.crypto.hash.Sha256Hash
Sha256Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Sha256Hash
Sha256Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Sha256Hash
Sha256Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Sha256Hash
Sha384Hash - Class in org.apache.shiro.crypto.hash: Generates an SHA-384 Hash from a given input source with an optional salt and hash iterations.
Sha384Hash() - Constructor for class org.apache.shiro.crypto.hash.Sha384Hash
Sha384Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Sha384Hash
Sha384Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Sha384Hash
Sha384Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Sha384Hash
Sha512Hash - Class in org.apache.shiro.crypto.hash: Generates an SHA-512 Hash from a given input source with an optional salt and hash iterations.
Sha512Hash() - Constructor for class org.apache.shiro.crypto.hash.Sha512Hash
Sha512Hash(Object) - Constructor for class org.apache.shiro.crypto.hash.Sha512Hash
Sha512Hash(Object, Object) - Constructor for class org.apache.shiro.crypto.hash.Sha512Hash
Sha512Hash(Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.Sha512Hash
SHIRO1 - org.apache.shiro.crypto.hash.format.ProvidedHashFormat: Value representing the Shiro1CryptFormat implementation.
Shiro1CryptFormat - Class in org.apache.shiro.crypto.hash.format: The Shiro1CryptFormat is a fully reversible Modular Crypt Format (MCF).
Shiro1CryptFormat() - Constructor for class org.apache.shiro.crypto.hash.format.Shiro1CryptFormat
SimpleHash - Class in org.apache.shiro.crypto.hash: A Hash implementation that allows any MessageDigest algorithm name to be used.
SimpleHash(String) - Constructor for class org.apache.shiro.crypto.hash.SimpleHash: Creates an new instance with only its algorithmName set - no hashing is performed.
SimpleHash(String, Object) - Constructor for class org.apache.shiro.crypto.hash.SimpleHash: Creates an algorithmName-specific hash of the specified source with no salt using a single hash iteration.
SimpleHash(String, Object, Object) - Constructor for class org.apache.shiro.crypto.hash.SimpleHash: Creates an algorithmName-specific hash of the specified source using the given salt using a single hash iteration.
SimpleHash(String, Object, Object, int) - Constructor for class org.apache.shiro.crypto.hash.SimpleHash: Creates an algorithmName-specific hash of the specified source using the given salt a total of hashIterations times.
SimpleHashRequest - Class in org.apache.shiro.crypto.hash: Simple implementation of HashRequest that can be used when interacting with a HashService.
SimpleHashRequest(String, ByteSource, ByteSource, int) - Constructor for class org.apache.shiro.crypto.hash.SimpleHashRequest: Creates a new SimpleHashRequest instance.

T

toBase64() - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Returns a Base64-encoded string of the underlying byte array.
toBase64() - Method in class org.apache.shiro.crypto.hash.SimpleHash: Returns a Base64-encoded string of the underlying byte array.
toByteSource(Object) - Method in class org.apache.shiro.crypto.hash.SimpleHash: Converts a given object into a ByteSource instance.
toHex() - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Returns a hex-encoded string of the underlying byte array.
toHex() - Method in class org.apache.shiro.crypto.hash.SimpleHash: Returns a hex-encoded string of the underlying byte array.
TOKEN_DELIMITER - Static variable in interface org.apache.shiro.crypto.hash.format.ModularCryptFormat
toString() - Method in class org.apache.shiro.crypto.hash.AbstractHash: Deprecated.

Simple implementation that merely returns toHex().
toString() - Method in class org.apache.shiro.crypto.hash.SimpleHash: Simple implementation that merely returns toHex().

V

valueOf(String) - Static method in enum org.apache.shiro.crypto.hash.format.ProvidedHashFormat: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.shiro.crypto.hash.format.ProvidedHashFormat: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N O P S T V
All Classes All Packages