Class PSSParameterSpec
java.lang.Object
java.security.spec.PSSParameterSpec
- All Implemented Interfaces:
AlgorithmParameterSpec
This class specifies a parameter spec for the RSASSA-PSS signature scheme,
as defined in the
PKCS#1 v2.2 standard.
Its ASN.1 definition in the 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 -- }
- Since:
- 1.4
- External Specifications
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final PSSParameterSpec
Deprecated.This field uses the default values defined in the PKCS #1 standard.static final int
TheTrailerFieldBC
constant as defined in the PKCS #1 standard. -
Constructor Summary
ConstructorDescriptionPSSParameterSpec
(int saltLen) Deprecated.This constructor uses the default values defined in the PKCS #1 standard except for the salt length.PSSParameterSpec
(String mdName, String mgfName, AlgorithmParameterSpec mgfSpec, int saltLen, int trailerField) Creates a newPSSParameterSpec
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. -
Method Summary
Modifier and TypeMethodDescriptionReturns the message digest algorithm name.Returns the mask generation function algorithm name.Returns the parameters for the mask generation function.int
Returns the salt length in bytes.int
Returns the value for the trailer field.
-
Field Details
-
TRAILER_FIELD_BC
public static final int TRAILER_FIELD_BCTheTrailerFieldBC
constant as defined in the PKCS #1 standard.- Since:
- 11
- See Also:
-
DEFAULT
Deprecated.This field uses the default values defined in the PKCS #1 standard. Some of these defaults are no longer recommended due to advances in cryptanalysis -- see the PKCS#1 v2.2 standard for more details. Thus, it is recommended to create a newPSSParameterSpec
with the desired parameter values using thePSSParameterSpec(String, String, AlgorithmParameterSpec, int, int)
constructor.The PSS parameter set with all default values.- Since:
- 1.5
- External Specifications
-
-
Constructor Details
-
PSSParameterSpec
public PSSParameterSpec(String mdName, String mgfName, AlgorithmParameterSpec mgfSpec, int saltLen, int trailerField) Creates a newPSSParameterSpec
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.- Parameters:
mdName
- the algorithm name of the hash function. See the PSSParameterSpec section of the Java Security Standard Algorithm Names Specification for information about standard names for the hash function.mgfName
- the algorithm name of the mask generation function. See the PSSParameterSpec section of the Java Security Standard Algorithm Names Specification for information about standard names for the mask generation function.mgfSpec
- the parameters for the mask generation function. If null is specified, null will be returned by getMGFParameters().saltLen
- the length of salt in bytestrailerField
- the value of the trailer field- Throws:
NullPointerException
- ifmdName
, ormgfName
is nullIllegalArgumentException
- ifsaltLen
ortrailerField
is less than 0- Since:
- 1.5
-
PSSParameterSpec
Deprecated.This constructor uses the default values defined in the PKCS #1 standard except for the salt length. Some of these defaults are no longer recommended due to advances in cryptanalysis -- see the PKCS#1 v2.2 standard for more details. Thus, it is recommended to explicitly specify all desired parameter values with thePSSParameterSpec(String, String, AlgorithmParameterSpec, int, int)
constructor.Creates a newPSSParameterSpec
using the specified salt length and other default values as defined in the PKCS #1 standard.- Parameters:
saltLen
- the length of salt in bytes- Throws:
IllegalArgumentException
- ifsaltLen
is less than 0- External Specifications
-
-
Method Details
-
getDigestAlgorithm
Returns the message digest algorithm name.- Returns:
- the message digest algorithm name
- Since:
- 1.5
-
getMGFAlgorithm
Returns the mask generation function algorithm name.- Returns:
- the mask generation function algorithm name
- Since:
- 1.5
-
getMGFParameters
Returns the parameters for the mask generation function.- Returns:
- the parameters for the mask generation function
- Since:
- 1.5
-
getSaltLength
public int getSaltLength()Returns the salt length in bytes.- Returns:
- the salt length
-
getTrailerField
public int getTrailerField()Returns the value for the trailer field.- Returns:
- the value for the trailer field
- Since:
- 1.5
-