PGPKeyManager Class

Properties Methods Events Config Settings Errors

The PGPKeyManager class manages PGP keys.

Syntax

class secureblackbox.PGPKeyManager

Remarks

PGPKeyManager allows you to load, save, generate, import, and export PGP keys.

Property List

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


fips_mode	Reserved.
key_bits_in_key	Indicates the key length in bits.
key_curve	Indicates the elliptic curve associated with a EC key.
key_encryption_algorithm	Indicates the symmetric algorithm used to encrypt the secret key.
key_expires	Indicates key expiration time in whole days from its generation moment.
key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
key_hash_algorithm	Specifies the hash algorithm associated with the key.
key_old_packet_format	Indicates whether legacy (PGP 2.
key_passphrase	The key protection password.
key_protection	Specifies the level of protection applied to the secret key.
key_public_key_algorithm	Specifies the asymmetric algorithm of the key.
key_q_bits	The length of the DSA Q (legitimate range: 160-512).
key_username	Specifies the name of the user bound to this key.

Method List

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


add_subkey	Adds a new subkey to the Key.
bind_user	Binds a new UserID to the Key.
change_passphrase	Changes the password of the secret key.
change_protection	Changes the protection level of the secret key.
check_passphrase	Checks if the password matches the secret key.
config	Sets or retrieves a configuration setting.
do_action	Performs an additional action.
export_key	Serializes the key to a byte array.
export_public_key	Exports the public key to a byte array.
export_public_to_file	Exports the public key to a file.
export_to_file	Exports the key to a file.
generate	Generates a new single PGP key.
generate_legacy	Generates a new key in the old format.
generate_pair	Generates a new pair of PGP keys.
import_from_file	Loads a key from a file.
import_key	Loads a key from a byte array.
remove_subkey	Removes the specified subkey from the key.
remove_user	Unbinds the specified user from the key.
revoke_key	Revokes the key.
revoke_subkey	Revokes the key's subkey.
revoke_subkeyby_id	Revokes the key's subkey.
revoke_user	Revokes a user certification.
revoke_user_by_name	Revokes a user certification.
validate	Validates the key.

Event List

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


on_error	Information about errors during PGP key management.
on_notification	This event notifies the application about an underlying control flow event.

Config Settings

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


TempPath	Path for storing temporary files.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

key_bits_in_key Property

Indicates the key length in bits.

Syntax

def get_key_bits_in_key() -> int: ...
def set_key_bits_in_key(value: int) -> None: ...

key_bits_in_key = property(get_key_bits_in_key, set_key_bits_in_key)

Default Value

2048

Remarks

Indicates the key length in bits.

key_curve Property

Indicates the elliptic curve associated with a EC key.

Syntax

def get_key_curve() -> str: ...
def set_key_curve(value: str) -> None: ...

key_curve = property(get_key_curve, set_key_curve)

Default Value

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:


SB_PGP_CURVE_P256	`P256`
SB_PGP_CURVE_P384	`P384`
SB_PGP_CURVE_P521	`P521`
SB_PGP_CURVE_ED25519	`ED25519`
SB_PGP_CURVE_CURVE25519	`CURVE25519`
SB_PGP_CURVE_BRAINPOOLP256R1	`BRAINPOOLP256`
SB_PGP_CURVE_BRAINPOOLP512R1	`BRAINPOOLP512`

key_encryption_algorithm Property

Indicates the symmetric algorithm used to encrypt the secret key.

Syntax

def get_key_encryption_algorithm() -> str: ...
def set_key_encryption_algorithm(value: str) -> None: ...

key_encryption_algorithm = property(get_key_encryption_algorithm, set_key_encryption_algorithm)

Default Value

"CAST5"

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

key_expires Property

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

Syntax

def get_key_expires() -> int: ...
def set_key_expires(value: int) -> None: ...

key_expires = property(get_key_expires, set_key_expires)

Default Value

Remarks

Indicates key expiration time in whole days from its generation moment. The value of 0 indicates that the key does not expire.

key_handle Property

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

Syntax

def get_key_handle() -> int: ...
def set_key_handle(value: int) -> None: ...

key_handle = property(get_key_handle, set_key_handle)

Default Value

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

key_hash_algorithm Property

Specifies the hash algorithm associated with the key.

Syntax

def get_key_hash_algorithm() -> str: ...
def set_key_hash_algorithm(value: str) -> None: ...

key_hash_algorithm = property(get_key_hash_algorithm, set_key_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the hash algorithm associated with the key.

key_old_packet_format Property

Indicates whether legacy (PGP 2.

Syntax

def get_key_old_packet_format() -> bool: ...
def set_key_old_packet_format(value: bool) -> None: ...

key_old_packet_format = property(get_key_old_packet_format, set_key_old_packet_format)

Default Value

FALSE

Remarks

Indicates whether legacy (PGP 2.6.x) packet format should be used.

key_passphrase Property

The key protection password.

Syntax

def get_key_passphrase() -> str: ...
def set_key_passphrase(value: str) -> None: ...

key_passphrase = property(get_key_passphrase, set_key_passphrase)

Default Value

Remarks

The key protection password.

key_protection Property

Specifies the level of protection applied to the secret key.

Syntax

def get_key_protection() -> int: ...
def set_key_protection(value: int) -> None: ...

key_protection = property(get_key_protection, set_key_protection)

Default Value

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:


pptNone	`0`	Key is not encrypted
pptLow	`1`	Only the password hash is used to derive the secret key
pptNormal	`2`	Password hash with salt is used to derive the secret key
pptHigh	`3`	Hash from multiple passwords and salt are used for key derivation

key_public_key_algorithm Property

Specifies the asymmetric algorithm of the key.

Syntax

def get_key_public_key_algorithm() -> str: ...
def set_key_public_key_algorithm(value: str) -> None: ...

key_public_key_algorithm = property(get_key_public_key_algorithm, set_key_public_key_algorithm)

Default Value

Remarks

Specifies the asymmetric algorithm of the key.

key_q_bits Property

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

Syntax

def get_key_q_bits() -> int: ...
def set_key_q_bits(value: int) -> None: ...

key_q_bits = property(get_key_q_bits, set_key_q_bits)

Default Value

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.

key_username Property

Specifies the name of the user bound to this key.

Syntax

def get_key_username() -> str: ...
def set_key_username(value: str) -> None: ...

key_username = property(get_key_username, set_key_username)

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.

add_subkey Method

Adds a new subkey to the Key.

Syntax

def add_subkey(bits: int, algorithm: str, expires: int) -> None: ...

Remarks

Use this method to add a subkey to a key. Note that the key you are adding the subkey to needs to contain its secret counterpart to be able to sign the new subkey.

Bits specifies the number of bits in the new subkey, Expires is the new subkey's expiration time and date, and Algorithm specifies its public key algorithm:


SB_PGP_PUBLIC_KEY_ALGORITHM_RSA	`RSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPT	`RSA-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGN	`RSA-sign`
SB_PGP_PUBLIC_KEY_ALGORITHM_DSA	`DSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSA	`ECDSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDH	`ECDH`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPT	`Elgamal-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL	`Elgamal`
SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSA	`EDDSA`

bind_user Method

Binds a new UserID to the Key.

Syntax

def bind_user(username: str) -> None: ...

Remarks

Use this method to add a new Username as an owner of the key.

Note that the key needs to contain its secret counterpart to be able to sign the new user ID.

change_passphrase Method

Changes the password of the secret key.

Syntax

def change_passphrase(old_passphrase: str, new_passphrase: str) -> None: ...

Remarks

Call this method to change the password that protects the secret key.

change_protection Method

Changes the protection level of the secret key.

Syntax

def change_protection(old_passphrase: str, new_passphrase: str, prot_type: int, enc_algorithm: str, hash_algorithm: str) -> None: ...

Remarks

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

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


SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT	`Plaintext`
SB_PGP_SYMMETRIC_ALGORITHM_IDEA	`Idea`
SB_PGP_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_PGP_SYMMETRIC_ALGORITHM_CAST5	`CAST5`
SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH	`Blowfish`
SB_PGP_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_PGP_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_PGP_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256	`Twofish256`

and HashAlgorithm specify the algorithms to be used for key derivation.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

check_passphrase Method

Checks if the password matches the secret key.

Syntax

def check_passphrase(passphrase: str) -> bool: ...

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

export_key Method

Serializes the key to a byte array.

Syntax

def export_key() -> bytes: ...

Remarks

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

export_public_key Method

Exports the public key to a byte array.

Syntax

def export_public_key() -> bytes: ...

Remarks

Use this method to save the public key contained in key to a byte array.

export_public_to_file Method

Exports the public key to a file.

Syntax

def export_public_to_file(filename: str) -> None: ...

Remarks

Use this method to save the public key stored in key to the file specified by Filename.

export_to_file Method

Exports the key to a file.

Syntax

def export_to_file(filename: str) -> None: ...

Remarks

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

generate Method

Generates a new single PGP key.

Syntax

def generate() -> None: ...

Remarks

Call this method after setting up relevant fields of key to generate a new PGP key. This method generates a 'standalone' key without subkeys. Use generate_pair to generate a pair of a main key and a subkey.

Most PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the generate_pair method.

generate_legacy Method

Generates a new key in the old format.

Syntax

def generate_legacy(username: str, bits: int, password: str, expires: int) -> None: ...

Remarks

Use this method when you need to generate an RSA key in the old (PGP 2.6.x) format.

Username specifies the user of the key, Bits is the key length in bits. Provide Password for the key and its expiration date and time via Expires.

Only use this method where you want to work with very old PGP software. While still providing a decent level of protection (subject to key length, of course), legacy keys are rarely used these days, and have almost everywhere been replaced with new-style keys.

Most modern PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the generate_pair method.

generate_pair Method

Generates a new pair of PGP keys.

Syntax

def generate_pair(username: str, key_algorithm: str, key_bits: int, sub_key_algorithm: str, sub_key_bits: int, password: str, expires: int) -> None: ...

Remarks

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

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

Set KeyAlgorithm and SubKeyAlgorithm to the public key algorithms that you want to use for the new key. See the full list of algorithms below. Where ECDSA or ECDH algorithm is used, you can specify a particular curve after the algorithm name, separated with the colon: ECDSA:P384 or ECDH:BRAINPOOLP256. KeyBits and SubKeyBits specify the number of bits in the key and the subkey. These parameters can be set to zero if the key length is implicitly defined by the algorithm of the key. For example, ECDSA P256 keys are always 256 bit long, so you may pass 0 as the corresponding KeyBits or SubKeyBits parameter.

Provide the key encryption password and the validity period in days via the Password and Expires parameters. Set Expires to zero to indicate that the key does not expire.

While you can use any combination of algorithms for your key and subkey, most implementations got used to specific hard-wired combinations. Sticking to those will help make sure your keys are understood by other implementations. Typical combinations are:

EDDSA main key with ECDH:CURVE25519 subkey;
ECDSA main key with ECDH subkey; both with NIST curves (P256, P384, or P512);
ECDSA main key with ECDH subkey; both with Brainpool curves (BRAINPOOLP256 or BRAINPOOLP512);
RSA main key with RSA subkey.

The code snippet below illustrates a typical key generation procedure:

    Pgpkeymanager mgr = new Pgpkeymanager();

    // generating a pair
    mgr.GeneratePair("Michel Legrand <ml@email.com>", "EDDSA", 0, "ECDH:CURVE25519", 0, "password", 0);

    // creating a keyring object and adding the new pair to the keyring
    Pgpkeyring keyring = new Pgpkeyring();

    keyring.CreateNew();

    keyring.PinnedKey = mgr.Key;
    keyring.AddPinned();

    // exporting the keyring to a file
    keyring.Save("pubkey.pkr", "seckey.skr");

Alternative calls to GeneratePair may look like this:

    mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:P384", 0, "ECDH", 0, "password", 0);

    mgr.GeneratePair("Michel Legrand <ml@email.com>", "ECDSA:BRAINPOOLP256", 0, "ECDH:BRAINPOOLP256", 0, "password", 0);

    mgr.GeneratePair("Michel Legrand <ml@email.com>", "RSA", 4096, "RSA", 2048, "password", 0);

Supported public key algorithms:


SB_PGP_PUBLIC_KEY_ALGORITHM_RSA	`RSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_ENCRYPT	`RSA-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_RSA_SIGN	`RSA-sign`
SB_PGP_PUBLIC_KEY_ALGORITHM_DSA	`DSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDSA	`ECDSA`
SB_PGP_PUBLIC_KEY_ALGORITHM_ECDH	`ECDH`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL_ENCRYPT	`Elgamal-encrypt`
SB_PGP_PUBLIC_KEY_ALGORITHM_ELGAMAL	`Elgamal`
SB_PGP_PUBLIC_KEY_ALGORITHM_EDDSA	`EDDSA`

Supported elliptic curves:


SB_PGP_CURVE_P256	`P256`
SB_PGP_CURVE_P384	`P384`
SB_PGP_CURVE_P521	`P521`
SB_PGP_CURVE_ED25519	`ED25519`
SB_PGP_CURVE_CURVE25519	`CURVE25519`
SB_PGP_CURVE_BRAINPOOLP256R1	`BRAINPOOLP256`
SB_PGP_CURVE_BRAINPOOLP512R1	`BRAINPOOLP512`

import_from_file Method

Loads a key from a file.

Syntax

def import_from_file(filename: str) -> None: ...

Remarks

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

import_key Method

Loads a key from a byte array.

Syntax

def import_key(data: bytes) -> None: ...

Remarks

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

remove_subkey Method

Removes the specified subkey from the key.

Syntax

def remove_subkey(index: int) -> None: ...

Remarks

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

remove_user Method

Unbinds the specified user from the key.

Syntax

def remove_user(index: int) -> None: ...

Remarks

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

revoke_key Method

Revokes the key.

Syntax

def revoke_key() -> None: ...

Remarks

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

revoke_subkey Method

Revokes the key's subkey.

Syntax

def revoke_subkey(index: int) -> None: ...

Remarks

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

revoke_subkeyby_id Method

Revokes the key's subkey.

Syntax

def revoke_subkeyby_id(key_id: str) -> None: ...

Remarks

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

revoke_user Method

Revokes a user certification.

Syntax

def revoke_user(index: int) -> None: ...

Remarks

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

revoke_user_by_name Method

Revokes a user certification.

Syntax

def revoke_user_by_name(username: str) -> None: ...

Remarks

Use this method to revoke the certification of the user specified by Username by adding a revocation signature.

validate Method

Validates the key.

Syntax

def validate() -> int: ...

Remarks

Call this method to validate signatures over the PGP key and all the subkeys.

Possible result:


pkvStrictlyValid	`0`	Strictly valid
pkvValid	`1`	Valid
pkvInvalid	`2`	Invalid
pkvFailure	`3`	Generic validation failure
pkvUnknown	`4`	Validity unknown

on_error Event

Information about errors during PGP key management.

Syntax

class PGPKeyManagerErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PGPKeyManager:
@property
def on_error() -> Callable[[PGPKeyManagerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PGPKeyManagerErrorEventParams], None]) -> None: ...

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_notification Event

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

Syntax

class PGPKeyManagerNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class PGPKeyManager:
@property
def on_notification() -> Callable[[PGPKeyManagerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[PGPKeyManagerNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

PGPKeyManager Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

PGPKeyManager Config Settings

TempPath: Path for storing temporary files.

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

Base Config Settings

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

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

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

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

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

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the class.

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

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

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

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

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

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

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

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

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

LogDestination: Specifies the debug log destination.

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

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (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:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

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-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

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


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush 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:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

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:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

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

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

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

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

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

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

StaticDNS: Specifies whether static DNS rules should be used.

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

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

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

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

StaticIPAddresses: Gets or sets all the static DNS rules.

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

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PGPKeyManager Errors


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