PGPKeyManager Class
Properties Methods Events Configuration Settings Errors
The PGPKeyManager class manages PGP keys.
Syntax
PGPKeyManager
Remarks
PGPKeyManager allows you to load, save, generate, import, and export PGP keys.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| FIPSMode | Reserved. |
| KeyBitsInKey | Indicates the key length in bits. |
| KeyCurve | Indicates the elliptic curve associated with a EC key. |
| KeyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
| KeyExpires | Indicates key expiration time in whole days from its generation moment. |
| KeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| KeyHashAlgorithm | Specifies the hash algorithm associated with the key. |
| KeyOldPacketFormat | Indicates whether legacy (PGP 2. |
| KeyPassphrase | The key protection password. |
| KeyProtection | Specifies the level of protection applied to the secret key. |
| KeyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
| KeyQBits | The length of the DSA Q (legitimate range: 160-512). |
| KeyUsername | Specifies the name of the user bound to this key. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddSubkey | Adds a new subkey to the Key. |
| BindUser | Binds a new UserID to the Key. |
| ChangePassphrase | Changes the password of the secret key. |
| ChangeProtection | Changes the protection level of the secret key. |
| CheckPassphrase | Checks if the password matches the secret key. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| ExportKey | Serializes the key to a byte array. |
| ExportPublicKey | Exports the public key to a byte array. |
| ExportPublicToFile | Exports the public key to a file. |
| ExportToFile | Exports the key to a file. |
| Generate | Generates a new single PGP key. |
| GenerateLegacy | Generates a new key in the old format. |
| GeneratePair | Generates a new pair of PGP keys. |
| ImportFromFile | Loads a key from a file. |
| ImportKey | Loads a key from a byte array. |
| RemoveSubkey | Removes the specified subkey from the key. |
| RemoveUser | Unbinds the specified user from the key. |
| RevokeKey | Revokes the key. |
| RevokeSubkey | Revokes the key's subkey. |
| RevokeSubkeybyID | Revokes the key's subkey. |
| RevokeUser | Revokes a user certification. |
| RevokeUserByName | Revokes a user certification. |
| Validate | Validates the key. |
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.
| Error | Information about errors during PGP key management. |
| Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| TempPath | Path for storing temporary files. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| Tag | Allows to store any custom data. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
FIPSMode Property (PGPKeyManager Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
KeyBitsInKey Property (PGPKeyManager Class)
Indicates the key length in bits.
Syntax
int GetKeyBitsInKey();
int SetKeyBitsInKey(int iKeyBitsInKey);
Default Value
2048
Remarks
Indicates the key length in bits.
This property is not available at design time.
Data Type
Integer
KeyCurve Property (PGPKeyManager Class)
Indicates the elliptic curve associated with a EC key.
Syntax
QString GetKeyCurve();
int SetKeyCurve(QString qsKeyCurve);
Default Value
""
Remarks
Indicates the elliptic curve associated with a EC key.
Supported values:
| SB_PGP_CURVE_P256 | P256 | |
| SB_PGP_CURVE_P384 | P384 | |
| SB_PGP_CURVE_P521 | P521 | |
| SB_PGP_CURVE_ED25519 | ED25519 | |
| SB_PGP_CURVE_CURVE25519 | CURVE25519 | |
| SB_PGP_CURVE_BRAINPOOLP256R1 | BRAINPOOLP256 | |
| SB_PGP_CURVE_BRAINPOOLP512R1 | BRAINPOOLP512 |
This property is not available at design time.
Data Type
String
KeyEncryptionAlgorithm Property (PGPKeyManager Class)
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
QString GetKeyEncryptionAlgorithm();
int SetKeyEncryptionAlgorithm(QString qsKeyEncryptionAlgorithm);
Default Value
"CAST5"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
This property is not available at design time.
Data Type
String
KeyExpires Property (PGPKeyManager Class)
Indicates key expiration time in whole days from its generation moment.
Syntax
int GetKeyExpires();
int SetKeyExpires(int iKeyExpires);
Default Value
0
Remarks
Indicates key expiration time in whole days from its generation moment. The value of 0 indicates that the key does not expire.
This property is not available at design time.
Data Type
Integer
KeyHandle Property (PGPKeyManager Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
KeyHashAlgorithm Property (PGPKeyManager Class)
Specifies the hash algorithm associated with the key.
Syntax
QString GetKeyHashAlgorithm();
int SetKeyHashAlgorithm(QString qsKeyHashAlgorithm);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm associated with the key.
This property is not available at design time.
Data Type
String
KeyOldPacketFormat Property (PGPKeyManager Class)
Indicates whether legacy (PGP 2.
Syntax
bool GetKeyOldPacketFormat();
int SetKeyOldPacketFormat(bool bKeyOldPacketFormat);
Default Value
false
Remarks
Indicates whether legacy (PGP 2.6.x) packet format should be used.
This property is not available at design time.
Data Type
Boolean
KeyPassphrase Property (PGPKeyManager Class)
The key protection password.
Syntax
QString GetKeyPassphrase();
int SetKeyPassphrase(QString qsKeyPassphrase);
Default Value
""
Remarks
The key protection password.
This property is not available at design time.
Data Type
String
KeyProtection Property (PGPKeyManager Class)
Specifies the level of protection applied to the secret key.
Syntax
int GetKeyProtection();
int SetKeyProtection(int iKeyProtection);
Possible Values
PPT_NONE(0),
PPT_LOW(1),
PPT_NORMAL(2),
PPT_HIGH(3)
Default Value
0
Remarks
Specifies the level of protection applied to the secret key.
Allowed values:
| pptNone | 0 | Key is not encrypted |
| pptLow | 1 | Only the password hash is used to derive the secret key |
| pptNormal | 2 | Password hash with salt is used to derive the secret key |
| pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation |
This property is not available at design time.
Data Type
Integer
KeyPublicKeyAlgorithm Property (PGPKeyManager Class)
Specifies the asymmetric algorithm of the key.
Syntax
QString GetKeyPublicKeyAlgorithm();
int SetKeyPublicKeyAlgorithm(QString qsKeyPublicKeyAlgorithm);
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
This property is not available at design time.
Data Type
String
KeyQBits Property (PGPKeyManager Class)
The length of the DSA Q (legitimate range: 160-512).
Syntax
int GetKeyQBits();
int SetKeyQBits(int iKeyQBits);
Default Value
0
Remarks
The length of the DSA Q (legitimate range: 160-512).
This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.
This property is not available at design time.
Data Type
Integer
KeyUsername Property (PGPKeyManager Class)
Specifies the name of the user bound to this key.
Syntax
QString GetKeyUsername();
int SetKeyUsername(QString qsKeyUsername);
Default Value
""
Remarks
Specifies the name of the user bound to this key.
The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.
This property is not available at design time.
Data Type
String
AddSubkey Method (PGPKeyManager Class)
Adds a new subkey to the Key.
Syntax
int AddSubkey(int iBits, const QString& qsAlgorithm, int iExpires);
Remarks
Use this method to add a subkey to a key. Note that the key you are adding the subkey to needs to contain its secret counterpart to be able to sign the new subkey.
Bits specifies the number of bits in the new subkey, Expires is the new subkey's expiration time and date, and Algorithm specifies its public key algorithm:
| SB_PGP_PUBLIC_KEY_ALGORITHM_RSA | RSA | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPT | RSA-encrypt | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGN | RSA-sign | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_DSA | DSA | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSA | ECDSA | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ECDH | ECDH | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPT | Elgamal-encrypt | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL | Elgamal | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSA | EDDSA |
Error Handling
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.)
BindUser Method (PGPKeyManager Class)
Binds a new UserID to the Key.
Syntax
int BindUser(const QString& qsUsername);
Remarks
Use this method to add a new Username as an owner of the Key.
Note that the key needs to contain its secret counterpart to be able to sign the new user ID.
Error Handling
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 (PGPKeyManager Class)
Changes the password of the secret key.
Syntax
int ChangePassphrase(const QString& qsOldPassphrase, const QString& qsNewPassphrase);
Remarks
Call this method to change the password that protects the secret key.
Error Handling
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.)
ChangeProtection Method (PGPKeyManager Class)
Changes the protection level of the secret key.
Syntax
int ChangeProtection(const QString& qsOldPassphrase, const QString& qsNewPassphrase, int iProtType, const QString& qsEncAlgorithm, const QString& qsHashAlgorithm);
Remarks
Use this method to change the protection level of the Key.
OldPassphrase specifies the current password to decrypt the key, NewPassphrase is the new password for the key, ProtType is the new protection type (see for more details), EncAlgorithm is the key encryption algorithm, and
| SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT | Plaintext | |
| SB_PGP_SYMMETRIC_ALGORITHM_IDEA | Idea | |
| SB_PGP_SYMMETRIC_ALGORITHM_3DES | 3DES | |
| SB_PGP_SYMMETRIC_ALGORITHM_CAST5 | CAST5 | |
| SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
| SB_PGP_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_PGP_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
| SB_PGP_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
| SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
Error Handling
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.)
CheckPassphrase Method (PGPKeyManager Class)
Checks if the password matches the secret key.
Syntax
bool CheckPassphrase(const QString& qsPassphrase);
Remarks
Use this method to check if a password can decrypt the Key.
Error Handling
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.
Config Method (PGPKeyManager Class)
Sets or retrieves a configuration setting.
Syntax
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
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.
DoAction Method (PGPKeyManager Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
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.
ExportKey Method (PGPKeyManager Class)
Serializes the key to a byte array.
Syntax
QByteArray ExportKey();
Remarks
Use this method to save the Key (both the public and secret parts) to a byte array.
Error Handling
This method returns a Byte Array 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.
ExportPublicKey Method (PGPKeyManager Class)
Exports the public key to a byte array.
Syntax
QByteArray ExportPublicKey();
Remarks
Use this method to save the public key contained in Key to a byte array.
Error Handling
This method returns a Byte Array 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.
ExportPublicToFile Method (PGPKeyManager Class)
Exports the public key to a file.
Syntax
int ExportPublicToFile(const QString& qsFilename);
Remarks
Use this method to save the public key stored in Key to the file specified by Filename.
Error Handling
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.)
ExportToFile Method (PGPKeyManager Class)
Exports the key to a file.
Syntax
int ExportToFile(const QString& qsFilename);
Remarks
Use this method to save the Key (both the public and secret parts) to the file specified in Filename.
Error Handling
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.)
Generate Method (PGPKeyManager Class)
Generates a new single PGP key.
Syntax
int Generate();
Remarks
Call this method after setting up relevant fields of Key to generate a new PGP key. This method generates a 'standalone' key without subkeys. Use GeneratePair to generate a pair of a main key and a subkey.
Most PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.
Error Handling
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.)
GenerateLegacy Method (PGPKeyManager Class)
Generates a new key in the old format.
Syntax
int GenerateLegacy(const QString& qsUsername, int iBits, const QString& qsPassword, int iExpires);
Remarks
Use this method when you need to generate an RSA key in the old (PGP 2.6.x) format.
Username specifies the user of the key, Bits is the key length in bits. Provide Password for the key and its expiration date and time via Expires.
Only use this method where you want to work with very old PGP software. While still providing a decent level of protection (subject to key length, of course), legacy keys are rarely used these days, and have almost everywhere been replaced with new-style keys.
Most modern PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.
Error Handling
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.)
GeneratePair Method (PGPKeyManager Class)
Generates a new pair of PGP keys.
Syntax
int GeneratePair(const QString& qsUsername, const QString& qsKeyAlgorithm, int iKeyBits, const QString& qsSubKeyAlgorithm, int iSubKeyBits, const QString& qsPassword, int iExpires);
Remarks
Use this method to create a new key-subkey pair. This is the primary method for generating conformant PGP keys.
Pass the user ID of the new key via the Username property. This typically should be in the format of User Name <user@email>, for example Robert Frost <robert@frost.com>, but generally can be an arbitrary text string.
Set KeyAlgorithm and SubKeyAlgorithm to the public key algorithms that you want to use for the new key. See the full list of algorithms below. Where ECDSA or ECDH algorithm is used, you can specify a particular curve after the algorithm name, separated with the colon: ECDSA:P384 or ECDH:BRAINPOOLP256. KeyBits and SubKeyBits specify the number of bits in the key and the subkey. These parameters can be set to zero if the key length is implicitly defined by the algorithm of the key. For example, ECDSA P256 keys are always 256 bit long, so you may pass 0 as the corresponding KeyBits or SubKeyBits parameter.
Provide the key encryption password and the validity period in days via the Password and Expires parameters. Set Expires to zero to indicate that the key does not expire.
While you can use any combination of algorithms for your key and subkey, most implementations got used to specific hard-wired combinations. Sticking to those will help make sure your keys are understood by other implementations. Typical combinations are:
- EDDSA main key with ECDH:CURVE25519 subkey;
- ECDSA main key with ECDH subkey; both with NIST curves (P256, P384, or P512);
- ECDSA main key with ECDH subkey; both with Brainpool curves (BRAINPOOLP256 or BRAINPOOLP512);
- RSA main key with RSA subkey.
Pgpkeymanager mgr = new Pgpkeymanager();
// generating a pair
mgr.GeneratePair("Michel Legrand <ml@email.com>", "EDDSA", 0, "ECDH:CURVE25519", 0, "password", 0);
// creating a keyring object and adding the new pair to the keyring
Pgpkeyring keyring = new Pgpkeyring();
keyring.CreateNew();
keyring.PinnedKey = mgr.Key;
keyring.AddPinned();
// exporting the keyring to a file
keyring.Save("pubkey.pkr", "seckey.skr");
Alternative calls to GeneratePair may look like this:
mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:P384", 0, "ECDH", 0, "password", 0);
mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:BRAINPOOLP256", 0, "ECDH:BRAINPOOLP256", 0, "password", 0);
mgr.GeneratePair("Michel Legrand <ml@email.com>", "RSA", 4096, "RSA", 2048, "password", 0);
Supported public key algorithms:
| SB_PGP_PUBLIC_KEY_ALGORITHM_RSA | RSA | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPT | RSA-encrypt | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGN | RSA-sign | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_DSA | DSA | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSA | ECDSA | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ECDH | ECDH | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPT | Elgamal-encrypt | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL | Elgamal | |
| SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSA | EDDSA |
| SB_PGP_CURVE_P256 | P256 | |
| SB_PGP_CURVE_P384 | P384 | |
| SB_PGP_CURVE_P521 | P521 | |
| SB_PGP_CURVE_ED25519 | ED25519 | |
| SB_PGP_CURVE_CURVE25519 | CURVE25519 | |
| SB_PGP_CURVE_BRAINPOOLP256R1 | BRAINPOOLP256 | |
| SB_PGP_CURVE_BRAINPOOLP512R1 | BRAINPOOLP512 |
Error Handling
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.)
ImportFromFile Method (PGPKeyManager Class)
Loads a key from a file.
Syntax
int ImportFromFile(const QString& qsFilename);
Remarks
Use this method to load a key, either public or secret, from a file.
Error Handling
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 (PGPKeyManager Class)
Loads a key from a byte array.
Syntax
int ImportKey(QByteArray qbaData);
Remarks
Use this method to load a key, either public or secret, from a byte array.
Error Handling
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.)
RemoveSubkey Method (PGPKeyManager Class)
Removes the specified subkey from the key.
Syntax
int RemoveSubkey(int iIndex);
Remarks
Use this method to remove the subkey referred by its Index from the key.
Error Handling
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.)
RemoveUser Method (PGPKeyManager Class)
Unbinds the specified user from the key.
Syntax
int RemoveUser(int iIndex);
Remarks
Use this method to remove the specified user from the list of UserIDs bound to the key.
Error Handling
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 (PGPKeyManager Class)
Revokes the key.
Syntax
int RevokeKey();
Remarks
Use this method to revoke the key by adding a revocation signature.
Error Handling
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.)
RevokeSubkey Method (PGPKeyManager Class)
Revokes the key's subkey.
Syntax
int RevokeSubkey(int iIndex);
Remarks
Use this method to revoke the subkey with a given Index by adding a revocation signature.
Error Handling
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.)
RevokeSubkeybyID Method (PGPKeyManager Class)
Revokes the key's subkey.
Syntax
int RevokeSubkeybyID(const QString& qsKeyId);
Remarks
Use this method to revoke the subkey with a given KeyID by adding a revocation signature.
Error Handling
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.)
RevokeUser Method (PGPKeyManager Class)
Revokes a user certification.
Syntax
int RevokeUser(int iIndex);
Remarks
Use this method to revoke the user with the specified Index by adding a revocation signature to the key.
Error Handling
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.)
RevokeUserByName Method (PGPKeyManager Class)
Revokes a user certification.
Syntax
int RevokeUserByName(const QString& qsUsername);
Remarks
Use this method to revoke the certification of the user specified by Username by adding a revocation signature.
Error Handling
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.)
Validate Method (PGPKeyManager Class)
Validates the key.
Syntax
int Validate();
Remarks
Call this method to validate signatures over the PGP key and all the subkeys.
Possible result:
| pkvStrictlyValid | 0 | Strictly valid |
| pkvValid | 1 | Valid |
| pkvInvalid | 2 | Invalid |
| pkvFailure | 3 | Generic validation failure |
| pkvUnknown | 4 | Validity unknown |
Error Handling
This method returns an Integer 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 (PGPKeyManager Class)
Information about errors during PGP key management.
Syntax
class PGPKeyManagerErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(PGPKeyManagerErrorEventParams *e);
// Or, subclass PGPKeyManager and override this emitter function.
virtual int FireError(PGPKeyManagerErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during key management.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (PGPKeyManager Class)
This event notifies the application about an underlying control flow event.
Syntax
class PGPKeyManagerNotificationEventParams {
public:
const QString &EventID();
const QString &EventParam();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Notification(PGPKeyManagerNotificationEventParams *e);
// Or, subclass PGPKeyManager and override this emitter function.
virtual int FireNotification(PGPKeyManagerNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
Configuration Settings (PGPKeyManager Class)
The class accepts one or more of the following configuration settings. Configuration 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.PGPKeyManager Configuration Settings | ||||||||||||||||||||||||||||||
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (PGPKeyManager Class)
PGPKeyManager Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 27262977 File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS) | |
| 27262978 Invalid key (SB_ERROR_PGP_INVALID_KEY) | |
| 27262979 No public key (SB_ERROR_PGP_NO_PUBLIC_KEY) | |
| 27262980 No secret key (SB_ERROR_PGP_NO_SECRET_KEY) | |
| 27262981 Not found (SB_ERROR_PGP_NOT_FOUND) | |
| 27262982 Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY) |