Package org.wildfly.security.password.impl

Class OneTimePasswordImpl

java.lang.Object

org.wildfly.security.password.impl.AbstractPasswordImpl

org.wildfly.security.password.impl.OneTimePasswordImpl

All Implemented Interfaces:

Serializable, Cloneable, Key, OneTimePassword, OneWayPassword, Password

class OneTimePasswordImpl
extends AbstractPasswordImpl
implements OneTimePassword

A Password implementation for OneTimePassword.

Author:

Farah Juma

Field Summary

Fields

Modifier and Type	Field	Description
private String	algorithm
private byte[]	hash
private String	seed
private int	sequenceNumber
private static long	serialVersionUID

Fields inherited from interface org.wildfly.security.password.interfaces.OneTimePassword

ALGORITHM_OTP_MD5, ALGORITHM_OTP_SHA_256, ALGORITHM_OTP_SHA_384, ALGORITHM_OTP_SHA_512, ALGORITHM_OTP_SHA1, OTP_HASH_SIZE

Constructor Summary

Constructors

Constructor	Description
OneTimePasswordImpl(String algorithm, byte[] hash, String seed, int sequenceNumber)
OneTimePasswordImpl(String algorithm, char[] password, OneTimePasswordAlgorithmSpec spec)
OneTimePasswordImpl(String algorithm, OneTimePasswordSpec spec)
OneTimePasswordImpl(OneTimePassword password)

Method Summary

Modifier and Type	Method	Description
OneTimePasswordImpl	clone()	Creates and returns a copy of this Password.
(package private) static byte[]	computeHash(byte[] hash, String algorithm, MessageDigest messageDigest, int start, int end)
(package private) <T extends KeySpec> boolean	convertibleTo(Class<T> keySpecType)
boolean	equals(Object obj)
private static byte[]	generateOTP(String algorithm, byte[] passPhrase, String seed, int sequenceNumber)	Generate a 64-bit OTP as specified in RFC 2289.
String	getAlgorithm()
byte[]	getHash()	Get the hash represented by this password.
(package private) <S extends KeySpec> S	getKeySpec(Class<S> keySpecType)
private static MessageDigest	getMessageDigest(String algorithm)
String	getSeed()	Get the seed used to generate the hash.
int	getSequenceNumber()	Get the sequence number used to generate the hash.
private static byte[]	hashAndFold(String algorithm, MessageDigest messageDigest, byte[] input)	Pass the given input through a hash function and fold the result to 64 bits.
int	hashCode()
private void	readObject(ObjectInputStream ignored)
private static void	reverse(byte[] bytes, int offset, int length)
(package private) Password	translate(AlgorithmParameterSpec parameterSpec)
(package private) boolean	verify(char[] guess)
(package private) Object	writeReplace()

Methods inherited from class org.wildfly.security.password.impl.AbstractPasswordImpl

getEncoded, getFormat, getNormalizedPasswordBytes, getNormalizedPasswordBytes, verify

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.security.Key

getEncoded, getFormat

Methods inherited from interface org.wildfly.security.password.interfaces.OneTimePassword

getParameterSpec, impliesParameters

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

castAndApply, castAndApply, castAs, castAs

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

algorithm

private final String algorithm

hash

private final byte[] hash

seed

private final String seed

sequenceNumber

private final int sequenceNumber

Constructor Detail

OneTimePasswordImpl

OneTimePasswordImpl(String algorithm,
                    byte[] hash,
                    String seed,
                    int sequenceNumber)

OneTimePasswordImpl

OneTimePasswordImpl(OneTimePassword password)

OneTimePasswordImpl

OneTimePasswordImpl(String algorithm,
                    OneTimePasswordSpec spec)

OneTimePasswordImpl

OneTimePasswordImpl(String algorithm,
                    char[] password,
                    OneTimePasswordAlgorithmSpec spec)
             throws SaslException

Throws:

SaslException

Method Detail

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getHash

public byte[] getHash()

Description copied from interface: OneTimePassword

Get the hash represented by this password.

Specified by:

getHash in interface OneTimePassword

Returns:

the hash represented by this password

getSeed

public String getSeed()

Description copied from interface: OneTimePassword

Get the seed used to generate the hash.

Specified by:

getSeed in interface OneTimePassword

Returns:

the seed used to generate the hash

getSequenceNumber

public int getSequenceNumber()

Description copied from interface: OneTimePassword

Get the sequence number used to generate the hash.

Specified by:

getSequenceNumber in interface OneTimePassword

Returns:

the sequence number used to generate the hash

getKeySpec

<S extends KeySpec> S getKeySpec(Class<S> keySpecType)
                          throws InvalidKeySpecException

Specified by:

getKeySpec in class AbstractPasswordImpl

Throws:

InvalidKeySpecException

translate

Password translate(AlgorithmParameterSpec parameterSpec)
            throws InvalidKeyException,
                   InvalidAlgorithmParameterException

Overrides:

translate in class AbstractPasswordImpl

Throws:

InvalidKeyException

InvalidAlgorithmParameterException

verify

boolean verify(char[] guess)
        throws InvalidKeyException

Specified by:

verify in class AbstractPasswordImpl

Throws:

InvalidKeyException

generateOTP

private static byte[] generateOTP(String algorithm,
                                  byte[] passPhrase,
                                  String seed,
                                  int sequenceNumber)
                           throws SaslException

Generate a 64-bit OTP as specified in RFC 2289.

Parameters:

algorithm - the OTP algorithm, must be either "otp-md5" or "otp-sha1"

passPhrase - the pass phrase, as a byte array

seed - the seed

sequenceNumber - the number of times the hash function will be applied

Returns:

the 64-bit OTP hash

Throws:

SaslException - if the given OTP algorithm is invalid

computeHash

static byte[] computeHash(byte[] hash,
                          String algorithm,
                          MessageDigest messageDigest,
                          int start,
                          int end)

getMessageDigest

private static MessageDigest getMessageDigest(String algorithm)
                                       throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

hashAndFold

private static byte[] hashAndFold(String algorithm,
                                  MessageDigest messageDigest,
                                  byte[] input)

Pass the given input through a hash function and fold the result to 64 bits.

Parameters:

algorithm - the OTP algorithm, must be either "otp-md5" or "otp-sha1"

messageDigest - the MessageDigest to use when generating the hash

input - the data to hash

Returns:

the folded hash

reverse

private static void reverse(byte[] bytes,
                            int offset,
                            int length)

convertibleTo

<T extends KeySpec> boolean convertibleTo(Class<T> keySpecType)

Specified by:

convertibleTo in class AbstractPasswordImpl

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractPasswordImpl

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractPasswordImpl

readObject

private void readObject(ObjectInputStream ignored)
                 throws NotSerializableException

Throws:

NotSerializableException

writeReplace

Object writeReplace()

clone

public OneTimePasswordImpl clone()

Description copied from interface: Password

Creates and returns a copy of this Password.

Specified by:

clone in interface OneTimePassword

Specified by:

clone in interface OneWayPassword

Specified by:

clone in interface Password

Specified by:

clone in class AbstractPasswordImpl

Returns:

a copy of this Password.