java.security.spec

Class MGF1ParameterSpec

java.lang.Object

java.security.spec.MGF1ParameterSpec

All Implemented Interfaces:

AlgorithmParameterSpec

public class MGF1ParameterSpec
extends Object
implements AlgorithmParameterSpec

This class specifies the set of parameters used with mask generation function MGF1 in OAEP Padding and RSASSA-PSS signature scheme, as defined in the PKCS#1 v2.2 standard.

Its ASN.1 definition in PKCS#1 standard is described below:

 PKCS1MGFAlgorithms    ALGORITHM-IDENTIFIER ::= {
   { OID id-mgf1 PARAMETERS HashAlgorithm },
   ...  -- Allows for future expansion --
 }
 

where

 HashAlgorithm ::= AlgorithmIdentifier {
   {OAEP-PSSDigestAlgorithms}
 }

 OAEP-PSSDigestAlgorithms    ALGORITHM-IDENTIFIER ::= {
   { OID id-sha1       PARAMETERS NULL }|
   { OID id-sha224     PARAMETERS NULL }|
   { OID id-sha256     PARAMETERS NULL }|
   { OID id-sha384     PARAMETERS NULL }|
   { OID id-sha512     PARAMETERS NULL }|
   { OID id-sha512-224 PARAMETERS NULL }|
   { OID id-sha512-256 PARAMETERS NULL },
   ...  -- Allows for future expansion --
 }
 

Since:

1.5

Author:

Valerie Peng

See Also:

OAEPParameterSpec

Field Summary

Fields

Modifier and Type	Field and Description
static MGF1ParameterSpec	SHA1 The MGF1ParameterSpec uses a "SHA-1" message digest.
static MGF1ParameterSpec	SHA224 The MGF1ParameterSpec uses a "SHA-224" message digest.
static MGF1ParameterSpec	SHA256 The MGF1ParameterSpec uses a "SHA-256" message digest.
static MGF1ParameterSpec	SHA3_224 The MGF1ParameterSpec uses a "SHA3-224" message digest.
static MGF1ParameterSpec	SHA3_256 The MGF1ParameterSpec uses a "SHA3-256" message digest.
static MGF1ParameterSpec	SHA3_384 The MGF1ParameterSpec uses a "SHA3-384" message digest.
static MGF1ParameterSpec	SHA3_512 The MGF1ParameterSpec uses a "SHA3-512" message digest.
static MGF1ParameterSpec	SHA384 The MGF1ParameterSpec uses a "SHA-384" message digest.
static MGF1ParameterSpec	SHA512 The MGF1ParameterSpec uses a "SHA-512" message digest.
static MGF1ParameterSpec	SHA512_224 The MGF1ParameterSpec uses a "SHA-512/224" message digest.
static MGF1ParameterSpec	SHA512_256 The MGF1ParameterSpec uses a "SHA-512/256" message digest.

Constructor Summary

Constructors

Constructor and Description
MGF1ParameterSpec(String mdName) Constructs a parameter set for mask generation function MGF1 as defined in the PKCS #1 standard.

Method Summary

Modifier and Type	Method and Description
String	getDigestAlgorithm() Returns the algorithm name of the message digest used by the mask generation function.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

SHA1

public static final MGF1ParameterSpec SHA1

The MGF1ParameterSpec uses a "SHA-1" message digest.

SHA224

public static final MGF1ParameterSpec SHA224

The MGF1ParameterSpec uses a "SHA-224" message digest.

SHA256

public static final MGF1ParameterSpec SHA256

The MGF1ParameterSpec uses a "SHA-256" message digest.

SHA3_224

public static final MGF1ParameterSpec SHA3_224

The MGF1ParameterSpec uses a "SHA3-224" message digest.

Since:

16

SHA3_256

public static final MGF1ParameterSpec SHA3_256

The MGF1ParameterSpec uses a "SHA3-256" message digest.

Since:

16

SHA3_384

public static final MGF1ParameterSpec SHA3_384

The MGF1ParameterSpec uses a "SHA3-384" message digest.

Since:

16

SHA3_512

public static final MGF1ParameterSpec SHA3_512

The MGF1ParameterSpec uses a "SHA3-512" message digest.

Since:

16

SHA384

public static final MGF1ParameterSpec SHA384

The MGF1ParameterSpec uses a "SHA-384" message digest.

SHA512

public static final MGF1ParameterSpec SHA512

The MGF1ParameterSpec uses a "SHA-512" message digest.

SHA512_224

public static final MGF1ParameterSpec SHA512_224

The MGF1ParameterSpec uses a "SHA-512/224" message digest.

Since:

11

SHA512_256

public static final MGF1ParameterSpec SHA512_256

The MGF1ParameterSpec uses a "SHA-512/256" message digest.

Since:

11

Constructor Detail

MGF1ParameterSpec

public MGF1ParameterSpec(String mdName)

Constructs a parameter set for mask generation function MGF1 as defined in the PKCS #1 standard.

Parameters:

mdName - the algorithm name for the message digest used in this mask generation function MGF1.

Throws:

NullPointerException - if mdName is null.

Method Detail

getDigestAlgorithm

public String getDigestAlgorithm()

Returns the algorithm name of the message digest used by the mask generation function.

Returns:

the algorithm name of the message digest.

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.