Struct secureblackbox::PGPKeyManager

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyManager struct manages individual PGP keys.

Syntax

secureblackbox::PGPKeyManager

Remarks

PGPKeyManager provides means for generating, checking, and editing individual PGP keys.

PGPKeyManager can work with RSA, Elgamal (DH), ECDSA, DSS, and EdDSA keypairs with or without subkeys. Public and private PGP keys of versions 2, 3, 4, 5, and 6 are supported.

Note: if you are looking to work with multi-key files ('keyrings'), please see the PGPKeyring component instead. PGPKeyManager works with individual PGP key structures ('key trees' - one primary key with subkeys). For that same reason, consider using PGPKeyring for loading keys that are to be used with PGPWriter and PGPReader for signing or encryption. It is often the case that even allegedly single-key files actually contain more than one key tree, which may lead to key material loss if they are loaded into PGPKeyManager.

Or, putting it in a simple way:

  • Use PGPKeyManager if you need to alter a key (e.g. generate, add or remove subkeys, revoke, re-sign, change password).
  • Where you need to use an existing key (e.g. for signing), use PGPKeyring, even if it is a standalone key.
  • To alter a key residing in a keyring, load the keyring files into PGPKeyring first. The assign the key in question to PGPKeyManager, make the necessary changes, return it back to the keyring, and re-save the keyring.

You can load keys into a PGPKeyManager object in one of the following ways:

Mgr.ImportFromFile("key.pub"); Once you have the key loaded in your PGPKeyManager object, you can perform a variety of operations on it:
  • Iterate over elements of the key tree using subkeys, signatures, and users collections.
  • Add new subkeys to it using create_subkey method. Note that your new subkey is unlikely to be accepted elsewhere unless you sign it.
  • Add new user records to the key with create_user method.
  • Signing keys, subkeys, and user records (existing or new) with this or another private key using sign_key, sign_subkey, and sign_user methods. The new signatures are added to the key tree.
  • Remove or revoke existing subkeys, user records, and signatures.
  • Change the key protection level or password.

Note: Use pinning to copy keys between PGPKeyring and PGPKeyManager: Keyring.PinnedKey = Mgr.Key; Keyring.ImportPinned(); Mgr.PinnedKey = Keyring.SelectedKeys[i]; Mgr.ImportPinned(); Once your work with the key tree has completed, save it to a buffer or file using export_bytes and export_to_file methods.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the PGPKeyManager struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PGPKeyManager when you have finished using the instance.

Property List

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

key_bits_in_keyIndicates the key length in bits.
key_can_encryptReturns True if this key can be used for encryption.
key_can_signReturns True if this key can be used for signing.
key_curveIndicates the elliptic curve associated with a EC key.
key_enabledEnables or disables this key for use in encryption or signing operation.
key_encryption_algorithmIndicates the symmetric algorithm used to encrypt the secret key.
key_is_publicReturns True if this key is a public key, and False otherwise.
key_is_secretReturns True if this key is a secret key, and False otherwise.
key_is_subkeyReturns True if this key is a subkey of another key, and False otherwise.
key_fpThe 20-byte fingerprint (hash value) of this key.
key_idContains a 8-byte key identifier.
key_passphraseThe key protection password.
key_passphrase_validUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
key_primary_key_idIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
key_protectionSpecifies the level of protection applied to the secret key.
key_public_key_algorithmSpecifies the asymmetric algorithm of the key.
key_q_bitsThe length of the DSA Q (legitimate range: 160-512).
key_timestampUse this property to check the time the key was generated.
key_usernameSpecifies the name of the user bound to this key.
key_valid_toProvide accurate expiration moment indication.
key_versionIndicates the key version.
pinned_key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
signature_countThe number of records in the Signature arrays.
signature_certification_typeSpecifies the type of a UserID signature.
signature_creation_timeThe time when the signature was created, in Universal Coordinated Time (UTC).
signature_expiration_timeSpecifies signature expiration time, in seconds since its creation time (CreationTime).
signature_exportableSpecifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
signature_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
signature_hash_algorithmSpecifies the hash algorithm used in the signature.
signature_hash_markReturns the hash mark attribute of a signature.
signature_key_expiration_timeThe number of seconds after which the signed key will expire.
signature_key_flagsReturns the key flags included in the signature.
signature_legacy_formatIndicates whether signature uses PGP 2.
signature_policy_urlContains the URL of the signature policy.
signature_preferred_algorithmsContains a list of algorithms preferred by the signed key holder.
signature_primary_user_idIndicates whether the UserID covered by the signature is the main user id for this key.
signature_reason_for_revocationDescribes the reason why the key or the certificate was revoked.
signature_revocableSpecifies whether the signature can be revoked.
signature_revocationIndicates whether or not the signature is a revocation signature.
signature_classIndicates the signature class.
signature_signer_key_idIndicates the KeyID of the signing key.
signature_signer_user_idIndicates the UserID associated with the signing key.
signature_strictly_validReturns True if this signature is valid in a strict way (no compatibility relaxations).
signature_targetIndicates the KeyID or Username of the target key or user.
signature_text_signatureIndicates whether or not the signature is made over a text document.
signature_trust_amountSpecifies the amount of trust assigned by this signature.
signature_trust_levelThe trust level assigned by this signature.
signature_validatedWhether the signature has been validated.
signature_validityProvides the validity status of the signature if the signature has been validated.
signature_versionIndicates the signature version.
signing_key_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
subkey_countThe number of records in the Subkey arrays.
subkey_bits_in_keyIndicates the key length in bits.
subkey_can_encryptReturns True if this key can be used for encryption.
subkey_can_signReturns True if this key can be used for signing.
subkey_curveIndicates the elliptic curve associated with a EC key.
subkey_enabledEnables or disables this key for use in encryption or signing operation.
subkey_encryption_algorithmIndicates the symmetric algorithm used to encrypt the secret key.
subkey_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
subkey_is_publicReturns True if this key is a public key, and False otherwise.
subkey_is_secretReturns True if this key is a secret key, and False otherwise.
subkey_is_subkeyReturns True if this key is a subkey of another key, and False otherwise.
subkey_key_fpThe 20-byte fingerprint (hash value) of this key.
subkey_key_idContains a 8-byte key identifier.
subkey_passphraseThe key protection password.
subkey_passphrase_validUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
subkey_primary_key_idIf this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.
subkey_protectionSpecifies the level of protection applied to the secret key.
subkey_public_key_algorithmSpecifies the asymmetric algorithm of the key.
subkey_q_bitsThe length of the DSA Q (legitimate range: 160-512).
subkey_timestampUse this property to check the time the key was generated.
subkey_usernameSpecifies the name of the user bound to this key.
subkey_valid_toProvide accurate expiration moment indication.
subkey_versionIndicates the key version.
user_countThe number of records in the User arrays.
user_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
usernameSpecifies the user name of user.

