The Wayback Machine - https://web.archive.org/web/20160412074141/http://developer.android.com/reference/java/security/spec/PSSParameterSpec.html

PSSParameterSpec

Developer Console

Interfaces
Classes
Exceptions
- InvalidKeySpecException
- InvalidParameterSpecException

fullscreen Use Tree Navigation

Summary: Fields | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

PSSParameterSpec

extends Object
implements AlgorithmParameterSpec

java.lang.Object
↳	java.security.spec.PSSParameterSpec

Class Overview

The parameter specification for the RSA-PSS Signature scheme.

Defined in the PKCS #1 v2.1 standard.

Summary

Fields
public static final PSSParameterSpec	DEFAULT	The default parameter specification.

Public Constructors
	PSSParameterSpec(int saltLen) Creates a new `PSSParameterSpec` with the specified salt length and the default values.
	PSSParameterSpec(String mdName, String mgfName, AlgorithmParameterSpec mgfSpec, int saltLen, int trailerField) Creates a new `PSSParameterSpec` with the specified message digest name, mask generation function name, mask generation function parameters, salt length, and trailer field value.

Public Methods
String	getDigestAlgorithm() Returns the name of the message digest algorithm.
String	getMGFAlgorithm() Returns the name of the mask generation function algorithm.
AlgorithmParameterSpec	getMGFParameters() Returns the parameter for the mask generation function algorithm.
int	getSaltLength() Returns the length of the salt (in bits).
int	getTrailerField() Returns the trailer field value.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Fields

public static final PSSParameterSpec DEFAULT

Added in API level 1

The default parameter specification. It specifies the following parameters:

message digest: "SHA-1"
mask generation function (mgf): "MGF1"
parameters for the mgf: SHA1
salt length: 20
trailer field: -1

Public Constructors

public PSSParameterSpec (int saltLen)

Added in API level 1

Creates a new PSSParameterSpec with the specified salt length and the default values.

Parameters
`saltLen`	`int`: the salt length (in bits).

Throws
`IllegalArgumentException`	if `saltLen` is negative.

public PSSParameterSpec (String mdName, String mgfName, AlgorithmParameterSpec mgfSpec, int saltLen, int trailerField)

Added in API level 1

Creates a new PSSParameterSpec with the specified message digest name, mask generation function name, mask generation function parameters, salt length, and trailer field value.

Parameters
`mdName`	`String`: the name of the message digest algorithm.
`mgfName`	`String`: the name of the mask generation function algorithm.
`mgfSpec`	`AlgorithmParameterSpec`: the parameter for the mask generation function algorithm.
`saltLen`	`int`: the salt length (in bits).
`trailerField`	`int`: the trailer field value.

Throws
`IllegalArgumentException`	if `saltLen` or `trailerField` is negative.

Public Methods

public String getDigestAlgorithm ()

Added in API level 1

Returns the name of the message digest algorithm.

Returns
`String`	the name of the message digest algorithm.

public String getMGFAlgorithm ()

Added in API level 1

Returns the name of the mask generation function algorithm.

Returns
`String`	the name of the mask generation function algorithm.

public AlgorithmParameterSpec getMGFParameters ()

Added in API level 1

Returns the parameter for the mask generation function algorithm.

Returns
`AlgorithmParameterSpec`	the parameter for the mask generation function algorithm, or `null` if none specified.

public int getSaltLength ()

Added in API level 1

Returns the length of the salt (in bits).

Returns
`int`	the length of the salt (in bits).

public int getTrailerField ()

Added in API level 1

Returns the trailer field value.

Returns
`int`	the trailer field value.

Mar	APR	May
	12
2015	2016	2017

Results

Interfaces

Classes

Exceptions

PSSParameterSpec

Class Overview

Summary

Fields

public static final PSSParameterSpec DEFAULT

Public Constructors

public PSSParameterSpec (int saltLen)

public PSSParameterSpec (String mdName, String mgfName, AlgorithmParameterSpec mgfSpec, int saltLen, int trailerField)

Public Methods

public String getDigestAlgorithm ()

public String getMGFAlgorithm ()

public AlgorithmParameterSpec getMGFParameters ()

public int getSaltLength ()

public int getTrailerField ()