APIdia Launch Partner
Top Description Fields Constructors Methods
java.security.spec

public Class MGF1ParameterSpec

extends Object
implements AlgorithmParameterSpec
Class Inheritance
All Implemented Interfaces
java.security.spec.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 --
}
Author
Valerie Peng
Since
1.5
External Specification
https://www.rfc-editor.org/info/rfc8017
See Also
PSSParameterSpec, javax.crypto.spec.OAEPParameterSpec

Field Summary

Modifier and TypeField and Description
private final String
mdName

public static final MGF1ParameterSpec
SHA1

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

public static final MGF1ParameterSpec
SHA224

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

public static final MGF1ParameterSpec
SHA256

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

public static final MGF1ParameterSpec
SHA384

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

public static final MGF1ParameterSpec
SHA3_224

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

public static final MGF1ParameterSpec
SHA3_256

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

public static final MGF1ParameterSpec
SHA3_384

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

public static final MGF1ParameterSpec
SHA3_512

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

public static final MGF1ParameterSpec
SHA512

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

public static final MGF1ParameterSpec
SHA512_224

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

public static final MGF1ParameterSpec
SHA512_256

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

Constructor Summary

AccessConstructor and Description
public
MGF1ParameterSpec(String
the algorithm name for the message digest used in this mask generation function MGF1.
mdName)

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

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the algorithm name of the message digest.
getDigestAlgorithm()

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

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

mdNameback to summary
private final String mdName
SHA1back to summary
public static final MGF1ParameterSpec SHA1

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

SHA224back to summary
public static final MGF1ParameterSpec SHA224

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

SHA256back to summary
public static final MGF1ParameterSpec SHA256

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

SHA384back to summary
public static final MGF1ParameterSpec SHA384

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

SHA3_224back to summary
public static final MGF1ParameterSpec SHA3_224

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

Since
16
SHA3_256back to summary
public static final MGF1ParameterSpec SHA3_256

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

Since
16
SHA3_384back to summary
public static final MGF1ParameterSpec SHA3_384

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

Since
16
SHA3_512back to summary
public static final MGF1ParameterSpec SHA3_512

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

Since
16
SHA512back to summary
public static final MGF1ParameterSpec SHA512

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

SHA512_224back to summary
public static final MGF1ParameterSpec SHA512_224

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

Since
11
SHA512_256back to summary
public static final MGF1ParameterSpec SHA512_256

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

Since
11

Constructor Detail

MGF1ParameterSpecback to summary
public MGF1ParameterSpec(String mdName)

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

Parameters
mdName:String

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

Exceptions
NullPointerException:
if mdName is null.

Method Detail

getDigestAlgorithmback to summary
public String getDigestAlgorithm()

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

Returns:String

the algorithm name of the message digest.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override