Method List

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

change_passphraseChanges the password of the secret key.
change_protectionChanges the protection level of the secret key.
check_passphraseChecks if the password matches the secret key.
configSets or retrieves a configuration setting.
create_keyGenerates a new key.
create_subkeyGenerates a new subkey.
create_userAdds a user to an existing key.
do_actionPerforms an additional action.
export_bytesSerializes the key to a byte array.
export_to_fileExports the key to a file.
generate_pairGenerates a new pair of PGP keys.
import_bytesLoads a key from a byte array.
import_from_fileLoads a key from a file.
import_pinnedLoads a key from a pinned key object.
remove_signatureUnbinds the specified signature from the key, subkey or user.
remove_subkeyRemoves the specified subkey from the key.
remove_userUnbinds the specified user from the key.
resetCreates a new empty keyring.
revoke_keyRevokes the key.
revoke_subkeyRevokes the key's subkey.
revoke_userRevokes a user certification.
sign_keySign the key.
sign_subkeySign the key's subkey.
sign_userCreates a user certification.
verifyVerifies the integrity of a key signature.

Event List

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

on_errorInformation about errors during PGP key management.
on_key_passphrase_neededRequests a key protection password from the application.
on_notificationThis event notifies the application about an underlying control flow event.

Config Settings

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

ArmorEnables or disables ASCII armouring.
ArmorBoundarySpecifies the armour boundary/title.
ArmorHeadersSpecifies armour headers.
HashAlgorithmThe hash algorithm to use with the operation, when not accepted via a parameter.
KeyFlagsSpecifies key flags for user certification signatures.
KeyHashAlgorithmThe hash algorithm associated with the key.
PreferredAlgsSpecifies preferred algorithms for user certification signatures.
RawKeyFormatSpecifies whether low-level key format should be used as input or output of an operation.
RespectKeyUsageEnables policy-based key usage checks.
SaveKeyTrustTells the struct to include the trust packets with the serialized keys.
SaveSecretKeySignaturesEnforces saving of signature packets to the secret keyring file.
SignatureCreationTimeIndicates the signature creation time.
SignatureExpirationTimeReturns or sets the signature expiration time.
SignatureHashAlgorithmThe hash algorithm of the signature.
SubkeyIndexAllows to select a specific subkey for certain operations.
UseLongKeyIDsUse full-length KeyID format.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
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 struct.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
EnableSSHMLKEMEnables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs.
EnableTLSMLKEMEnables support for ML-KEM and hybrid groups in TLS client and server structs.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client structs created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
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.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
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.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client structs should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

key_bits_in_key property (PGPKeyManager Struct)

Indicates the key length in bits.

Syntax

fn key_bits_in_key(&self ) -> Result<i32, SecureBlackboxError>

Default Value

2048

Remarks

Indicates the key length in bits.

This property is read-only.

Data Type

i32

key_can_encrypt property (PGPKeyManager Struct)

Returns True if this key can be used for encryption.

Syntax

fn key_can_encrypt(&self ) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Returns True if this key can be used for encryption.

This property is read-only.

Data Type

bool

key_can_sign property (PGPKeyManager Struct)

Returns True if this key can be used for signing.

Syntax

fn key_can_sign(&self ) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Returns True if this key can be used for signing.

This property is read-only.

Data Type

bool

key_curve property (PGPKeyManager Struct)

Indicates the elliptic curve associated with a EC key.

Syntax

fn key_curve(&self ) -> Result<String, SecureBlackboxError>

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

This property is read-only.

Data Type

String

key_enabled property (PGPKeyManager Struct)

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

Syntax

fn key_enabled(&self ) -> Result<bool, SecureBlackboxError> 
fn set_key_enabled(&self, value : bool) ->  Option<SecureBlackboxError>

Default Value

false

Remarks

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

Data Type

bool

key_encryption_algorithm property (PGPKeyManager Struct)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

fn key_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError>

Default Value

"AES128"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

This property is read-only.

