Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/java/security/spec/PSSParameterSpec#constants) \| [Fields](https://developer.android.com/reference/java/security/spec/PSSParameterSpec#lfields) \| [Ctors](https://developer.android.com/reference/java/security/spec/PSSParameterSpec#pubctors) \| [Methods](https://developer.android.com/reference/java/security/spec/PSSParameterSpec#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/security/spec/PSSParameterSpec#inhmethods)

# PSSParameterSpec


`
public


class
PSSParameterSpec
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | java.security.spec.PSSParameterSpec |

<br />

*** ** * ** ***

This class specifies a parameter spec for RSASSA-PSS signature scheme,
as defined in the
[PKCS#1 v2.2](https://tools.ietf.org/rfc/rfc8017.txt) standard.

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

```
RSASSA-PSS-params ::= SEQUENCE {
  hashAlgorithm      [0] HashAlgorithm      DEFAULT sha1,
  maskGenAlgorithm   [1] MaskGenAlgorithm   DEFAULT mgf1SHA1,
  saltLength         [2] INTEGER            DEFAULT 20,
  trailerField       [3] TrailerField       DEFAULT trailerFieldBC(1)
}
```
where

```
HashAlgorithm ::= AlgorithmIdentifier {
  {OAEP-PSSDigestAlgorithms}
}
MaskGenAlgorithm ::= AlgorithmIdentifier { {PKCS1MGFAlgorithms} }
TrailerField ::= INTEGER { trailerFieldBC(1) }

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 --
}
PKCS1MGFAlgorithms    ALGORITHM-IDENTIFIER ::= {
  { OID id-mgf1 PARAMETERS HashAlgorithm },
  ...  -- Allows for future expansion --
}
```

Note: the PSSParameterSpec.DEFAULT uses the following:
message digest -- "SHA-1"
mask generation function (mgf) -- "MGF1"
parameters for mgf -- MGF1ParameterSpec.SHA1
SaltLength -- 20
TrailerField -- 1
**See also:**

- `https://developer.android.com/reference/java/security/spec/MGF1ParameterSpec`
- `https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec`
- `https://developer.android.com/reference/java/security/Signature`

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/java/security/spec/PSSParameterSpec#TRAILER_FIELD_BC` The `TrailerFieldBC` constant as defined in PKCS#1 |

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/java/security/spec/PSSParameterSpec` | `https://developer.android.com/reference/java/security/spec/PSSParameterSpec#DEFAULT` The PSS parameter set with all default values |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#PSSParameterSpec(int)(int saltLen) ` Creates a new `PSSParameterSpec` using the specified salt length and other default values as defined in PKCS#1. |
| ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#PSSParameterSpec(java.lang.String,%20java.lang.String,%20java.security.spec.AlgorithmParameterSpec,%20int,%20int)(https://developer.android.com/reference/java/lang/String mdName, https://developer.android.com/reference/java/lang/String mgfName, https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec mgfSpec, int saltLen, int trailerField) ` Creates a new `PSSParameterSpec` as defined in the PKCS #1 standard using the specified message digest, mask generation function, parameters for mask generation function, salt length, and trailer field values. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#getDigestAlgorithm()() ` Returns the message digest algorithm name. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#getMGFAlgorithm()() ` Returns the mask generation function algorithm name. |
| ` https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec` | ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#getMGFParameters()() ` Returns the parameters for the mask generation function. |
| ` int` | ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#getSaltLength()() ` Returns the salt length in bytes. |
| ` int` | ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#getTrailerField()() ` Returns the value for the trailer field. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/security/spec/PSSParameterSpec#toString()() ` Returns a string representation of the object. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Constants

### TRAILER_FIELD_BC

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int TRAILER_FIELD_BC
```

The `TrailerFieldBC` constant as defined in PKCS#1

<br />

Constant Value:

1
(0x00000001)


## Fields

### DEFAULT

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final PSSParameterSpec DEFAULT
```

The PSS parameter set with all default values

<br />

## Public constructors

### PSSParameterSpec

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PSSParameterSpec (int saltLen)
```

Creates a new `PSSParameterSpec`
using the specified salt length and other default values as
defined in PKCS#1.

<br />

| Parameters ||
|---|---|
| `saltLen` | `int`: the length of salt in bytes to be used in PKCS#1 PSS encoding <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `saltLen` is less than 0 |

### PSSParameterSpec

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

Creates a new `PSSParameterSpec` as defined in
the PKCS #1 standard using the specified message digest,
mask generation function, parameters for mask generation
function, salt length, and trailer field values.

<br />

| Parameters ||
|---|---|
| `mdName` | `String`: the algorithm name of the hash function <br /> |
| `mgfName` | `String`: the algorithm name of the mask generation function <br /> |
| `mgfSpec` | `AlgorithmParameterSpec`: the parameters for the mask generation function. If null is specified, null will be returned by getMGFParameters(). <br /> |
| `saltLen` | `int`: the length of salt <br /> |
| `trailerField` | `int`: the value of the trailer field <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `saltLen` or `trailerField` is less than 0 |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `mdName`, or `mgfName` is null |

## Public methods

### getDigestAlgorithm

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getDigestAlgorithm ()
```

Returns the message digest algorithm name.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the message digest algorithm name <br /> |

### getMGFAlgorithm

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getMGFAlgorithm ()
```

Returns the mask generation function algorithm name.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the mask generation function algorithm name <br /> |

### getMGFParameters

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public AlgorithmParameterSpec getMGFParameters ()
```

Returns the parameters for the mask generation function.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec` | the parameters for the mask generation function <br /> |

### getSaltLength

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSaltLength ()
```

Returns the salt length in bytes.

<br />

| Returns ||
|---|---|
| `int` | the salt length <br /> |

### getTrailerField

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getTrailerField ()
```

Returns the value for the trailer field.

<br />

| Returns ||
|---|---|
| `int` | the value for the trailer field <br /> |

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |