org.wildfly.security.password.interfaces

Interface MaskedPassword

All Superinterfaces:

Cloneable, Destroyable, Key, Password, Serializable, TwoWayPassword

public interface MaskedPassword
extends TwoWayPassword

A password which has been masked, PicketBox style.

Author:

David M. Lloyd

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM_MASKED_HMAC_SHA1_AES_128
static String	ALGORITHM_MASKED_HMAC_SHA1_AES_256
static String	ALGORITHM_MASKED_HMAC_SHA224_AES_128
static String	ALGORITHM_MASKED_HMAC_SHA224_AES_256
static String	ALGORITHM_MASKED_HMAC_SHA256_AES_128
static String	ALGORITHM_MASKED_HMAC_SHA256_AES_256
static String	ALGORITHM_MASKED_HMAC_SHA384_AES_128
static String	ALGORITHM_MASKED_HMAC_SHA384_AES_256
static String	ALGORITHM_MASKED_HMAC_SHA512_AES_128
static String	ALGORITHM_MASKED_HMAC_SHA512_AES_256
static String	ALGORITHM_MASKED_MD5_3DES
static String	ALGORITHM_MASKED_MD5_3DES_CBC_PKCS5
static String	ALGORITHM_MASKED_MD5_DES
static String	ALGORITHM_MASKED_MD5_DES_CBC_PKCS5
static String	ALGORITHM_MASKED_PBKDF_HMAC_SHA1
static String	ALGORITHM_MASKED_PBKDF_HMAC_SHA224
static String	ALGORITHM_MASKED_PBKDF_HMAC_SHA256
static String	ALGORITHM_MASKED_PBKDF_HMAC_SHA384
static String	ALGORITHM_MASKED_PBKDF_HMAC_SHA512
static String	ALGORITHM_MASKED_SHA1_DES_EDE
static String	ALGORITHM_MASKED_SHA1_DES_EDE_CBC_PKCS5
static String	ALGORITHM_MASKED_SHA1_RC2_128
static String	ALGORITHM_MASKED_SHA1_RC2_128_CBC_PKCS5
static String	ALGORITHM_MASKED_SHA1_RC2_40
static String	ALGORITHM_MASKED_SHA1_RC2_40_CBC_PKCS5
static String	ALGORITHM_MASKED_SHA1_RC4_128
static String	ALGORITHM_MASKED_SHA1_RC4_128_ECB
static String	ALGORITHM_MASKED_SHA1_RC4_40
static String	ALGORITHM_MASKED_SHA1_RC4_40_ECB

Fields inherited from interface java.security.Key

serialVersionUID

Method Summary

Modifier and Type	Method and Description
MaskedPassword	clone() Creates and returns a copy of this Password.
static MaskedPassword	createRaw(String algorithm, char[] initialKeyMaterial, int iterationCount, byte[] salt, byte[] maskedPasswordBytes) Create a raw instance of this password type.
char[]	getInitialKeyMaterial() Get the initial key material.
int	getIterationCount() Get the iteration count.
byte[]	getMaskedPasswordBytes() Get the masked password bytes.
default MaskedPasswordAlgorithmSpec	getParameterSpec() Get the applicable algorithm parameter specification for this password type.
static String	getPBEName(String name) Get the name of the PBE algorithm that goes with the given password algorithm name.
byte[]	getSalt() Get the salt bytes.
default boolean	impliesParameters(AlgorithmParameterSpec parameterSpec) Determine if this password is matched by the given parameter specification.
static boolean	isMaskedAlgorithm(String name) Determine if the given algorithm name is a valid masked password algorithm name.

Methods inherited from interface org.wildfly.security.password.Password

castAndApply, castAndApply, castAs, castAs

Methods inherited from interface java.security.Key

getAlgorithm, getEncoded, getFormat

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Field Detail

ALGORITHM_MASKED_MD5_DES

static final String ALGORITHM_MASKED_MD5_DES

See Also:

Constant Field Values

ALGORITHM_MASKED_MD5_DES_CBC_PKCS5

static final String ALGORITHM_MASKED_MD5_DES_CBC_PKCS5

See Also:

Constant Field Values

ALGORITHM_MASKED_MD5_3DES

static final String ALGORITHM_MASKED_MD5_3DES

See Also:

Constant Field Values

ALGORITHM_MASKED_MD5_3DES_CBC_PKCS5

static final String ALGORITHM_MASKED_MD5_3DES_CBC_PKCS5

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_DES_EDE

static final String ALGORITHM_MASKED_SHA1_DES_EDE

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_DES_EDE_CBC_PKCS5

static final String ALGORITHM_MASKED_SHA1_DES_EDE_CBC_PKCS5

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC2_40

static final String ALGORITHM_MASKED_SHA1_RC2_40

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC2_40_CBC_PKCS5

static final String ALGORITHM_MASKED_SHA1_RC2_40_CBC_PKCS5

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC2_128

static final String ALGORITHM_MASKED_SHA1_RC2_128

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC2_128_CBC_PKCS5

static final String ALGORITHM_MASKED_SHA1_RC2_128_CBC_PKCS5

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC4_40

static final String ALGORITHM_MASKED_SHA1_RC4_40

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC4_40_ECB

static final String ALGORITHM_MASKED_SHA1_RC4_40_ECB

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC4_128

static final String ALGORITHM_MASKED_SHA1_RC4_128

See Also:

Constant Field Values

ALGORITHM_MASKED_SHA1_RC4_128_ECB

static final String ALGORITHM_MASKED_SHA1_RC4_128_ECB

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA1_AES_128

static final String ALGORITHM_MASKED_HMAC_SHA1_AES_128

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA224_AES_128

static final String ALGORITHM_MASKED_HMAC_SHA224_AES_128

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA256_AES_128

static final String ALGORITHM_MASKED_HMAC_SHA256_AES_128

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA384_AES_128

static final String ALGORITHM_MASKED_HMAC_SHA384_AES_128

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA512_AES_128

static final String ALGORITHM_MASKED_HMAC_SHA512_AES_128

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA1_AES_256

static final String ALGORITHM_MASKED_HMAC_SHA1_AES_256

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA224_AES_256

static final String ALGORITHM_MASKED_HMAC_SHA224_AES_256

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA256_AES_256

static final String ALGORITHM_MASKED_HMAC_SHA256_AES_256

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA384_AES_256

static final String ALGORITHM_MASKED_HMAC_SHA384_AES_256

See Also:

Constant Field Values

ALGORITHM_MASKED_HMAC_SHA512_AES_256

static final String ALGORITHM_MASKED_HMAC_SHA512_AES_256

See Also:

Constant Field Values

ALGORITHM_MASKED_PBKDF_HMAC_SHA1

static final String ALGORITHM_MASKED_PBKDF_HMAC_SHA1

See Also:

Constant Field Values

ALGORITHM_MASKED_PBKDF_HMAC_SHA224

static final String ALGORITHM_MASKED_PBKDF_HMAC_SHA224

See Also:

Constant Field Values

ALGORITHM_MASKED_PBKDF_HMAC_SHA256

static final String ALGORITHM_MASKED_PBKDF_HMAC_SHA256

See Also:

Constant Field Values

ALGORITHM_MASKED_PBKDF_HMAC_SHA384

static final String ALGORITHM_MASKED_PBKDF_HMAC_SHA384

See Also:

Constant Field Values

ALGORITHM_MASKED_PBKDF_HMAC_SHA512

static final String ALGORITHM_MASKED_PBKDF_HMAC_SHA512

See Also:

Constant Field Values

Method Detail

isMaskedAlgorithm

static boolean isMaskedAlgorithm(String name)

Determine if the given algorithm name is a valid masked password algorithm name.

Parameters:

name - the algorithm name

Returns:

true if the algorithm name is valid for this password type, false otherwise

getPBEName

static String getPBEName(String name)

Get the name of the PBE algorithm that goes with the given password algorithm name.

Parameters:

name - the password algorithm name

Returns:

the PBE algorithm name, or null if the password algorithm name was null or not recognized

getInitialKeyMaterial

char[] getInitialKeyMaterial()

Get the initial key material.

Returns:

the initial key material (must not be null)

getIterationCount

int getIterationCount()

Get the iteration count.

Returns:

the iteration count

getSalt

byte[] getSalt()

Get the salt bytes.

Returns:

the salt bytes (must not be null)

getMaskedPasswordBytes

byte[] getMaskedPasswordBytes()

Get the masked password bytes.

Returns:

the masked password bytes (must not be null)

getParameterSpec

default MaskedPasswordAlgorithmSpec getParameterSpec()

Description copied from interface: Password

Get the applicable algorithm parameter specification for this password type.

Specified by:

getParameterSpec in interface Password

Returns:

the algorithm parameter specification, or null if this password type does not support algorithms

impliesParameters

default boolean impliesParameters(AlgorithmParameterSpec parameterSpec)

Description copied from interface: Password

Determine if this password is matched by the given parameter specification.

Specified by:

impliesParameters in interface Password

Parameters:

parameterSpec - the parameter specification (must not be null)

Returns:

true if the password is matched by the parameters, false otherwise

clone

MaskedPassword clone()

Description copied from interface: TwoWayPassword

Creates and returns a copy of this Password.

Specified by:

clone in interface Password

Specified by:

clone in interface TwoWayPassword

Returns:

a copy of this Password.

createRaw

static MaskedPassword createRaw(String algorithm,
                                char[] initialKeyMaterial,
                                int iterationCount,
                                byte[] salt,
                                byte[] maskedPasswordBytes)

Create a raw instance of this password type.

Parameters:

algorithm - the algorithm name (must not be null)

initialKeyMaterial - the initial key material (must not be null)

iterationCount - the iteration count

salt - the salt (must not be null)

maskedPasswordBytes - the masked password bytes (must not be null)

Returns:

the raw instance (not null)