Data Type

String

key_is_public property (PGPKeyManager Struct)

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

Syntax

fn key_is_public(&self ) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_is_secret property (PGPKeyManager Struct)

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

Syntax

fn key_is_secret(&self ) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_is_subkey property (PGPKeyManager Struct)

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

Syntax

fn key_is_subkey(&self ) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_fp property (PGPKeyManager Struct)

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

Syntax

fn key_fp(&self ) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

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

KeyFP could be used to distinguish two keys with the same KeyID.

This property is read-only.

Data Type

String

key_id property (PGPKeyManager Struct)

Contains a 8-byte key identifier.

Syntax

fn key_id(&self ) -> Result<String, SecureBlackboxError>

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.

This property is read-only.

Data Type

String

key_passphrase property (PGPKeyManager Struct)

The key protection password.

Syntax

fn key_passphrase(&self ) -> Result<String, SecureBlackboxError> 
fn set_key_passphrase(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_key_passphrase_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

""

Remarks

The key protection password.

Data Type

String

key_passphrase_valid property (PGPKeyManager Struct)

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

Syntax

fn key_passphrase_valid(&self ) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

key_primary_key_id property (PGPKeyManager Struct)

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

Syntax

fn key_primary_key_id(&self ) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

key_protection property (PGPKeyManager Struct)

Specifies the level of protection applied to the secret key.

Syntax

fn key_protection(&self ) -> Result<i32, SecureBlackboxError>

Possible Values

0   // None
1   // Low
2   // Normal
3   // High

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

This property is read-only.

Data Type

i32

key_public_key_algorithm property (PGPKeyManager Struct)

Specifies the asymmetric algorithm of the key.

Syntax

fn key_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

This property is read-only.

Data Type

String

key_q_bits property (PGPKeyManager Struct)

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

Syntax

fn key_q_bits(&self ) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

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

This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.

This property is read-only.

Data Type

i32

key_timestamp property (PGPKeyManager Struct)

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

Syntax

fn key_timestamp(&self ) -> Result<String, SecureBlackboxError>

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

This property is read-only.

Data Type

String

key_username property (PGPKeyManager Struct)

Specifies the name of the user bound to this key.

Syntax

fn key_username(&self ) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

This property is read-only.

Data Type

String

key_valid_to property (PGPKeyManager Struct)

Provide accurate expiration moment indication.

Syntax

fn key_valid_to(&self ) -> Result<String, SecureBlackboxError>

Default Value

"0"

Remarks

Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.

This property is read-only.

Data Type

String

key_version property (PGPKeyManager Struct)

Indicates the key version.

Syntax

fn key_version(&self ) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6.

This property is read-only.

Data Type

i32

pinned_key_handle property (PGPKeyManager Struct)

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

Syntax

fn pinned_key_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_pinned_key_handle(&self, value : i64) ->  Option<SecureBlackboxError>

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());

Data Type

i64

signature_count property (PGPKeyManager Struct)

The number of records in the Signature arrays.

Syntax

fn signature_count(&self ) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

Data Type

i32

signature_certification_type property (PGPKeyManager Struct)

Specifies the type of a UserID signature.

Syntax

