ECIESParameterSpec (ECCelerate 6.2 API)

java.lang.Object
- iaik.security.ec.ecies.ECIESParameterSpec

All Implemented Interfaces:

AlgorithmParameterSpec
```
public final class ECIESParameterSpec
extends Object
implements AlgorithmParameterSpec
```
This class specifies the set of parameters for use with the Elliptic Curve Integrated Encryption Scheme (ECIES).
References:
[1] Certicom Research. 2009. Standards for Efficient Cryptography - SEC 1: Elliptic Curve Cryptography v2.0

Author:

Christian Wagner

See Also:

ECIES, AlgorithmParameterSpec

Field Summary

Fields
Modifier and Type	Field and Description
`static iaik.asn1.structures.AlgorithmID`	`DEFAULT_KDF_MD` Default KDF-message digest
`static String`	`DEFAULT_KEY_AGREEMENT` Default KeyAgreement protocol
`static String`	`DEFAULT_MAC` Default MAC function
`static String`	`DEFAULT_SYM_CIPHER` Default symmetric cipher

Constructor Summary

Constructors
Constructor and Description
`ECIESParameterSpec()` Creates a new instance.
`ECIESParameterSpec(KDFParameterSpec kdfparams)` Creates a new instance.
`ECIESParameterSpec(KDFParameterSpec kdfparams, String symmetricCipherName, iaik.asn1.structures.AlgorithmID macID)` Creates a new instance.
`ECIESParameterSpec(KDFParameterSpec kdfparams, String symmetricCipherName, iaik.asn1.structures.AlgorithmID macID, byte[] macEncodingParameter)` Creates a new instance.
`ECIESParameterSpec(KDFParameterSpec kdfparams, String symmetricCipherName, String macName)` Creates a new instance.
`ECIESParameterSpec(KDFParameterSpec kdfparams, String symmetricCipherName, String macName, byte[] macEncodingParameter)` Creates a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ECIESParameterSpec`	`decode(iaik.asn1.ASN1Object parameters)` Creates a new `ECIESParameterSpec` object from the specified ASN.1 structure.
`static ECIESParameterSpec`	`decode(iaik.asn1.ASN1Object parameters, byte[] macEncodingParameter)` Creates a new `ECIESParameterSpec` object from the specified ASN.1 structure.
`int`	`getCipherKeyLength()` Returns the key length of the symmetric cipher in bytes. If in internal XOR mode the length will be `0`.
`static iaik.asn1.structures.AlgorithmID`	`getDefaultKDFMessageDigest()` Returns the algorithm identifier of the default key derivation message.
`static String`	`getDefaultMacName()` Returns the name of the default MAC function.
`static String`	`getDefaultSymmetricCipherName()` Returns the name of the default symmetric cipher.
`KDFParameterSpec`	`getKDFParams()` Returns the key derivation function parameter.
`static String`	`getKeyAgreementName()` Returns the name for the ECDH-KeyAgreement. If not set the name of the default ECDH-KeyAgreement is returned.
`byte[]`	`getMacEncodingParameter()` Returns the MAC encoding parameter.
`int`	`getMacLength()` Returns the length of the MAC function.
`iaik.asn1.structures.AlgorithmID`	`getMacMD()` Returns the algorithm identifier of the MAC function's message digest.
`String`	`getMacName()` Returns the name of the MAC function.
`static Enumeration<String>`	`getMACNames()` Returns the standard names of the supported MAC functions.
`String`	`getSymmetricCipherName()` Returns the name of the symmetric cipher.
`static Enumeration<String>`	`getSymmetricCipherNames()` Returns the standard names of the supported symmetric ciphers.
`iaik.asn1.ASN1Object`	`toASN1Object()` This method returns the following ASN.1 structure (according to [1]):

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SYM_CIPHER
```
public static final String DEFAULT_SYM_CIPHER
```
    Default symmetric cipher
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAC
```
public static final String DEFAULT_MAC
```
    Default MAC function
    
    See Also:
    
    Constant Field Values
  - DEFAULT_KEY_AGREEMENT
```
public static final String DEFAULT_KEY_AGREEMENT
```
    Default KeyAgreement protocol
    
    See Also:
    
    Constant Field Values
  - DEFAULT_KDF_MD
```
public static final iaik.asn1.structures.AlgorithmID DEFAULT_KDF_MD
```
    Default KDF-message digest
- Constructor Detail
  - ECIESParameterSpec
```
public ECIESParameterSpec()
```
    Creates a new instance.
  - ECIESParameterSpec
```
public ECIESParameterSpec(KDFParameterSpec kdfparams)
```
    Creates a new instance.
    
    Parameters:
    
    kdfparams - parameter for the key derivation function
  - ECIESParameterSpec
```
public ECIESParameterSpec(KDFParameterSpec kdfparams,
                          String symmetricCipherName,
                          String macName)
