PGPKeyring Class

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyring class accesses and manages PGP keyring files.

Class Name

SecureBlackbox_PGPKeyring

Procedural Interface

 secureblackbox_pgpkeyring_open();
 secureblackbox_pgpkeyring_close($res);
 secureblackbox_pgpkeyring_register_callback($res, $id, $function);
 secureblackbox_pgpkeyring_get_last_error($res);
 secureblackbox_pgpkeyring_get_last_error_code($res);
 secureblackbox_pgpkeyring_set($res, $id, $index, $value);
 secureblackbox_pgpkeyring_get($res, $id, $index);
 secureblackbox_pgpkeyring_do_addfrombytes($res, $bytes);
 secureblackbox_pgpkeyring_do_addfromfile($res, $filename);
 secureblackbox_pgpkeyring_do_addfromfiles($res, $publickeyringfile, $secretkeyringfile);
 secureblackbox_pgpkeyring_do_addpinned($res);
 secureblackbox_pgpkeyring_do_clear($res);
 secureblackbox_pgpkeyring_do_close($res);
 secureblackbox_pgpkeyring_do_config($res, $configurationstring);
 secureblackbox_pgpkeyring_do_createnew($res);
 secureblackbox_pgpkeyring_do_doaction($res, $actionid, $actionparams);
 secureblackbox_pgpkeyring_do_load($res, $publickeyringfile, $secretkeyringfile);
 secureblackbox_pgpkeyring_do_loadfrombytes($res, $publickeyring, $secretkeyring);
 secureblackbox_pgpkeyring_do_removebyid($res, $keyid);
 secureblackbox_pgpkeyring_do_removepublic($res, $index);
 secureblackbox_pgpkeyring_do_removesecret($res, $index);
 secureblackbox_pgpkeyring_do_save($res, $publickeyringfile, $secretkeyringfile);
 secureblackbox_pgpkeyring_do_savetobytes($res, $secret);
 secureblackbox_pgpkeyring_do_select($res, $filter, $secretonly, $maxcount);

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.