fn signature_certification_type(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Possible Values

0   // Generic
1   // Persona
2   // Casual
3   // Positive

Default Value

0

Remarks

Specifies the type of a UserID signature.

pctGeneric0Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type.
pctPersona1Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID.
pctCasual2Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity.
pctPositive3Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_creation_time property (PGPKeyManager Struct)

The time when the signature was created, in Universal Coordinated Time (UTC).

Syntax

fn signature_creation_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

The time when the signature was created, in Universal Coordinated Time (UTC).

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_expiration_time property (PGPKeyManager Struct)

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Syntax

fn signature_expiration_time(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

Specifies signature expiration time, in seconds since its creation time (CreationTime).

This property set to 0 indicates that the signature never expires.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_exportable property (PGPKeyManager Struct)

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

Syntax

fn signature_exportable(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_handle property (PGPKeyManager Struct)

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

Syntax

fn signature_handle(&self , SignatureIndex : i32) -> Result<i64, SecureBlackboxError>

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 SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i64

signature_hash_algorithm property (PGPKeyManager Struct)

Specifies the hash algorithm used in the signature.

Syntax

fn signature_hash_algorithm(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Specifies the hash algorithm used in the signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_hash_mark property (PGPKeyManager Struct)

Returns the hash mark attribute of a signature.

Syntax

fn signature_hash_mark(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

Returns the hash mark attribute of a signature.

Check this property to get a hash mark of a signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_key_expiration_time property (PGPKeyManager Struct)

The number of seconds after which the signed key will expire.

Syntax

fn signature_key_expiration_time(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

The number of seconds after which the signed key will expire.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_key_flags property (PGPKeyManager Struct)

Returns the key flags included in the signature.

Syntax

fn signature_key_flags(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

Returns the key flags included in the signature.

Use this property to retrieve the key flags stored in the key signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_legacy_format property (PGPKeyManager Struct)

Indicates whether signature uses PGP 2.

Syntax

fn signature_legacy_format(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Indicates whether signature uses PGP 2.6.x-compatible packet format.

The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_policy_url property (PGPKeyManager Struct)

Contains the URL of the signature policy.

Syntax

fn signature_policy_url(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Contains the URL of the signature policy.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_preferred_algorithms property (PGPKeyManager Struct)

Contains a list of algorithms preferred by the signed key holder.

Syntax

fn signature_preferred_algorithms(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Contains a list of algorithms preferred by the signed key holder.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_primary_user_id property (PGPKeyManager Struct)

Indicates whether the UserID covered by the signature is the main user id for this key.

Syntax

fn signature_primary_user_id(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Indicates whether the UserID covered by the signature is the main user id for this key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_reason_for_revocation property (PGPKeyManager Struct)

Describes the reason why the key or the certificate was revoked.

Syntax

fn signature_reason_for_revocation(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Describes the reason why the key or the certificate was revoked.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_revocable property (PGPKeyManager Struct)

Specifies whether the signature can be revoked.

Syntax

fn signature_revocable(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Specifies whether the signature can be revoked.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_revocation property (PGPKeyManager Struct)

Indicates whether or not the signature is a revocation signature.

Syntax

fn signature_revocation(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Indicates whether or not the signature is a revocation signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_class property (PGPKeyManager Struct)

Indicates the signature class.

Syntax

fn signature_class(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Possible Values

0   // Document
1   // TextDocument
2   // Standalone
3   // UIDGeneric
4   // UIDPersona
5   // UIDCasual
6   // UIDPositive
7   // SubkeyBinding
8   // PrimaryKeyBinding
9   // DirectKey
10   // KeyRevocation
11   // SubkeyRevocation
12   // CertRevocation
13   // Timestamp
14   // ThirdParty
15   // NotSpecified

Default Value

0

Remarks

Indicates the signature class.

pscDocument0Signature over binary file
pscTextDocument1Signature over text
pscStandalone2A standalone signature
pscUIDGeneric3User certification signature
pscUIDPersona4User certification signature (persona)
pscUIDCasual5User certification signature (casual)
pscUIDPositive6User certification signature (positive)
pscSubkeyBinding7Subkey binding signature
pscPrimaryKeyBinding8Primary key binding signature
pscDirectKey9Direct signature over a public key
pscKeyRevocation10Key revocation
pscSubkeyRevocation11Subkey revocation
pscCertRevocation12User revocation
pscTimestamp13Timestamp signature
pscThirdParty14Third-party signature
pscNotSpecified15Signature type not provided

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_signer_key_id property (PGPKeyManager Struct)

Indicates the KeyID of the signing key.

Syntax

fn signature_signer_key_id(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Indicates the KeyID of the signing key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_signer_user_id property (PGPKeyManager Struct)

Indicates the UserID associated with the signing key.

Syntax

fn signature_signer_user_id(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Indicates the UserID associated with the signing key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_strictly_valid property (PGPKeyManager Struct)

Returns True if this signature is valid in a strict way (no compatibility relaxations).

Syntax

fn signature_strictly_valid(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Returns True if this signature is valid in a strict way (no compatibility relaxations).

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_target property (PGPKeyManager Struct)

Indicates the KeyID or Username of the target key or user.

Syntax

fn signature_target(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Indicates the KeyID or Username of the target key or user.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_text_signature property (PGPKeyManager Struct)

Indicates whether or not the signature is made over a text document.

Syntax

fn signature_text_signature(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Indicates whether or not the signature is made over a text document.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_trust_amount property (PGPKeyManager Struct)

Specifies the amount of trust assigned by this signature.

Syntax

fn signature_trust_amount(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

Specifies the amount of trust assigned by this signature.

Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_trust_level property (PGPKeyManager Struct)

The trust level assigned by this signature.

Syntax

fn signature_trust_level(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

The trust level assigned by this signature.

Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_validated property (PGPKeyManager Struct)

Whether the signature has been validated.

Syntax

fn signature_validated(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Whether the signature has been validated.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_validity property (PGPKeyManager Struct)

Provides the validity status of the signature if the signature has been validated.

Syntax

fn signature_validity(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

0

Remarks

Provides the validity status of the signature if the signature has been validated.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_version property (PGPKeyManager Struct)

Indicates the signature version.

Syntax

fn signature_version(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

Indicates the signature version.

RFC 4880 defines two versions for PGP signatures: 3 and 4.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signing_key_handle property (PGPKeyManager Struct)

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

Syntax

fn signing_key_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_signing_key_handle(&self, value : i64) ->  Option<SecureBlackboxError>

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());

Data Type

i64

subkey_count property (PGPKeyManager Struct)

The number of records in the Subkey arrays.

Syntax

fn subkey_count(&self ) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

Data Type

i32

subkey_bits_in_key property (PGPKeyManager Struct)

Indicates the key length in bits.

Syntax

fn subkey_bits_in_key(&self , SubkeyIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

2048

Remarks

Indicates the key length in bits.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

i32

subkey_can_encrypt property (PGPKeyManager Struct)

Returns True if this key can be used for encryption.

Syntax

fn subkey_can_encrypt(&self , SubkeyIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Returns True if this key can be used for encryption.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

bool

subkey_can_sign property (PGPKeyManager Struct)

Returns True if this key can be used for signing.

Syntax

fn subkey_can_sign(&self , SubkeyIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

Returns True if this key can be used for signing.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

bool

subkey_curve property (PGPKeyManager Struct)

Indicates the elliptic curve associated with a EC key.

Syntax

fn subkey_curve(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_enabled property (PGPKeyManager Struct)

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

Syntax

fn subkey_enabled(&self , SubkeyIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

bool

subkey_encryption_algorithm property (PGPKeyManager Struct)

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

fn subkey_encryption_algorithm(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

"AES128"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_handle property (PGPKeyManager Struct)

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

Syntax

fn subkey_handle(&self , SubkeyIndex : i32) -> Result<i64, SecureBlackboxError>

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

i64

subkey_is_public property (PGPKeyManager Struct)

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

Syntax

fn subkey_is_public(&self , SubkeyIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

bool

subkey_is_secret property (PGPKeyManager Struct)

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

Syntax

fn subkey_is_secret(&self , SubkeyIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

bool

subkey_is_subkey property (PGPKeyManager Struct)

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

Syntax

fn subkey_is_subkey(&self , SubkeyIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

bool

subkey_key_fp property (PGPKeyManager Struct)

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

Syntax

fn subkey_key_fp(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_key_id property (PGPKeyManager Struct)

Contains a 8-byte key identifier.

Syntax

fn subkey_key_id(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_passphrase property (PGPKeyManager Struct)

The key protection password.

Syntax

fn subkey_passphrase(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

The key protection password.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_passphrase_valid property (PGPKeyManager Struct)

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

Syntax

fn subkey_passphrase_valid(&self , SubkeyIndex : i32) -> Result<bool, SecureBlackboxError>

Default Value

false

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

bool

subkey_primary_key_id property (PGPKeyManager Struct)

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

Syntax

fn subkey_primary_key_id(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

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

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_protection property (PGPKeyManager Struct)

Specifies the level of protection applied to the secret key.

Syntax

fn subkey_protection(&self , SubkeyIndex : i32) -> Result<i32, SecureBlackboxError>

Possible Values

0   // None
1   // Low
2   // Normal
3   // High

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

i32

subkey_public_key_algorithm property (PGPKeyManager Struct)

Specifies the asymmetric algorithm of the key.

Syntax

fn subkey_public_key_algorithm(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Specifies the asymmetric algorithm of the key.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_q_bits property (PGPKeyManager Struct)

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

Syntax

fn subkey_q_bits(&self , SubkeyIndex : i32) -> Result<i32, SecureBlackboxError>

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

i32

subkey_timestamp property (PGPKeyManager Struct)

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

Syntax

fn subkey_timestamp(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_username property (PGPKeyManager Struct)

Specifies the name of the user bound to this key.

Syntax

fn subkey_username(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

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 SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_valid_to property (PGPKeyManager Struct)

Provide accurate expiration moment indication.

Syntax

fn subkey_valid_to(&self , SubkeyIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

"0"

Remarks

Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

String

subkey_version property (PGPKeyManager Struct)

Indicates the key version.

Syntax

fn subkey_version(&self , SubkeyIndex : i32) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6.

The SubkeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

This property is read-only.

Data Type

i32

user_count property (PGPKeyManager Struct)

The number of records in the User arrays.

Syntax

fn user_count(&self ) -> Result<i32, SecureBlackboxError>

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

Data Type

i32

user_handle property (PGPKeyManager Struct)

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

Syntax

fn user_handle(&self , UserIndex : i32) -> Result<i64, SecureBlackboxError>

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 UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is read-only.

Data Type

i64

username property (PGPKeyManager Struct)

Specifies the user name of user.

Syntax

fn username(&self , UserIndex : i32) -> Result<String, SecureBlackboxError>

Default Value

""

Remarks

Specifies the user name of user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

This property is read-only.

Data Type

String

change_passphrase method (PGPKeyManager Struct)

Changes the password of the secret key.

Syntax

fn change_passphrase(&self, old_passphrase : &str, new_passphrase : &str) -> Result<(), SecureBlackboxError>

Remarks

Call this method to change the password that protects the secret key and all its subkeys.

Note: use SubkeyIndex configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys).

change_protection method (PGPKeyManager Struct)

Changes the protection level of the secret key.

Syntax

fn change_protection(&self, old_passphrase : &str, new_passphrase : &str, prot_type : i32, enc_algorithm : &str, hash_algorithm : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to change the protection level of the key.

OldPassphrase specifies the current password to decrypt the key, NewPassphrase is the new password for the key, ProtType is the new protection type (see for more details), EncAlgorithm is the key encryption algorithm, and

SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXTPlaintext
SB_PGP_SYMMETRIC_ALGORITHM_IDEAIdea
SB_PGP_SYMMETRIC_ALGORITHM_3DES3DES
SB_PGP_SYMMETRIC_ALGORITHM_CAST5CAST5
SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_PGP_SYMMETRIC_ALGORITHM_AES128AES128
SB_PGP_SYMMETRIC_ALGORITHM_AES192AES192
SB_PGP_SYMMETRIC_ALGORITHM_AES256AES256
SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256
and HashAlgorithm specify the algorithms to be used for key derivation.
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

Note: use SubkeyIndex configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys).

check_passphrase method (PGPKeyManager Struct)

Checks if the password matches the secret key.

Syntax

fn check_passphrase(&self, passphrase : &str) ->  Result<bool, SecureBlackboxError>

Remarks

Use this method to check if a password can decrypt the key.

config method (PGPKeyManager Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

create_key method (PGPKeyManager Struct)

Generates a new key.

Syntax

fn create_key(&self, version : i32, algorithm : &str, bits : i32, valid_to : &str, password : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to generate a new key with the provided parameters.

create_subkey method (PGPKeyManager Struct)

Generates a new subkey.

Syntax

fn create_subkey(&self, algorithm : &str, bits : i32, valid_to : &str, password : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to generate a new subkey with the provided parameters.

create_user method (PGPKeyManager Struct)

Adds a user to an existing key.

Syntax

fn create_user(&self, username : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to add a user to an existing key. A typical format for a PGP key usage is "Name <email>", for example "John Johnson <john@johnson.com>".

do_action method (PGPKeyManager Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. 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;....

Common ActionIDs:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

export_bytes method (PGPKeyManager Struct)

Serializes the key to a byte array.

Syntax

fn export_bytes(&self, secret : bool) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to save the key (both the public and secret parts) to a byte array.

export_to_file method (PGPKeyManager Struct)

Exports the key to a file.

Syntax

fn export_to_file(&self, file_name : &str, secret : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to save the key (both the public and secret parts) to the file specified in Filename.

generate_pair method (PGPKeyManager Struct)

Generates a new pair of PGP keys.

Syntax

fn generate_pair(&self, version : i32, username : &str, strength : i32, valid_to : &str, password : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to create a standard key-subkey pair. This is the primary method for generating conformant PGP keys.

Pass the user ID of the new key via the Username property. This typically should be in the format of User Name <user@email>, for example Robert Frost <robert@frost.com>, but generally can be an arbitrary text string.

This method generates a 'standard' keypair based on the Version and Strength parameters. This can range from RSA keys for version 3 to strong Ed25519 keys for version 6.

The following PGP key versions and strengths are supported:

pvDefault0The default version (situation-specific)

pv33Version 3

pv44Version 4

pv55Version 5

pv66Version 6

psNormal0Normal strength

psStrong1Increased strength

psPostQuantum2Post-quantum algorithms

Provide the key encryption password and the validity period in days via the Password and ValidTo parameters.

import_bytes method (PGPKeyManager Struct)

Loads a key from a byte array.

Syntax

fn import_bytes(&self, key : &[u8]) -> Result<(), SecureBlackboxError>

Remarks

Use this method to load a key, either public or secret, from a byte array.

import_from_file method (PGPKeyManager Struct)

Loads a key from a file.

Syntax

fn import_from_file(&self, file_name : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to load a key, either public or secret, from a file.

import_pinned method (PGPKeyManager Struct)

Loads a key from a pinned key object.

Syntax

fn import_pinned(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to load a PGP key from a pinned_key object. This is an easy way to import a key object from a keyring.

remove_signature method (PGPKeyManager Struct)

Unbinds the specified signature from the key, subkey or user.

Syntax

fn remove_signature(&self, index : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to remove the specified signature from the list of Signatures bound to the key, subkey or user.

remove_subkey method (PGPKeyManager Struct)

Removes the specified subkey from the key.

Syntax

fn remove_subkey(&self, index : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to remove the subkey referred by its Index from the key.

remove_user method (PGPKeyManager Struct)

Unbinds the specified user from the key.

Syntax

fn remove_user(&self, index : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to remove the specified user from the list of UserIDs bound to the key.

reset method (PGPKeyManager Struct)

Creates a new empty keyring.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to initialize a new empty keyring.

revoke_key method (PGPKeyManager Struct)

Revokes the key.

Syntax

fn revoke_key(&self, reason : i32, comment : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to revoke the key by adding a revocation signature.

revoke_subkey method (PGPKeyManager Struct)

Revokes the key's subkey.

Syntax

fn revoke_subkey(&self, index : i32, reason : i32, comment : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to revoke the subkey with a given Index by adding a revocation signature.

revoke_user method (PGPKeyManager Struct)

Revokes a user certification.

Syntax

fn revoke_user(&self, index : i32, reason : i32, comment : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to revoke the user with the specified Index by adding a revocation signature to the key.

sign_key method (PGPKeyManager Struct)

Sign the key.

Syntax

fn sign_key(&self, key_valid_to : &str, hash_algorithm : &str, preferred_algs : &str, key_flags : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to sign the main key, or 'create a key binding signature', in terms of the PGP specification. Provide the signing key in signing_key.

Use the KeyValidTo parameter to specify the key validity period and HashAlgorithm to provide the signature hash algorithm.

The PreferredAlgs parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists:

Encryption algorithms:

  • Plaintext
  • IDEA
  • 3DES
  • Blowfish
  • AES128
  • AES192
  • AES256
  • Twofish256
  • CAST5
  • Camellia128
  • Camellia192
  • Camellia256

Compression algorithms:

  • ZIP
  • ZLIB
  • BZIP2

Hash algorithms:

  • MD5
  • SHA
  • RIPEMD160
  • SHA224
  • SHA256
  • SHA384
  • SHA512
  • SHA3-256
  • SHA3-384
  • SHA3-512

Example: Camellia192,AES192,SHA256,ZIP

If you leave PreferredAlgs, no algorithm preferences information will be saved with the key.

The KeyFlags parameter is a bitmask that can contain the following bit flags:

KeyFlagCertifyOtherKeys1The key can certify other keys

KeyFlagSignData2The key can be used to sign data

KeyFlagEncryptData4The key can be used to encrypt data (in transit)

KeyFlagEncryptStorage8The key can be used to encrypt data (at rest)

KeyFlagSplitKey16The key is part of a split key scheme

KeyFlagGroupKey32The key is part of a group key scheme

sign_subkey method (PGPKeyManager Struct)

Sign the key's subkey.

Syntax

fn sign_subkey(&self, index : i32, key_valid_to : &str, hash_algorithm : &str, preferred_algs : &str, key_flags : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to sign the subkey with a given Index (create a 'subkey binding signature'). Provide the signing key in signing_key.

Use the KeyValidTo parameter to specify the subkey validity period and HashAlgorithm to provide the signature hash algorithm.

The PreferredAlgs parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use when using the subkey that is being signed. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists:

Encryption algorithms:

  • Plaintext
  • IDEA
  • 3DES
  • Blowfish
  • AES128
  • AES192
  • AES256
  • Twofish256
  • CAST5
  • Camellia128
  • Camellia192
  • Camellia256

Compression algorithms:

  • ZIP
  • ZLIB
  • BZIP2

Hash algorithms:

  • MD5
  • SHA
  • RIPEMD160
  • SHA224
  • SHA256
  • SHA384
  • SHA512
  • SHA3-256
  • SHA3-384
  • SHA3-512

Example: Camellia256,Twofish256,AES256,ZLIB,SHA512

If you leave PreferredAlgs, no algorithm preferences information will be saved with the key.

The KeyFlags parameter is a bitmask that can contain the following bit flags:

KeyFlagCertifyOtherKeys1The key can certify other keys

KeyFlagSignData2The key can be used to sign data

KeyFlagEncryptData4The key can be used to encrypt data (in transit)

KeyFlagEncryptStorage8The key can be used to encrypt data (at rest)

KeyFlagSplitKey16The key is part of a split key scheme

KeyFlagGroupKey32The key is part of a group key scheme

sign_user method (PGPKeyManager Struct)

Creates a user certification.

Syntax

fn sign_user(&self, index : i32, key_valid_to : &str, hash_algorithm : &str, primary : bool, cert_type : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to sign the user ID with the specified Index using the signing_key. This signature creates a binding between the user ID and their main key.

While it is typical to sign user IDs with their own secret keys, occasionally third-party authentication is used where the binding is signed with a third-party key.

The KeyValidTo parameter indicates the expiration date of the binding. It can be different to that of the signing and/or the main key. The Primary parameter indicates whether this should be considered the primary user ID for this key (for example, if the user has more than one email). The CertType parameters indicates the type of binding, and should be set to one of the following values (if unsure, use pctGeneric):

pctGeneric0Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type.
pctPersona1Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID.
pctCasual2Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity.
pctPositive3Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity.

verify method (PGPKeyManager Struct)

Verifies the integrity of a key signature.

Syntax

fn verify(&self, index : i32) ->  Result<bool, SecureBlackboxError>

Remarks

Use this method to validate a key signature. Provide the index of the signature as a parameter.

on_error event (PGPKeyManager Struct)

Information about errors during PGP key management.

Syntax

// PGPKeyManagerErrorEventArgs carries the PGPKeyManager Error event's parameters.
pub struct PGPKeyManagerErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PGPKeyManagerErrorEvent defines the signature of the PGPKeyManager Error event's handler function.
pub trait PGPKeyManagerErrorEvent {
  fn on_error(&self, sender : PGPKeyManager, e : &mut PGPKeyManagerErrorEventArgs);
}

impl <'a> PGPKeyManager<'a> {
  pub fn on_error(&self) -> &'a dyn PGPKeyManagerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PGPKeyManagerErrorEvent);
  ...
}

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.

on_key_passphrase_needed event (PGPKeyManager Struct)

Requests a key protection password from the application.

Syntax

// PGPKeyManagerKeyPassphraseNeededEventArgs carries the PGPKeyManager KeyPassphraseNeeded event's parameters.
pub struct PGPKeyManagerKeyPassphraseNeededEventArgs {
  fn key_id(&self) -> &String
  fn user_id(&self) -> &String
  fn main_key(&self) -> bool
  fn passphrase(&self) -> &String
  fn set_passphrase(&self, value : &str)
  fn set_passphrase_ref(&self, value : &String)
  fn skip(&self) -> bool
  fn set_skip(&self, value : bool)
}

// PGPKeyManagerKeyPassphraseNeededEvent defines the signature of the PGPKeyManager KeyPassphraseNeeded event's handler function.
pub trait PGPKeyManagerKeyPassphraseNeededEvent {
  fn on_key_passphrase_needed(&self, sender : PGPKeyManager, e : &mut PGPKeyManagerKeyPassphraseNeededEventArgs);
}

impl <'a> PGPKeyManager<'a> {
  pub fn on_key_passphrase_needed(&self) -> &'a dyn PGPKeyManagerKeyPassphraseNeededEvent;
  pub fn set_on_key_passphrase_needed(&mut self, value : &'a dyn PGPKeyManagerKeyPassphraseNeededEvent);
  ...
}

Remarks

The struct fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The struct fires it when it attempts to use a secret key to sign the data.

This event is fired for every protected secret key residing in signing_keys. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.

The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.

For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.

on_notification event (PGPKeyManager Struct)

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

Syntax

// PGPKeyManagerNotificationEventArgs carries the PGPKeyManager Notification event's parameters.
pub struct PGPKeyManagerNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// PGPKeyManagerNotificationEvent defines the signature of the PGPKeyManager Notification event's handler function.
pub trait PGPKeyManagerNotificationEvent {
  fn on_notification(&self, sender : PGPKeyManager, e : &mut PGPKeyManagerNotificationEventArgs);
}

impl <'a> PGPKeyManager<'a> {
  pub fn on_notification(&self) -> &'a dyn PGPKeyManagerNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn PGPKeyManagerNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (PGPKeyManager Struct)

The struct 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 struct, access to these internal properties is provided through the config method.

PGPKeyManager Config Settings

Armor:   Enables or disables ASCII armouring.

Adjust this setting to enable or disable ASCII armouring on the outgoing messages.

ArmorBoundary:   Specifies the armour boundary/title.

Use this setting to specify custom ASCII armouring titles that go after the -----BEGIN and -----END tokens.

ArmorHeaders:   Specifies armour headers.

Use this setting to provide custom ASCII armouring (PEM) headers that should be included in the output.

HashAlgorithm:   The hash algorithm to use with the operation, when not accepted via a parameter.

This configuration setting lets you specify the hash algorithm to be used with an operation that does not accept it via a method parameter.

KeyFlags:   Specifies key flags for user certification signatures.

Use this setting to pass a bit mask of key flags to the user certification signature:

KeyFlagCertifyOtherKeys1The key can certify other keys

KeyFlagSignData2The key can be used to sign data

KeyFlagEncryptData4The key can be used to encrypt data (in transit)

KeyFlagEncryptStorage8The key can be used to encrypt data (at rest)

KeyFlagSplitKey16The key is part of a split key scheme

KeyFlagGroupKey32The key is part of a group key scheme

Use this property before calling the sign_user method. The config setting is cleared after each signing operation.

KeyHashAlgorithm:   The hash algorithm associated with the key.

This setting returns the hash algorithm associated with and inherent to the key (such as SHA1 for DSA keys, or SHA512 for EdDSA keys)

PreferredAlgs:   Specifies preferred algorithms for user certification signatures.

Use this setting to include a list of preferred algorithms in the certification signature. The algorithms may include symmetric, hash, and compression algorithms.

Example: AES256,SHA256,AES128,SHA512,ZIP,ZLIB,CAST5

RawKeyFormat:   Specifies whether low-level key format should be used as input or output of an operation.

This setting specifies whether to use the raw (low-level, such as PKCS#1) key format during import or export operation.

RespectKeyUsage:   Enables policy-based key usage checks.

Set this property to true to enable policy-based key usage checks. If set to false (the default value), the values of CanSign and CanEncrypt properties of the key objects are based on the underlying cryptographic algorithm capabilities only. If switched to true, the values of the properties also consider the content of the key flags extension included in the respective key signatures.

SaveKeyTrust:   Tells the component to include the trust packets with the serialized keys.

Enables or disables inclusion of trust markers in the output keyring files. The default value is true.

SaveSecretKeySignatures:   Enforces saving of signature packets to the secret keyring file.

By default, key binding and user ID signatures are saved with the public part of the PGP keyring, whereas the private part only contains the secret key material. Set this option to true to enforce saving of signatures alongside the private keys. This may be useful when storing the keyring as a single file instead of a public/private pair.

SignatureCreationTime:   Indicates the signature creation time.

Returns the signature creation time.

SignatureExpirationTime:   Returns or sets the signature expiration time.

Returns the signature expiration time.

SignatureHashAlgorithm:   The hash algorithm of the signature.

Use this setting to obtain the hash algorithm of the signature.

SubkeyIndex:   Allows to select a specific subkey for certain operations.

It is typical for PGP key trees to employ the same protection parameters and passwords for all the keys and subkeys contained in the tree. This config setting lets you select a specific subkey if you want to apply certain protection parameter exclusively to that subkey. For example, the following code will only change the passphrase on the subkey with the index of 2: mgr.Config("SubkeyIndex=2"); mgr.ChangePassphrase("oldpass", "newpass");

Note: set this property to -2 to apply the setting to the main key. The default value of -1 indicates that any protection operation applies to all keys and subkeys in the tree.

UseLongKeyIDs:   Use full-length KeyID format.

It is typical for implementations to use the lower 4 bytes of PGP key IDs. Set this property to true to switch to the full (8-byte) key ID format.

Base Config Settings

ASN1UseGlobalTagCache:   Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins:   Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the struct.

Use this property to get cookies from the internal cookie storage of the struct 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.

DNSLocalSuffix:   The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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.

EnableSSHMLKEM:   Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.

Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

EnableTLSMLKEM:   Enables support for ML-KEM and hybrid groups in TLS client and server components.

Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

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 structs that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy:   The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy.

Supported Values:

auto Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default).
enableAlways attempt to use hardware cryptography. If unavailable, exception will be thrown.
disableDo not use hardware cryptography.

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

HttpVersion:   The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter:   The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

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.

OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache:   Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

certificateEnables caching of certificates.
crlEnables caching of Certificate Revocation Lists (CRLs).
ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath:   Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion:   Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the struct. 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 struct) 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 divided 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 struct is set to "local", the property returns/restores the rules from/to the internal storage of the struct. If StaticDNS of the struct 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 cached 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 structs.

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

UseCRLObjectCaching:   Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation:   Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching:   Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

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.

UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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.

XMLRDNDescriptorName[OID]:   Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]:   Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder:   Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator:   Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (PGPKeyManager Struct)

PGPKeyManager Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)
27262977   The file was not found (SB_ERROR_PGP_FILE_NOT_EXISTS)
27262978   Invalid signing key (SB_ERROR_PGP_INVALID_KEY)
27262980   No secret key is available (SB_ERROR_PGP_NO_SECRET_KEY)
27262982   The operation is not supported on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)