PGPKeyManager Component

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyManager component manages individual PGP keys.

Syntax

nsoftware.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 CreateSubkey method. Note that your new subkey is unlikely to be accepted elsewhere unless you sign it.
  • Add new user records to the key with CreateUser method.
  • Signing keys, subkeys, and user records (existing or new) with this or another private key using SignKey, SignSubkey, and SignUser 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 ExportBytes and ExportToFile methods.

Property List

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

KeyThe key to manipulate on.
PinnedKeyA PGP key that is being manipulated on.
SignaturesSignatures available in the key.
SigningKeyA PGP key that is to be used for signing other PGP entities while editing the key.
SubkeysPGP subkeys available in the key.
UsersUsers available in the key.

Method List

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

ChangePassphraseChanges the password of the secret key.
ChangeProtectionChanges the protection level of the secret key.
CheckPassphraseChecks if the password matches the secret key.
ConfigSets or retrieves a configuration setting.
CreateKeyGenerates a new key.
CreateSubkeyGenerates a new subkey.
CreateUserAdds a user to an existing key.
DoActionPerforms an additional action.
ExportBytesSerializes the key to a byte array.
ExportToFileExports the key to a file.
ExportToStreamExports the key to a stream.
GeneratePairGenerates a new pair of PGP keys.
ImportBytesLoads a key from a byte array.
ImportFromFileLoads a key from a file.
ImportFromStreamLoads a key from a stream.
ImportPinnedLoads a key from a pinned key object.
RemoveSignatureUnbinds the specified signature from the key, subkey or user.
RemoveSubkeyRemoves the specified subkey from the key.
RemoveUserUnbinds the specified user from the key.
ResetCreates a new empty keyring.
RevokeKeyRevokes the key.
RevokeSubkeyRevokes the key's subkey.
RevokeUserRevokes a user certification.
SignKeySign the key.
SignSubkeySign the key's subkey.
SignUserCreates a user certification.
VerifyVerifies the integrity of a key signature.

Event List

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

ErrorInformation about errors during PGP key management.
KeyPassphraseNeededRequests a key protection password from the application.
NotificationThis event notifies the application about an underlying control flow event.

Config Settings

The following is a list of config settings for the component 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.
KeyHashAlgorithmThe hash algorithm associated with the key.
RawKeyFormatSpecifies whether low-level key format should be used as input or output of an operation.
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 component.
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.
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 components 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 components 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 Property (PGPKeyManager Component)

The key to manipulate on.

Syntax

public PGPKey Key { get; }

Public ReadOnly Property Key As PGPKey

Remarks

Use this property to specify the key to perform operations on.

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

Please refer to the PGPKey type for a complete list of fields.

PinnedKey Property (PGPKeyManager Component)

A PGP key that is being manipulated on.

Syntax

public PGPKey PinnedKey { get; set; }

Public Property PinnedKey As PGPKey

Remarks

Use this property to specify a key to perform operations on, such as adding.

This property is not available at design time.

Please refer to the PGPKey type for a complete list of fields.

Signatures Property (PGPKeyManager Component)

Signatures available in the key.

Syntax

public PGPSignatureList Signatures { get; }

Public ReadOnly Property Signatures As PGPSignatureList

Remarks

This property populates a collection of all signatures contained in the key.

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

Please refer to the PGPSignature type for a complete list of fields.

SigningKey Property (PGPKeyManager Component)

A PGP key that is to be used for signing other PGP entities while editing the key.

Syntax

public PGPKey SigningKey { get; set; }

Public Property SigningKey As PGPKey

Remarks

Use this property to specify the key that you want to use for signing other PGP entities, such as the key, subkeys, or user IDs. This key will be used by the signing method used, such as SignKey, SignSubkey, or SignUser.

For self-signatures, you can assign the object contained in the Key to this property.

This property is not available at design time.

Please refer to the PGPKey type for a complete list of fields.

Subkeys Property (PGPKeyManager Component)

PGP subkeys available in the key.

Syntax

public PGPKeyList Subkeys { get; }

Public ReadOnly Property Subkeys As PGPKeyList

Remarks

