QCA::PrivateKey Class Reference

Generic private key. More...

#include <QtCrypto>

Inheritance diagram for QCA::PrivateKey:

Collaboration diagram for QCA::PrivateKey:

[legend]List of all members.

Public Member Functions
	PrivateKey ()
	PrivateKey (const QString &fileName, const SecureArray &passphrase=SecureArray())
	PrivateKey (const PrivateKey &from)
PrivateKey &	operator= (const PrivateKey &from)
RSAPrivateKey	toRSA () const
DSAPrivateKey	toDSA () const
DHPrivateKey	toDH () const
bool	canDecrypt () const
bool	canSign () const
bool	decrypt (const SecureArray &in, SecureArray *out, EncryptionAlgorithm alg)
void	startSign (SignatureAlgorithm alg, SignatureFormat format=DefaultFormat)
void	update (const MemoryRegion &a)
QByteArray	signature ()
QByteArray	signMessage (const MemoryRegion &a, SignatureAlgorithm alg, SignatureFormat format=DefaultFormat)
SymmetricKey	deriveKey (const PublicKey &theirs)
SecureArray	toDER (const SecureArray &passphrase=SecureArray(), PBEAlgorithm pbe=PBEDefault) const
QString	toPEM (const SecureArray &passphrase=SecureArray(), PBEAlgorithm pbe=PBEDefault) const
bool	toPEMFile (const QString &fileName, const SecureArray &passphrase=SecureArray(), PBEAlgorithm pbe=PBEDefault) const
Static Public Member Functions
static QList< PBEAlgorithm >	supportedPBEAlgorithms (const QString &provider=QString())
static PrivateKey	fromDER (const SecureArray &a, const SecureArray &passphrase=SecureArray(), ConvertResult *result=0, const QString &provider=QString())
static PrivateKey	fromPEM (const QString &s, const SecureArray &passphrase=SecureArray(), ConvertResult *result=0, const QString &provider=QString())
static PrivateKey	fromPEMFile (const QString &fileName, const SecureArray &passphrase=SecureArray(), ConvertResult *result=0, const QString &provider=QString())
Protected Member Functions
	PrivateKey (const QString &type, const QString &provider)

---

Detailed Description

Generic private key.

Examples:

cmsexample.cpp, keyloader.cpp, publickeyexample.cpp, rsatest.cpp, and sslservtest.cpp.

---

Constructor & Destructor Documentation

QCA::PrivateKey::PrivateKey (   )

Create an empty private key.

QCA::PrivateKey::PrivateKey (  const QString &  fileName, const SecureArray &  passphrase = SecureArray() )  [explicit]

Import a private key from a PEM representation in a file. Parameters: fileName  the name of the file containing the private key passphrase  the pass phrase for the private key See also: fromPEMFile for an alternative method Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler.

QCA::PrivateKey::PrivateKey (  const PrivateKey &  from  )

Copy constructor. Parameters: from  the PrivateKey to copy from

QCA::PrivateKey::PrivateKey (  const QString &  type, const QString &  provider )  [protected]

Create a new private key. Parameters: type  the type of key to create provider  the provider to use, if a specific provider is required.

---

Member Function Documentation

PrivateKey& QCA::PrivateKey::operator= (  const PrivateKey &  from  )

Assignment operator. Parameters: from  the PrivateKey to copy from

RSAPrivateKey QCA::PrivateKey::toRSA (   )  const

Interpret / convert the key to an RSA key.

DSAPrivateKey QCA::PrivateKey::toDSA (   )  const

Interpret / convert the key to a DSA key.

DHPrivateKey QCA::PrivateKey::toDH (   )  const

Interpret / convert the key to a Diffie-Hellman key.

bool QCA::PrivateKey::canDecrypt (   )  const

Test if this key can be used for decryption. Returns: true if the key can be used for decryption Examples: publickeyexample.cpp.

bool QCA::PrivateKey::canSign (   )  const

Test if this key can be used for signing. Returns: true if the key can be used to make a signature Examples: rsatest.cpp.

bool QCA::PrivateKey::decrypt (  const SecureArray &  in, SecureArray *  out, EncryptionAlgorithm  alg )

Decrypt the message. Parameters: in  the cipher (encrypted) data out  the plain text data alg  the algorithm to use Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler. Examples: publickeyexample.cpp, and rsatest.cpp.

void QCA::PrivateKey::startSign (  SignatureAlgorithm  alg, SignatureFormat  format = DefaultFormat )

Initialise the message signature process. Parameters: alg  the algorithm to use for the message signature process format  the signature format to use, for DSA Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler. Examples: rsatest.cpp.

void QCA::PrivateKey::update (  const MemoryRegion &  a  )

Update the signature process. Parameters: a  the message to use to update the signature Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler. Examples: rsatest.cpp.

QByteArray QCA::PrivateKey::signature (   )

The resulting signature. Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler. Examples: rsatest.cpp.

QByteArray QCA::PrivateKey::signMessage (  const MemoryRegion &  a, SignatureAlgorithm  alg, SignatureFormat  format = DefaultFormat )

One step signature process. Parameters: a  the message to sign alg  the algorithm to use for the signature format  the signature format to use, for DSA Returns: the signature Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler.

SymmetricKey QCA::PrivateKey::deriveKey (  const PublicKey &  theirs  )

Derive a shared secret key from a public key. Parameters: theirs  the public key to derive from

static QList<PBEAlgorithm> QCA::PrivateKey::supportedPBEAlgorithms (  const QString &  provider = QString()  )  [static]

List the supported Password Based Encryption Algorithms that can be used to protect the key. Parameters: provider  the provider to use, if a particular provider is required

SecureArray QCA::PrivateKey::toDER (  const SecureArray &  passphrase = SecureArray(), PBEAlgorithm  pbe = PBEDefault )  const

Export the key in Distinguished Encoding Rules (DER) format. Parameters: passphrase  the pass phrase to use to protect the key pbe  the symmetric encryption algorithm to use to protect the key See also: fromDER provides an inverse of toDER, converting the DER encoded key back to a PrivateKey

QString QCA::PrivateKey::toPEM (  const SecureArray &  passphrase = SecureArray(), PBEAlgorithm  pbe = PBEDefault )  const

Export the key in Privacy Enhanced Mail (PEM) format. Parameters: passphrase  the pass phrase to use to protect the key pbe  the symmetric encryption algorithm to use to protect the key See also: toPEMFile provides a convenient way to save the PEM encoded key to a file fromPEM provides an inverse of toPEM, converting the PEM encoded key back to a PrivateKey

bool QCA::PrivateKey::toPEMFile (  const QString &  fileName, const SecureArray &  passphrase = SecureArray(), PBEAlgorithm  pbe = PBEDefault )  const

Export the key in Privacy Enhanced Mail (PEM) format to a file. Parameters: fileName  the name (and path, if required) that the key should be exported to. passphrase  the pass phrase to use to protect the key pbe  the symmetric encryption algorithm to use to protect the key Returns: true if the export succeeds See also: toPEM provides a convenient way to save the PEM encoded key to a file fromPEM provides an inverse of toPEM, converting the PEM encoded key back to a PrivateKey

static PrivateKey QCA::PrivateKey::fromDER (  const SecureArray &  a, const SecureArray &  passphrase = SecureArray(), ConvertResult *  result = 0, const QString &  provider = QString() )  [static]

Import the key from Distinguished Encoding Rules (DER) format. Parameters: a  the array containing the DER representation of the key passphrase  the pass phrase that is used to protect the key result  a pointer to a ConvertResult, that if specified, will be set to reflect the result of the import provider  the provider to use, if a particular provider is required See also: toDER provides an inverse of fromDER, exporting the key to an array QCA::KeyLoader for an asynchronous loader approach. Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler.

static PrivateKey QCA::PrivateKey::fromPEM (  const QString &  s, const SecureArray &  passphrase = SecureArray(), ConvertResult *  result = 0, const QString &  provider = QString() )  [static]

Import the key from Privacy Enhanced Mail (PEM) format. Parameters: s  the string containing the PEM representation of the key passphrase  the pass phrase that is used to protect the key result  a pointer to a ConvertResult, that if specified, will be set to reflect the result of the import provider  the provider to use, if a particular provider is required See also: toPEM provides an inverse of fromPEM, exporting the key to a string in PEM encoding. QCA::KeyLoader for an asynchronous loader approach. Note: This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler. Examples: sslservtest.cpp.

static PrivateKey QCA::PrivateKey::fromPEMFile (  const QString &  fileName, const SecureArray &  passphrase = SecureArray(), ConvertResult *  result = 0, const QString &  provider = QString() )  [static]

Import the key in Privacy Enhanced Mail (PEM) format from a file. Parameters: fileName  the name (and path, if required) of the file containing the PEM representation of the key passphrase  the pass phrase that is used to protect the key result  a pointer to a ConvertResult, that if specified, will be set to reflect the result of the import provider  the provider to use, if a particular provider is required See also: toPEMFile provides an inverse of fromPEMFile fromPEM which allows import from a string QCA::KeyLoader for an asynchronous loader approach. Note: there is also a constructor form, that allows you to create the key directly This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler. Examples: cmsexample.cpp, publickeyexample.cpp, and rsatest.cpp.

---

The documentation for this class was generated from the following file:

• qca_publickey.h

---