iaik.pkcs.pkcs1

Class MGF1ParameterSpec

java.lang.Object

iaik.pkcs.pkcs1.PKCS1AlgorithmParameterSpec

iaik.pkcs.pkcs1.MGF1ParameterSpec

All Implemented Interfaces:

java.security.spec.AlgorithmParameterSpec

public class MGF1ParameterSpec
extends PKCS1AlgorithmParameterSpec

Algorithm parameter specification for the PKCS#1v2.1 MGF1 mask generation function.

According to PKCS#1v2.1 the only parameter used by MGF1 is the algorithm id of the hash algorithm (default SHA-1) to be used:

 mgf1SHA1 MaskGenAlgorithm ::= {
   algorithm id-mgf1,
   parameters HashAlgorithm : sha1
 }
 

Version:

File Revision 13

Constructor Summary

Constructors

Constructor and Description
MGF1ParameterSpec() Creates a new MGF1ParameterSpec for the default hash algorithm (SHA-1) to be used with MGF1.
MGF1ParameterSpec(AlgorithmID hashAlgorithm) Creates a new MGF1ParameterSpec for the hash algorithm to be used with MGF1.

Method Summary

Methods

Modifier and Type	Method and Description
AlgorithmID	getHashAlgorithm() Returns the hash algorithm to be used
java.security.MessageDigest	getHashEngine() Gets the JCA MessageDigest engine to be used by MGF1.
void	setHashEngine(java.security.MessageDigest hashEngine) Sets the JCA MessageDigest engine to be used by MGF1.
java.lang.String	toString() Returns a String representation of this object.

Methods inherited from class iaik.pkcs.pkcs1.PKCS1AlgorithmParameterSpec

getSecureRandom, setSecureRandom

Methods inherited from class java.lang.Object

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

Constructor Detail

MGF1ParameterSpec

public MGF1ParameterSpec()

Creates a new MGF1ParameterSpec for the default hash algorithm (SHA-1) to be used with MGF1.

MGF1ParameterSpec

public MGF1ParameterSpec(AlgorithmID hashAlgorithm)

Creates a new MGF1ParameterSpec for the hash algorithm to be used with MGF1.

Parameters:

hashAlgorithm - the hash algorithm ID

Method Detail

getHashAlgorithm

public AlgorithmID getHashAlgorithm()

Returns the hash algorithm to be used

Returns:

the hash algorithm

setHashEngine

public void setHashEngine(java.security.MessageDigest hashEngine)

Sets the JCA MessageDigest engine to be used by MGF1.

This method may be used to set a JCA MessageDigest engine to be used by MGF1 for doing the any required hashing operations. If not set by this method, getHashEngine will try to create a MessageDigest engine from the algorithm id.

Parameters:

hashEngine - the JCA MessageDigest engine to be used

getHashEngine

public java.security.MessageDigest getHashEngine()
                                          throws java.security.NoSuchAlgorithmException

Gets the JCA MessageDigest engine to be used by MGF1.

If method setHashEngine has been used to set a MessageDigest engine, this engine is returned; otherwise it is tried to create a MessageDigest engine from the algorithm id.

Returns:

the MessageDigest engine to be used by MGF1

Throws:

java.security.NoSuchAlgorithmException

toString

public java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a String representation this object