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

External Specifications

• RFC 8017: PKCS #1: RSA Cryptography Specifications Version 2.2

See Also:

• PSSParameterSpec
• OAEPParameterSpec

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	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	Description
String	getDigestAlgorithm()	Returns the algorithm name of the message digest used by the mask generation function.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

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.

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

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

Constructor Details

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 Details

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.