OAEPParameterSpec

public class OAEPParameterSpec
extends Object implements AlgorithmParameterSpec

java.lang.Object
↳	javax.crypto.spec.OAEPParameterSpec

This class specifies the set of parameters used with OAEP Padding, as defined in the PKCS #1 standard. Its ASN.1 definition in PKCS#1 standard is described below:

 RSAES-OAEP-params ::= SEQUENCE {
   hashAlgorithm      [0] OAEP-PSSDigestAlgorithms     DEFAULT sha1,
   maskGenAlgorithm   [1] PKCS1MGFAlgorithms  DEFAULT mgf1SHA1,
   pSourceAlgorithm   [2] PKCS1PSourceAlgorithms  DEFAULT pSpecifiedEmpty
 }

where

 OAEP-PSSDigestAlgorithms    ALGORITHM-IDENTIFIER ::= {
   { OID id-sha1 PARAMETERS NULL   }|
   { OID id-sha256 PARAMETERS NULL }|
   { OID id-sha384 PARAMETERS NULL }|
   { OID id-sha512 PARAMETERS NULL },
   ...  -- Allows for future expansion --
 }
 PKCS1MGFAlgorithms    ALGORITHM-IDENTIFIER ::= {
   { OID id-mgf1 PARAMETERS OAEP-PSSDigestAlgorithms },
   ...  -- Allows for future expansion --
 }
 PKCS1PSourceAlgorithms    ALGORITHM-IDENTIFIER ::= {
   { OID id-pSpecified PARAMETERS OCTET STRING },
   ...  -- Allows for future expansion --
 }

Note: the OAEPParameterSpec.DEFAULT uses the following: message digest -- "SHA-1" mask generation function (mgf) -- "MGF1" parameters for mgf -- MGF1ParameterSpec.SHA1 source of encoding input -- PSource.PSpecified.DEFAULT

See also:

MGF1ParameterSpec
PSource

Summary

Fields
`public static final OAEPParameterSpec`	`DEFAULT` The OAEP parameter set with all default values.

Public constructors
`OAEPParameterSpec(String mdName, String mgfName, AlgorithmParameterSpec mgfSpec, PSource pSrc)` Constructs a parameter set for OAEP padding as defined in the PKCS #1 standard using the specified message digest algorithm `mdName`, mask generation function algorithm `mgfName`, parameters for the mask generation function `mgfSpec`, and source of the encoding input P `pSrc`.

Public methods
`String`	`getDigestAlgorithm()` Returns the message digest algorithm name.
`String`	`getMGFAlgorithm()` Returns the mask generation function algorithm name.
`AlgorithmParameterSpec`	`getMGFParameters()` Returns the parameters for the mask generation function.
`PSource`	`getPSource()` Returns the source of encoding input P.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the 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(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.
`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()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Fields

DEFAULT

Added in API level 1

public static final OAEPParameterSpec DEFAULT

The OAEP parameter set with all default values.

Public constructors

OAEPParameterSpec

Added in API level 1

public OAEPParameterSpec (String mdName, 
                String mgfName, 
                AlgorithmParameterSpec mgfSpec, 
                PSource pSrc)

Constructs a parameter set for OAEP padding as defined in the PKCS #1 standard using the specified message digest algorithm mdName, mask generation function algorithm mgfName, parameters for the mask generation function mgfSpec, and source of the encoding input P pSrc.

Parameters
`mdName`	`String`: the algorithm name for the message digest.
`mgfName`	`String`: the algorithm name for the mask generation function.
`mgfSpec`	`AlgorithmParameterSpec`: the parameters for the mask generation function. If null is specified, null will be returned by getMGFParameters().
`pSrc`	`PSource`: the source of the encoding input P.

Throws
`NullPointerException`	if `mdName`, `mgfName`, or `pSrc` is null.

Public methods

getDigestAlgorithm

Added in API level 1

public String getDigestAlgorithm ()

Returns the message digest algorithm name.

Returns
`String`	the message digest algorithm name.

getMGFAlgorithm

Added in API level 1

public String getMGFAlgorithm ()

Returns the mask generation function algorithm name.

Returns
`String`	the mask generation function algorithm name.

getMGFParameters

Added in API level 1

public AlgorithmParameterSpec getMGFParameters ()

Returns the parameters for the mask generation function.

Returns
`AlgorithmParameterSpec`	the parameters for the mask generation function.

getPSource

Added in API level 1

public PSource getPSource ()

Returns the source of encoding input P.

Returns
`PSource`	the source of encoding input P.