PGPKeyring Class
Properties Methods Events Config 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. |
AddFromStream | Adds a key to the keyring. |
AddFromStreams | 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. |
LoadFromStreams | Loads a keyring from two streams. |
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. |
SaveToStreams | Saves the keyring to streams. |
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. |
Config Settings
The following is a list of config 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. |
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. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
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
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_pgpkeyring_getfipsmode(void* lpObj);
int secureblackbox_pgpkeyring_setfipsmode(void* lpObj, int bFIPSMode);
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
ANSI (Cross Platform) int GetOpened(); Unicode (Windows) BOOL GetOpened();
int secureblackbox_pgpkeyring_getopened(void* lpObj);
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
ANSI (Cross Platform) int64 GetPinnedKeyHandle();
int SetPinnedKeyHandle(int64 lPinnedKeyHandle); Unicode (Windows) LONG64 GetPinnedKeyHandle();
INT SetPinnedKeyHandle(LONG64 lPinnedKeyHandle);
int64 secureblackbox_pgpkeyring_getpinnedkeyhandle(void* lpObj);
int secureblackbox_pgpkeyring_setpinnedkeyhandle(void* lpObj, int64 lPinnedKeyHandle);
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
ANSI (Cross Platform) int GetPublicKeyCount(); Unicode (Windows) INT GetPublicKeyCount();
int secureblackbox_pgpkeyring_getpublickeycount(void* lpObj);
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
ANSI (Cross Platform) int GetPublicKeyBitsInKey(int iPublicKeyIndex); Unicode (Windows) INT GetPublicKeyBitsInKey(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeybitsinkey(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyCanEncrypt(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyCanEncrypt(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeycanencrypt(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyCanSign(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyCanSign(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeycansign(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyCurve(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyCurve(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeycurve(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyEnabled(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyEnabled(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyenabled(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyEncryptionAlgorithm(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyEncryptionAlgorithm(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeyencryptionalgorithm(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyExpires(int iPublicKeyIndex); Unicode (Windows) INT GetPublicKeyExpires(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyexpires(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int64 GetPublicKeyHandle(int iPublicKeyIndex); Unicode (Windows) LONG64 GetPublicKeyHandle(INT iPublicKeyIndex);
int64 secureblackbox_pgpkeyring_getpublickeyhandle(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyHashAlgorithm(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyHashAlgorithm(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeyhashalgorithm(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyIsPublic(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyIsPublic(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyispublic(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyIsSecret(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyIsSecret(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyissecret(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyIsSubkey(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyIsSubkey(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyissubkey(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyKeyFP(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyKeyFP(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeykeyfp(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyKeyHashAlgorithm(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyKeyHashAlgorithm(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeykeyhashalgorithm(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyKeyID(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyKeyID(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeykeyid(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyOldPacketFormat(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyOldPacketFormat(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyoldpacketformat(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyPassphrase(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyPassphrase(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeypassphrase(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyPassphraseValid(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyPassphraseValid(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeypassphrasevalid(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyPrimaryKeyID(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyPrimaryKeyID(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeyprimarykeyid(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyProtection(int iPublicKeyIndex); Unicode (Windows) INT GetPublicKeyProtection(INT iPublicKeyIndex);
Possible Values
PPT_NONE(0),
PPT_LOW(1),
PPT_NORMAL(2),
PPT_HIGH(3)
int secureblackbox_pgpkeyring_getpublickeyprotection(void* lpObj, int publickeyindex);
int GetPublicKeyProtection(int iPublicKeyIndex);
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
ANSI (Cross Platform) char* GetPublicKeyPublicKeyAlgorithm(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyPublicKeyAlgorithm(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeypublickeyalgorithm(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyQBits(int iPublicKeyIndex); Unicode (Windows) INT GetPublicKeyQBits(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyqbits(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyRevoked(int iPublicKeyIndex); Unicode (Windows) BOOL GetPublicKeyRevoked(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyrevoked(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeySubkeyFP(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeySubkeyFP(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeysubkeyfp(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeySubkeyID(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeySubkeyID(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeysubkeyid(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyTimestamp(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyTimestamp(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeytimestamp(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) char* GetPublicKeyUsername(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyUsername(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeyusername(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyValid(int iPublicKeyIndex); Unicode (Windows) INT GetPublicKeyValid(INT iPublicKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
int secureblackbox_pgpkeyring_getpublickeyvalid(void* lpObj, int publickeyindex);
int GetPublicKeyValid(int iPublicKeyIndex);
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
ANSI (Cross Platform) char* GetPublicKeyValidTo(int iPublicKeyIndex); Unicode (Windows) LPWSTR GetPublicKeyValidTo(INT iPublicKeyIndex);
char* secureblackbox_pgpkeyring_getpublickeyvalidto(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetPublicKeyVersion(int iPublicKeyIndex); Unicode (Windows) INT GetPublicKeyVersion(INT iPublicKeyIndex);
int secureblackbox_pgpkeyring_getpublickeyversion(void* lpObj, int publickeyindex);
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
ANSI (Cross Platform) int GetSecretKeyCount(); Unicode (Windows) INT GetSecretKeyCount();
int secureblackbox_pgpkeyring_getsecretkeycount(void* lpObj);
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
ANSI (Cross Platform) int GetSecretKeyBitsInKey(int iSecretKeyIndex); Unicode (Windows) INT GetSecretKeyBitsInKey(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeybitsinkey(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyCanEncrypt(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyCanEncrypt(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeycanencrypt(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyCanSign(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyCanSign(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeycansign(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyCurve(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyCurve(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeycurve(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyEnabled(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyEnabled(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyenabled(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyEncryptionAlgorithm(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyEncryptionAlgorithm(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeyencryptionalgorithm(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyExpires(int iSecretKeyIndex); Unicode (Windows) INT GetSecretKeyExpires(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyexpires(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int64 GetSecretKeyHandle(int iSecretKeyIndex); Unicode (Windows) LONG64 GetSecretKeyHandle(INT iSecretKeyIndex);
int64 secureblackbox_pgpkeyring_getsecretkeyhandle(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyHashAlgorithm(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyHashAlgorithm(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeyhashalgorithm(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyIsPublic(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyIsPublic(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyispublic(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyIsSecret(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyIsSecret(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyissecret(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyIsSubkey(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyIsSubkey(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyissubkey(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyKeyFP(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyKeyFP(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeykeyfp(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyKeyHashAlgorithm(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyKeyHashAlgorithm(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeykeyhashalgorithm(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyKeyID(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyKeyID(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeykeyid(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyOldPacketFormat(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyOldPacketFormat(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyoldpacketformat(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyPassphrase(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyPassphrase(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeypassphrase(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyPassphraseValid(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyPassphraseValid(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeypassphrasevalid(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyPrimaryKeyID(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyPrimaryKeyID(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeyprimarykeyid(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyProtection(int iSecretKeyIndex); Unicode (Windows) INT GetSecretKeyProtection(INT iSecretKeyIndex);
Possible Values
PPT_NONE(0),
PPT_LOW(1),
PPT_NORMAL(2),
PPT_HIGH(3)
int secureblackbox_pgpkeyring_getsecretkeyprotection(void* lpObj, int secretkeyindex);
int GetSecretKeyProtection(int iSecretKeyIndex);
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
ANSI (Cross Platform) char* GetSecretKeyPublicKeyAlgorithm(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyPublicKeyAlgorithm(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeypublickeyalgorithm(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyQBits(int iSecretKeyIndex); Unicode (Windows) INT GetSecretKeyQBits(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyqbits(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyRevoked(int iSecretKeyIndex); Unicode (Windows) BOOL GetSecretKeyRevoked(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyrevoked(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeySubkeyFP(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeySubkeyFP(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeysubkeyfp(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeySubkeyID(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeySubkeyID(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeysubkeyid(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyTimestamp(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyTimestamp(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeytimestamp(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) char* GetSecretKeyUsername(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyUsername(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeyusername(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyValid(int iSecretKeyIndex); Unicode (Windows) INT GetSecretKeyValid(INT iSecretKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
int secureblackbox_pgpkeyring_getsecretkeyvalid(void* lpObj, int secretkeyindex);
int GetSecretKeyValid(int iSecretKeyIndex);
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
ANSI (Cross Platform) char* GetSecretKeyValidTo(int iSecretKeyIndex); Unicode (Windows) LPWSTR GetSecretKeyValidTo(INT iSecretKeyIndex);
char* secureblackbox_pgpkeyring_getsecretkeyvalidto(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSecretKeyVersion(int iSecretKeyIndex); Unicode (Windows) INT GetSecretKeyVersion(INT iSecretKeyIndex);
int secureblackbox_pgpkeyring_getsecretkeyversion(void* lpObj, int secretkeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyCount(); Unicode (Windows) INT GetSelectedPublicKeyCount();
int secureblackbox_pgpkeyring_getselectedpublickeycount(void* lpObj);
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
ANSI (Cross Platform) int GetSelectedPublicKeyBitsInKey(int iSelectedPublicKeyIndex); Unicode (Windows) INT GetSelectedPublicKeyBitsInKey(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeybitsinkey(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyCanEncrypt(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyCanEncrypt(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeycanencrypt(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyCanSign(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyCanSign(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeycansign(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyCurve(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyCurve(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeycurve(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyEnabled(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyEnabled(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyenabled(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyEncryptionAlgorithm(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyEncryptionAlgorithm(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeyencryptionalgorithm(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyExpires(int iSelectedPublicKeyIndex); Unicode (Windows) INT GetSelectedPublicKeyExpires(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyexpires(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int64 GetSelectedPublicKeyHandle(int iSelectedPublicKeyIndex); Unicode (Windows) LONG64 GetSelectedPublicKeyHandle(INT iSelectedPublicKeyIndex);
int64 secureblackbox_pgpkeyring_getselectedpublickeyhandle(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyHashAlgorithm(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyHashAlgorithm(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeyhashalgorithm(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyIsPublic(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyIsPublic(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyispublic(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyIsSecret(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyIsSecret(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyissecret(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyIsSubkey(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyIsSubkey(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyissubkey(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyKeyFP(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyKeyFP(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeykeyfp(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyKeyHashAlgorithm(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyKeyHashAlgorithm(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeykeyhashalgorithm(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyKeyID(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyKeyID(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeykeyid(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyOldPacketFormat(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyOldPacketFormat(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyoldpacketformat(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyPassphrase(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyPassphrase(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeypassphrase(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyPassphraseValid(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyPassphraseValid(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeypassphrasevalid(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyPrimaryKeyID(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyPrimaryKeyID(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeyprimarykeyid(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyProtection(int iSelectedPublicKeyIndex); Unicode (Windows) INT GetSelectedPublicKeyProtection(INT iSelectedPublicKeyIndex);
Possible Values
PPT_NONE(0),
PPT_LOW(1),
PPT_NORMAL(2),
PPT_HIGH(3)
int secureblackbox_pgpkeyring_getselectedpublickeyprotection(void* lpObj, int selectedpublickeyindex);
int GetSelectedPublicKeyProtection(int iSelectedPublicKeyIndex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyPublicKeyAlgorithm(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyPublicKeyAlgorithm(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeypublickeyalgorithm(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyQBits(int iSelectedPublicKeyIndex); Unicode (Windows) INT GetSelectedPublicKeyQBits(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyqbits(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyRevoked(int iSelectedPublicKeyIndex); Unicode (Windows) BOOL GetSelectedPublicKeyRevoked(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyrevoked(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeySubkeyFP(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeySubkeyFP(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeysubkeyfp(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeySubkeyID(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeySubkeyID(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeysubkeyid(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyTimestamp(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyTimestamp(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeytimestamp(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyUsername(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyUsername(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeyusername(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyValid(int iSelectedPublicKeyIndex); Unicode (Windows) INT GetSelectedPublicKeyValid(INT iSelectedPublicKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
int secureblackbox_pgpkeyring_getselectedpublickeyvalid(void* lpObj, int selectedpublickeyindex);
int GetSelectedPublicKeyValid(int iSelectedPublicKeyIndex);
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
ANSI (Cross Platform) char* GetSelectedPublicKeyValidTo(int iSelectedPublicKeyIndex); Unicode (Windows) LPWSTR GetSelectedPublicKeyValidTo(INT iSelectedPublicKeyIndex);
char* secureblackbox_pgpkeyring_getselectedpublickeyvalidto(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedPublicKeyVersion(int iSelectedPublicKeyIndex); Unicode (Windows) INT GetSelectedPublicKeyVersion(INT iSelectedPublicKeyIndex);
int secureblackbox_pgpkeyring_getselectedpublickeyversion(void* lpObj, int selectedpublickeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyCount(); Unicode (Windows) INT GetSelectedSecretKeyCount();
int secureblackbox_pgpkeyring_getselectedsecretkeycount(void* lpObj);
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
ANSI (Cross Platform) int GetSelectedSecretKeyBitsInKey(int iSelectedSecretKeyIndex); Unicode (Windows) INT GetSelectedSecretKeyBitsInKey(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeybitsinkey(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyCanEncrypt(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyCanEncrypt(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeycanencrypt(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyCanSign(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyCanSign(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeycansign(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyCurve(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyCurve(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeycurve(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyEnabled(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyEnabled(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyenabled(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyEncryptionAlgorithm(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyEncryptionAlgorithm(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeyencryptionalgorithm(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyExpires(int iSelectedSecretKeyIndex); Unicode (Windows) INT GetSelectedSecretKeyExpires(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyexpires(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int64 GetSelectedSecretKeyHandle(int iSelectedSecretKeyIndex); Unicode (Windows) LONG64 GetSelectedSecretKeyHandle(INT iSelectedSecretKeyIndex);
int64 secureblackbox_pgpkeyring_getselectedsecretkeyhandle(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyHashAlgorithm(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyHashAlgorithm(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeyhashalgorithm(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyIsPublic(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyIsPublic(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyispublic(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyIsSecret(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyIsSecret(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyissecret(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyIsSubkey(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyIsSubkey(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyissubkey(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyKeyFP(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyKeyFP(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeykeyfp(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyKeyHashAlgorithm(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyKeyHashAlgorithm(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeykeyhashalgorithm(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyKeyID(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyKeyID(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeykeyid(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyOldPacketFormat(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyOldPacketFormat(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyoldpacketformat(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyPassphrase(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyPassphrase(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeypassphrase(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyPassphraseValid(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyPassphraseValid(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeypassphrasevalid(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyPrimaryKeyID(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyPrimaryKeyID(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeyprimarykeyid(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyProtection(int iSelectedSecretKeyIndex); Unicode (Windows) INT GetSelectedSecretKeyProtection(INT iSelectedSecretKeyIndex);
Possible Values
PPT_NONE(0),
PPT_LOW(1),
PPT_NORMAL(2),
PPT_HIGH(3)
int secureblackbox_pgpkeyring_getselectedsecretkeyprotection(void* lpObj, int selectedsecretkeyindex);
int GetSelectedSecretKeyProtection(int iSelectedSecretKeyIndex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyPublicKeyAlgorithm(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyPublicKeyAlgorithm(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeypublickeyalgorithm(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyQBits(int iSelectedSecretKeyIndex); Unicode (Windows) INT GetSelectedSecretKeyQBits(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyqbits(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyRevoked(int iSelectedSecretKeyIndex); Unicode (Windows) BOOL GetSelectedSecretKeyRevoked(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyrevoked(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeySubkeyFP(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeySubkeyFP(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeysubkeyfp(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeySubkeyID(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeySubkeyID(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeysubkeyid(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyTimestamp(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyTimestamp(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeytimestamp(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyUsername(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyUsername(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeyusername(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyValid(int iSelectedSecretKeyIndex); Unicode (Windows) INT GetSelectedSecretKeyValid(INT iSelectedSecretKeyIndex);
Possible Values
PKV_STRICTLY_VALID(0),
PKV_VALID(1),
PKV_INVALID(2),
PKV_FAILURE(3),
PKV_UNKNOWN(4)
int secureblackbox_pgpkeyring_getselectedsecretkeyvalid(void* lpObj, int selectedsecretkeyindex);
int GetSelectedSecretKeyValid(int iSelectedSecretKeyIndex);
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
ANSI (Cross Platform) char* GetSelectedSecretKeyValidTo(int iSelectedSecretKeyIndex); Unicode (Windows) LPWSTR GetSelectedSecretKeyValidTo(INT iSelectedSecretKeyIndex);
char* secureblackbox_pgpkeyring_getselectedsecretkeyvalidto(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int GetSelectedSecretKeyVersion(int iSelectedSecretKeyIndex); Unicode (Windows) INT GetSelectedSecretKeyVersion(INT iSelectedSecretKeyIndex);
int secureblackbox_pgpkeyring_getselectedsecretkeyversion(void* lpObj, int selectedsecretkeyindex);
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
ANSI (Cross Platform) int AddFromBytes(const char* lpBytes, int lenBytes); Unicode (Windows) INT AddFromBytes(LPCSTR lpBytes, INT lenBytes);
int secureblackbox_pgpkeyring_addfrombytes(void* lpObj, const char* lpBytes, int lenBytes);
int AddFromBytes(QByteArray qbaBytes);
Remarks
Use this method to add a key stored in a byte array to the keyring.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddFromFile Method (PGPKeyring Class)
Adds an existing key to the keyring.
Syntax
ANSI (Cross Platform) int AddFromFile(const char* lpszFilename); Unicode (Windows) INT AddFromFile(LPCWSTR lpszFilename);
int secureblackbox_pgpkeyring_addfromfile(void* lpObj, const char* lpszFilename);
int AddFromFile(const QString& qsFilename);
Remarks
Use this method to add a key stored in a file to the keyring.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddFromFiles Method (PGPKeyring Class)
Adds a collection of keys to the keyring.
Syntax
ANSI (Cross Platform) int AddFromFiles(const char* lpszPublicKeyringFile, const char* lpszSecretKeyringFile); Unicode (Windows) INT AddFromFiles(LPCWSTR lpszPublicKeyringFile, LPCWSTR lpszSecretKeyringFile);
int secureblackbox_pgpkeyring_addfromfiles(void* lpObj, const char* lpszPublicKeyringFile, const char* lpszSecretKeyringFile);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddFromStream Method (PGPKeyring Class)
Adds a key to the keyring.
Syntax
ANSI (Cross Platform) int AddFromStream(SecureBlackboxStream* sStream); Unicode (Windows) INT AddFromStream(SecureBlackboxStream* sStream);
int secureblackbox_pgpkeyring_addfromstream(void* lpObj, SecureBlackboxStream* sStream);
int AddFromStream(SecureBlackboxStream* sStream);
Remarks
Use this method to add a key contained in Stream to the keyring.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddFromStreams Method (PGPKeyring Class)
Adds a collection of keys to the keyring.
Syntax
ANSI (Cross Platform) int AddFromStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream); Unicode (Windows) INT AddFromStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
int secureblackbox_pgpkeyring_addfromstreams(void* lpObj, SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
int AddFromStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
Remarks
Use this method to add keys stored in two separate keyring streams to the keyring.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AddPinned Method (PGPKeyring Class)
Adds a pinned secret key to the keyring.
Syntax
ANSI (Cross Platform) int AddPinned(); Unicode (Windows) INT AddPinned();
int secureblackbox_pgpkeyring_addpinned(void* lpObj);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Clear Method (PGPKeyring Class)
Removes all the keys from the keyring.
Syntax
ANSI (Cross Platform) int Clear(); Unicode (Windows) INT Clear();
int secureblackbox_pgpkeyring_clear(void* lpObj);
int Clear();
Remarks
Use this method to remove all the items from the keyring.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Close Method (PGPKeyring Class)
Closes the keyring.
Syntax
ANSI (Cross Platform) int Close(); Unicode (Windows) INT Close();
int secureblackbox_pgpkeyring_close(void* lpObj);
int Close();
Remarks
Use this method to close the keyring and release any associated memory resources.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (PGPKeyring Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_pgpkeyring_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CreateNew Method (PGPKeyring Class)
Creates a new empty keyring.
Syntax
ANSI (Cross Platform) int CreateNew(); Unicode (Windows) INT CreateNew();
int secureblackbox_pgpkeyring_createnew(void* lpObj);
int CreateNew();
Remarks
Use this method to initialize a new empty keyring.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoAction Method (PGPKeyring Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_pgpkeyring_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
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 (case insencitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Load Method (PGPKeyring Class)
Loads a keyring from disk.
Syntax
ANSI (Cross Platform) int Load(const char* lpszPublicKeyringFile, const char* lpszSecretKeyringFile); Unicode (Windows) INT Load(LPCWSTR lpszPublicKeyringFile, LPCWSTR lpszSecretKeyringFile);
int secureblackbox_pgpkeyring_load(void* lpObj, const char* lpszPublicKeyringFile, const char* lpszSecretKeyringFile);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
LoadFromBytes Method (PGPKeyring Class)
Loads a keyring from two byte arrays.
Syntax
ANSI (Cross Platform) int LoadFromBytes(const char* lpPublicKeyring, int lenPublicKeyring, const char* lpSecretKeyring, int lenSecretKeyring); Unicode (Windows) INT LoadFromBytes(LPCSTR lpPublicKeyring, INT lenPublicKeyring, LPCSTR lpSecretKeyring, INT lenSecretKeyring);
int secureblackbox_pgpkeyring_loadfrombytes(void* lpObj, const char* lpPublicKeyring, int lenPublicKeyring, const char* lpSecretKeyring, int lenSecretKeyring);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
LoadFromStreams Method (PGPKeyring Class)
Loads a keyring from two streams.
Syntax
ANSI (Cross Platform) int LoadFromStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream); Unicode (Windows) INT LoadFromStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
int secureblackbox_pgpkeyring_loadfromstreams(void* lpObj, SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
int LoadFromStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
Remarks
Use this method to load a keyring (usually stored in two objects, public and secret) to the keyring object. If you only one keyring object/file, pass null as the second parameter.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RemoveByID Method (PGPKeyring Class)
Removes key by its ID.
Syntax
ANSI (Cross Platform) int RemoveByID(const char* lpszKeyID); Unicode (Windows) INT RemoveByID(LPCWSTR lpszKeyID);
int secureblackbox_pgpkeyring_removebyid(void* lpObj, const char* lpszKeyID);
int RemoveByID(const QString& qsKeyID);
Remarks
Call this method to remove the specified key from the keyring.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RemovePublic Method (PGPKeyring Class)
Removes the specified public key from the keyring.
Syntax
ANSI (Cross Platform) int RemovePublic(int iIndex); Unicode (Windows) INT RemovePublic(INT iIndex);
int secureblackbox_pgpkeyring_removepublic(void* lpObj, int iIndex);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RemoveSecret Method (PGPKeyring Class)
Removes the specified secret key from the keyring.
Syntax
ANSI (Cross Platform) int RemoveSecret(int iIndex); Unicode (Windows) INT RemoveSecret(INT iIndex);
int secureblackbox_pgpkeyring_removesecret(void* lpObj, int iIndex);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Save Method (PGPKeyring Class)
Saves the keyring to disk.
Syntax
ANSI (Cross Platform) int Save(const char* lpszPublicKeyringFile, const char* lpszSecretKeyringFile); Unicode (Windows) INT Save(LPCWSTR lpszPublicKeyringFile, LPCWSTR lpszSecretKeyringFile);
int secureblackbox_pgpkeyring_save(void* lpObj, const char* lpszPublicKeyringFile, const char* lpszSecretKeyringFile);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SaveToBytes Method (PGPKeyring Class)
Saves the keyring to a byte array.
Syntax
ANSI (Cross Platform) char* SaveToBytes(int bSecret, int *lpSize = NULL); Unicode (Windows) LPSTR SaveToBytes(BOOL bSecret, LPINT lpSize = NULL);
char* secureblackbox_pgpkeyring_savetobytes(void* lpObj, int bSecret, int *lpSize);
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 (C++)
This method returns a Byte Array value (with length lpSize); 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.
SaveToStreams Method (PGPKeyring Class)
Saves the keyring to streams.
Syntax
ANSI (Cross Platform) int SaveToStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream); Unicode (Windows) INT SaveToStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
int secureblackbox_pgpkeyring_savetostreams(void* lpObj, SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
int SaveToStreams(SecureBlackboxStream* sPublicKeyringStream, SecureBlackboxStream* sSecretKeyringStream);
Remarks
Use this method to save the keyring to streams. PGP software typically uses two files to store keyrings, public and private.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Select Method (PGPKeyring Class)
Filters a selection of keys from the keyring using a template.
Syntax
ANSI (Cross Platform) int Select(const char* lpszFilter, int bSecretOnly, int iMaxCount); Unicode (Windows) INT Select(LPCWSTR lpszFilter, BOOL bSecretOnly, INT iMaxCount);
int secureblackbox_pgpkeyring_select(void* lpObj, const char* lpszFilter, int bSecretOnly, int iMaxCount);
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 (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (PGPKeyring Class)
Information about errors during PGP key management.
Syntax
ANSI (Cross Platform) virtual int FireError(PGPKeyringErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } PGPKeyringErrorEventParams;
Unicode (Windows) virtual INT FireError(PGPKeyringErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } PGPKeyringErrorEventParams;
#define EID_PGPKEYRING_ERROR 1 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
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
ANSI (Cross Platform) virtual int FireNotification(PGPKeyringNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } PGPKeyringNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(PGPKeyringNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } PGPKeyringNotificationEventParams;
#define EID_PGPKEYRING_NOTIFICATION 2 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
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.
SecureBlackboxStream Type
Syntax
SecureBlackboxStream (declared in secureblackbox.h)
Remarks
The PGPKeyring class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the PGPKeyring class an instance of that concrete class.
When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config 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 Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (PGPKeyring Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
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) |