org.jasypt.salt

Class StringFixedSaltGenerator

java.lang.Object

org.jasypt.salt.StringFixedSaltGenerator

All Implemented Interfaces:

FixedSaltGenerator, SaltGenerator

public class StringFixedSaltGenerator
extends java.lang.Object
implements FixedSaltGenerator

String based implementation of FixedSaltGenerator, that will always return the same salt. This salt is returned as bytes using the specified charset for conversion (UTF-8 by default).

If the requested salt has a size in bytes smaller than the specified salt, the first n bytes are returned. If it is larger, an exception is thrown.

This class is thread-safe.

Since:

1.9.2

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	charset
private static java.lang.String	DEFAULT_CHARSET
private java.lang.String	salt
private byte[]	saltBytes

Constructor Summary

Constructors

Constructor and Description
StringFixedSaltGenerator(java.lang.String salt) Creates a new instance of FixedStringSaltGenerator using the default charset.
StringFixedSaltGenerator(java.lang.String salt, java.lang.String charset) Creates a new instance of FixedStringSaltGenerator

Method Summary

Modifier and Type	Method and Description
byte[]	generateSalt(int lengthBytes) Return salt with the specified byte length.
boolean	includePlainSaltInEncryptionResults() As this salt generator provides a fixed salt, its inclusion unencrypted in encryption results is not necessary, and in fact not desirable (so that it remains hidden).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CHARSET

private static final java.lang.String DEFAULT_CHARSET

See Also:

Constant Field Values

salt

private final java.lang.String salt

charset

private final java.lang.String charset

saltBytes

private final byte[] saltBytes

Constructor Detail

StringFixedSaltGenerator

public StringFixedSaltGenerator(java.lang.String salt)

Creates a new instance of FixedStringSaltGenerator using the default charset.

Parameters:

salt - the specified salt.

StringFixedSaltGenerator

public StringFixedSaltGenerator(java.lang.String salt,
                                java.lang.String charset)

Creates a new instance of FixedStringSaltGenerator

Parameters:

salt - the specified salt.

charset - the specified charset

Method Detail

generateSalt

public byte[] generateSalt(int lengthBytes)

Return salt with the specified byte length.

Specified by:

generateSalt in interface SaltGenerator

Parameters:

lengthBytes - length in bytes.

Returns:

the generated salt.

includePlainSaltInEncryptionResults

public boolean includePlainSaltInEncryptionResults()

As this salt generator provides a fixed salt, its inclusion unencrypted in encryption results is not necessary, and in fact not desirable (so that it remains hidden).

Specified by:

includePlainSaltInEncryptionResults in interface SaltGenerator

Returns:

false