QCA::PGPKey Class Reference
[QCA user API]
Pretty Good Privacy key.
More...
#include <QtCrypto>
List of all members.
Detailed Description
Pretty Good Privacy key.
This holds either a reference to an item in a real PGP keyring, or a standalone item created using the from*() functions.
Note that with the latter method, the key is of no use besides being informational. The key must be in a keyring (that is, inKeyring() == true) to actually do crypto with it.
Constructor & Destructor Documentation
QCA::PGPKey::PGPKey |
( |
const QString & |
fileName |
) |
|
Create a PGP key from an encoded file.
- Parameters:
-
| fileName | the name (and path, if required) of the file that the PGP key is to be loaded from. |
- See also:
- fromFile for a version that allows better error checking / validation
-
toFile for a method to write out the key.
QCA::PGPKey::PGPKey |
( |
const PGPKey & |
from |
) |
|
Standard copy constructor.
- Parameters:
-
| from | the PGPKey to use as the source |
Member Function Documentation
Standard assignment operator.
- Parameters:
-
| from | the PGPKey to use as the source |
bool QCA::PGPKey::isNull |
( |
|
) |
const |
Test if the PGP key is empty (null).
- Returns:
- true if the PGP key is null
QString QCA::PGPKey::keyId |
( |
|
) |
const |
The Key identification for the PGP key.
QString QCA::PGPKey::primaryUserId |
( |
|
) |
const |
The primary user identification for the key.
The list of all user identifications associated with the key.
bool QCA::PGPKey::isSecret |
( |
|
) |
const |
Test if the PGP key is the secret key.
- Returns:
- true if the PGP key is the secret key
QDateTime QCA::PGPKey::creationDate |
( |
|
) |
const |
The creation date for the key.
QDateTime QCA::PGPKey::expirationDate |
( |
|
) |
const |
The expiration date for the key.
QString QCA::PGPKey::fingerprint |
( |
|
) |
const |
The key fingerpint.
This will return the PGP fingerprint as a string. It comprises 40 hex digits, without spaces.
bool QCA::PGPKey::inKeyring |
( |
|
) |
const |
Test if this key is in a keyring.
- Returns:
- true if the key is in a keyring
- Note:
- keys that are not in a keyring cannot be used for encryption, decryption, signing or verification
bool QCA::PGPKey::isTrusted |
( |
|
) |
const |
Test if the key is trusted.
- Returns:
- true if the key is trusted
Export the key to an array.
This will export the key in a binary format (that is, not in an "ascii armoured" form).
- See also:
- fromArray for a static import method.
-
toString for an "ascii armoured" export method.
QString QCA::PGPKey::toString |
( |
|
) |
const |
Export the key to a string.
This will export the key in an "ascii armoured" form.
- See also:
- fromString for a static import method.
-
toArray for a binary format export method.
bool QCA::PGPKey::toFile |
( |
const QString & |
fileName |
) |
const |
Export the key to a file.
- Parameters:
-
| fileName | the name of the file to save the key to |
Import the key from an array.
- Parameters:
-
| a | the array to import from |
| result | if not null, this will be set to the result of the import process |
| provider | the provider to use, if a particular provider is required |
Import the key from a string.
- Parameters:
-
| s | the string to import from |
| result | if not null, this will be set to the result of the import process |
| provider | the provider to use, if a particular provider is required |
Import the key from a file.
- Parameters:
-
| fileName | string containing the name of the file to import from |
| result | if not null, this will be set to the result of the import process |
| provider | the provider to use, if a particular provider is required |
The documentation for this class was generated from the following file: