iaik.pkcs.pkcs5

Class PBMAC1Parameters

java.lang.Object

java.security.AlgorithmParametersSpi

iaik.pkcs.pkcs5.PBMAC1Parameters

public class PBMAC1Parameters
extends java.security.AlgorithmParametersSpi

This class represents PBMAC1 parameters in opaque form for the PKCS#5 PBMAC1 password-based Message Authentication Scheme as specified by PKCS#5 v2.1 (RFC 8018).

PBMAC1 uses a message authentication scheme like HMAC for calculating the mac value with a secret key derived from a password by using a key derivation function like PBKDF2. The message authentication scheme and key derivation function to be used have to be specified by PBMAC1 parameters (see RFC 8018):

PBMAC1 parameters specify message authentication scheme and key derivation function to be used (see RFC 8018):

 PBMAC1-params ::= SEQUENCE {
   keyDerivationFunc AlgorithmIdentifier {{PBMAC1-KDFs}},
   encryptionScheme AlgorithmIdentifier {{PBMAC1-Encs}} }
   
 PBMAC1-KDFs ALGORITHM-IDENTIFIER ::=
   { {PBKDF2-params IDENTIFIED BY id-PBKDF2}, ... }
   
 PBMAC1-Encs ALGORITHM-IDENTIFIER ::= { ... }
 

PBMAC1Parameters can be generated by calling one of the AlgorithmParameters.getInstance methods. Subsequently the new AlgorithmParameters object must be initialized with a proper PBMAC1 parameter specification or a DER encoded byte array, e.g.:

 PBMAC1ParameterSpec paramSpec = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("PBMAC1", "IAIK");
 params.init(paramSpec);
 

respectively:

 byte[] encodedParams = ...;
 AlgorithmParameters params = AlgorithmParameters.getInstance("PBMAC1", "IAIK");
 params.init(encodedParams);
 

For obtaining PBMAC1 parameters in transparent representation from an opaque PBMAC1Parameters object, the getParameterSpec method can be used; for obtaining the parameters as DER encoded ASN.1 object, use method getEncoded:

 PBMAC1ParameterSpec paramSpec = (PBMAC1ParameterSpec) params
     .getParameterSpec(PBMAC1ParameterSpec.class);
 

respectively

 byte[] encodedParams = params.getEncoded();
 

Version:

File Revision 15

See Also:

PBMAC1ParameterSpec, AlgorithmParameters

Constructor Summary

Constructors

Constructor and Description
PBMAC1Parameters() The default constructor.

Method Summary

Modifier and Type	Method and Description
protected byte[]	engineGetEncoded() Returns the (DER) encoded PBMAC1 parameters.
protected byte[]	engineGetEncoded(java.lang.String format) Returns the (DER) encoded PBMAC1 parameters.
protected java.security.spec.AlgorithmParameterSpec	engineGetParameterSpec(java.lang.Class paramSpec) Returns the PBMAC1 parameters as transparent PBMAC1 parameter specification of the given class type.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec paramSpec) Initializes this PBMAC1Parameters with the given PBMAC1ParameterSpec.
protected void	engineInit(byte[] params) Initializes this PBMAC1Parameters object from the given DER encoded byte array.
protected void	engineInit(byte[] params, java.lang.String format) Inits the parameters from an DER encoded byte array.
protected java.lang.String	engineToString() Returns a String representation of the parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PBMAC1Parameters

public PBMAC1Parameters()

The default constructor. Only internally used for creating a PBMAC1Parameters object. Applications shall use one of the AlgorithmParameters.getInstance("PBMAC1", "IAIK") factory methods for obtaining PBMAC1Parameters.

Method Detail

engineGetEncoded

protected byte[] engineGetEncoded()
                           throws java.io.IOException

Returns the (DER) encoded PBMAC1 parameters.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Returns:

the PBMAC1 parameters as DER byte array

Throws:

java.io.IOException - if an encoding error occurs

engineGetEncoded

protected byte[] engineGetEncoded(java.lang.String format)
                           throws java.io.IOException

Returns the (DER) encoded PBMAC1 parameters.

Format is ignored. Only DER encoding is supported at this time. This method only calls engineGetEncoded() for returning the PBMAC1 parameters as DER encoded byte array, regardless of what is specified in the format string.

Specified by:

engineGetEncoded in class java.security.AlgorithmParametersSpi

Parameters:

format - the encoding format; ignored

Returns:

the PBMAC1 parameters as DER byte array

Throws:

java.io.IOException - if an encoding error occurs

engineGetParameterSpec

protected java.security.spec.AlgorithmParameterSpec engineGetParameterSpec(java.lang.Class paramSpec)
                                                                    throws java.security.spec.InvalidParameterSpecException

Returns the PBMAC1 parameters as transparent PBMAC1 parameter specification of the given class type.

Specified by:

engineGetParameterSpec in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the desired parameter specification class, must be PBMAC1ParameterSpec.class

Returns:

the PBMAC1 parameters as PBMAC1ParameterSpec

Throws:

java.security.spec.InvalidParameterSpecException - if the parameters cannot be converted to the desired parameter specification

engineInit

protected void engineInit(java.security.spec.AlgorithmParameterSpec paramSpec)
                   throws java.security.spec.InvalidParameterSpecException

Initializes this PBMAC1Parameters with the given PBMAC1ParameterSpec.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

paramSpec - the parameter specification, which has to be a PBMAC1ParameterSpec

Throws:

java.security.spec.InvalidParameterSpecException - if the given parameter specification is not a PBMAC1ParameterSpec

engineInit

protected void engineInit(byte[] params)
                   throws java.io.IOException

Initializes this PBMAC1Parameters object from the given DER encoded byte array.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the DER encoded PBMAC1 parameters

Throws:

java.io.IOException - if an error occurs when decoding the given byte array

engineInit

protected void engineInit(byte[] params,
                          java.lang.String format)
                   throws java.io.IOException

Inits the parameters from an DER encoded byte array. Format is ignored. Only calls engineInit(params) for initializing this PBMAC1Parameters object from the given DER encoded byte array, regardless of what is specified in the format string.

Specified by:

engineInit in class java.security.AlgorithmParametersSpi

Parameters:

params - the DER encoded PBMAC1 parameters

format - the encoding format; ignored

Throws:

java.io.IOException - if an error occurs when decoding the given byte array

engineToString

protected java.lang.String engineToString()

Returns a String representation of the parameters.

Specified by:

engineToString in class java.security.AlgorithmParametersSpi

Returns:

a String representation of this PBKDF2 parameters