KeyMgr Class

Properties   Methods   Events   Config Settings   Errors  

The KeyMgr class is used to create and manage OpenPGP keys.

Syntax

KeyMgr

Remarks

The KeyMgr class supports key management according to the specifications outlined in RFC 4880, in addition to draft-ietf-openpgp-crypto-refresh-13, which introduces support for OpenPGP Version 6. You can create, delete, import, export, and manage keys, including both individual keys and keyrings.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Key Property (KeyMgr Class)

The currently selected key.

Syntax

• C++
• C
• Qt

IPWorksOpenPGPKey* GetKey();
int SetKey(IPWorksOpenPGPKey* val);

char* ipworksopenpgp_keymgr_getkeycurve(void* lpObj);

char* ipworksopenpgp_keymgr_getkeyeffectivedate(void* lpObj);

int ipworksopenpgp_keymgr_getkeyencoded(void* lpObj, char** lpKeyEncoded, int* lenKeyEncoded);
int ipworksopenpgp_keymgr_setkeyencoded(void* lpObj, const char* lpKeyEncoded, int lenKeyEncoded);

char* ipworksopenpgp_keymgr_getkeyexpirationdate(void* lpObj);

char* ipworksopenpgp_keymgr_getkeyfingerprint(void* lpObj);
int ipworksopenpgp_keymgr_setkeyfingerprint(void* lpObj, const char* lpszKeyFingerprint);

char* ipworksopenpgp_keymgr_getkeyid(void* lpObj);
int ipworksopenpgp_keymgr_setkeyid(void* lpObj, const char* lpszKeyId);

char* ipworksopenpgp_keymgr_getkeyotheruserids(void* lpObj);

char* ipworksopenpgp_keymgr_getkeypassphrase(void* lpObj);
int ipworksopenpgp_keymgr_setkeypassphrase(void* lpObj, const char* lpszKeyPassphrase);

char* ipworksopenpgp_keymgr_getkeypublickey(void* lpObj);

char* ipworksopenpgp_keymgr_getkeypublickeyalgorithm(void* lpObj);

int ipworksopenpgp_keymgr_getkeypublickeylength(void* lpObj);

int ipworksopenpgp_keymgr_getkeyrevoked(void* lpObj);

char* ipworksopenpgp_keymgr_getkeysecretkey(void* lpObj);

int ipworksopenpgp_keymgr_getkeysecretkeyavailable(void* lpObj);

char* ipworksopenpgp_keymgr_getkeyusage(void* lpObj);

int ipworksopenpgp_keymgr_getkeyusageflags(void* lpObj);

char* ipworksopenpgp_keymgr_getkeyuserid(void* lpObj);
int ipworksopenpgp_keymgr_setkeyuserid(void* lpObj, const char* lpszKeyUserId);

int ipworksopenpgp_keymgr_getkeyversion(void* lpObj);

QString GetKeyCurve();

QString GetKeyEffectiveDate();

QByteArray GetKeyEncoded();
int SetKeyEncoded(QByteArray qbaKeyEncoded);

QString GetKeyExpirationDate();

QString GetKeyFingerprint();
int SetKeyFingerprint(QString qsKeyFingerprint);

QString GetKeyId();
int SetKeyId(QString qsKeyId);

QString GetKeyOtherUserIds();

QString GetKeyPassphrase();
int SetKeyPassphrase(QString qsKeyPassphrase);

QString GetKeyPublicKey();

QString GetKeyPublicKeyAlgorithm();

int GetKeyPublicKeyLength();

bool GetKeyRevoked();

QString GetKeySecretKey();

bool GetKeySecretKeyAvailable();

QString GetKeyUsage();

int GetKeyUsageFlags();

QString GetKeyUserId();
int SetKeyUserId(QString qsKeyUserId);

int GetKeyVersion();

Remarks

This property holds the currently selected key. It is populated after calling ImportKey or after setting Keyring. This may also be set to directly load an existing key. Both public keys and secret keys are supported.

This property is not available at design time.

Data Type

IPWorksOpenPGPKey

Keyring Property (KeyMgr Class)

The location on disk of the keyring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyring();

Unicode (Windows)
LPWSTR GetKeyring();

char* ipworksopenpgp_keymgr_getkeyring(void* lpObj);

QString GetKeyring();

Default Value

""

Remarks

To load a keyring use the LoadKeyring method.

This property is read-only.

Data Type

String

AddRevoker Method (KeyMgr Class)

Adds a designated revoker to the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddRevoker(const char* lpszUserId);

Unicode (Windows)
INT AddRevoker(LPCWSTR lpszUserId);

int ipworksopenpgp_keymgr_addrevoker(void* lpObj, const char* lpszUserId);

int AddRevoker(const QString& qsUserId);

Remarks

This method adds a designated revoker to the selected Key. The UserId parameter specifies the revoker to add. The revoker's key must be present in the current keyring. Use this with caution: once added, a revoker cannot be removed. The key's passphrase is required for this operation and may be specified via Passphrase or through the KeyPassphrase event.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddUserId Method (KeyMgr Class)

Adds the specified user Id to the current key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddUserId(const char* lpszUserId);

Unicode (Windows)
INT AddUserId(LPCWSTR lpszUserId);

int ipworksopenpgp_keymgr_adduserid(void* lpObj, const char* lpszUserId);

int AddUserId(const QString& qsUserId);

Remarks

The key's passphrase is required for this operation and may be specified via Passphrase or through the KeyPassphrase event.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangeExpirationDate Method (KeyMgr Class)

Changes the expiration date of the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeExpirationDate(int iExpirationDate);

Unicode (Windows)
INT ChangeExpirationDate(INT iExpirationDate);

int ipworksopenpgp_keymgr_changeexpirationdate(void* lpObj, int iExpirationDate);

int ChangeExpirationDate(int iExpirationDate);

Remarks

This method changes the expiration date of the current Key. The ExpirationDate parameter specifies the number of days for which the key is valid starting today. For instance a value of "31" means the key is valid for the next 31 days.

The special value "0" means the key will never expire.

The key's passphrase is required for this operation and may be specified via Passphrase or through the KeyPassphrase event.

Note: See KeyValidityTime for information on specifying the expiration date when creating the key with CreateKey.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangePassphrase Method (KeyMgr Class)

Changes the passphrase of the current key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangePassphrase(const char* lpszPassphrase);

Unicode (Windows)
INT ChangePassphrase(LPCWSTR lpszPassphrase);

int ipworksopenpgp_keymgr_changepassphrase(void* lpObj, const char* lpszPassphrase);

int ChangePassphrase(const QString& qsPassphrase);

Remarks

The Passphrase parameter specifies the new passphrase.

The key's passphrase is required for this operation and may be specified via Passphrase or through the KeyPassphrase event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (KeyMgr Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksopenpgp_keymgr_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateKey Method (KeyMgr Class)

Creates an OpenPGP key pair.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateKey(const char* lpszUserId, const char* lpszPassphrase);

Unicode (Windows)
INT CreateKey(LPCWSTR lpszUserId, LPCWSTR lpszPassphrase);

int ipworksopenpgp_keymgr_createkey(void* lpObj, const char* lpszUserId, const char* lpszPassphrase);

int CreateKey(const QString& qsUserId, const QString& qsPassphrase);

Remarks

This method creates a new OpenPGP key pair. The UserId parameter specifies the user Id of the key. If KeyVersion is 6, this parameter may be an empty string.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

Additional configuration settings may be set to further configure the details of the key (and subkey) being created. Please see the following settings for details:

• KeyEncryptionAlgorithm
• KeyUsage
• KeyValidityTime
• PublicKeyLength
• PublicKeyAlgorithm
• PublicKeySignatureHashAlgorithm
• Curve
• SubKeyAlgorithm
• SubKeyLength
• SubKeyCurve
• SubKeyUsage
• UseArgon2
• Argon2Iterations
• Argon2Parallelism

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateSubKey Method (KeyMgr Class)

Creates a new subkey.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateSubKey();

Unicode (Windows)
INT CreateSubKey();

int ipworksopenpgp_keymgr_createsubkey(void* lpObj);

int CreateSubKey();

Remarks

This method creates a new subkey. Before calling this method the Id property must be set to a valid private key.

The following settings may optionally be set to define specific values for the created subkey:

• KeyValidityTime
• PublicKeyLength
• SubKeyAlgorithm
• SubKeyLength
• SubKeyCurve
• SubKeyUsage

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteKey Method (KeyMgr Class)

Deletes the specified key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteKey(const char* lpszUserId);

Unicode (Windows)
INT DeleteKey(LPCWSTR lpszUserId);

int ipworksopenpgp_keymgr_deletekey(void* lpObj, const char* lpszUserId);

int DeleteKey(const QString& qsUserId);

Remarks

This method deletes the key specified by UserId from the current keyring. Below is a table of the type of Ids that may be specified to identify the key:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportPublicKey Method (KeyMgr Class)

Exports the public key of the current key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportPublicKey(const char* lpszFileName, int buseAsciiArmor);

Unicode (Windows)
INT ExportPublicKey(LPCWSTR lpszFileName, BOOL buseAsciiArmor);

int ipworksopenpgp_keymgr_exportpublickey(void* lpObj, const char* lpszFileName, int buseAsciiArmor);

int ExportPublicKey(const QString& qsFileName, bool buseAsciiArmor);

Remarks

This method exports the public key of the currently selected Key. The FileName parameter specifies the file on disk to which the public key will be written. The UseAsciiArmor parameter determines whether or not ASCII armoring is used when writing the key to disk.

Note: When UseAsciiArmor is set to True the VersionHeader setting may also be set to specify your own header value.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportSecretKey Method (KeyMgr Class)

Exports the private key of the current key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExportSecretKey(const char* lpszFileName, int buseAsciiArmor);

Unicode (Windows)
INT ExportSecretKey(LPCWSTR lpszFileName, BOOL buseAsciiArmor);

int ipworksopenpgp_keymgr_exportsecretkey(void* lpObj, const char* lpszFileName, int buseAsciiArmor);

int ExportSecretKey(const QString& qsFileName, bool buseAsciiArmor);

Remarks

This method exports the private key of the currently selected Key. The FileName parameter specifies the file on disk that the private key will be written to. The UseAsciiArmor parameter determines whether or not ASCII armoring is used when writing the key to disk.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportKey Method (KeyMgr Class)

Imports the key specified by UserId to the current keyring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportKey(const char* lpszFileName, const char* lpszUserId);

Unicode (Windows)
INT ImportKey(LPCWSTR lpszFileName, LPCWSTR lpszUserId);

int ipworksopenpgp_keymgr_importkey(void* lpObj, const char* lpszFileName, const char* lpszUserId);

int ImportKey(const QString& qsFileName, const QString& qsUserId);

Remarks

This method imports the key specified by UserId from the key file specified by FileName into the current Keyring. The imported key will be automatically selected and available in the Key property.

If the FileName specifies a key file which contains multiple keys only the key belonging to UserId will be imported.

If UserId is set to "*" or "" (empty string) all keys in the key file will be imported. The ImportAllKeys setting controls the behavior of the class in this case.

Note: If you simply wish to select a key in the current ring set UserId instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportKeyB Method (KeyMgr Class)

Imports the key specified by UserId to the current keyring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportKeyB(const char* lpData, int lenData, const char* lpszUserId);

Unicode (Windows)
INT ImportKeyB(LPCSTR lpData, INT lenData, LPCWSTR lpszUserId);

int ipworksopenpgp_keymgr_importkeyb(void* lpObj, const char* lpData, int lenData, const char* lpszUserId);

int ImportKeyB(QByteArray qbaData, const QString& qsUserId);

Remarks

This method imports the key specified by UserId from the key data specified by Data into the current Keyring. The imported key will be automatically selected and available in the Key property.

If the Data specifies key data that contains multiple keys only the key belonging to UserId will be imported.

If UserId is set to "*" or "" (empty string) all keys in the key data will be imported. The ImportAllKeys setting controls the behavior of the class in this case.

Note: If you simply wish to select a key in the current ring set UserId instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListKeys Method (KeyMgr Class)

Lists keys in the specified Keyring .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ListKeys();

Unicode (Windows)
LPWSTR ListKeys();

char* ipworksopenpgp_keymgr_listkeys(void* lpObj);

QString ListKeys();

Remarks

This method lists the keys (public/private key pairs) in the specified keyring. The results are provided through the KeyList event.

KeyList data will also be returned from this method, however it is recommended to use the KeyList event if possible.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListSignatures Method (KeyMgr Class)

Lists all signatures of the current key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ListSignatures();

Unicode (Windows)
LPWSTR ListSignatures();

char* ipworksopenpgp_keymgr_listsignatures(void* lpObj);