```
    Creates a new instance.
    
    Parameters:
    
    kdfparams - parameter for the key derivation function
    
    symmetricCipherName - name of the symmetric cipher
    
    macName - name of the MAC function
  - ECIESParameterSpec
```
public ECIESParameterSpec(KDFParameterSpec kdfparams,
                          String symmetricCipherName,
                          iaik.asn1.structures.AlgorithmID macID)
```
    Creates a new instance.
    
    Parameters:
    
    kdfparams - parameter for the key derivation function
    
    symmetricCipherName - name of the symmetric cipher
    
    macID - AlgorithmID of the MAC function
  - ECIESParameterSpec
```
public ECIESParameterSpec(KDFParameterSpec kdfparams,
                          String symmetricCipherName,
                          String macName,
                          byte[] macEncodingParameter)
```
    Creates a new instance.
    
    Parameters:
    
    kdfparams - parameter for the key derivation function
    
    symmetricCipherName - name of the symmetric cipher
    
    macName - name of the MAC function
    
    macEncodingParameter - encoding parameter for the MAC function
  - ECIESParameterSpec
```
public ECIESParameterSpec(KDFParameterSpec kdfparams,
                          String symmetricCipherName,
                          iaik.asn1.structures.AlgorithmID macID,
                          byte[] macEncodingParameter)
```
    Creates a new instance.
    
    Parameters:
    
    kdfparams - parameter for the key derivation function
    
    symmetricCipherName - name of the symmetric cipher
    
    macID - AlgorithmID of the MAC function
    
    macEncodingParameter - encoding parameter for the MAC function
- Method Detail
  - toASN1Object
```
public iaik.asn1.ASN1Object toASN1Object()
```
    This method returns the following ASN.1 structure (according to [1]):
```
 ECIESParameters ::= SEQUENCE {
     kdf [0] KeyDerivationFunction OPTIONAL,
     sym [1] SymmetricEncryption OPTIONAL,
     mac [2] MessageAuthenticationCode OPTIONAL
 }
 
```
    with
```
 KeyDerivationFunction ::= AlgorithmIdentifier {{KDFSet}}

 KDFSet ALGORITHM ::= {
     {OID x9-63-kdf PARMS HashAlgorithm } |
     {OID nist-concatenation-kdf PARMS HashAlgorithm } |
     {OID tls-kdf PARMS HashAlgorithm } |
     {OID ikev2-kdf PARMS HashAlgorithm }
 }
 
```
```
 SymmetricEncryption ::= AlgorithmIdentifier {{SYMENCSet}}

 SYMENCSet ALGORITHM ::= {
     { OID xor-in-ecies } |
     { OID tdes-cbc-in-ecies } |
     { OID aes128-cbc-in-ecies } |
     { OID aes192-cbc-in-ecies } |
     { OID aes256-cbc-in-ecies } |
     { OID aes128-ctr-in-ecies } |
     { OID aes192-ctr-in-ecies } |
     { OID aes256-ctr-in-ecies }
 }
 
```
```
 MessageAuthenticationCode ::= AlgorithmIdentifier {{MACSet}}

 MACSet ALGORITHM ::= {
    { OID hmac-full-ecies PARMS HashAlgorithm} |
    { OID hmac-half-ecies PARMS HashAlgorithm} |
    { OID cmac-aes128-ecies } |
    { OID cmac-aes192-ecies } |
    { OID cmac-aes256-ecies }
 }

 
