A B C D E F G H I J L M N O P R S T U V
All Classes All Packages
All Classes All Packages
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 nosalt
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 givensalt
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 givensalt
a total ofhashIterations
times. - AbstractSymmetricCipherService - Class in org.apache.shiro.crypto
-
Base abstract class for supporting symmetric key cipher algorithms.
- AbstractSymmetricCipherService(String) - Constructor for class org.apache.shiro.crypto.AbstractSymmetricCipherService
- AesCipherService - Class in org.apache.shiro.crypto
-
CipherService
using theAES
cipher algorithm for all encryption, decryption, and key operations. - AesCipherService() - Constructor for class org.apache.shiro.crypto.AesCipherService
-
Creates a new
CipherService
instance using theAES
cipher algorithm with the following important cipher default attributes: Attribute ValuekeySize
128
bitsblockSize
128
bits (required forAES
mode
GCM
*paddingScheme
NoPadding
***initializationVectorSize
128
bitsgenerateInitializationVectors
true
** - 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
- BlowfishCipherService - Class in org.apache.shiro.crypto
-
CipherService
using theBlowfish
cipher algorithm for all encryption, decryption, and key operations. - BlowfishCipherService() - Constructor for class org.apache.shiro.crypto.BlowfishCipherService
-
Creates a new
CipherService
instance using theBlowfish
cipher algorithm with the following important cipher default attributes: Attribute ValuekeySize
128
bitsblockSize
64
bits (required forBlowfish
)mode
CBC
*paddingScheme
PKCS5
initializationVectorSize
64
bitsgenerateInitializationVectors
true
** - 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
- CBC - org.apache.shiro.crypto.OperationMode
-
Cipher-block Chaining mode, defined in FIPS PUB 81.
- CCM - org.apache.shiro.crypto.OperationMode
-
Counter with CBC-MAC mode* - for block ciphers with 128 bit block-size only.
- CFB - org.apache.shiro.crypto.OperationMode
- CipherService - Interface in org.apache.shiro.crypto
-
A
CipherService
uses a cryptographic algorithm called a Cipher to convert an original input source using akey
to an uninterpretable format. - 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 aByteSource
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 aByteSource
instance. - createParameterSpec(byte[], boolean) - Method in class org.apache.shiro.crypto.AesCipherService
- createParameterSpec(byte[], boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
- CryptoException - Exception in org.apache.shiro.crypto
-
Base Shiro exception for problems encountered during cryptographic operations.
- CryptoException(String) - Constructor for exception org.apache.shiro.crypto.CryptoException
- CryptoException(String, Throwable) - Constructor for exception org.apache.shiro.crypto.CryptoException
- CryptoException(Throwable) - Constructor for exception org.apache.shiro.crypto.CryptoException
- CTR - org.apache.shiro.crypto.OperationMode
-
Counter Mode, aka Integer Counter Mode (ICM) and Segmented Integer Counter (SIC).
D
- decrypt(byte[], byte[]) - Method in interface org.apache.shiro.crypto.CipherService
-
Decrypts encrypted data via the specified cipher key and returns the original (pre-encrypted) data.
- decrypt(byte[], byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
- decrypt(InputStream, OutputStream, byte[]) - Method in interface org.apache.shiro.crypto.CipherService
-
Receives encrypted data from the given
InputStream
, decrypts it, and sends the resulting decrypted data to the givenOutputStream
. - decrypt(InputStream, OutputStream, byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
- DEFAULT_NEXT_BYTES_SIZE - Static variable in class org.apache.shiro.crypto.SecureRandomNumberGenerator
- DefaultBlockCipherService - Class in org.apache.shiro.crypto
-
Base abstract class for block cipher algorithms.
- DefaultBlockCipherService(String) - Constructor for class org.apache.shiro.crypto.DefaultBlockCipherService
-
Creates a new
DefaultBlockCipherService
using the specified block cipheralgorithmName
. - DefaultHashFormatFactory - Class in org.apache.shiro.crypto.hash.format
-
This default
HashFormatFactory
implementation heuristically determines aHashFormat
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 internalprivateSalt
. - 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
= newSecureRandomNumberGenerator
()generatePublicSalt
=false
E
- EAX - org.apache.shiro.crypto.OperationMode
-
EAX Mode*.
- ECB - org.apache.shiro.crypto.OperationMode
-
Electronic Codebook mode, defined in FIPS PUB 81.
- encrypt(byte[], byte[]) - Method in interface org.apache.shiro.crypto.CipherService
-
Encrypts data via the specified cipher key.
- encrypt(byte[], byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
- encrypt(InputStream, OutputStream, byte[]) - Method in interface org.apache.shiro.crypto.CipherService
-
Receives the data from the given
InputStream
, encrypts it, and sends the resulting encrypted data to the givenOutputStream
. - encrypt(InputStream, OutputStream, byte[]) - Method in class org.apache.shiro.crypto.JcaCipherService
- ensureSecureRandom() - Method in class org.apache.shiro.crypto.JcaCipherService
- equals(Object) - Method in class org.apache.shiro.crypto.hash.AbstractHash
-
Deprecated.Returns
true
if the specified object is a Hash and itsbyte 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 itsbyte 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
- GCM - org.apache.shiro.crypto.OperationMode
-
Galois/Counter mode* - for block ciphers with 128 bit block-size only.
- generateInitializationVector(boolean) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- generateInitializationVector(boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
- generateNewKey() - Method in class org.apache.shiro.crypto.AbstractSymmetricCipherService
-
Generates a new
Key
suitable for this CipherService'salgorithm
by callinggenerateNewKey(128)
(uses a 128 bit size by default). - generateNewKey(int) - Method in class org.apache.shiro.crypto.AbstractSymmetricCipherService
-
Generates a new
Key
of the specified size suitable for this CipherService (based on thealgorithmName
using the JDKKeyGenerator
. - 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 theHash
, ornull
if the default algorithm configuration of theHashService
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() - Method in class org.apache.shiro.crypto.JcaCipherService
-
Returns the cipher algorithm name that will be used for all encryption, decryption, and key operations (for example, 'AES', 'Blowfish', 'RSA', 'DSA', 'TripleDES', etc).
- getAlgorithmName(HashRequest) - Method in class org.apache.shiro.crypto.hash.DefaultHashService
- getBlockSize() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- getBytes() - Method in class org.apache.shiro.crypto.hash.AbstractHash
-
Deprecated.
- getBytes() - Method in class org.apache.shiro.crypto.hash.SimpleHash
- getDefaultNextBytesSize() - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
-
Returns the size of the generated byte array for calls to
nextBytes()
. - getDefaultSecureRandom() - Static method in class org.apache.shiro.crypto.JcaCipherService
- 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
- getInitializationVectorSize() - Method in class org.apache.shiro.crypto.JcaCipherService
-
Returns the algorithm-specific size in bits of generated initialization vectors.
- 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
- getKeySize() - Method in class org.apache.shiro.crypto.JcaCipherService
-
Returns the size in bits (not bytes) of generated cipher keys.
- getModeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- getPaddingSchemeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- 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, ornull
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 thegetHashFormat(packageName, token)
JavaDoc. - getSecureRandom() - Method in class org.apache.shiro.crypto.JcaCipherService
-
Returns a source of randomness for encryption operations.
- getSecureRandom() - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
-
Returns the
SecureRandom
backing this instance. - 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
- getStreamingBlockSize() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- getStreamingBufferSize() - Method in class org.apache.shiro.crypto.JcaCipherService
-
Returns the size in bytes of the internal buffer used to transfer data from one stream to another during stream operations (
JcaCipherService.encrypt(java.io.InputStream, java.io.OutputStream, byte[])
andJcaCipherService.decrypt(java.io.InputStream, java.io.OutputStream, byte[])
). - getStreamingModeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Same purpose as the
modeName
attribute, but is used instead only for for streaming operations (JcaCipherService.encrypt(java.io.InputStream, java.io.OutputStream, byte[])
andJcaCipherService.decrypt(java.io.InputStream, java.io.OutputStream, byte[])
). - getStreamingPaddingSchemeName() - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- getTransformationName() - Method in enum org.apache.shiro.crypto.PaddingScheme
-
Returns the actual string name to use when building the
Cipher
transformation string
. - getTransformationString(boolean) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Returns the transformation string to use with the
Cipher.getInstance(java.lang.String)
call. - getTransformationString(boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
-
Returns the transformation string to use with the
Cipher.getInstance(java.lang.String)
invocation when creating a newCipher
instance.
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 aHash
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 aHashService
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
- isGenerateInitializationVectors() - Method in class org.apache.shiro.crypto.JcaCipherService
- isGenerateInitializationVectors(boolean) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Overrides the parent implementation to ensure initialization vectors are always generated if streaming is enabled (block ciphers must use initialization vectors if they are to be used as a stream cipher).
- isGenerateInitializationVectors(boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
- 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 aHashRequest
does not specify a salt,false
otherwise. - ISO10126 - org.apache.shiro.crypto.PaddingScheme
-
Padding scheme as defined in the W3C's "XML Encryption Syntax and Processing" document, Section 5.2 - Block Encryption Algorithms.
J
- JcaCipherService - Class in org.apache.shiro.crypto
-
Abstract
CipherService
implementation utilizing Java's JCA APIs. - JcaCipherService(String) - Constructor for class org.apache.shiro.crypto.JcaCipherService
-
Creates a new
JcaCipherService
instance which will use the specified cipheralgorithmName
for all encryption, decryption, and key operations.
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
- nextBytes() - Method in interface org.apache.shiro.crypto.RandomNumberGenerator
-
Generates a byte array of fixed length filled with random data, often useful for generating salts, initialization vectors or other seed data.
- nextBytes() - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
- nextBytes(int) - Method in interface org.apache.shiro.crypto.RandomNumberGenerator
-
Generates a byte array of the specified length filled with random data.
- nextBytes(int) - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
- NONE - org.apache.shiro.crypto.OperationMode
-
No mode.
- NONE - org.apache.shiro.crypto.PaddingScheme
-
No padding.
O
- OAEP - org.apache.shiro.crypto.PaddingScheme
-
Optimal Asymmetric Encryption Padding defined in RSA's PKSC#1 standard (aka RFC 3447).
- OAEPWithMd5AndMgf1 - org.apache.shiro.crypto.PaddingScheme
-
Optimal Asymmetric Encryption Padding with
MD5
message digest andMGF1
mask generation function. - OAEPWithSha1AndMgf1 - org.apache.shiro.crypto.PaddingScheme
-
Optimal Asymmetric Encryption Padding with
SHA-1
message digest andMGF1
mask generation function. - OAEPWithSha256AndMgf1 - org.apache.shiro.crypto.PaddingScheme
-
Optimal Asymmetric Encryption Padding with
SHA-256
message digest andMGF1
mask generation function. - OAEPWithSha384AndMgf1 - org.apache.shiro.crypto.PaddingScheme
-
Optimal Asymmetric Encryption Padding with
SHA-384
message digest andMGF1
mask generation function. - OAEPWithSha512AndMgf1 - org.apache.shiro.crypto.PaddingScheme
-
Optimal Asymmetric Encryption Padding with
SHA-512
message digest andMGF1
mask generation function. - OCB - org.apache.shiro.crypto.OperationMode
-
Offset Codebook mode*.
- OFB - org.apache.shiro.crypto.OperationMode
-
Output Feedback mode, defined in FIPS PUB 81.
- OperationMode - Enum in org.apache.shiro.crypto
-
A cipher mode of operation directs a cipher algorithm how to convert data during the encryption or decryption process.
- org.apache.shiro.crypto - package org.apache.shiro.crypto
-
Cryptography Cipher and Hashing components that greatly simplify the JDK's cryptography concepts and add additional convenient behavior.
- 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
- PaddingScheme - Enum in org.apache.shiro.crypto
-
A
CipherPaddingScheme
represents well-known padding schemes supported by JPA providers in a type-safe manner. - ParsableHashFormat - Interface in org.apache.shiro.crypto.hash.format
-
A
ParsableHashFormat
is able to parse a formatted string and convert it into aHash
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
- PCBC - org.apache.shiro.crypto.OperationMode
- PKCS1 - org.apache.shiro.crypto.PaddingScheme
- PKCS5 - org.apache.shiro.crypto.PaddingScheme
-
Padding scheme defined in RSA's Password-Based Cryptography Standard.
- ProvidedHashFormat - Enum in org.apache.shiro.crypto.hash.format
-
An enum representing Shiro's default provided
HashFormat
implementations.
R
- RandomNumberGenerator - Interface in org.apache.shiro.crypto
-
A component that can generate random number/byte values as needed.
S
- SecureRandomNumberGenerator - Class in org.apache.shiro.crypto
-
Default implementation of the
RandomNumberGenerator
interface, backed by aSecureRandom
instance. - SecureRandomNumberGenerator() - Constructor for class org.apache.shiro.crypto.SecureRandomNumberGenerator
-
Creates a new instance with a default backing
SecureRandom
and adefaultNextBytesSize
of16
, which equals 128 bits, a size commonly used in cryptographic algorithms. - 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 theHash
. - setBlockSize(int) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Sets the block cipher's block size to be used when constructing
Cipher
transformation string. - 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.
- setDefaultNextBytesSize(int) - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
-
Sets the size of the generated byte array for calls to
nextBytes()
. - 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 theDefaultHashFormatFactory.getInstance(String)
implementation. - setGenerateInitializationVectors(boolean) - Method in class org.apache.shiro.crypto.JcaCipherService
- 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
- setInitializationVectorSize(int) - Method in class org.apache.shiro.crypto.JcaCipherService
-
Sets the algorithm-specific initialization vector size in bits (not bytes!) to be used when generating initialization vectors.
- 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.
- setKeySize(int) - Method in class org.apache.shiro.crypto.JcaCipherService
-
Sets the size in bits (not bytes) of generated cipher keys.
- setMode(OperationMode) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Sets the cipher operation mode of operation to be used when constructing the
Cipher
transformation string. - setModeName(String) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Sets the cipher operation mode name to be used when constructing the
Cipher
transformation string. - setPaddingScheme(PaddingScheme) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Sets the padding scheme to be used when constructing the
Cipher
transformation string. - setPaddingSchemeName(String) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- 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 thegetHashFormat(packageName, token)
JavaDoc. - setSecureRandom(SecureRandom) - Method in class org.apache.shiro.crypto.JcaCipherService
-
Sets a source of randomness for encryption operations.
- setSecureRandom(SecureRandom) - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
-
Sets the
SecureRandom
to back this instance. - setSeed(byte[]) - Method in class org.apache.shiro.crypto.SecureRandomNumberGenerator
-
Seeds the backing
SecureRandom
instance with additional seed data. - 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
. - setStreamingBlockSize(int) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- setStreamingBufferSize(int) - Method in class org.apache.shiro.crypto.JcaCipherService
-
Sets the size in bytes of the internal buffer used to transfer data from one stream to another during stream operations (
JcaCipherService.encrypt(java.io.InputStream, java.io.OutputStream, byte[])
andJcaCipherService.decrypt(java.io.InputStream, java.io.OutputStream, byte[])
). - setStreamingMode(OperationMode) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Sets the transformation string mode to be used for streaming operations only.
- setStreamingModeName(String) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
-
Sets the transformation string mode name to be used for streaming operations only.
- setStreamingPaddingScheme(PaddingScheme) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- setStreamingPaddingSchemeName(String) - Method in class org.apache.shiro.crypto.DefaultBlockCipherService
- 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 anyMessageDigest
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 specifiedsource
with nosalt
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 specifiedsource
using the givensalt
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 specifiedsource
using the givensalt
a total ofhashIterations
times. - SimpleHashRequest - Class in org.apache.shiro.crypto.hash
-
Simple implementation of
HashRequest
that can be used when interacting with aHashService
. - SimpleHashRequest(String, ByteSource, ByteSource, int) - Constructor for class org.apache.shiro.crypto.hash.SimpleHashRequest
-
Creates a new SimpleHashRequest instance.
- SSL3 - org.apache.shiro.crypto.PaddingScheme
-
Padding scheme defined in the SSL 3.0 specification, section
5.2.3.2 (CBC block cipher)
.
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()
.
U
- UnknownAlgorithmException - Exception in org.apache.shiro.crypto
-
Exception thrown when attempting to lookup or use a cryptographic algorithm that does not exist in the current JVM environment.
- UnknownAlgorithmException(String) - Constructor for exception org.apache.shiro.crypto.UnknownAlgorithmException
- UnknownAlgorithmException(String, Throwable) - Constructor for exception org.apache.shiro.crypto.UnknownAlgorithmException
- UnknownAlgorithmException(Throwable) - Constructor for exception org.apache.shiro.crypto.UnknownAlgorithmException
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.
- valueOf(String) - Static method in enum org.apache.shiro.crypto.OperationMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.shiro.crypto.PaddingScheme
-
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.
- values() - Static method in enum org.apache.shiro.crypto.OperationMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.shiro.crypto.PaddingScheme
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes All Packages