QString ListSignatures();

Remarks

This method lists all the signatures of the currently selected key. The SignatureList event will fire for each signature.

SignatureList data will also be returned from this method. However, it is recommended to use the SignatureList event if possible.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListSubkeys Method (KeyMgr Class)

Lists the subkeys of the currently selected key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ListSubkeys();

Unicode (Windows)
LPWSTR ListSubkeys();

char* ipworksopenpgp_keymgr_listsubkeys(void* lpObj);

QString ListSubkeys();

Remarks

This method lists all subkeys of current key. The SubkeyList event will be fired for each subkey.

SubkeyList data will also be returned from this method, however it is recommended to use the SubkeyList event if possible.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

LoadKeyring Method (KeyMgr Class)

Loads the keyring from disk.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadKeyring(const char* lpszKeyringPath);

Unicode (Windows)
INT LoadKeyring(LPCWSTR lpszKeyringPath);

int ipworksopenpgp_keymgr_loadkeyring(void* lpObj, const char* lpszKeyringPath);

int LoadKeyring(const QString& qsKeyringPath);

Remarks

This method loads the keyring from disk. If the keyring is stored in a directory, set KeyringPath to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file KeyringPath should be set to the path of the file.

When this method is called the class will read the keyring and populate the Key property with the first key found in the keyring. Set UserId to select a different key in the current keyring.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LoadKeyringB Method (KeyMgr Class)

Loads the keyring from SecretKeyringData and PublicKeyringData .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadKeyringB(const char* lpSecretKeyringData, int lenSecretKeyringData, const char* lpPublicKeyringData, int lenPublicKeyringData);

Unicode (Windows)
INT LoadKeyringB(LPCSTR lpSecretKeyringData, INT lenSecretKeyringData, LPCSTR lpPublicKeyringData, INT lenPublicKeyringData);

int ipworksopenpgp_keymgr_loadkeyringb(void* lpObj, const char* lpSecretKeyringData, int lenSecretKeyringData, const char* lpPublicKeyringData, int lenPublicKeyringData);

int LoadKeyringB(QByteArray qbaSecretKeyringData, QByteArray qbaPublicKeyringData);

Remarks

This method loads the keyring from SecretKeyringData and PublicKeyringData.

When this method is called the class will read the keyring and populate the Key property with the first key found in the keyring. Set UserId to select a different key in the current keyring.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (KeyMgr Class)

Resets the class properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksopenpgp_keymgr_reset(void* lpObj);

int Reset();

Remarks

This method resets all message and key properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RevokeKey Method (KeyMgr Class)

Revokes the specified key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* RevokeKey(const char* lpszKeyId);

Unicode (Windows)
LPWSTR RevokeKey(LPCWSTR lpszKeyId);

char* ipworksopenpgp_keymgr_revokekey(void* lpObj, const char* lpszKeyId);

QString RevokeKey(const QString& qsKeyId);

Remarks

This method revokes the key specified by KeyId and returns the revocation certificate.

When creating a revocation certificate there are two supported formats. The first format includes only the revocation signature. This format is returned by this method. The second format includes both the public key and the revocation signature. This format can be obtained by calling ExportPublicKey after calling this method. Both formats are common, and both formats are acceptable when calling ImportKey.

Before calling this method a key must be selected and available in the Key property.

The KeyId may be the Id of the main key or a subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SaveKeyring Method (KeyMgr Class)

Saves the current Keyring to disk.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveKeyring(const char* lpszKeyringPath);

Unicode (Windows)
INT SaveKeyring(LPCWSTR lpszKeyringPath);

int ipworksopenpgp_keymgr_savekeyring(void* lpObj, const char* lpszKeyringPath);

int SaveKeyring(const QString& qsKeyringPath);

Remarks

This method saves the current keyring to disk. There are two output options. The keyring may either be saved to a single key file or may be saved to a directory.

To save the keyring to a directory set KeyringPath to the path. The directory must already exist. The class will create a "pubring.gpg" and "secring.gpg" file in the specified directory. If the files already exist they will be overwritten.

To save the keyring to a key file set KeyringPath to a path and file name. If the file already exists it will be overwritten.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SignUserId Method (KeyMgr Class)

Signs the specified user Id of the current key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignUserId(const char* lpszUserId, const char* lpszIssuerUserId);

