SHOW Signed
 

net.rim.device.api.crypto
Class PKCS5KDF2PseudoRandomSource

java.lang.Object
  |
  +--net.rim.device.api.crypto.AbstractPseudoRandomSource
        |
        +--net.rim.device.api.crypto.PKCS5KDF2PseudoRandomSource
All Implemented Interfaces:
PseudoRandomSource

public final class PKCS5KDF2PseudoRandomSource
extends AbstractPseudoRandomSource
implements PseudoRandomSource

Provides PKCS #5 Key Derivation Function 2 pseudo random number generation. This is the recommended algorithm for new applications because the derived key length is not dependent on the hash algorithm length.

We implemented the PKCS5 KDF2 as per PKCS #5 version 2.0 ( March 1999 ).

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:
JDE 3.6.0

Constructor Summary
 Category: Signed PKCS5KDF2PseudoRandomSource(byte[] password, byte[] salt, int iterationCount)
          Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters using the default SHA-1 digest algorithm.
 Category: Signed PKCS5KDF2PseudoRandomSource(byte[] password, int offset, int length, byte[] salt, int iterationCount)
          Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters using the default SHA-1 digest algorithm.
 Category: Signed PKCS5KDF2PseudoRandomSource(byte[] password, int offset, int length, byte[] salt, int iterationCount, Digest digest)
          Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters.
 Category: Signed PKCS5KDF2PseudoRandomSource(HMACKey key, byte[] salt, int iterationCount, Digest digest)
          Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters.
 
Method Summary
 Category: Signed  String getAlgorithm()
          Returns the name of this PseudoRandomSource "PKCS5KDF2".
 Category: Signed  int getAvailable()
          Returns the number of pseudo random bytes currently available.
 Category: Signed  int getMaxAvailable()
          Returns the maximum number of pseudo random bytes that this PRNG can produce.
 Category: Signed  void xorBytes(byte[] buffer, int offset, int length)
          Exclusive-OR's (xor) random bytes into the given buffer starting at the specified array offset.
 
Methods inherited from class net.rim.device.api.crypto.AbstractPseudoRandomSource
getBytes, getBytes, getBytes, xorBytes, xorBytes, xorCopy, xorCopy
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.rim.device.api.crypto.PseudoRandomSource
getBytes, getBytes, getBytes, xorBytes, xorBytes, xorCopy, xorCopy
 

Constructor Detail

PKCS5KDF2PseudoRandomSource

public PKCS5KDF2PseudoRandomSource(byte[] password,
                                   byte[] salt,
                                   int iterationCount)
Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters using the default SHA-1 digest algorithm.

Parameters:
password - The password used to initialize the HMAC function.
salt - The salt data that is hashed to generate the key data.
iterationCount - The number of times to hash each block of the key.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

PKCS5KDF2PseudoRandomSource

public PKCS5KDF2PseudoRandomSource(byte[] password,
                                   int offset,
                                   int length,
                                   byte[] salt,
                                   int iterationCount)
Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters using the default SHA-1 digest algorithm.

Parameters:
password - The password used to initialize the HMAC function.
offset - The offset, or starting position, of the password data within the array.
length - The number of bytes to use as password data.
salt - The salt data that is hashed to generate the key data.
iterationCount - The number of times to hash each block of the key.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

PKCS5KDF2PseudoRandomSource

public PKCS5KDF2PseudoRandomSource(byte[] password,
                                   int offset,
                                   int length,
                                   byte[] salt,
                                   int iterationCount,
                                   Digest digest)
Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters.

Parameters:
password - The password used to initialize the HMAC function.
offset - The offset, or starting position, of the password data within the array.
length - The number of bytes to use as password data.
salt - The salt data that is hashed to generate the key data.
iterationCount - The number of times to hash each block of the key.
digest - The digest
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

PKCS5KDF2PseudoRandomSource

public PKCS5KDF2PseudoRandomSource(HMACKey key,
                                   byte[] salt,
                                   int iterationCount,
                                   Digest digest)
                            throws CryptoTokenException,
                                   CryptoUnsupportedOperationException
Creates a PKCS5KDF2PseudoRandomSource object with the desired parameters.

Parameters:
key - The key used to initialize the HMAC function.
salt - The salt data that is hashed to generate the key data.
iterationCount - The number of times to hash each block of the key.
digest - The digest algorithm to use.
Throws:
CryptoTokenException - Thrown when an error occurs with a crypto token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to an unsupported operation.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Method Detail

getAlgorithm

public String getAlgorithm()
Returns the name of this PseudoRandomSource "PKCS5KDF2".

This method will always return the String "PKCS5KDF2".

Returns:
A String that represents the name of the algorithm.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getAvailable

public int getAvailable()
Description copied from interface: PseudoRandomSource
Returns the number of pseudo random bytes currently available.

For PRNG sources that have an indefinite length but implement this interface, the value returned is Integer.MAX.

Since:
JDE 3.6.0

Following copied from interface: PseudoRandomSource
Returns:
An integer that represents the number of bytes.
Throws:
CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getMaxAvailable

public int getMaxAvailable()
Description copied from interface: PseudoRandomSource
Returns the maximum number of pseudo random bytes that this PRNG can produce.

For PRNG sources that have an indefinite length but implement this interface, the value returned is Integer.MAX.

Since:
JDE 3.6.0

Following copied from interface: PseudoRandomSource
Returns:
An integer that specifies the maximum number of random bytes that can be produced.
Throws:
CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

xorBytes

public void xorBytes(byte[] buffer,
                     int offset,
                     int length)
Exclusive-OR's (xor) random bytes into the given buffer starting at the specified array offset.

Specified by:
xorBytes in interface PseudoRandomSource
Overrides:
xorBytes in class AbstractPseudoRandomSource
Parameters:
buffer - The buffer to xor the bytes into.
offset - The starting offset within buffer.
length - The number of bytes to xor.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.