This property populates a collection of all subkeys contained in the key.

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

Please refer to the PGPKey type for a complete list of fields.

Users Property (PGPKeyManager Component)

Users available in the key.

Syntax

public PGPUserList Users { get; }

Public ReadOnly Property Users As PGPUserList

Remarks

This property populates a collection of all users contained in the key.

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

Please refer to the PGPUser type for a complete list of fields.

ChangePassphrase Method (PGPKeyManager Component)

Changes the password of the secret key.

Syntax

public void ChangePassphrase(string oldPassphrase, string newPassphrase);

Public Sub ChangePassphrase(ByVal OldPassphrase As String, ByVal NewPassphrase As String)

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

ChangeProtection Method (PGPKeyManager Component)

Changes the protection level of the secret key.

Syntax

public void ChangeProtection(string oldPassphrase, string newPassphrase, int protType, string encAlgorithm, string hashAlgorithm);

Public Sub ChangeProtection(ByVal OldPassphrase As String, ByVal NewPassphrase As String, ByVal ProtType As Integer, ByVal EncAlgorithm As String, ByVal HashAlgorithm As String)

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

CheckPassphrase Method (PGPKeyManager Component)

Checks if the password matches the secret key.

Syntax

public bool CheckPassphrase(string passphrase);

Public Function CheckPassphrase(ByVal Passphrase As String) As Boolean

Remarks

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