Unicode (Windows)
INT SignUserId(LPCWSTR lpszUserId, LPCWSTR lpszIssuerUserId);

int ipworksopenpgp_keymgr_signuserid(void* lpObj, const char* lpszUserId, const char* lpszIssuerUserId);

int SignUserId(const QString& qsUserId, const QString& qsIssuerUserId);

Remarks

This method signs the UserId with the IssuerUserId.

To sign all user Ids in the current key set the UserId parameter to "*".

The key's passphrase is required for this operation and may be specified via Passphrase or through the KeyPassphrase event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyPassphrase Method (KeyMgr Class)

Verifies the passphrase of specified key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool VerifyPassphrase(const char* lpszPassphrase);

Unicode (Windows)
INT VerifyPassphrase(LPCWSTR lpszPassphrase);

bool ipworksopenpgp_keymgr_verifypassphrase(void* lpObj, const char* lpszPassphrase);

bool VerifyPassphrase(const QString& qsPassphrase);

Remarks

This method verifies the passphrase of the key specified by UserId.

If the password is correct, this method returns True; otherwise, this method returns False.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Error Event (KeyMgr Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(KeyMgrErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} KeyMgrErrorEventParams;


Unicode (Windows)
virtual INT FireError(KeyMgrErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} KeyMgrErrorEventParams;

#define EID_KEYMGR_ERROR 1

virtual INT IPWORKSOPENPGP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class KeyMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(KeyMgrErrorEventParams *e);

// Or, subclass KeyMgr and override this emitter function.
virtual int FireError(KeyMgrErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

KeyList Event (KeyMgr Class)

Fires for each key in the keyring when ListKeys is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireKeyList(KeyMgrKeyListEventParams *e);

typedef struct {
  const char *UserId;
  const char *KeyId;
  const char *Fingerprint;
  int HasSecretKey;
  const char *PublicKeyAlgorithm;
  int PublicKeyLength;
  const char *Curve;
  int reserved;
} KeyMgrKeyListEventParams;


Unicode (Windows)
virtual INT FireKeyList(KeyMgrKeyListEventParams *e);

typedef struct {
  LPCWSTR UserId;
  LPCWSTR KeyId;
  LPCWSTR Fingerprint;
  BOOL HasSecretKey;
  LPCWSTR PublicKeyAlgorithm;
  INT PublicKeyLength;
  LPCWSTR Curve;
  INT reserved;
} KeyMgrKeyListEventParams;

#define EID_KEYMGR_KEYLIST 2

virtual INT IPWORKSOPENPGP_CALL FireKeyList(LPSTR &lpszUserId, LPSTR &lpszKeyId, LPSTR &lpszFingerprint, BOOL &bHasSecretKey, LPSTR &lpszPublicKeyAlgorithm, INT &iPublicKeyLength, LPSTR &lpszCurve);

class KeyMgrKeyListEventParams {
public:
  const QString &UserId();

  const QString &KeyId();

  const QString &Fingerprint();

  bool HasSecretKey();

  const QString &PublicKeyAlgorithm();

  int PublicKeyLength();

  const QString &Curve();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void KeyList(KeyMgrKeyListEventParams *e);

// Or, subclass KeyMgr and override this emitter function.
virtual int FireKeyList(KeyMgrKeyListEventParams *e) {...}

Remarks

This event fires once for each key in the Keyring when ListKeys is called.

UserId holds the current user Id of the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

HasSecretKey returns True if the key contains a secret key.

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448

PublicKeyLength is the length of the public key. Common values are 512, 1024, and 2048. If the PublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448, the length of the public key is determined by the Curve. Possible lengths are:

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448. Possible values are:

KeyPassphrase Event (KeyMgr Class)

Fired if the passphrase of current key is incorrect or empty.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireKeyPassphrase(KeyMgrKeyPassphraseEventParams *e);

typedef struct {
  const char *UserId;
  const char *KeyId;
  const char *Fingerprint;
  char *Passphrase;
  int reserved;
} KeyMgrKeyPassphraseEventParams;


Unicode (Windows)
virtual INT FireKeyPassphrase(KeyMgrKeyPassphraseEventParams *e);

typedef struct {
  LPCWSTR UserId;
  LPCWSTR KeyId;
  LPCWSTR Fingerprint;
  LPWSTR Passphrase;
  INT reserved;
} KeyMgrKeyPassphraseEventParams;

#define EID_KEYMGR_KEYPASSPHRASE 3

virtual INT IPWORKSOPENPGP_CALL FireKeyPassphrase(LPSTR &lpszUserId, LPSTR &lpszKeyId, LPSTR &lpszFingerprint, LPSTR &lpszPassphrase);

class KeyMgrKeyPassphraseEventParams {
public:
  const QString &UserId();

  const QString &KeyId();

  const QString &Fingerprint();

  const QString &Passphrase();
  void SetPassphrase(const QString &qsPassphrase);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void KeyPassphrase(KeyMgrKeyPassphraseEventParams *e);

// Or, subclass KeyMgr and override this emitter function.
virtual int FireKeyPassphrase(KeyMgrKeyPassphraseEventParams *e) {...}

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the Passphrase field before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

UserId holds the user Id of the key the passphrase is required for.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

SignatureList Event (KeyMgr Class)

Fires for each signature of the current key when ListSignatures is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSignatureList(KeyMgrSignatureListEventParams *e);

typedef struct {
  const char *KeyId;
  const char *Fingerprint;
  const char *UserId;
  const char *IssuerFingerprint;
  const char *IssuerKeyId;
  const char *IssuerUserId;
  const char *PublicKeyAlgorithm;
  const char *Curve;
  const char *HashAlgorithm;
  const char *EffectiveDate;
  int SignatureClass;
  int ValidityStatus;
  int reserved;
} KeyMgrSignatureListEventParams;


Unicode (Windows)
virtual INT FireSignatureList(KeyMgrSignatureListEventParams *e);

typedef struct {
  LPCWSTR KeyId;
  LPCWSTR Fingerprint;
  LPCWSTR UserId;
  LPCWSTR IssuerFingerprint;
  LPCWSTR IssuerKeyId;
  LPCWSTR IssuerUserId;
  LPCWSTR PublicKeyAlgorithm;
  LPCWSTR Curve;
  LPCWSTR HashAlgorithm;
  LPCWSTR EffectiveDate;
  INT SignatureClass;
  INT ValidityStatus;
  INT reserved;
} KeyMgrSignatureListEventParams;

#define EID_KEYMGR_SIGNATURELIST 4

virtual INT IPWORKSOPENPGP_CALL FireSignatureList(LPSTR &lpszKeyId, LPSTR &lpszFingerprint, LPSTR &lpszUserId, LPSTR &lpszIssuerFingerprint, LPSTR &lpszIssuerKeyId, LPSTR &lpszIssuerUserId, LPSTR &lpszPublicKeyAlgorithm, LPSTR &lpszCurve, LPSTR &lpszHashAlgorithm, LPSTR &lpszEffectiveDate, INT &iSignatureClass, INT &iValidityStatus);

class KeyMgrSignatureListEventParams {
public:
  const QString &KeyId();

  const QString &Fingerprint();

  const QString &UserId();

  const QString &IssuerFingerprint();

  const QString &IssuerKeyId();

  const QString &IssuerUserId();

  const QString &PublicKeyAlgorithm();

  const QString &Curve();

  const QString &HashAlgorithm();

  const QString &EffectiveDate();

  int SignatureClass();

  int ValidityStatus();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureList(KeyMgrSignatureListEventParams *e);

// Or, subclass KeyMgr and override this emitter function.
virtual int FireSignatureList(KeyMgrSignatureListEventParams *e) {...}

Remarks

This event fires once for each signature of the current key when ListSignatures is called.

The KeyId, UserId, and Fingerprint parameters contain relevant information for the current key. Similarly, the IssuerKeyId, IssuerUserId, and IssuerFingerprint parameters contain relevant information for the issuer's key. The format of these parameters are described below.

KeyId and IssuerKeyId hold the hex-encoded, 4- or 8-byte Id of the respective key. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

UserId and IssuerUserId hold the user Id of the respective key. The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

Fingerprint and IssuerFingerprint hold the hex-encoded, 20-byte fingerprint of the respective key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Note that if IssuerUserId and IssuerFingerprint are empty, this indicates that the issuer's key could not be found in the current keyring.

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448. Possible values are:

HashAlgorithm is the hash algorithm used by the signature. Possible values are:

• SHA1
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

EffectiveDate is the date when this signature became valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00 .

SignatureClass is the type of signature. Possible values are:

ValidityStatus specifies the current validity status of the signature. Possible values are:

Status Event (KeyMgr Class)

Shows the progress of the operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(KeyMgrStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} KeyMgrStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(KeyMgrStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} KeyMgrStatusEventParams;

#define EID_KEYMGR_STATUS 5

virtual INT IPWORKSOPENPGP_CALL FireStatus(LPSTR &lpszMessage);

class KeyMgrStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(KeyMgrStatusEventParams *e);

// Or, subclass KeyMgr and override this emitter function.
virtual int FireStatus(KeyMgrStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

SubkeyList Event (KeyMgr Class)

Fires once for each subkey listed when ListSubkeys is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSubkeyList(KeyMgrSubkeyListEventParams *e);

typedef struct {
  const char *KeyId;
  const char *Fingerprint;
  const char *PublicKeyAlgorithm;
  int PublicKeyLength;
  const char *Curve;
  int UsageFlags;
  const char *Usage;
  const char *EffectiveDate;
  const char *ExpirationDate;
  int Revoked;
  int reserved;
} KeyMgrSubkeyListEventParams;


Unicode (Windows)
virtual INT FireSubkeyList(KeyMgrSubkeyListEventParams *e);

typedef struct {
  LPCWSTR KeyId;
  LPCWSTR Fingerprint;
  LPCWSTR PublicKeyAlgorithm;
  INT PublicKeyLength;
  LPCWSTR Curve;
  INT UsageFlags;
  LPCWSTR Usage;
  LPCWSTR EffectiveDate;
  LPCWSTR ExpirationDate;
  BOOL Revoked;
  INT reserved;
} KeyMgrSubkeyListEventParams;

#define EID_KEYMGR_SUBKEYLIST 6

virtual INT IPWORKSOPENPGP_CALL FireSubkeyList(LPSTR &lpszKeyId, LPSTR &lpszFingerprint, LPSTR &lpszPublicKeyAlgorithm, INT &iPublicKeyLength, LPSTR &lpszCurve, INT &iUsageFlags, LPSTR &lpszUsage, LPSTR &lpszEffectiveDate, LPSTR &lpszExpirationDate, BOOL &bRevoked);

class KeyMgrSubkeyListEventParams {
public:
  const QString &KeyId();

  const QString &Fingerprint();

  const QString &PublicKeyAlgorithm();

  int PublicKeyLength();

  const QString &Curve();

  int UsageFlags();

  const QString &Usage();

  const QString &EffectiveDate();

  const QString &ExpirationDate();

  bool Revoked();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SubkeyList(KeyMgrSubkeyListEventParams *e);

// Or, subclass KeyMgr and override this emitter function.
virtual int FireSubkeyList(KeyMgrSubkeyListEventParams *e) {...}

Remarks

This event fires once for each subkey when ListSubkeys is called.

KeyId is the hex-encoded, 4- or 8-byte Id of the key. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

PublicKeyAlgorithm is the public key algorithm of the subkey. Possible values are:

• RSA
• DSA
• ElGamal
• ECDSA
• EdDSA
• ECDH
• Ed25519
• Ed448
• X25519
• X448

PublicKeyLength is the length of the subkey. Common values are 512, 1024, and 2048. If PublicKeyAlgorithm is ECDSA, EdDSA, ECDH, Ed25519, Ed448, X25519, or X448, the length of the public key is determined by the Curve. Possible lengths are:

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA, EdDSA, ECDH, Ed25519, Ed448, X25519, or X448. Possible values are:

Usage is the textual description of UsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

UsageFlags is an integer flag that shows the intended use for the key. The value is a combination of the following flags:

EffectiveDate is the date when this key became valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00.

ExpirationDate is the date the key expires. After this date the key will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. If the ExpirationDate is not populated this indicates that the key never expires.

Revoked Indicates whether the subkey is revoked or not.

Key Type

The OpenPGP key being used.

Syntax

IPWorksOpenPGPKey (declared in ipworksopenpgp.h)

Remarks

This type describes the current key. The key may be a public or secret key. The fields are used to identify or select the key.

Fields

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

5E70662EA810E768

FirstName LastName (Comment) <Email>

Config Settings (KeyMgr Class)

KeyMgr Config Settings

5E70662EA810E768

Base Config Settings

Trappable Errors (KeyMgr Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

OpenPGP Errors