PGPKeyring Class
Properties Methods Events Configuration Settings Errors
The PGPKeyring class accesses and manages PGP keyring files.
Syntax
PGPKeyring
Remarks
PGPKeyring is used to hold and access PGP keys. It contains information about both public keys and secret keys, which are usually stored in two separate files: "public keyring" and "secret keyring", respectively.
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. |
Opened | Indicates if the keyring is in an opened state. |
PinnedKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
PublicKeyCount | The number of records in the PublicKey arrays. |
PublicKeyBitsInKey | Indicates the key length in bits. |
PublicKeyCanEncrypt | Returns True if this key can be used for encryption. |
PublicKeyCanSign | Returns True if this key can be used for signing. |
PublicKeyCurve | Indicates the elliptic curve associated with a EC key. |
PublicKeyEnabled | Enables or disables this key for use in encryption or signing operation. |
PublicKeyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
PublicKeyExpires | Indicates key expiration time in whole days from its generation moment. |
PublicKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
PublicKeyHashAlgorithm | Specifies the hash algorithm associated with the key. |
PublicKeyIsPublic | Returns True if this key is a public key, and False otherwise. |
PublicKeyIsSecret | Returns True if this key is a secret key, and False otherwise. |
PublicKeyIsSubkey | Returns True if this key is a subkey of another key, and False otherwise. |
PublicKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
PublicKeyKeyHashAlgorithm | Specifies the hash algorithm used with DSA keys to calculate signatures. |
PublicKeyKeyID | Contains a 8-byte key identifier. |
PublicKeyOldPacketFormat | Indicates whether legacy (PGP 2. |
PublicKeyPassphrase | The key protection password. |
PublicKeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
PublicKeyPrimaryKeyID | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
PublicKeyProtection | Specifies the level of protection applied to the secret key. |
PublicKeyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
PublicKeyQBits | The length of the DSA Q (legitimate range: 160-512). |
PublicKeyRevoked | Returns True if the key has been revoked, and False otherwise. |
PublicKeySubkeyFP | The 20-byte fingerprint (hash value) of this key's subkey. |
PublicKeySubkeyID | Contains a 8-byte subkey identifier. |
PublicKeyTimestamp | Use this property to check the time the key was generated. |
PublicKeyUsername | Specifies the name of the user bound to this key. |
PublicKeyValid | Indicates the validity status of the key. |
PublicKeyValidTo | Provide accurate expiration moment indication. |
PublicKeyVersion | Indicates the key version. |
SecretKeyCount | The number of records in the SecretKey arrays. |
SecretKeyBitsInKey | Indicates the key length in bits. |
SecretKeyCanEncrypt | Returns True if this key can be used for encryption. |
SecretKeyCanSign | Returns True if this key can be used for signing. |
SecretKeyCurve | Indicates the elliptic curve associated with a EC key. |
SecretKeyEnabled | Enables or disables this key for use in encryption or signing operation. |
SecretKeyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
SecretKeyExpires | Indicates key expiration time in whole days from its generation moment. |
SecretKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SecretKeyHashAlgorithm | Specifies the hash algorithm associated with the key. |
SecretKeyIsPublic | Returns True if this key is a public key, and False otherwise. |
SecretKeyIsSecret | Returns True if this key is a secret key, and False otherwise. |
SecretKeyIsSubkey | Returns True if this key is a subkey of another key, and False otherwise. |
SecretKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
SecretKeyKeyHashAlgorithm | Specifies the hash algorithm used with DSA keys to calculate signatures. |
SecretKeyKeyID | Contains a 8-byte key identifier. |
SecretKeyOldPacketFormat | Indicates whether legacy (PGP 2. |
SecretKeyPassphrase | The key protection password. |
SecretKeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
SecretKeyPrimaryKeyID | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
SecretKeyProtection | Specifies the level of protection applied to the secret key. |
SecretKeyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
SecretKeyQBits | The length of the DSA Q (legitimate range: 160-512). |
SecretKeyRevoked | Returns True if the key has been revoked, and False otherwise. |
SecretKeySubkeyFP | The 20-byte fingerprint (hash value) of this key's subkey. |
SecretKeySubkeyID | Contains a 8-byte subkey identifier. |
SecretKeyTimestamp | Use this property to check the time the key was generated. |
SecretKeyUsername | Specifies the name of the user bound to this key. |
SecretKeyValid | Indicates the validity status of the key. |
SecretKeyValidTo | Provide accurate expiration moment indication. |
SecretKeyVersion | Indicates the key version. |
SelectedPublicKeyCount | The number of records in the SelectedPublicKey arrays. |
SelectedPublicKeyBitsInKey | Indicates the key length in bits. |
SelectedPublicKeyCanEncrypt | Returns True if this key can be used for encryption. |
SelectedPublicKeyCanSign | Returns True if this key can be used for signing. |
SelectedPublicKeyCurve | Indicates the elliptic curve associated with a EC key. |
SelectedPublicKeyEnabled | Enables or disables this key for use in encryption or signing operation. |
SelectedPublicKeyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
SelectedPublicKeyExpires | Indicates key expiration time in whole days from its generation moment. |
SelectedPublicKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SelectedPublicKeyHashAlgorithm | Specifies the hash algorithm associated with the key. |
SelectedPublicKeyIsPublic | Returns True if this key is a public key, and False otherwise. |
SelectedPublicKeyIsSecret | Returns True if this key is a secret key, and False otherwise. |
SelectedPublicKeyIsSubkey | Returns True if this key is a subkey of another key, and False otherwise. |
SelectedPublicKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
SelectedPublicKeyKeyHashAlgorithm | Specifies the hash algorithm used with DSA keys to calculate signatures. |
SelectedPublicKeyKeyID | Contains a 8-byte key identifier. |
SelectedPublicKeyOldPacketFormat | Indicates whether legacy (PGP 2. |
SelectedPublicKeyPassphrase | The key protection password. |
SelectedPublicKeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
SelectedPublicKeyPrimaryKeyID | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
SelectedPublicKeyProtection | Specifies the level of protection applied to the secret key. |
SelectedPublicKeyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
SelectedPublicKeyQBits | The length of the DSA Q (legitimate range: 160-512). |
SelectedPublicKeyRevoked | Returns True if the key has been revoked, and False otherwise. |
SelectedPublicKeySubkeyFP | The 20-byte fingerprint (hash value) of this key's subkey. |
SelectedPublicKeySubkeyID | Contains a 8-byte subkey identifier. |
SelectedPublicKeyTimestamp | Use this property to check the time the key was generated. |
SelectedPublicKeyUsername | Specifies the name of the user bound to this key. |
SelectedPublicKeyValid | Indicates the validity status of the key. |
SelectedPublicKeyValidTo | Provide accurate expiration moment indication. |
SelectedPublicKeyVersion | Indicates the key version. |
SelectedSecretKeyCount | The number of records in the SelectedSecretKey arrays. |
SelectedSecretKeyBitsInKey | Indicates the key length in bits. |
SelectedSecretKeyCanEncrypt | Returns True if this key can be used for encryption. |
SelectedSecretKeyCanSign | Returns True if this key can be used for signing. |
SelectedSecretKeyCurve | Indicates the elliptic curve associated with a EC key. |
SelectedSecretKeyEnabled | Enables or disables this key for use in encryption or signing operation. |
SelectedSecretKeyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
SelectedSecretKeyExpires | Indicates key expiration time in whole days from its generation moment. |
SelectedSecretKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SelectedSecretKeyHashAlgorithm | Specifies the hash algorithm associated with the key. |
SelectedSecretKeyIsPublic | Returns True if this key is a public key, and False otherwise. |
SelectedSecretKeyIsSecret | Returns True if this key is a secret key, and False otherwise. |
SelectedSecretKeyIsSubkey | Returns True if this key is a subkey of another key, and False otherwise. |
SelectedSecretKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
SelectedSecretKeyKeyHashAlgorithm | Specifies the hash algorithm used with DSA keys to calculate signatures. |
SelectedSecretKeyKeyID | Contains a 8-byte key identifier. |
SelectedSecretKeyOldPacketFormat | Indicates whether legacy (PGP 2. |
SelectedSecretKeyPassphrase | The key protection password. |
SelectedSecretKeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
SelectedSecretKeyPrimaryKeyID | If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key. |
SelectedSecretKeyProtection | Specifies the level of protection applied to the secret key. |
SelectedSecretKeyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
SelectedSecretKeyQBits | The length of the DSA Q (legitimate range: 160-512). |
SelectedSecretKeyRevoked | Returns True if the key has been revoked, and False otherwise. |
SelectedSecretKeySubkeyFP | The 20-byte fingerprint (hash value) of this key's subkey. |
SelectedSecretKeySubkeyID | Contains a 8-byte subkey identifier. |
SelectedSecretKeyTimestamp | Use this property to check the time the key was generated. |
SelectedSecretKeyUsername | Specifies the name of the user bound to this key. |
SelectedSecretKeyValid | Indicates the validity status of the key. |
SelectedSecretKeyValidTo | Provide accurate expiration moment indication. |
SelectedSecretKeyVersion | Indicates the key version. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddFromBytes | Adds an existing key to the keyring. |
AddFromFile | Adds an existing key to the keyring. |
AddFromFiles | Adds a collection of keys to the keyring. |
AddPinned | Adds a pinned secret key to the keyring. |
Clear | Removes all the keys from the keyring. |
Close | Closes the keyring. |
Config | Sets or retrieves a configuration setting. |
CreateNew | Creates a new empty keyring. |
DoAction | Performs an additional action. |
Load | Loads a keyring from disk. |
LoadFromBytes | Loads a keyring from two byte arrays. |
RemoveByID | Removes key by its ID. |
RemovePublic | Removes the specified public key from the keyring. |
RemoveSecret | Removes the specified secret key from the keyring. |
Save | Saves the keyring to disk. |
SaveToBytes | Saves the keyring to a byte array. |
Select | Filters a selection of keys from the keyring using a template. |
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 | Location where the temporary files are stored. |
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 (PGPKeyring Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
Opened Property (PGPKeyring Class)
Indicates if the keyring is in an opened state.
Syntax
bool GetOpened();
Default Value
false
Remarks
If the keyring is open, it means that you can access, add, or removes keys from it.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedKeyHandle Property (PGPKeyring Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetPinnedKeyHandle();
int SetPinnedKeyHandle(qint64 lPinnedKeyHandle);
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
PublicKeyCount Property (PGPKeyring Class)
The number of records in the PublicKey arrays.
Syntax
int GetPublicKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PublicKeyBitsInKey
- PublicKeyCanEncrypt
- PublicKeyCanSign
- PublicKeyCurve
- PublicKeyEnabled
- PublicKeyEncryptionAlgorithm
- PublicKeyExpires
- PublicKeyHandle
- PublicKeyHashAlgorithm
- PublicKeyIsPublic
- PublicKeyIsSecret
- PublicKeyIsSubkey
- PublicKeyKeyFP
- PublicKeyKeyHashAlgorithm
- PublicKeyKeyID
- PublicKeyOldPacketFormat
- PublicKeyPassphrase
- PublicKeyPassphraseValid
- PublicKeyPrimaryKeyID
- PublicKeyProtection
- PublicKeyPublicKeyAlgorithm
- PublicKeyQBits
- PublicKeyRevoked
- PublicKeySubkeyFP
- PublicKeySubkeyID
- PublicKeyTimestamp
- PublicKeyUsername
- PublicKeyValid
- PublicKeyValidTo
- PublicKeyVersion
This property is read-only and not available at design time.
Data Type
Integer
PublicKeyBitsInKey Property (PGPKeyring Class)
Indicates the key length in bits.
Syntax
int GetPublicKeyBitsInKey(int iPublicKeyIndex);
Default Value
2048
Remarks
Indicates the key length in bits.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
PublicKeyCanEncrypt Property (PGPKeyring Class)
Returns True if this key can be used for encryption.
Syntax
bool GetPublicKeyCanEncrypt(int iPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for encryption.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyCanSign Property (PGPKeyring Class)
Returns True if this key can be used for signing.
Syntax
bool GetPublicKeyCanSign(int iPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for signing.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyCurve Property (PGPKeyring Class)
Indicates the elliptic curve associated with a EC key.
Syntax
QString GetPublicKeyCurve(int iPublicKeyIndex);
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 |
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyEnabled Property (PGPKeyring Class)
Enables or disables this key for use in encryption or signing operation.
Syntax
bool GetPublicKeyEnabled(int iPublicKeyIndex);
Default Value
false
Remarks
Enables or disables this key for use in encryption or signing operation.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyEncryptionAlgorithm Property (PGPKeyring Class)
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
QString GetPublicKeyEncryptionAlgorithm(int iPublicKeyIndex);
Default Value
"CAST5"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyExpires Property (PGPKeyring Class)
Indicates key expiration time in whole days from its generation moment.
Syntax
int GetPublicKeyExpires(int iPublicKeyIndex);
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.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
PublicKeyHandle Property (PGPKeyring Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetPublicKeyHandle(int iPublicKeyIndex);
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());
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
PublicKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm associated with the key.
Syntax
QString GetPublicKeyHashAlgorithm(int iPublicKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm associated with the key.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyIsPublic Property (PGPKeyring Class)
Returns True if this key is a public key, and False otherwise.
Syntax
bool GetPublicKeyIsPublic(int iPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key is a public key, and False otherwise.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyIsSecret Property (PGPKeyring Class)
Returns True if this key is a secret key, and False otherwise.
Syntax
bool GetPublicKeyIsSecret(int iPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key is a secret key, and False otherwise.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyIsSubkey Property (PGPKeyring Class)
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
bool GetPublicKeyIsSubkey(int iPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyKeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetPublicKeyKeyFP(int iPublicKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm used with DSA keys to calculate signatures.
Syntax
QString GetPublicKeyKeyHashAlgorithm(int iPublicKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm used with DSA keys to calculate signatures.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyKeyID Property (PGPKeyring Class)
Contains a 8-byte key identifier.
Syntax
QString GetPublicKeyKeyID(int iPublicKeyIndex);
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyOldPacketFormat Property (PGPKeyring Class)
Indicates whether legacy (PGP 2.
Syntax
bool GetPublicKeyOldPacketFormat(int iPublicKeyIndex);
Default Value
false
Remarks
Indicates whether legacy (PGP 2.6.x) packet format should be used.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyPassphrase Property (PGPKeyring Class)
The key protection password.
Syntax
QString GetPublicKeyPassphrase(int iPublicKeyIndex);
Default Value
""
Remarks
The key protection password.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyPassphraseValid Property (PGPKeyring Class)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
bool GetPublicKeyPassphraseValid(int iPublicKeyIndex);
Default Value
false
Remarks
Use this property to check whether the specified PublicKeyPassphrase is valid and can be used to unlock the secret key.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeyPrimaryKeyID Property (PGPKeyring Class)
If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
Syntax
QString GetPublicKeyPrimaryKeyID(int iPublicKeyIndex);
Default Value
""
Remarks
If this key is a subkey (PublicKeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyProtection Property (PGPKeyring Class)
Specifies the level of protection applied to the secret key.
Syntax
int GetPublicKeyProtection(int iPublicKeyIndex);
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 |
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
PublicKeyPublicKeyAlgorithm Property (PGPKeyring Class)
Specifies the asymmetric algorithm of the key.
Syntax
QString GetPublicKeyPublicKeyAlgorithm(int iPublicKeyIndex);
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyQBits Property (PGPKeyring Class)
The length of the DSA Q (legitimate range: 160-512).
Syntax
int GetPublicKeyQBits(int iPublicKeyIndex);
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.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
PublicKeyRevoked Property (PGPKeyring Class)
Returns True if the key has been revoked, and False otherwise.
Syntax
bool GetPublicKeyRevoked(int iPublicKeyIndex);
Default Value
false
Remarks
Returns True if the key has been revoked, and False otherwise.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PublicKeySubkeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key's subkey.
Syntax
QString GetPublicKeySubkeyFP(int iPublicKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key's subkey.
KeyFP could be used to distinguish two subkeys with the same SubkeyID.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeySubkeyID Property (PGPKeyring Class)
Contains a 8-byte subkey identifier.
Syntax
QString GetPublicKeySubkeyID(int iPublicKeyIndex);
Default Value
""
Remarks
Contains a 8-byte subkey identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (SubkeyFP) can be used to distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyTimestamp Property (PGPKeyring Class)
Use this property to check the time the key was generated.
Syntax
QString GetPublicKeyTimestamp(int iPublicKeyIndex);
Default Value
""
Remarks
Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyUsername Property (PGPKeyring Class)
Specifies the name of the user bound to this key.
Syntax
QString GetPublicKeyUsername(int iPublicKeyIndex);
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.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyValid Property (PGPKeyring Class)
Indicates the validity status of the key.
Syntax
int GetPublicKeyValid(int iPublicKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
Default Value
0
Remarks
Indicates the validity status of the key.
pkvStrictlyValid | 0 | Strictly valid |
pkvValid | 1 | Valid |
pkvInvalid | 2 | Invalid |
pkvFailure | 3 | Generic validation failure |
pkvUnknown | 4 | Validity unknown |
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
PublicKeyValidTo Property (PGPKeyring Class)
Provide accurate expiration moment indication.
Syntax
QString GetPublicKeyValidTo(int iPublicKeyIndex);
Default Value
"0"
Remarks
Provide accurate expiration moment indication. This is different to PublicKeyExpires property which only contains expiration time in days in old keys.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
PublicKeyVersion Property (PGPKeyring Class)
Indicates the key version.
Syntax
int GetPublicKeyVersion(int iPublicKeyIndex);
Default Value
-1
Remarks
Indicates the key version.
The key version refers to the version of the public-key packet format as defined in RFC 4880.
Only two versions are currently allowed here: 3 and 4. It is recommended that all new keys are created with version of 4.
The PublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SecretKeyCount Property (PGPKeyring Class)
The number of records in the SecretKey arrays.
Syntax
int GetSecretKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SecretKeyBitsInKey
- SecretKeyCanEncrypt
- SecretKeyCanSign
- SecretKeyCurve
- SecretKeyEnabled
- SecretKeyEncryptionAlgorithm
- SecretKeyExpires
- SecretKeyHandle
- SecretKeyHashAlgorithm
- SecretKeyIsPublic
- SecretKeyIsSecret
- SecretKeyIsSubkey
- SecretKeyKeyFP
- SecretKeyKeyHashAlgorithm
- SecretKeyKeyID
- SecretKeyOldPacketFormat
- SecretKeyPassphrase
- SecretKeyPassphraseValid
- SecretKeyPrimaryKeyID
- SecretKeyProtection
- SecretKeyPublicKeyAlgorithm
- SecretKeyQBits
- SecretKeyRevoked
- SecretKeySubkeyFP
- SecretKeySubkeyID
- SecretKeyTimestamp
- SecretKeyUsername
- SecretKeyValid
- SecretKeyValidTo
- SecretKeyVersion
This property is read-only and not available at design time.
Data Type
Integer
SecretKeyBitsInKey Property (PGPKeyring Class)
Indicates the key length in bits.
Syntax
int GetSecretKeyBitsInKey(int iSecretKeyIndex);
Default Value
2048
Remarks
Indicates the key length in bits.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SecretKeyCanEncrypt Property (PGPKeyring Class)
Returns True if this key can be used for encryption.
Syntax
bool GetSecretKeyCanEncrypt(int iSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for encryption.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyCanSign Property (PGPKeyring Class)
Returns True if this key can be used for signing.
Syntax
bool GetSecretKeyCanSign(int iSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for signing.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyCurve Property (PGPKeyring Class)
Indicates the elliptic curve associated with a EC key.
Syntax
QString GetSecretKeyCurve(int iSecretKeyIndex);
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 |
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyEnabled Property (PGPKeyring Class)
Enables or disables this key for use in encryption or signing operation.
Syntax
bool GetSecretKeyEnabled(int iSecretKeyIndex);
Default Value
false
Remarks
Enables or disables this key for use in encryption or signing operation.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyEncryptionAlgorithm Property (PGPKeyring Class)
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
QString GetSecretKeyEncryptionAlgorithm(int iSecretKeyIndex);
Default Value
"CAST5"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyExpires Property (PGPKeyring Class)
Indicates key expiration time in whole days from its generation moment.
Syntax
int GetSecretKeyExpires(int iSecretKeyIndex);
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.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SecretKeyHandle Property (PGPKeyring Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSecretKeyHandle(int iSecretKeyIndex);
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());
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
SecretKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm associated with the key.
Syntax
QString GetSecretKeyHashAlgorithm(int iSecretKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm associated with the key.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyIsPublic Property (PGPKeyring Class)
Returns True if this key is a public key, and False otherwise.
Syntax
bool GetSecretKeyIsPublic(int iSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key is a public key, and False otherwise.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyIsSecret Property (PGPKeyring Class)
Returns True if this key is a secret key, and False otherwise.
Syntax
bool GetSecretKeyIsSecret(int iSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key is a secret key, and False otherwise.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyIsSubkey Property (PGPKeyring Class)
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
bool GetSecretKeyIsSubkey(int iSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyKeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetSecretKeyKeyFP(int iSecretKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm used with DSA keys to calculate signatures.
Syntax
QString GetSecretKeyKeyHashAlgorithm(int iSecretKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm used with DSA keys to calculate signatures.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyKeyID Property (PGPKeyring Class)
Contains a 8-byte key identifier.
Syntax
QString GetSecretKeyKeyID(int iSecretKeyIndex);
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyOldPacketFormat Property (PGPKeyring Class)
Indicates whether legacy (PGP 2.
Syntax
bool GetSecretKeyOldPacketFormat(int iSecretKeyIndex);
Default Value
false
Remarks
Indicates whether legacy (PGP 2.6.x) packet format should be used.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyPassphrase Property (PGPKeyring Class)
The key protection password.
Syntax
QString GetSecretKeyPassphrase(int iSecretKeyIndex);
Default Value
""
Remarks
The key protection password.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyPassphraseValid Property (PGPKeyring Class)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
bool GetSecretKeyPassphraseValid(int iSecretKeyIndex);
Default Value
false
Remarks
Use this property to check whether the specified SecretKeyPassphrase is valid and can be used to unlock the secret key.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeyPrimaryKeyID Property (PGPKeyring Class)
If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
Syntax
QString GetSecretKeyPrimaryKeyID(int iSecretKeyIndex);
Default Value
""
Remarks
If this key is a subkey (SecretKeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyProtection Property (PGPKeyring Class)
Specifies the level of protection applied to the secret key.
Syntax
int GetSecretKeyProtection(int iSecretKeyIndex);
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 |
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SecretKeyPublicKeyAlgorithm Property (PGPKeyring Class)
Specifies the asymmetric algorithm of the key.
Syntax
QString GetSecretKeyPublicKeyAlgorithm(int iSecretKeyIndex);
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyQBits Property (PGPKeyring Class)
The length of the DSA Q (legitimate range: 160-512).
Syntax
int GetSecretKeyQBits(int iSecretKeyIndex);
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.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SecretKeyRevoked Property (PGPKeyring Class)
Returns True if the key has been revoked, and False otherwise.
Syntax
bool GetSecretKeyRevoked(int iSecretKeyIndex);
Default Value
false
Remarks
Returns True if the key has been revoked, and False otherwise.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SecretKeySubkeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key's subkey.
Syntax
QString GetSecretKeySubkeyFP(int iSecretKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key's subkey.
KeyFP could be used to distinguish two subkeys with the same SubkeyID.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeySubkeyID Property (PGPKeyring Class)
Contains a 8-byte subkey identifier.
Syntax
QString GetSecretKeySubkeyID(int iSecretKeyIndex);
Default Value
""
Remarks
Contains a 8-byte subkey identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (SubkeyFP) can be used to distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyTimestamp Property (PGPKeyring Class)
Use this property to check the time the key was generated.
Syntax
QString GetSecretKeyTimestamp(int iSecretKeyIndex);
Default Value
""
Remarks
Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyUsername Property (PGPKeyring Class)
Specifies the name of the user bound to this key.
Syntax
QString GetSecretKeyUsername(int iSecretKeyIndex);
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.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyValid Property (PGPKeyring Class)
Indicates the validity status of the key.
Syntax
int GetSecretKeyValid(int iSecretKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
Default Value
0
Remarks
Indicates the validity status of the key.
pkvStrictlyValid | 0 | Strictly valid |
pkvValid | 1 | Valid |
pkvInvalid | 2 | Invalid |
pkvFailure | 3 | Generic validation failure |
pkvUnknown | 4 | Validity unknown |
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SecretKeyValidTo Property (PGPKeyring Class)
Provide accurate expiration moment indication.
Syntax
QString GetSecretKeyValidTo(int iSecretKeyIndex);
Default Value
"0"
Remarks
Provide accurate expiration moment indication. This is different to SecretKeyExpires property which only contains expiration time in days in old keys.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SecretKeyVersion Property (PGPKeyring Class)
Indicates the key version.
Syntax
int GetSecretKeyVersion(int iSecretKeyIndex);
Default Value
-1
Remarks
Indicates the key version.
The key version refers to the version of the public-key packet format as defined in RFC 4880.
Only two versions are currently allowed here: 3 and 4. It is recommended that all new keys are created with version of 4.
The SecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedPublicKeyCount Property (PGPKeyring Class)
The number of records in the SelectedPublicKey arrays.
Syntax
int GetSelectedPublicKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SelectedPublicKeyBitsInKey
- SelectedPublicKeyCanEncrypt
- SelectedPublicKeyCanSign
- SelectedPublicKeyCurve
- SelectedPublicKeyEnabled
- SelectedPublicKeyEncryptionAlgorithm
- SelectedPublicKeyExpires
- SelectedPublicKeyHandle
- SelectedPublicKeyHashAlgorithm
- SelectedPublicKeyIsPublic
- SelectedPublicKeyIsSecret
- SelectedPublicKeyIsSubkey
- SelectedPublicKeyKeyFP
- SelectedPublicKeyKeyHashAlgorithm
- SelectedPublicKeyKeyID
- SelectedPublicKeyOldPacketFormat
- SelectedPublicKeyPassphrase
- SelectedPublicKeyPassphraseValid
- SelectedPublicKeyPrimaryKeyID
- SelectedPublicKeyProtection
- SelectedPublicKeyPublicKeyAlgorithm
- SelectedPublicKeyQBits
- SelectedPublicKeyRevoked
- SelectedPublicKeySubkeyFP
- SelectedPublicKeySubkeyID
- SelectedPublicKeyTimestamp
- SelectedPublicKeyUsername
- SelectedPublicKeyValid
- SelectedPublicKeyValidTo
- SelectedPublicKeyVersion
This property is read-only and not available at design time.
Data Type
Integer
SelectedPublicKeyBitsInKey Property (PGPKeyring Class)
Indicates the key length in bits.
Syntax
int GetSelectedPublicKeyBitsInKey(int iSelectedPublicKeyIndex);
Default Value
2048
Remarks
Indicates the key length in bits.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedPublicKeyCanEncrypt Property (PGPKeyring Class)
Returns True if this key can be used for encryption.
Syntax
bool GetSelectedPublicKeyCanEncrypt(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for encryption.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyCanSign Property (PGPKeyring Class)
Returns True if this key can be used for signing.
Syntax
bool GetSelectedPublicKeyCanSign(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for signing.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyCurve Property (PGPKeyring Class)
Indicates the elliptic curve associated with a EC key.
Syntax
QString GetSelectedPublicKeyCurve(int iSelectedPublicKeyIndex);
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 |
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyEnabled Property (PGPKeyring Class)
Enables or disables this key for use in encryption or signing operation.
Syntax
bool GetSelectedPublicKeyEnabled(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Enables or disables this key for use in encryption or signing operation.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyEncryptionAlgorithm Property (PGPKeyring Class)
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
QString GetSelectedPublicKeyEncryptionAlgorithm(int iSelectedPublicKeyIndex);
Default Value
"CAST5"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyExpires Property (PGPKeyring Class)
Indicates key expiration time in whole days from its generation moment.
Syntax
int GetSelectedPublicKeyExpires(int iSelectedPublicKeyIndex);
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.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedPublicKeyHandle Property (PGPKeyring Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSelectedPublicKeyHandle(int iSelectedPublicKeyIndex);
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());
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
SelectedPublicKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm associated with the key.
Syntax
QString GetSelectedPublicKeyHashAlgorithm(int iSelectedPublicKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm associated with the key.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyIsPublic Property (PGPKeyring Class)
Returns True if this key is a public key, and False otherwise.
Syntax
bool GetSelectedPublicKeyIsPublic(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key is a public key, and False otherwise.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyIsSecret Property (PGPKeyring Class)
Returns True if this key is a secret key, and False otherwise.
Syntax
bool GetSelectedPublicKeyIsSecret(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key is a secret key, and False otherwise.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyIsSubkey Property (PGPKeyring Class)
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
bool GetSelectedPublicKeyIsSubkey(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyKeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetSelectedPublicKeyKeyFP(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm used with DSA keys to calculate signatures.
Syntax
QString GetSelectedPublicKeyKeyHashAlgorithm(int iSelectedPublicKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm used with DSA keys to calculate signatures.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyKeyID Property (PGPKeyring Class)
Contains a 8-byte key identifier.
Syntax
QString GetSelectedPublicKeyKeyID(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyOldPacketFormat Property (PGPKeyring Class)
Indicates whether legacy (PGP 2.
Syntax
bool GetSelectedPublicKeyOldPacketFormat(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Indicates whether legacy (PGP 2.6.x) packet format should be used.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyPassphrase Property (PGPKeyring Class)
The key protection password.
Syntax
QString GetSelectedPublicKeyPassphrase(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
The key protection password.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyPassphraseValid Property (PGPKeyring Class)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
bool GetSelectedPublicKeyPassphraseValid(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Use this property to check whether the specified SelectedPublicKeyPassphrase is valid and can be used to unlock the secret key.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeyPrimaryKeyID Property (PGPKeyring Class)
If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
Syntax
QString GetSelectedPublicKeyPrimaryKeyID(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
If this key is a subkey (SelectedPublicKeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyProtection Property (PGPKeyring Class)
Specifies the level of protection applied to the secret key.
Syntax
int GetSelectedPublicKeyProtection(int iSelectedPublicKeyIndex);
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 |
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedPublicKeyPublicKeyAlgorithm Property (PGPKeyring Class)
Specifies the asymmetric algorithm of the key.
Syntax
QString GetSelectedPublicKeyPublicKeyAlgorithm(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyQBits Property (PGPKeyring Class)
The length of the DSA Q (legitimate range: 160-512).
Syntax
int GetSelectedPublicKeyQBits(int iSelectedPublicKeyIndex);
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.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedPublicKeyRevoked Property (PGPKeyring Class)
Returns True if the key has been revoked, and False otherwise.
Syntax
bool GetSelectedPublicKeyRevoked(int iSelectedPublicKeyIndex);
Default Value
false
Remarks
Returns True if the key has been revoked, and False otherwise.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedPublicKeySubkeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key's subkey.
Syntax
QString GetSelectedPublicKeySubkeyFP(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key's subkey.
KeyFP could be used to distinguish two subkeys with the same SubkeyID.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeySubkeyID Property (PGPKeyring Class)
Contains a 8-byte subkey identifier.
Syntax
QString GetSelectedPublicKeySubkeyID(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
Contains a 8-byte subkey identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (SubkeyFP) can be used to distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyTimestamp Property (PGPKeyring Class)
Use this property to check the time the key was generated.
Syntax
QString GetSelectedPublicKeyTimestamp(int iSelectedPublicKeyIndex);
Default Value
""
Remarks
Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyUsername Property (PGPKeyring Class)
Specifies the name of the user bound to this key.
Syntax
QString GetSelectedPublicKeyUsername(int iSelectedPublicKeyIndex);
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.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyValid Property (PGPKeyring Class)
Indicates the validity status of the key.
Syntax
int GetSelectedPublicKeyValid(int iSelectedPublicKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
Default Value
0
Remarks
Indicates the validity status of the key.
pkvStrictlyValid | 0 | Strictly valid |
pkvValid | 1 | Valid |
pkvInvalid | 2 | Invalid |
pkvFailure | 3 | Generic validation failure |
pkvUnknown | 4 | Validity unknown |
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedPublicKeyValidTo Property (PGPKeyring Class)
Provide accurate expiration moment indication.
Syntax
QString GetSelectedPublicKeyValidTo(int iSelectedPublicKeyIndex);
Default Value
"0"
Remarks
Provide accurate expiration moment indication. This is different to SelectedPublicKeyExpires property which only contains expiration time in days in old keys.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedPublicKeyVersion Property (PGPKeyring Class)
Indicates the key version.
Syntax
int GetSelectedPublicKeyVersion(int iSelectedPublicKeyIndex);
Default Value
-1
Remarks
Indicates the key version.
The key version refers to the version of the public-key packet format as defined in RFC 4880.
Only two versions are currently allowed here: 3 and 4. It is recommended that all new keys are created with version of 4.
The SelectedPublicKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedPublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedSecretKeyCount Property (PGPKeyring Class)
The number of records in the SelectedSecretKey arrays.
Syntax
int GetSelectedSecretKeyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SelectedSecretKeyBitsInKey
- SelectedSecretKeyCanEncrypt
- SelectedSecretKeyCanSign
- SelectedSecretKeyCurve
- SelectedSecretKeyEnabled
- SelectedSecretKeyEncryptionAlgorithm
- SelectedSecretKeyExpires
- SelectedSecretKeyHandle
- SelectedSecretKeyHashAlgorithm
- SelectedSecretKeyIsPublic
- SelectedSecretKeyIsSecret
- SelectedSecretKeyIsSubkey
- SelectedSecretKeyKeyFP
- SelectedSecretKeyKeyHashAlgorithm
- SelectedSecretKeyKeyID
- SelectedSecretKeyOldPacketFormat
- SelectedSecretKeyPassphrase
- SelectedSecretKeyPassphraseValid
- SelectedSecretKeyPrimaryKeyID
- SelectedSecretKeyProtection
- SelectedSecretKeyPublicKeyAlgorithm
- SelectedSecretKeyQBits
- SelectedSecretKeyRevoked
- SelectedSecretKeySubkeyFP
- SelectedSecretKeySubkeyID
- SelectedSecretKeyTimestamp
- SelectedSecretKeyUsername
- SelectedSecretKeyValid
- SelectedSecretKeyValidTo
- SelectedSecretKeyVersion
This property is read-only and not available at design time.
Data Type
Integer
SelectedSecretKeyBitsInKey Property (PGPKeyring Class)
Indicates the key length in bits.
Syntax
int GetSelectedSecretKeyBitsInKey(int iSelectedSecretKeyIndex);
Default Value
2048
Remarks
Indicates the key length in bits.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedSecretKeyCanEncrypt Property (PGPKeyring Class)
Returns True if this key can be used for encryption.
Syntax
bool GetSelectedSecretKeyCanEncrypt(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for encryption.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyCanSign Property (PGPKeyring Class)
Returns True if this key can be used for signing.
Syntax
bool GetSelectedSecretKeyCanSign(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key can be used for signing.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyCurve Property (PGPKeyring Class)
Indicates the elliptic curve associated with a EC key.
Syntax
QString GetSelectedSecretKeyCurve(int iSelectedSecretKeyIndex);
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 |
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyEnabled Property (PGPKeyring Class)
Enables or disables this key for use in encryption or signing operation.
Syntax
bool GetSelectedSecretKeyEnabled(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Enables or disables this key for use in encryption or signing operation.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyEncryptionAlgorithm Property (PGPKeyring Class)
Indicates the symmetric algorithm used to encrypt the secret key.
Syntax
QString GetSelectedSecretKeyEncryptionAlgorithm(int iSelectedSecretKeyIndex);
Default Value
"CAST5"
Remarks
Indicates the symmetric algorithm used to encrypt the secret key.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyExpires Property (PGPKeyring Class)
Indicates key expiration time in whole days from its generation moment.
Syntax
int GetSelectedSecretKeyExpires(int iSelectedSecretKeyIndex);
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.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedSecretKeyHandle Property (PGPKeyring Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSelectedSecretKeyHandle(int iSelectedSecretKeyIndex);
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());
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Long64
SelectedSecretKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm associated with the key.
Syntax
QString GetSelectedSecretKeyHashAlgorithm(int iSelectedSecretKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm associated with the key.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyIsPublic Property (PGPKeyring Class)
Returns True if this key is a public key, and False otherwise.
Syntax
bool GetSelectedSecretKeyIsPublic(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key is a public key, and False otherwise.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyIsSecret Property (PGPKeyring Class)
Returns True if this key is a secret key, and False otherwise.
Syntax
bool GetSelectedSecretKeyIsSecret(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key is a secret key, and False otherwise.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyIsSubkey Property (PGPKeyring Class)
Returns True if this key is a subkey of another key, and False otherwise.
Syntax
bool GetSelectedSecretKeyIsSubkey(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Returns True if this key is a subkey of another key, and False otherwise.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyKeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetSelectedSecretKeyKeyFP(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyKeyHashAlgorithm Property (PGPKeyring Class)
Specifies the hash algorithm used with DSA keys to calculate signatures.
Syntax
QString GetSelectedSecretKeyKeyHashAlgorithm(int iSelectedSecretKeyIndex);
Default Value
"SHA256"
Remarks
Specifies the hash algorithm used with DSA keys to calculate signatures.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyKeyID Property (PGPKeyring Class)
Contains a 8-byte key identifier.
Syntax
QString GetSelectedSecretKeyKeyID(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyOldPacketFormat Property (PGPKeyring Class)
Indicates whether legacy (PGP 2.
Syntax
bool GetSelectedSecretKeyOldPacketFormat(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Indicates whether legacy (PGP 2.6.x) packet format should be used.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyPassphrase Property (PGPKeyring Class)
The key protection password.
Syntax
QString GetSelectedSecretKeyPassphrase(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
The key protection password.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyPassphraseValid Property (PGPKeyring Class)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
bool GetSelectedSecretKeyPassphraseValid(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Use this property to check whether the specified SelectedSecretKeyPassphrase is valid and can be used to unlock the secret key.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeyPrimaryKeyID Property (PGPKeyring Class)
If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
Syntax
QString GetSelectedSecretKeyPrimaryKeyID(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
If this key is a subkey (SelectedSecretKeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyProtection Property (PGPKeyring Class)
Specifies the level of protection applied to the secret key.
Syntax
int GetSelectedSecretKeyProtection(int iSelectedSecretKeyIndex);
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 |
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedSecretKeyPublicKeyAlgorithm Property (PGPKeyring Class)
Specifies the asymmetric algorithm of the key.
Syntax
QString GetSelectedSecretKeyPublicKeyAlgorithm(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
Specifies the asymmetric algorithm of the key.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyQBits Property (PGPKeyring Class)
The length of the DSA Q (legitimate range: 160-512).
Syntax
int GetSelectedSecretKeyQBits(int iSelectedSecretKeyIndex);
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.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedSecretKeyRevoked Property (PGPKeyring Class)
Returns True if the key has been revoked, and False otherwise.
Syntax
bool GetSelectedSecretKeyRevoked(int iSelectedSecretKeyIndex);
Default Value
false
Remarks
Returns True if the key has been revoked, and False otherwise.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SelectedSecretKeySubkeyFP Property (PGPKeyring Class)
The 20-byte fingerprint (hash value) of this key's subkey.
Syntax
QString GetSelectedSecretKeySubkeyFP(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key's subkey.
KeyFP could be used to distinguish two subkeys with the same SubkeyID.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeySubkeyID Property (PGPKeyring Class)
Contains a 8-byte subkey identifier.
Syntax
QString GetSelectedSecretKeySubkeyID(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
Contains a 8-byte subkey identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (SubkeyFP) can be used to distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyTimestamp Property (PGPKeyring Class)
Use this property to check the time the key was generated.
Syntax
QString GetSelectedSecretKeyTimestamp(int iSelectedSecretKeyIndex);
Default Value
""
Remarks
Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyUsername Property (PGPKeyring Class)
Specifies the name of the user bound to this key.
Syntax
QString GetSelectedSecretKeyUsername(int iSelectedSecretKeyIndex);
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.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyValid Property (PGPKeyring Class)
Indicates the validity status of the key.
Syntax
int GetSelectedSecretKeyValid(int iSelectedSecretKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
Default Value
0
Remarks
Indicates the validity status of the key.
pkvStrictlyValid | 0 | Strictly valid |
pkvValid | 1 | Valid |
pkvInvalid | 2 | Invalid |
pkvFailure | 3 | Generic validation failure |
pkvUnknown | 4 | Validity unknown |
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
SelectedSecretKeyValidTo Property (PGPKeyring Class)
Provide accurate expiration moment indication.
Syntax
QString GetSelectedSecretKeyValidTo(int iSelectedSecretKeyIndex);
Default Value
"0"
Remarks
Provide accurate expiration moment indication. This is different to SelectedSecretKeyExpires property which only contains expiration time in days in old keys.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SelectedSecretKeyVersion Property (PGPKeyring Class)
Indicates the key version.
Syntax
int GetSelectedSecretKeyVersion(int iSelectedSecretKeyIndex);
Default Value
-1
Remarks
Indicates the key version.
The key version refers to the version of the public-key packet format as defined in RFC 4880.
Only two versions are currently allowed here: 3 and 4. It is recommended that all new keys are created with version of 4.
The SelectedSecretKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SelectedSecretKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer
AddFromBytes Method (PGPKeyring Class)
Adds an existing key to the keyring.
Syntax
int AddFromBytes(QByteArray qbaBytes);
Remarks
Use this method to add a key stored in a byte array to the keyring.
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.)
AddFromFile Method (PGPKeyring Class)
Adds an existing key to the keyring.
Syntax
int AddFromFile(const QString& qsFilename);
Remarks
Use this method to add a key stored in a file to the keyring.
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.)
AddFromFiles Method (PGPKeyring Class)
Adds a collection of keys to the keyring.
Syntax
int AddFromFiles(const QString& qsPublicKeyringFile, const QString& qsSecretKeyringFile);
Remarks
Use this method to add keys stored in two separate keyring files to the keyring.
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.)
AddPinned Method (PGPKeyring Class)
Adds a pinned secret key to the keyring.
Syntax
int AddPinned();
Remarks
Use this method to add a key provided via PinnedKey to the keyring. This can be a public or 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.)
Clear Method (PGPKeyring Class)
Removes all the keys from the keyring.
Syntax
int Clear();
Remarks
Use this method to remove all the items from the keyring.
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.)
Close Method (PGPKeyring Class)
Closes the keyring.
Syntax
int Close();
Remarks
Use this method to close the keyring and release any associated memory resources.
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.)
Config Method (PGPKeyring 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.
CreateNew Method (PGPKeyring Class)
Creates a new empty keyring.
Syntax
int CreateNew();
Remarks
Use this method to initialize a new empty keyring.
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.)
DoAction Method (PGPKeyring 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.
Load Method (PGPKeyring Class)
Loads a keyring from disk.
Syntax
int Load(const QString& qsPublicKeyringFile, const QString& qsSecretKeyringFile);
Remarks
Use this method to load a keyring (usually stored in two files) to the keyring object. If you only have it in one file, pass an empty string as the second parameter.
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.)
LoadFromBytes Method (PGPKeyring Class)
Loads a keyring from two byte arrays.
Syntax
int LoadFromBytes(QByteArray qbaPublicKeyring, QByteArray qbaSecretKeyring);
Remarks
Use this method to load a keyring from two byte arrays. Keyring are typically stored in the form of two files (public and secret), but if you only have one file, pass an empty array as the second parameter.
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.)
RemoveByID Method (PGPKeyring Class)
Removes key by its ID.
Syntax
int RemoveByID(const QString& qsKeyID);
Remarks
Call this method to remove the specified key from the keyring.
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.)
RemovePublic Method (PGPKeyring Class)
Removes the specified public key from the keyring.
Syntax
int RemovePublic(int iIndex);
Remarks
Use this method to remove a public key from the keyring. Use Index to pass the index of the key to be removed.
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.)
RemoveSecret Method (PGPKeyring Class)
Removes the specified secret key from the keyring.
Syntax
int RemoveSecret(int iIndex);
Remarks
Use this method to remove a secret key from the keyring. Use Index to pass the index of the key to be removed.
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.)
Save Method (PGPKeyring Class)
Saves the keyring to disk.
Syntax
int Save(const QString& qsPublicKeyringFile, const QString& qsSecretKeyringFile);
Remarks
Use this method to save the keyring to disk. PGP software typically uses two files to store keyrings, public and private.
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.)
SaveToBytes Method (PGPKeyring Class)
Saves the keyring to a byte array.
Syntax
QByteArray SaveToBytes(bool bSecret);
Remarks
Use this method to save the keyring to a byte array. PGP software typically uses two files to store keyrings. Use Secret parameter to specify which part of the keyring you would like to save (public or secret).
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.
Select Method (PGPKeyring Class)
Filters a selection of keys from the keyring using a template.
Syntax
int Select(const QString& qsFilter, bool bSecretOnly, int iMaxCount);
Remarks
Use this method to get a list of keys that satisfy the Filter criteria. The filter should follow the "Name=Value" format, where Name can be one of the following: userid, fp, fingerprint, and keyid.
Set SecretOnly to True to only search for secret keys. MaxCount allows to limit the number of keys returned.
Once the method completes, the keys that match the criteria will be available in SelectedPublicKeys and SelectedSecretKeys properties.
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.)
Error Event (PGPKeyring Class)
Information about errors during PGP key management.
Syntax
class PGPKeyringErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(PGPKeyringErrorEventParams *e);
// Or, subclass PGPKeyring and override this emitter function. virtual int FireError(PGPKeyringErrorEventParams *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 (PGPKeyring Class)
This event notifies the application about an underlying control flow event.
Syntax
class PGPKeyringNotificationEventParams { 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(PGPKeyringNotificationEventParams *e);
// Or, subclass PGPKeyring and override this emitter function. virtual int FireNotification(PGPKeyringNotificationEventParams *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 (PGPKeyring 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.PGPKeyring Configuration Settings | ||||||||||||||||||||||||||||||
TempPath: Location where the temporary files are stored.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 (PGPKeyring Class)
PGPKeyring 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) |