```
    Returns:
    
    an ASN1Object instance
  - decode
```
public static ECIESParameterSpec decode(iaik.asn1.ASN1Object parameters)
```
    Creates a new ECIESParameterSpec object from the specified ASN.1 structure.
    
    Parameters:
    
    parameters - the ASN.1 object
    
    Returns:
    
    an ECIESParameterSpec instance
  - decode
```
public static ECIESParameterSpec decode(iaik.asn1.ASN1Object parameters,
                                        byte[] macEncodingParameter)
```
    Creates a new ECIESParameterSpec object from the specified ASN.1 structure.
    
    Parameters:
    
    parameters - the ASN.1 object
    
    macEncodingParameter - encoding parameter for the MAC function
    
    Returns:
    
    an ECIESParameterSpec instance
  - getSymmetricCipherName
```
public String getSymmetricCipherName()
```
    Returns the name of the symmetric cipher.
    
    Returns:
    
    the name of the symmetric cipher
  - getDefaultSymmetricCipherName
```
public static String getDefaultSymmetricCipherName()
```
    Returns the name of the default symmetric cipher.
    
    Returns:
    
    the name of the default symmetric cipher
  - getMacMD
```
public iaik.asn1.structures.AlgorithmID getMacMD()
```
    Returns the algorithm identifier of the MAC function's message digest.
    
    Returns:
    
    an algorithm identifier
  - getMacName
```
public String getMacName()
```
    Returns the name of the MAC function.
    
    Returns:
    
    the name
  - getDefaultMacName
```
public static String getDefaultMacName()
```
    Returns the name of the default MAC function.
    
    Returns:
    
    the default name
  - getDefaultKDFMessageDigest
```
public static iaik.asn1.structures.AlgorithmID getDefaultKDFMessageDigest()
```
    Returns the algorithm identifier of the default key derivation message. digest
    
    Returns:
    
    the default algorithm identifier
  - getMacLength
```
public int getMacLength()
```
    Returns the length of the MAC function.
    
    Returns:
    
    the length
  - getKDFParams
```
public KDFParameterSpec getKDFParams()
```
    Returns the key derivation function parameter.
    
    Returns:
    
    the key derivation function parameter.
  - getMacEncodingParameter
```
public byte[] getMacEncodingParameter()
```
    Returns the MAC encoding parameter.
    
    Returns:
    
    the MAC encoding parameter.
  - getCipherKeyLength
```
public int getCipherKeyLength()
```
    Returns the key length of the symmetric cipher in bytes.
    If in internal XOR mode the length will be 0.
    
    Returns:
    
    the key length in bytes
  - getKeyAgreementName
```
public static String getKeyAgreementName()
```
    Returns the name for the ECDH-KeyAgreement.
    If not set the name of the default ECDH-KeyAgreement is returned.
    
    Returns:
    
    the name of the KeyAgreement
  - getMACNames
```
public static Enumeration<String> getMACNames()
```
    Returns the standard names of the supported MAC functions.
    
    Returns:
    
    an enumeration holding the standard names
  - getSymmetricCipherNames
```
public static Enumeration<String> getSymmetricCipherNames()
```
    Returns the standard names of the supported symmetric ciphers.
    
    Returns:
    
    an enumeration holding the standard names

Class ECIESParameterSpec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SYM_CIPHER

DEFAULT_MAC

DEFAULT_KEY_AGREEMENT

DEFAULT_KDF_MD

Constructor Detail

ECIESParameterSpec

ECIESParameterSpec

ECIESParameterSpec

ECIESParameterSpec

ECIESParameterSpec

ECIESParameterSpec

Method Detail

toASN1Object

decode

decode

getSymmetricCipherName

getDefaultSymmetricCipherName

getMacMD

getMacName

getDefaultMacName

getDefaultKDFMessageDigest

getMacLength

getKDFParams

getMacEncodingParameter

getCipherKeyLength

getKeyAgreementName

getMACNames

getSymmetricCipherNames