Sailfish Crypto

API Documentation

EcKeyPairGenerationParameters Class

(Sailfish::Crypto::EcKeyPairGenerationParameters)

Encapsulates parameters related to the generation of an asymmetric cryptographic key pair based on an elliptic curve More...

Header:	#include <Crypto/keypairgenerationparameters.h>
Inherits:	KeyPairGenerationParameters

List of all members, including inherited members

Properties

ellipticCurve : Sailfish::Crypto::CryptoManager::EllipticCurve

2 properties inherited from Sailfish::Crypto::KeyPairGenerationParameters

Public Functions

	EcKeyPairGenerationParameters()
	EcKeyPairGenerationParameters(const KeyPairGenerationParameters &other)
	~EcKeyPairGenerationParameters()
Sailfish::Crypto::CryptoManager::EllipticCurve	ellipticCurve() const
void	setEllipticCurve(Sailfish::Crypto::CryptoManager::EllipticCurve curve)
EcKeyPairGenerationParameters &	operator=(const EcKeyPairGenerationParameters &other)

Reimplemented Public Functions

virtual bool isValid() const

7 public functions inherited from Sailfish::Crypto::KeyPairGenerationParameters

Detailed Description

Encapsulates parameters related to the generation of an asymmetric cryptographic key pair based on an elliptic curve

This class encapsulates a variety of parameters which will affect how the crypto plugin generates a key pair. Usually, an instance of this class will be used when performing a GenerateStoredKeyRequest.

An example of parameters to generate an elliptic curve key pair for use in ECDSA and ECDH operations follows:

 Sailfish::Crypto::EcKeyPairGenerationParameters eckpgParams;
 eckpgParams.setEllipticCurve(Sailfish::Crypto::CryptoManager::Curve25519);

The security size of the generated key will depend on the size of the field over which the curve is defined. For example, Curve25519 is a 255-bit elliptic curve requiring 252-bit private keys (usually encoded as 256-bit values with four fixed bits), providing security approximately equivalent to using a 128-bit symmetric cipher key, or 3072 bit RSA key.

Support for different curves is entirely plugin-specific; please see the documentation for the crypto plugin you intend to use for more information about the different curves which are supported, and what (if any) custom parameters may be supported.

Property Documentation

ellipticCurve : Sailfish::Crypto::CryptoManager::EllipticCurve

Access functions:

Sailfish::Crypto::CryptoManager::EllipticCurve	ellipticCurve() const
void	setEllipticCurve(Sailfish::Crypto::CryptoManager::EllipticCurve curve)

Member Function Documentation

EcKeyPairGenerationParameters::EcKeyPairGenerationParameters()

Constructs a new instance of EcKeyPairGenerationParameters

EcKeyPairGenerationParameters::EcKeyPairGenerationParameters(const KeyPairGenerationParameters &other)

Constructs a copy of the other KeyPairGenerationParameters instance

EcKeyPairGenerationParameters::~EcKeyPairGenerationParameters()

Destroys the EcKeyPairGenerationParameters instance

Sailfish::Crypto::CryptoManager::EllipticCurve EcKeyPairGenerationParameters::ellipticCurve() const

Returns the elliptic curve which should be used to calculate the key pair

Note: Getter function for property ellipticCurve.

See also setEllipticCurve().

`[virtual]` bool EcKeyPairGenerationParameters::isValid() const

EcKeyPairGenerationParameters &EcKeyPairGenerationParameters::operator=(const EcKeyPairGenerationParameters &other)

Assigns the other EcKeyPairGenerationParameters to this instance