Config Method (PGPKeyManager Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

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

CreateKey Method (PGPKeyManager Component)

Generates a new key.

Syntax

public void CreateKey(int version, string algorithm, int bits, string validTo, string password);

Public Sub CreateKey(ByVal Version As Integer, ByVal Algorithm As String, ByVal Bits As Integer, ByVal ValidTo As String, ByVal Password As String)

Remarks

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

CreateSubkey Method (PGPKeyManager Component)

Generates a new subkey.

Syntax

public void CreateSubkey(string algorithm, int bits, string validTo, string password);

Public Sub CreateSubkey(ByVal Algorithm As String, ByVal Bits As Integer, ByVal ValidTo As String, ByVal Password As String)

Remarks

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

CreateUser Method (PGPKeyManager Component)

Adds a user to an existing key.

Syntax

public void CreateUser(string username);

Public Sub CreateUser(ByVal Username As String)

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

DoAction Method (PGPKeyManager Component)

Performs an additional action.

Syntax

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. 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.

ExportBytes Method (PGPKeyManager Component)

Serializes the key to a byte array.

Syntax

public byte[] ExportBytes(bool secret);

Public Function ExportBytes(ByVal Secret As Boolean) As Byte()

Remarks

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

ExportToFile Method (PGPKeyManager Component)

Exports the key to a file.

Syntax

public void ExportToFile(string fileName, bool secret);

Public Sub ExportToFile(ByVal FileName As String, ByVal Secret As Boolean)

Remarks

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

ExportToStream Method (PGPKeyManager Component)

Exports the key to a stream.

Syntax

public void ExportToStream(System.IO.Stream keyStream, bool secret);

Public Sub ExportToStream(ByVal KeyStream As System.IO.Stream, ByVal Secret As Boolean)

Remarks

Use this method to save the Key (both the public and secret parts) to a stream pointed by Stream.

GeneratePair Method (PGPKeyManager Component)

Generates a new pair of PGP keys.

Syntax

public void GeneratePair(int version, string username, int strength, string validTo, string password);

Public Sub GeneratePair(ByVal Version As Integer, ByVal Username As String, ByVal Strength As Integer, ByVal ValidTo As String, ByVal Password As String)

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

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

ImportBytes Method (PGPKeyManager Component)

Loads a key from a byte array.

Syntax

public void ImportBytes(byte[] key);

Public Sub ImportBytes(ByVal Key As Byte())

Remarks

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

ImportFromFile Method (PGPKeyManager Component)

Loads a key from a file.

Syntax

public void ImportFromFile(string fileName);

Public Sub ImportFromFile(ByVal FileName As String)

Remarks

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

ImportFromStream Method (PGPKeyManager Component)

Loads a key from a stream.

Syntax

public void ImportFromStream(System.IO.Stream keyStream);

Public Sub ImportFromStream(ByVal KeyStream As System.IO.Stream)

Remarks

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

ImportPinned Method (PGPKeyManager Component)

Loads a key from a pinned key object.

Syntax

public void ImportPinned();

Public Sub ImportPinned()

Remarks

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

RemoveSignature Method (PGPKeyManager Component)

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

Syntax

public void RemoveSignature(int index);

Public Sub RemoveSignature(ByVal Index As Integer)

Remarks

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

RemoveSubkey Method (PGPKeyManager Component)

Removes the specified subkey from the key.

Syntax

public void RemoveSubkey(int index);

Public Sub RemoveSubkey(ByVal Index As Integer)

Remarks

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

RemoveUser Method (PGPKeyManager Component)

Unbinds the specified user from the key.

Syntax

public void RemoveUser(int index);

Public Sub RemoveUser(ByVal Index As Integer)

Remarks

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

Reset Method (PGPKeyManager Component)

Creates a new empty keyring.

Syntax

public void Reset();

Public Sub Reset()

Remarks

Use this method to initialize a new empty keyring.

RevokeKey Method (PGPKeyManager Component)

Revokes the key.

Syntax

public void RevokeKey(int reason, string comment);

Public Sub RevokeKey(ByVal Reason As Integer, ByVal Comment As String)

Remarks

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

RevokeSubkey Method (PGPKeyManager Component)

Revokes the key's subkey.

Syntax

public void RevokeSubkey(int index, int reason, string comment);

Public Sub RevokeSubkey(ByVal Index As Integer, ByVal Reason As Integer, ByVal Comment As String)

Remarks

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

RevokeUser Method (PGPKeyManager Component)

Revokes a user certification.

Syntax

public void RevokeUser(int index, int reason, string comment);

Public Sub RevokeUser(ByVal Index As Integer, ByVal Reason As Integer, ByVal Comment As String)

Remarks

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

SignKey Method (PGPKeyManager Component)

Sign the key.

Syntax

public void SignKey(string keyValidTo, string hashAlgorithm, string preferredAlgs, int keyFlags);

Public Sub SignKey(ByVal KeyValidTo As String, ByVal HashAlgorithm As String, ByVal PreferredAlgs As String, ByVal KeyFlags As Integer)

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

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

SignSubkey Method (PGPKeyManager Component)

Sign the key's subkey.

Syntax

public void SignSubkey(int index, string keyValidTo, string hashAlgorithm, string preferredAlgs, int keyFlags);

Public Sub SignSubkey(ByVal Index As Integer, ByVal KeyValidTo As String, ByVal HashAlgorithm As String, ByVal PreferredAlgs As String, ByVal KeyFlags As Integer)

Remarks

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

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

SignUser Method (PGPKeyManager Component)

Creates a user certification.

Syntax

public void SignUser(int index, string keyValidTo, string hashAlgorithm, bool primary, int certType);

Public Sub SignUser(ByVal Index As Integer, ByVal KeyValidTo As String, ByVal HashAlgorithm As String, ByVal Primary As Boolean, ByVal CertType As Integer)

Remarks

Use this method to sign the user ID with the specified Index using the SigningKey. 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 Component)

Verifies the integrity of a key signature.

Syntax

public bool Verify(int index);

Public Function Verify(ByVal Index As Integer) As Boolean

Remarks

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

Error Event (PGPKeyManager Component)

Information about errors during PGP key management.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PGPKeyManagerErrorEventArgs e);

public class PGPKeyManagerErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PGPKeyManagerErrorEventArgs)

Public Class PGPKeyManagerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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.

KeyPassphraseNeeded Event (PGPKeyManager Component)

Requests a key protection password from the application.

Syntax

public event OnKeyPassphraseNeededHandler OnKeyPassphraseNeeded;

public delegate void OnKeyPassphraseNeededHandler(object sender, PGPKeyManagerKeyPassphraseNeededEventArgs e);

