iaik.pkcs.pkcs1

Class RSAPssSaltParameterSpec

java.lang.Object

iaik.pkcs.pkcs1.PKCS1AlgorithmParameterSpec

iaik.pkcs.pkcs1.RSAPssSaltParameterSpec

All Implemented Interfaces:

java.security.spec.AlgorithmParameterSpec

Direct Known Subclasses:

RSAPssParameterSpec

public class RSAPssSaltParameterSpec
extends PKCS1AlgorithmParameterSpec

Parameter specification to may be used for specifying the saltLength parameter for the PKCS#1v2.1 RSASSA-PSS signature algorithm.

According PKCS#1v2.1 RSASSA-PSS parameters consist of hash algorithm id, mask generation function id, salt length and trailer field:

 RSASSA-PSS-params :: = SEQUENCE {
      hashAlgorithm            [0] HashAlgorithm     DEFAULT sha1,
      maskGenerationAlgorithm  [1] MaskGenAlgorithm  DEFAULT mgf1SHA1,
      saltLength               [2] INTEGER           DEFAULT 20,
      trailerField             [3] TrailerField      DEFAULT trailerFieldBC
 }
 
 HashAlgorithm ::= Algorithmidentifier { {OAEP-PSSDigestAlgorithms} }
 
 MaskGenAlgorithm ::= AlgorithmIdentifier { {PKCS1MGFAlgorithms} }
 
 TrailerField ::= INTEGER { trailerFieldBC(1) }
 

The Java Cryptography Architecture, however, only allows to set the salt length as parameter and specifies all the other parameters by the algorithm standard name to be implemented by a corresponding PSS signature engine: A signature engine that implements the, for instance, "SHA1withRSAandMGF1" (in general: <digest>with<encryption>and<mgf>) PSS signature algorithm has to use SHA-1 as hash- and MGF1 as mask generation algorithm. The trailer field (0xBC) is fixed by the PKCS#1v2.1 standard and the salt length may be supplied as parameter (default 20 for the SHA-1 hash algorithm).

Version:

File Revision 13

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SALT_LENGTH Default salt length (20).
protected byte[]	salt_ The salt value; if set by the application.
protected int	saltLength_ Salt length.

Constructor Summary

Constructors

Constructor and Description
RSAPssSaltParameterSpec() Creates a RSAPssSaltParameterSpec with the default salt length value (20).
RSAPssSaltParameterSpec(byte[] salt) Creates a RSAPssSaltParameterSpec for the given salt value.
RSAPssSaltParameterSpec(int saltLength) Creates a RSAPssSaltParameterSpec for the given salt length.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares this RSAPssSaltParameterSpec object with the supplied object.
byte[]	getSalt() Gets the salt value, if set by the application.
int	getSaltLength() Gets the salt length.
int	hashCode() Gets a hash code for this object.
java.lang.String	toString() Gets a String representation of this RSAPssSaltParameterSpec.

Methods inherited from class iaik.pkcs.pkcs1.PKCS1AlgorithmParameterSpec

getSecureRandom, setSecureRandom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SALT_LENGTH

public static final int DEFAULT_SALT_LENGTH

Default salt length (20).

See Also:

Constant Field Values

saltLength_

protected int saltLength_

Salt length.

salt_

protected byte[] salt_

The salt value; if set by the application.

Constructor Detail

RSAPssSaltParameterSpec

public RSAPssSaltParameterSpec()

Creates a RSAPssSaltParameterSpec with the default salt length value (20).

RSAPssSaltParameterSpec

public RSAPssSaltParameterSpec(int saltLength)

Creates a RSAPssSaltParameterSpec for the given salt length.

Parameters:

saltLength - the salt length value to be used.

Throws:

java.lang.IllegalArgumentException - if saltLength < 0

RSAPssSaltParameterSpec

public RSAPssSaltParameterSpec(byte[] salt)

Creates a RSAPssSaltParameterSpec for the given salt value. This constructor maybe used by an application for supplying its own salt value.

Parameters:

salt - the salt value to be used (will be not cloned)

Throws:

java.lang.NullPointerException - if the salt value is null

Method Detail

getSaltLength

public int getSaltLength()

Gets the salt length.

Returns:

the salt length value

getSalt

public byte[] getSalt()

Gets the salt value, if set by the application.

Returns:

the salt value, or null if not set by the application

hashCode

public int hashCode()

Gets a hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

equals

public boolean equals(java.lang.Object obj)

Compares this RSAPssSaltParameterSpec object with the supplied object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to be compared

Returns:

true if the two objects are RSAPssSaltParameterSpec objects with same salt length and -- if set -- salt values; false otherwise

toString

public java.lang.String toString()

Gets a String representation of this RSAPssSaltParameterSpec.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this RSAPssSaltParameterSpec