FIPSModeReserved.
OpenedIndicates if the keyring is in an opened state.
PinnedKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
PublicKeyCountThe number of records in the PublicKey arrays.
PublicKeyBitsInKeyIndicates the key length in bits.
PublicKeyCanEncryptReturns True if this key can be used for encryption.
PublicKeyCanSignReturns True if this key can be used for signing.
PublicKeyCurveIndicates the elliptic curve associated with a EC key.
PublicKeyEnabledEnables or disables this key for use in encryption or signing operation.
PublicKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
PublicKeyExpiresIndicates key expiration time in whole days from its generation moment.
PublicKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
PublicKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
PublicKeyIsPublicReturns True if this key is a public key, and False otherwise.
PublicKeyIsSecretReturns True if this key is a secret key, and False otherwise.
PublicKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
PublicKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
PublicKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
PublicKeyKeyIDContains a 8-byte key identifier.
PublicKeyOldPacketFormatIndicates whether legacy (PGP 2.
PublicKeyPassphraseThe key protection password.
PublicKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
PublicKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
PublicKeyProtectionSpecifies the level of protection applied to the secret key.
PublicKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
PublicKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
PublicKeyRevokedReturns True if the key has been revoked, and False otherwise.
PublicKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
PublicKeySubkeyIDContains a 8-byte subkey identifier.
PublicKeyTimestampUse this property to check the time the key was generated.
PublicKeyUsernameSpecifies the name of the user bound to this key.
PublicKeyValidIndicates the validity status of the key.
PublicKeyValidToProvide accurate expiration moment indication.
PublicKeyVersionIndicates the key version.
SecretKeyCountThe number of records in the SecretKey arrays.
SecretKeyBitsInKeyIndicates the key length in bits.
SecretKeyCanEncryptReturns True if this key can be used for encryption.
SecretKeyCanSignReturns True if this key can be used for signing.
SecretKeyCurveIndicates the elliptic curve associated with a EC key.
SecretKeyEnabledEnables or disables this key for use in encryption or signing operation.
SecretKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
SecretKeyExpiresIndicates key expiration time in whole days from its generation moment.
SecretKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SecretKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
SecretKeyIsPublicReturns True if this key is a public key, and False otherwise.
SecretKeyIsSecretReturns True if this key is a secret key, and False otherwise.
SecretKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
SecretKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
SecretKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
SecretKeyKeyIDContains a 8-byte key identifier.
SecretKeyOldPacketFormatIndicates whether legacy (PGP 2.
SecretKeyPassphraseThe key protection password.
SecretKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
SecretKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
SecretKeyProtectionSpecifies the level of protection applied to the secret key.
SecretKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
SecretKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
SecretKeyRevokedReturns True if the key has been revoked, and False otherwise.
SecretKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
SecretKeySubkeyIDContains a 8-byte subkey identifier.
SecretKeyTimestampUse this property to check the time the key was generated.
SecretKeyUsernameSpecifies the name of the user bound to this key.
SecretKeyValidIndicates the validity status of the key.
SecretKeyValidToProvide accurate expiration moment indication.
SecretKeyVersionIndicates the key version.
SelectedPublicKeyCountThe number of records in the SelectedPublicKey arrays.
SelectedPublicKeyBitsInKeyIndicates the key length in bits.
SelectedPublicKeyCanEncryptReturns True if this key can be used for encryption.
SelectedPublicKeyCanSignReturns True if this key can be used for signing.
SelectedPublicKeyCurveIndicates the elliptic curve associated with a EC key.
SelectedPublicKeyEnabledEnables or disables this key for use in encryption or signing operation.
SelectedPublicKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
SelectedPublicKeyExpiresIndicates key expiration time in whole days from its generation moment.
SelectedPublicKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedPublicKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
SelectedPublicKeyIsPublicReturns True if this key is a public key, and False otherwise.
SelectedPublicKeyIsSecretReturns True if this key is a secret key, and False otherwise.
SelectedPublicKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
SelectedPublicKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
SelectedPublicKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
SelectedPublicKeyKeyIDContains a 8-byte key identifier.
SelectedPublicKeyOldPacketFormatIndicates whether legacy (PGP 2.
SelectedPublicKeyPassphraseThe key protection password.
SelectedPublicKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
SelectedPublicKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
SelectedPublicKeyProtectionSpecifies the level of protection applied to the secret key.
SelectedPublicKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
SelectedPublicKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
SelectedPublicKeyRevokedReturns True if the key has been revoked, and False otherwise.
SelectedPublicKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
SelectedPublicKeySubkeyIDContains a 8-byte subkey identifier.
SelectedPublicKeyTimestampUse this property to check the time the key was generated.
SelectedPublicKeyUsernameSpecifies the name of the user bound to this key.
SelectedPublicKeyValidIndicates the validity status of the key.
SelectedPublicKeyValidToProvide accurate expiration moment indication.
SelectedPublicKeyVersionIndicates the key version.
SelectedSecretKeyCountThe number of records in the SelectedSecretKey arrays.
SelectedSecretKeyBitsInKeyIndicates the key length in bits.
SelectedSecretKeyCanEncryptReturns True if this key can be used for encryption.
SelectedSecretKeyCanSignReturns True if this key can be used for signing.
SelectedSecretKeyCurveIndicates the elliptic curve associated with a EC key.
SelectedSecretKeyEnabledEnables or disables this key for use in encryption or signing operation.
SelectedSecretKeyEncryptionAlgorithmIndicates the symmetric algorithm used to encrypt the secret key.
SelectedSecretKeyExpiresIndicates key expiration time in whole days from its generation moment.
SelectedSecretKeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SelectedSecretKeyHashAlgorithmSpecifies the hash algorithm associated with the key.
SelectedSecretKeyIsPublicReturns True if this key is a public key, and False otherwise.
SelectedSecretKeyIsSecretReturns True if this key is a secret key, and False otherwise.
SelectedSecretKeyIsSubkeyReturns True if this key is a subkey of another key, and False otherwise.
SelectedSecretKeyKeyFPThe 20-byte fingerprint (hash value) of this key.
SelectedSecretKeyKeyHashAlgorithmSpecifies the hash algorithm used with DSA keys to calculate signatures.
SelectedSecretKeyKeyIDContains a 8-byte key identifier.
SelectedSecretKeyOldPacketFormatIndicates whether legacy (PGP 2.
SelectedSecretKeyPassphraseThe key protection password.
SelectedSecretKeyPassphraseValidUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
SelectedSecretKeyPrimaryKeyIDIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
SelectedSecretKeyProtectionSpecifies the level of protection applied to the secret key.
SelectedSecretKeyPublicKeyAlgorithmSpecifies the asymmetric algorithm of the key.
SelectedSecretKeyQBitsThe length of the DSA Q (legitimate range: 160-512).
SelectedSecretKeyRevokedReturns True if the key has been revoked, and False otherwise.
SelectedSecretKeySubkeyFPThe 20-byte fingerprint (hash value) of this key's subkey.
SelectedSecretKeySubkeyIDContains a 8-byte subkey identifier.
SelectedSecretKeyTimestampUse this property to check the time the key was generated.
SelectedSecretKeyUsernameSpecifies the name of the user bound to this key.
SelectedSecretKeyValidIndicates the validity status of the key.
SelectedSecretKeyValidToProvide accurate expiration moment indication.
SelectedSecretKeyVersionIndicates 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.

AddFromBytesAdds an existing key to the keyring.
AddFromFileAdds an existing key to the keyring.
AddFromFilesAdds a collection of keys to the keyring.
AddPinnedAdds a pinned secret key to the keyring.
ClearRemoves all the keys from the keyring.
CloseCloses the keyring.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new empty keyring.
DoActionPerforms an additional action.
LoadLoads a keyring from disk.
LoadFromBytesLoads a keyring from two byte arrays.
RemoveByIDRemoves key by its ID.
RemovePublicRemoves the specified public key from the keyring.
RemoveSecretRemoves the specified secret key from the keyring.
SaveSaves the keyring to disk.
SaveToBytesSaves the keyring to a byte array.
SelectFilters 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.

ErrorInformation about errors during PGP key management.
NotificationThis 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.

TempPathLocation where the temporary files are stored.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

FIPSMode Property (SecureBlackbox_PGPKeyring Class)

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_pgpkeyring_get($res, 1 );


secureblackbox_pgpkeyring_set($res, 1, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Opened Property (SecureBlackbox_PGPKeyring Class)

Indicates if the keyring is in an opened state.

Object Oriented Interface


public function getOpened();


Procedural Interface


secureblackbox_pgpkeyring_get($res, 2 );


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 (SecureBlackbox_PGPKeyring Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getPinnedKeyHandle();


public function setPinnedKeyHandle($value);

Procedural Interface


secureblackbox_pgpkeyring_get($res, 10 );


secureblackbox_pgpkeyring_set($res, 10, $value );

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 (SecureBlackbox_PGPKeyring Class)

The number of records in the PublicKey arrays.

Object Oriented Interface


public function getPublicKeyCount();


Procedural Interface


secureblackbox_pgpkeyring_get($res, 33 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at PublicKeyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PublicKeyBitsInKey Property (SecureBlackbox_PGPKeyring Class)

Indicates the key length in bits.

Object Oriented Interface


public function getPublicKeyBitsInKey($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 34 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for encryption.

Object Oriented Interface


public function getPublicKeyCanEncrypt($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 35 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for signing.

Object Oriented Interface


public function getPublicKeyCanSign($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 36 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the elliptic curve associated with a EC key.

Object Oriented Interface


public function getPublicKeyCurve($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 37 , $publickeyindex);


Default Value

''

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

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 (SecureBlackbox_PGPKeyring Class)

Enables or disables this key for use in encryption or signing operation.

Object Oriented Interface


public function getPublicKeyEnabled($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 38 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the symmetric algorithm used to encrypt the secret key.

Object Oriented Interface


public function getPublicKeyEncryptionAlgorithm($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 39 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates key expiration time in whole days from its generation moment.

Object Oriented Interface


public function getPublicKeyExpires($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 40 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getPublicKeyHandle($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 41 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm associated with the key.

Object Oriented Interface


public function getPublicKeyHashAlgorithm($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 42 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a public key, and False otherwise.

Object Oriented Interface


public function getPublicKeyIsPublic($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 43 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a secret key, and False otherwise.

Object Oriented Interface


public function getPublicKeyIsSecret($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 44 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a subkey of another key, and False otherwise.

Object Oriented Interface


public function getPublicKeyIsSubkey($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 45 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key.

Object Oriented Interface


public function getPublicKeyKeyFP($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 46 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm used with DSA keys to calculate signatures.

Object Oriented Interface


public function getPublicKeyKeyHashAlgorithm($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 47 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte key identifier.

Object Oriented Interface


public function getPublicKeyKeyID($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 48 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates whether legacy (PGP 2.

Object Oriented Interface


public function getPublicKeyOldPacketFormat($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 49 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The key protection password.

Object Oriented Interface


public function getPublicKeyPassphrase($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 50 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

Object Oriented Interface


public function getPublicKeyPassphraseValid($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 51 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.

Object Oriented Interface


public function getPublicKeyPrimaryKeyID($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 52 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the level of protection applied to the secret key.

Object Oriented Interface


public function getPublicKeyProtection($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 53 , $publickeyindex);


Default Value

0

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash 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 (SecureBlackbox_PGPKeyring Class)

Specifies the asymmetric algorithm of the key.

Object Oriented Interface


public function getPublicKeyPublicKeyAlgorithm($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 54 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The length of the DSA Q (legitimate range: 160-512).

Object Oriented Interface


public function getPublicKeyQBits($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 55 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if the key has been revoked, and False otherwise.

Object Oriented Interface


public function getPublicKeyRevoked($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 56 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key's subkey.

Object Oriented Interface


public function getPublicKeySubkeyFP($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 57 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte subkey identifier.

Object Oriented Interface


public function getPublicKeySubkeyID($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 58 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check the time the key was generated.

Object Oriented Interface


public function getPublicKeyTimestamp($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 59 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the name of the user bound to this key.

Object Oriented Interface


public function getPublicKeyUsername($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 60 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the validity status of the key.

Object Oriented Interface


public function getPublicKeyValid($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 61 , $publickeyindex);


Default Value

0

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity 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 (SecureBlackbox_PGPKeyring Class)

Provide accurate expiration moment indication.

Object Oriented Interface


public function getPublicKeyValidTo($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 62 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the key version.

Object Oriented Interface


public function getPublicKeyVersion($publickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 63 , $publickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The number of records in the SecretKey arrays.

Object Oriented Interface


public function getSecretKeyCount();


Procedural Interface


secureblackbox_pgpkeyring_get($res, 64 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SecretKeyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SecretKeyBitsInKey Property (SecureBlackbox_PGPKeyring Class)

Indicates the key length in bits.

Object Oriented Interface


public function getSecretKeyBitsInKey($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 65 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for encryption.

Object Oriented Interface


public function getSecretKeyCanEncrypt($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 66 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for signing.

Object Oriented Interface


public function getSecretKeyCanSign($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 67 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the elliptic curve associated with a EC key.

Object Oriented Interface


public function getSecretKeyCurve($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 68 , $secretkeyindex);


Default Value

''

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

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 (SecureBlackbox_PGPKeyring Class)

Enables or disables this key for use in encryption or signing operation.

Object Oriented Interface


public function getSecretKeyEnabled($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 69 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the symmetric algorithm used to encrypt the secret key.

Object Oriented Interface


public function getSecretKeyEncryptionAlgorithm($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 70 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates key expiration time in whole days from its generation moment.

Object Oriented Interface


public function getSecretKeyExpires($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 71 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getSecretKeyHandle($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 72 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm associated with the key.

Object Oriented Interface


public function getSecretKeyHashAlgorithm($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 73 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a public key, and False otherwise.

Object Oriented Interface


public function getSecretKeyIsPublic($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 74 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a secret key, and False otherwise.

Object Oriented Interface


public function getSecretKeyIsSecret($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 75 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a subkey of another key, and False otherwise.

Object Oriented Interface


public function getSecretKeyIsSubkey($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 76 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key.

Object Oriented Interface


public function getSecretKeyKeyFP($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 77 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm used with DSA keys to calculate signatures.

Object Oriented Interface


public function getSecretKeyKeyHashAlgorithm($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 78 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte key identifier.

Object Oriented Interface


public function getSecretKeyKeyID($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 79 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates whether legacy (PGP 2.

Object Oriented Interface


public function getSecretKeyOldPacketFormat($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 80 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The key protection password.

Object Oriented Interface


public function getSecretKeyPassphrase($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 81 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

Object Oriented Interface


public function getSecretKeyPassphraseValid($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 82 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.

Object Oriented Interface


public function getSecretKeyPrimaryKeyID($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 83 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the level of protection applied to the secret key.

Object Oriented Interface


public function getSecretKeyProtection($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 84 , $secretkeyindex);


Default Value

0

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash 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 (SecureBlackbox_PGPKeyring Class)

Specifies the asymmetric algorithm of the key.

Object Oriented Interface


public function getSecretKeyPublicKeyAlgorithm($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 85 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The length of the DSA Q (legitimate range: 160-512).

Object Oriented Interface


public function getSecretKeyQBits($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 86 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if the key has been revoked, and False otherwise.

Object Oriented Interface


public function getSecretKeyRevoked($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 87 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key's subkey.

Object Oriented Interface


public function getSecretKeySubkeyFP($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 88 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte subkey identifier.

Object Oriented Interface


public function getSecretKeySubkeyID($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 89 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check the time the key was generated.

Object Oriented Interface


public function getSecretKeyTimestamp($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 90 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the name of the user bound to this key.

Object Oriented Interface


public function getSecretKeyUsername($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 91 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the validity status of the key.

Object Oriented Interface


public function getSecretKeyValid($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 92 , $secretkeyindex);


Default Value

0

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity 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 (SecureBlackbox_PGPKeyring Class)

Provide accurate expiration moment indication.

Object Oriented Interface


public function getSecretKeyValidTo($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 93 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the key version.

Object Oriented Interface


public function getSecretKeyVersion($secretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 94 , $secretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The number of records in the SelectedPublicKey arrays.

Object Oriented Interface


public function getSelectedPublicKeyCount();


Procedural Interface


secureblackbox_pgpkeyring_get($res, 95 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SelectedPublicKeyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SelectedPublicKeyBitsInKey Property (SecureBlackbox_PGPKeyring Class)

Indicates the key length in bits.

Object Oriented Interface


public function getSelectedPublicKeyBitsInKey($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 96 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for encryption.

Object Oriented Interface


public function getSelectedPublicKeyCanEncrypt($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 97 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for signing.

Object Oriented Interface


public function getSelectedPublicKeyCanSign($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 98 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the elliptic curve associated with a EC key.

Object Oriented Interface


public function getSelectedPublicKeyCurve($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 99 , $selectedpublickeyindex);


Default Value

''

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

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 (SecureBlackbox_PGPKeyring Class)

Enables or disables this key for use in encryption or signing operation.

Object Oriented Interface


public function getSelectedPublicKeyEnabled($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 100 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the symmetric algorithm used to encrypt the secret key.

Object Oriented Interface


public function getSelectedPublicKeyEncryptionAlgorithm($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 101 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates key expiration time in whole days from its generation moment.

Object Oriented Interface


public function getSelectedPublicKeyExpires($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 102 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getSelectedPublicKeyHandle($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 103 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm associated with the key.

Object Oriented Interface


public function getSelectedPublicKeyHashAlgorithm($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 104 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a public key, and False otherwise.

Object Oriented Interface


public function getSelectedPublicKeyIsPublic($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 105 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a secret key, and False otherwise.

Object Oriented Interface


public function getSelectedPublicKeyIsSecret($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 106 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a subkey of another key, and False otherwise.

Object Oriented Interface


public function getSelectedPublicKeyIsSubkey($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 107 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key.

Object Oriented Interface


public function getSelectedPublicKeyKeyFP($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 108 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm used with DSA keys to calculate signatures.

Object Oriented Interface


public function getSelectedPublicKeyKeyHashAlgorithm($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 109 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte key identifier.

Object Oriented Interface


public function getSelectedPublicKeyKeyID($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 110 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates whether legacy (PGP 2.

Object Oriented Interface


public function getSelectedPublicKeyOldPacketFormat($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 111 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The key protection password.

Object Oriented Interface


public function getSelectedPublicKeyPassphrase($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 112 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

Object Oriented Interface


public function getSelectedPublicKeyPassphraseValid($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 113 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.

Object Oriented Interface


public function getSelectedPublicKeyPrimaryKeyID($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 114 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the level of protection applied to the secret key.

Object Oriented Interface


public function getSelectedPublicKeyProtection($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 115 , $selectedpublickeyindex);


Default Value

0

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash 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 (SecureBlackbox_PGPKeyring Class)

Specifies the asymmetric algorithm of the key.

Object Oriented Interface


public function getSelectedPublicKeyPublicKeyAlgorithm($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 116 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The length of the DSA Q (legitimate range: 160-512).

Object Oriented Interface


public function getSelectedPublicKeyQBits($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 117 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if the key has been revoked, and False otherwise.

Object Oriented Interface


public function getSelectedPublicKeyRevoked($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 118 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key's subkey.

Object Oriented Interface


public function getSelectedPublicKeySubkeyFP($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 119 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte subkey identifier.

Object Oriented Interface


public function getSelectedPublicKeySubkeyID($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 120 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check the time the key was generated.

Object Oriented Interface


public function getSelectedPublicKeyTimestamp($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 121 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the name of the user bound to this key.

Object Oriented Interface


public function getSelectedPublicKeyUsername($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 122 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the validity status of the key.

Object Oriented Interface


public function getSelectedPublicKeyValid($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 123 , $selectedpublickeyindex);


Default Value

0

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity 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 (SecureBlackbox_PGPKeyring Class)

Provide accurate expiration moment indication.

Object Oriented Interface


public function getSelectedPublicKeyValidTo($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 124 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the key version.

Object Oriented Interface


public function getSelectedPublicKeyVersion($selectedpublickeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 125 , $selectedpublickeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The number of records in the SelectedSecretKey arrays.

Object Oriented Interface


public function getSelectedSecretKeyCount();


Procedural Interface


secureblackbox_pgpkeyring_get($res, 126 );


Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SelectedSecretKeyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SelectedSecretKeyBitsInKey Property (SecureBlackbox_PGPKeyring Class)

Indicates the key length in bits.

Object Oriented Interface


public function getSelectedSecretKeyBitsInKey($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 127 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for encryption.

Object Oriented Interface


public function getSelectedSecretKeyCanEncrypt($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 128 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key can be used for signing.

Object Oriented Interface


public function getSelectedSecretKeyCanSign($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 129 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the elliptic curve associated with a EC key.

Object Oriented Interface


public function getSelectedSecretKeyCurve($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 130 , $selectedsecretkeyindex);


Default Value

''

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

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 (SecureBlackbox_PGPKeyring Class)

Enables or disables this key for use in encryption or signing operation.

Object Oriented Interface


public function getSelectedSecretKeyEnabled($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 131 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the symmetric algorithm used to encrypt the secret key.

Object Oriented Interface


public function getSelectedSecretKeyEncryptionAlgorithm($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 132 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates key expiration time in whole days from its generation moment.

Object Oriented Interface


public function getSelectedSecretKeyExpires($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 133 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface


public function getSelectedSecretKeyHandle($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 134 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm associated with the key.

Object Oriented Interface


public function getSelectedSecretKeyHashAlgorithm($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 135 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a public key, and False otherwise.

Object Oriented Interface


public function getSelectedSecretKeyIsPublic($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 136 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a secret key, and False otherwise.

Object Oriented Interface


public function getSelectedSecretKeyIsSecret($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 137 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if this key is a subkey of another key, and False otherwise.

Object Oriented Interface


public function getSelectedSecretKeyIsSubkey($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 138 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key.

Object Oriented Interface


public function getSelectedSecretKeyKeyFP($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 139 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the hash algorithm used with DSA keys to calculate signatures.

Object Oriented Interface


public function getSelectedSecretKeyKeyHashAlgorithm($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 140 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte key identifier.

Object Oriented Interface


public function getSelectedSecretKeyKeyID($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 141 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates whether legacy (PGP 2.

Object Oriented Interface


public function getSelectedSecretKeyOldPacketFormat($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 142 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The key protection password.

Object Oriented Interface


public function getSelectedSecretKeyPassphrase($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 143 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

Object Oriented Interface


public function getSelectedSecretKeyPassphraseValid($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 144 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.

Object Oriented Interface


public function getSelectedSecretKeyPrimaryKeyID($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 145 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the level of protection applied to the secret key.

Object Oriented Interface


public function getSelectedSecretKeyProtection($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 146 , $selectedsecretkeyindex);


Default Value

0

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash 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 (SecureBlackbox_PGPKeyring Class)

Specifies the asymmetric algorithm of the key.

Object Oriented Interface


public function getSelectedSecretKeyPublicKeyAlgorithm($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 147 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The length of the DSA Q (legitimate range: 160-512).

Object Oriented Interface


public function getSelectedSecretKeyQBits($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 148 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Returns True if the key has been revoked, and False otherwise.

Object Oriented Interface


public function getSelectedSecretKeyRevoked($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 149 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

The 20-byte fingerprint (hash value) of this key's subkey.

Object Oriented Interface


public function getSelectedSecretKeySubkeyFP($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 150 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Contains a 8-byte subkey identifier.

Object Oriented Interface


public function getSelectedSecretKeySubkeyID($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 151 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Use this property to check the time the key was generated.

Object Oriented Interface


public function getSelectedSecretKeyTimestamp($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 152 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Specifies the name of the user bound to this key.

Object Oriented Interface


public function getSelectedSecretKeyUsername($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 153 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the validity status of the key.

Object Oriented Interface


public function getSelectedSecretKeyValid($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 154 , $selectedsecretkeyindex);


Default Value

0

Remarks

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity 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 (SecureBlackbox_PGPKeyring Class)

Provide accurate expiration moment indication.

Object Oriented Interface


public function getSelectedSecretKeyValidTo($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 155 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Indicates the key version.

Object Oriented Interface


public function getSelectedSecretKeyVersion($selectedsecretkeyindex);


Procedural Interface


secureblackbox_pgpkeyring_get($res, 156 , $selectedsecretkeyindex);


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 (SecureBlackbox_PGPKeyring Class)

Adds an existing key to the keyring.

Object Oriented Interface

public function doAddFromBytes($bytes);

Procedural Interface

secureblackbox_pgpkeyring_do_addfrombytes($res, $bytes);

Remarks

Use this method to add a key stored in a byte array to the keyring.

AddFromFile Method (SecureBlackbox_PGPKeyring Class)

Adds an existing key to the keyring.

Object Oriented Interface

public function doAddFromFile($filename);

Procedural Interface

secureblackbox_pgpkeyring_do_addfromfile($res, $filename);

Remarks

Use this method to add a key stored in a file to the keyring.

AddFromFiles Method (SecureBlackbox_PGPKeyring Class)

Adds a collection of keys to the keyring.

Object Oriented Interface

public function doAddFromFiles($publickeyringfile, $secretkeyringfile);

Procedural Interface

secureblackbox_pgpkeyring_do_addfromfiles($res, $publickeyringfile, $secretkeyringfile);

Remarks

Use this method to add keys stored in two separate keyring files to the keyring.

AddPinned Method (SecureBlackbox_PGPKeyring Class)

Adds a pinned secret key to the keyring.

Object Oriented Interface

public function doAddPinned();

Procedural Interface

secureblackbox_pgpkeyring_do_addpinned($res);

Remarks

Use this method to add a key provided via PinnedKey to the keyring. This can be a public or secret key.

Clear Method (SecureBlackbox_PGPKeyring Class)

Removes all the keys from the keyring.

Object Oriented Interface

public function doClear();

Procedural Interface

secureblackbox_pgpkeyring_do_clear($res);

Remarks

Use this method to remove all the items from the keyring.

Close Method (SecureBlackbox_PGPKeyring Class)

Closes the keyring.

Object Oriented Interface

public function doClose();

Procedural Interface

secureblackbox_pgpkeyring_do_close($res);

Remarks

Use this method to close the keyring and release any associated memory resources.

Config Method (SecureBlackbox_PGPKeyring Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_pgpkeyring_do_config($res, $configurationstring);

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.

CreateNew Method (SecureBlackbox_PGPKeyring Class)

Creates a new empty keyring.

Object Oriented Interface

public function doCreateNew();

Procedural Interface

secureblackbox_pgpkeyring_do_createnew($res);

Remarks

Use this method to initialize a new empty keyring.

DoAction Method (SecureBlackbox_PGPKeyring Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_pgpkeyring_do_doaction($res, $actionid, $actionparams);

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 insensitive) 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;....

Load Method (SecureBlackbox_PGPKeyring Class)

Loads a keyring from disk.

Object Oriented Interface

public function doLoad($publickeyringfile, $secretkeyringfile);

Procedural Interface

secureblackbox_pgpkeyring_do_load($res, $publickeyringfile, $secretkeyringfile);

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.

LoadFromBytes Method (SecureBlackbox_PGPKeyring Class)

Loads a keyring from two byte arrays.

Object Oriented Interface

public function doLoadFromBytes($publickeyring, $secretkeyring);

Procedural Interface

secureblackbox_pgpkeyring_do_loadfrombytes($res, $publickeyring, $secretkeyring);

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.

RemoveByID Method (SecureBlackbox_PGPKeyring Class)

Removes key by its ID.

Object Oriented Interface

public function doRemoveByID($keyid);

Procedural Interface

secureblackbox_pgpkeyring_do_removebyid($res, $keyid);

Remarks

Call this method to remove the specified key from the keyring.

RemovePublic Method (SecureBlackbox_PGPKeyring Class)

Removes the specified public key from the keyring.

Object Oriented Interface

public function doRemovePublic($index);

Procedural Interface

secureblackbox_pgpkeyring_do_removepublic($res, $index);

Remarks

Use this method to remove a public key from the keyring. Use Index to pass the index of the key to be removed.

RemoveSecret Method (SecureBlackbox_PGPKeyring Class)

Removes the specified secret key from the keyring.

Object Oriented Interface

public function doRemoveSecret($index);

Procedural Interface

secureblackbox_pgpkeyring_do_removesecret($res, $index);

Remarks

Use this method to remove a secret key from the keyring. Use Index to pass the index of the key to be removed.

Save Method (SecureBlackbox_PGPKeyring Class)

Saves the keyring to disk.

Object Oriented Interface

public function doSave($publickeyringfile, $secretkeyringfile);

Procedural Interface

secureblackbox_pgpkeyring_do_save($res, $publickeyringfile, $secretkeyringfile);

Remarks

Use this method to save the keyring to disk. PGP software typically uses two files to store keyrings, public and private.

SaveToBytes Method (SecureBlackbox_PGPKeyring Class)

Saves the keyring to a byte array.

Object Oriented Interface

public function doSaveToBytes($secret);

Procedural Interface

secureblackbox_pgpkeyring_do_savetobytes($res, $secret);

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).

Select Method (SecureBlackbox_PGPKeyring Class)

Filters a selection of keys from the keyring using a template.

Object Oriented Interface

public function doSelect($filter, $secretonly, $maxcount);

Procedural Interface

secureblackbox_pgpkeyring_do_select($res, $filter, $secretonly, $maxcount);

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 Event (SecureBlackbox_PGPKeyring Class)

Information about errors during PGP key management.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_pgpkeyring_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

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 (SecureBlackbox_PGPKeyring Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_pgpkeyring_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

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

TempPath:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (PGPKeyring Class)

PGPKeyring Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
27262977   File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS)
27262978   Invalid key (SB_ERROR_PGP_INVALID_KEY)
27262979   No public key (SB_ERROR_PGP_NO_PUBLIC_KEY)
27262980   No secret key (SB_ERROR_PGP_NO_SECRET_KEY)
27262981   Not found (SB_ERROR_PGP_NOT_FOUND)
27262982   Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)