public class PGPKeyManagerKeyPassphraseNeededEventArgs : EventArgs {
  public string KeyID { get; }
  public string UserID { get; }
  public bool MainKey { get; }
  public string Passphrase { get; set; }
  public bool Skip { get; set; }
}

Public Event OnKeyPassphraseNeeded As OnKeyPassphraseNeededHandler

Public Delegate Sub OnKeyPassphraseNeededHandler(sender As Object, e As PGPKeyManagerKeyPassphraseNeededEventArgs)

Public Class PGPKeyManagerKeyPassphraseNeededEventArgs Inherits EventArgs
  Public ReadOnly Property KeyID As String
  Public ReadOnly Property UserID As String
  Public ReadOnly Property MainKey As Boolean
  Public Property Passphrase As String
  Public Property Skip As Boolean
End Class

Remarks

The component 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 component 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 SigningKeys. 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.

Notification Event (PGPKeyManager Component)

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

Syntax

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, PGPKeyManagerNotificationEventArgs e);

public class PGPKeyManagerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As PGPKeyManagerNotificationEventArgs)

Public Class PGPKeyManagerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

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

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

PGPKey Type

This container represents a PGP key.

Remarks

OpenPGP standard supports several types of keys. In our days, a typical OpenPGP keypair actually consists of two cryptographic keys: a primary key and a subkey. The primary key is normally used for signing, while the subkey is used for encryption.

While it is typical for PGP environments to use a primary key/subkey bundle, this is not a must. Sometimes you may come across standalone keys (mainly when dealing with older implementations), as well as whole key trees, each of those carrying a bunch of differently-purposed subkeys bound to the same primary key.

Algorithm-wise, OpenPGP keys also differ. Generally speaking, OpenPGP supports the following public key algorithms: RSA, Elgamal (often incorrectly referred to as DH), DSA, ECDH and ECDSA. When it comes to primary key/subkey bundles, DSA/Elgamal, RSA/RSA and ECDSA/ECDH pairs are typically used. Although there's no restriction on algorithm bundles, and, e.g. a ECDSA/Elgamal key bundle is perfectly possible, such combination is rarely used in practice.

A typical OpenPGP key is associated with some kind of user ID (Username). It is normally represented with a user's e-mail address, while in theory can be any piece of text. The secret part of the OpenPGP keypair is protected with a password (Passphrase).

The following fields are available:
  • BitsInKey
  • CanEncrypt
  • CanSign
  • Curve
  • Enabled
  • EncryptionAlgorithm
  • IsPublic
  • IsSecret
  • IsSubkey
  • KeyFP
  • KeyID
  • Passphrase
  • PassphraseValid
  • PrimaryKeyID
  • Protection
  • PublicKeyAlgorithm
  • QBits
  • Timestamp
  • Username
  • ValidTo
  • Version

    • Fields

    BitsInKey
    int (read-only)
    Default: 2048

    Indicates the key length in bits.

    CanEncrypt
    bool (read-only)
    Default: False

    Returns True if this key can be used for encryption.

    CanSign
    bool (read-only)
    Default: False

    Returns True if this key can be used for signing.

    Curve
    string (read-only)
    Default: ""

    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

    Enabled
    bool
    Default: False

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

    EncryptionAlgorithm
    string (read-only)
    Default: "AES128"

    Indicates the symmetric algorithm used to encrypt the secret key.

    IsPublic
    bool (read-only)
    Default: False

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

    IsSecret
    bool (read-only)
    Default: False

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

    IsSubkey
    bool (read-only)
    Default: False

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

    KeyFP
    string (read-only)
    Default: ""

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

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

    KeyID
    string (read-only)
    Default: ""

    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.

    Passphrase
    string
    Default: ""

    The key protection password.

    PassphraseValid
    bool (read-only)
    Default: False

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

    PrimaryKeyID
    string (read-only)
    Default: ""

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

    Protection
    PGPProtectionTypes (read-only)
    Default: 0

    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

    PublicKeyAlgorithm
    string (read-only)
    Default: ""

    Specifies the asymmetric algorithm of the key.

    QBits
    int (read-only)
    Default: 0

    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.

    Timestamp
    string (read-only)
    Default: ""

    Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).

    Username
    string (read-only)
    Default: ""

    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.

    ValidTo
    string (read-only)
    Default: "0"

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

    Version
    int (read-only)
    Default: 0

    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.

    Constructors

    public PGPKey();

    Public PGPKey()

    Creates an empty PGP key object. 

    public PGPKey(string fileName);

    Public PGPKey(ByVal FileName As String)

    Create a PGP key object from a key file.

    PGPSignature Type

    A container for PGP signature properties.

    Remarks

    PGPSignature contains details and validation information for a PGP signature.

    The following fields are available:
  • CertificationType
  • CreationTime
  • ExpirationTime
  • Exportable
  • HashAlgorithm
  • HashMark
  • KeyExpirationTime
  • KeyFlags
  • LegacyFormat
  • PolicyURL
  • PreferredAlgorithms
  • PrimaryUserID
  • ReasonForRevocation
  • Revocable
  • Revocation
  • SignatureClass
  • SignerKeyID
  • SignerUserID
  • StrictlyValid
  • Target
  • TextSignature
  • TrustAmount
  • TrustLevel
  • Validated
  • Validity
  • Version

    • Fields

    CertificationType
    PGPCertificationTypes (read-only)
    Default: 0

    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.

    CreationTime
    string (read-only)
    Default: ""

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

    ExpirationTime
    int (read-only)
    Default: 0

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

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

    Exportable
    bool (read-only)
    Default: False

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

    HashAlgorithm
    string (read-only)
    Default: ""

    Specifies the hash algorithm used in the signature.

    HashMark
    int (read-only)
    Default: 0

    Returns the hash mark attribute of a signature.

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

    KeyExpirationTime
    int (read-only)
    Default: 0

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

    KeyFlags
    int (read-only)
    Default: 0

    Returns the key flags included in the signature.

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

    LegacyFormat
    bool (read-only)
    Default: False

    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.

    PolicyURL
    string (read-only)
    Default: ""

    Contains the URL of the signature policy.

    PreferredAlgorithms
    string (read-only)
    Default: ""

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

    PrimaryUserID
    bool (read-only)
    Default: False

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

    ReasonForRevocation
    string (read-only)
    Default: ""

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

    Revocable
    bool (read-only)
    Default: False

    Specifies whether the signature can be revoked.

    Revocation
    bool (read-only)
    Default: False

    Indicates whether or not the signature is a revocation signature.

    SignatureClass
    PGPSignatureClasses (read-only)
    Default: 0

    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

    SignerKeyID
    string (read-only)
    Default: ""

    Indicates the KeyID of the signing key.

    SignerUserID
    string (read-only)
    Default: ""

    Indicates the UserID associated with the signing key.

    StrictlyValid
    bool (read-only)
    Default: False

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

    Target
    string (read-only)
    Default: ""

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

    TextSignature
    bool (read-only)
    Default: False

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

    TrustAmount
    int (read-only)
    Default: 0

    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.

    TrustLevel
    int (read-only)
    Default: 0

    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.

    Validated
    bool (read-only)
    Default: False

    Whether the signature has been validated.

    Validity
    SignatureValidities (read-only)
    Default: 0

    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)

    Version
    int (read-only)
    Default: 0

    Indicates the signature version.

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

    Constructors

    public PGPSignature();

    Public PGPSignature()

    Creates an empty PGPSignature object.

    PGPUser Type

    A container for PGP user properties.

    Remarks

    PGPUser contains details information for a PGP user.

    The following fields are available:
  • Username

    • Fields

    Username
    string (read-only)
    Default: ""

    Specifies the user name of user.

    Constructors

    public PGPUser();

    Public PGPUser()

    Creates an empty PGPUser object.

    Config Settings (PGPKeyManager Component)

    The component 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 component, 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.

    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)

    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.

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

    Supported values are:

    offNo caching (default)
    localLocal caching
    globalGlobal caching

    Cookies:   Gets or sets local cookies for the component.

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

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

    HardwareCryptoUsePolicy:   The hardware crypto usage policy.

    This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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

    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 component. 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 component) 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 component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component 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 components.

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

    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)