# PGPKeyring Class

The PGPKeyring class manages PGP keyring files.

## Syntax

```text
PGPKeyring
```

## Remarks

Keyring keep the details of local PGP key collections. A typical keyring consists of two parts, with the first part containing the public keys of other people, and the second part containing the secret keys of the keyring owner (i.e. your secret keys).

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

Depending on your task at hand, you may need to only use the public part, or both. However, there is a couple of catches here. Some PGP implementations operate with just one keyring file that contains both the public and secret keys. The others sometimes mess-up the keys, with secret key accidentally ending up in the public part of the keyring, or the other way round.

Our suggestion therefore is to load *all the keyring files that you have* into PGPKeyring using consecutive [ImportFromFile](#importfromfile-method-pgpkeyring-class) (or [ImportBytes](#importbytes-method-pgpkeyring-class)) calls, and then look for the keys that match the required parameters in the [Keys](#keys-property-pgpkeyring-class) collection. That would provide fault-tolerant and smooth experience to your customers.

```text
  PGPKeyring keyring = new PGPKeyring();
  keyring.ImportFromFile("pubring.pkr");
  keyring.ImportFromFile("secring.skr");
```

Once you have loaded your keyring files into the keyring, you can perform the following operations on the keys:

- Iterate over the whole set of keys using [Keys](#keys-property-pgpkeyring-class) collection.
- Add new keys to the keyring using methods such as [ImportBytes](#importbytes-method-pgpkeyring-class), [ImportPinned](#importpinned-method-pgpkeyring-class), or [ImportFromFile](#importfromfile-method-pgpkeyring-class).
- Save the updated keyring using [ExportBytes](#exportbytes-method-pgpkeyring-class) or [ExportToFile](#exporttofile-method-pgpkeyring-class) methods.
- Use [Select](#select-method-pgpkeyring-class) to filter keys by certain criteria (public/private, KeyID) into a separate [SelectedKeys](#selectedkeys-property-pgpkeyring-class) list.
- Remove keys from the keyring.
- Assign the keyring keys to properties like PGPWriter.SigningKeys to use them for encryption or signing.

 Note: PGPKeyring provides access to keyring contents but does not let you edit or generate keys. To achieve these, please see [PGPKeyManager](PGPKeyManager.md#PGPKeyManager).

Once you have completed your work with PGPKeyring, dispose of the object or call [Reset](#reset-method-pgpkeyring-class) to clean up all the key information from memory.

## Property List

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

|  |  |
| --- | --- |
| [Keys](#keys-property-pgpkeyring-class) | PGP keys available in the keyring. |
| [PinnedKey](#pinnedkey-property-pgpkeyring-class) | A PGP key that is being manipulated on. |
| [SelectedKeys](#selectedkeys-property-pgpkeyring-class) | The keys matching the selection criteria. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-pgpkeyring-class) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-pgpkeyring-class) | Performs an additional action. |
| [ExportBytes](#exportbytes-method-pgpkeyring-class) | Exports the keyring to a byte array. |
| [ExportToFile](#exporttofile-method-pgpkeyring-class) | Exports the keyring to disk. |
| [ExportToStream](#exporttostream-method-pgpkeyring-class) | Exports the keyring to streams. |
| [ImportBytes](#importbytes-method-pgpkeyring-class) | Loads a key from a byte array. |
| [ImportFromFile](#importfromfile-method-pgpkeyring-class) | Loads a key from a file. |
| [ImportFromStream](#importfromstream-method-pgpkeyring-class) | Loads a key from a stream. |
| [ImportPinned](#importpinned-method-pgpkeyring-class) | Imports a pinned secret key to the keyring. |
| [Remove](#remove-method-pgpkeyring-class) | Removes the specified key from the keyring. |
| [RemoveByID](#removebyid-method-pgpkeyring-class) | Removes key by its ID. |
| [Reset](#reset-method-pgpkeyring-class) | Creates a new empty keyring. |
| [Select](#select-method-pgpkeyring-class) | Filters a selection of keys from the keyring using a template. |
| [UpdatePinned](#updatepinned-method-pgpkeyring-class) | Update a pinned key in the keyring. |

## Event List

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

|  |  |
| --- | --- |
| [Error](#error-event-pgpkeyring-class) | Information about errors during PGP key management. |
| [Notification](#notification-event-pgpkeyring-class) | 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.*

|  |  |
| --- | --- |
| [Armor](#Armor) | Enables or disables ASCII armouring. |
| [ArmorBoundary](#ArmorBoundary) | Specifies the armour boundary/title. |
| [ArmorHeaders](#ArmorHeaders) | Specifies armour headers. |
| [RespectKeyUsage](#RespectKeyUsage) | Enables policy-based key usage checks. |
| [SaveKeyTrust](#SaveKeyTrust) | Tells the class to include the trust packets with the serialized keys. |
| [SaveSecretKeySignatures](#SaveSecretKeySignatures) | Enforces saving of signature packets to the secret keyring file. |
| [UseLongKeyIDs](#UseLongKeyIDs) | Enables long (8-byte) KeyID representation. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# Keys Property ([PGPKeyring](#pgpkeyring-class) Class)

PGP keys available in the keyring.

## Syntax

```text
SecureBlackboxList<SecureBlackboxPGPKey>* GetKeys();
```

## Remarks

This property populates a collection of all pgp keys contained in the keyring.

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

## Data Type

[SecureBlackboxPGPKey](#pgpkey-type)

# PinnedKey Property ([PGPKeyring](#pgpkeyring-class) Class)

A PGP key that is being manipulated on.

## Syntax

```text
SecureBlackboxPGPKey* GetPinnedKey();
int SetPinnedKey(SecureBlackboxPGPKey* val);
```

## Remarks

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

This property is not available at design time.

## Data Type

[SecureBlackboxPGPKey](#pgpkey-type)

# SelectedKeys Property ([PGPKeyring](#pgpkeyring-class) Class)

The keys matching the selection criteria.

## Syntax

```text
SecureBlackboxList<SecureBlackboxPGPKey>* GetSelectedKeys();
```

## Remarks

This property contains all the keys that match the selection filter passed to [Select](#select-method-pgpkeyring-class) method.

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

## Data Type

[SecureBlackboxPGPKey](#pgpkey-type)

# Config Method ([PGPKeyring](#pgpkeyring-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pgpkeyring-class) 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](#config-settings-pgpkeyring-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DoAction Method ([PGPKeyring](#pgpkeyring-class) Class)

Performs an additional action.

## Syntax

```text
ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
```

## Remarks

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

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

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

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# ExportBytes Method ([PGPKeyring](#pgpkeyring-class) Class)

Exports the keyring to a byte array.

## Syntax

```text
ANSI (Cross Platform)
char* ExportBytes(int bSecret, int *lpSize = NULL);

Unicode (Windows)
LPSTR ExportBytes(BOOL bSecret, LPINT lpSize = NULL);
```

## Remarks

Use this method to export the keyring to a byte array. PGP software typically uses two files to store keyrings. Use *Secret* parameter to specify which part of the keyring you would like to export (public or secret).

## Error Handling (C++)

This method returns a Byte Array value (with length *lpSize*); after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# ExportToFile Method ([PGPKeyring](#pgpkeyring-class) Class)

Exports the keyring to disk.

## Syntax

```text
ANSI (Cross Platform)
int ExportToFile(const char* lpszFileName, int bSecret);

Unicode (Windows)
INT ExportToFile(LPCWSTR lpszFileName, BOOL bSecret);
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ExportToStream Method ([PGPKeyring](#pgpkeyring-class) Class)

Exports the keyring to streams.

## Syntax

```text
ANSI (Cross Platform)
int ExportToStream(SecureBlackboxStream* sKeyringStream, int bSecret);

Unicode (Windows)
INT ExportToStream(SecureBlackboxStream* sKeyringStream, BOOL bSecret);
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ImportBytes Method ([PGPKeyring](#pgpkeyring-class) Class)

Loads a key from a byte array.

## Syntax

```text
ANSI (Cross Platform)
int ImportBytes(const char* lpKeyring, int lenKeyring);

Unicode (Windows)
INT ImportBytes(LPCSTR lpKeyring, INT lenKeyring);
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ImportFromFile Method ([PGPKeyring](#pgpkeyring-class) Class)

Loads a key from a file.

## Syntax

```text
ANSI (Cross Platform)
int ImportFromFile(const char* lpszKeyringFile);

Unicode (Windows)
INT ImportFromFile(LPCWSTR lpszKeyringFile);
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ImportFromStream Method ([PGPKeyring](#pgpkeyring-class) Class)

Loads a key from a stream.

## Syntax

```text
ANSI (Cross Platform)
int ImportFromStream(SecureBlackboxStream* sKeyringStream);

Unicode (Windows)
INT ImportFromStream(SecureBlackboxStream* sKeyringStream);
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ImportPinned Method ([PGPKeyring](#pgpkeyring-class) Class)

Imports a pinned secret key to the keyring.

## Syntax

```text
ANSI (Cross Platform)
int ImportPinned();

Unicode (Windows)
INT ImportPinned();
```

## Remarks

Use this method to import a key provided via [PinnedKey](#pinnedkey-property-pgpkeyring-class) to the keyring. This can be a public or secret key.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Remove Method ([PGPKeyring](#pgpkeyring-class) Class)

Removes the specified key from the keyring.

## Syntax

```text
ANSI (Cross Platform)
int Remove(int iIndex);

Unicode (Windows)
INT Remove(INT iIndex);
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RemoveByID Method ([PGPKeyring](#pgpkeyring-class) Class)

Removes key by its ID.

## Syntax

```text
ANSI (Cross Platform)
int RemoveByID(const char* lpszKeyID);

Unicode (Windows)
INT RemoveByID(LPCWSTR lpszKeyID);
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Reset Method ([PGPKeyring](#pgpkeyring-class) Class)

Creates a new empty keyring.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

Use this method to initialize a new empty keyring.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Select Method ([PGPKeyring](#pgpkeyring-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int Select(const char* lpszFilter, int bSecretOnly, int iMaxCount);

Unicode (Windows)
INT Select(LPCWSTR lpszFilter, BOOL bSecretOnly, INT iMaxCount);
```

## Remarks

Use this method to get a list of keys that satisfy the *Filter* criteria. The filter should follow the "Name=Value" format, where Name can be one of the following:

- userid
- fp *or* fingerprint
- keyid

Set *SecretOnly* to True to only search for secret keys. *MaxCount* allows to limit the number of keys returned.

Once the method completes, the keys that match the criteria will be available in [SelectedKeys](#selectedkeys-property-pgpkeyring-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# UpdatePinned Method ([PGPKeyring](#pgpkeyring-class) Class)

Update a pinned key in the keyring.

## Syntax

```text
ANSI (Cross Platform)
int UpdatePinned();

Unicode (Windows)
INT UpdatePinned();
```

## Remarks

Use this method to update a key provided via [PinnedKey](#pinnedkey-property-pgpkeyring-class) in the keyring. This can be a public or secret key.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Error Event ([PGPKeyring](#pgpkeyring-class) Class)

Information about errors during PGP key management.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(PGPKeyringErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} PGPKeyringErrorEventParams;

Unicode (Windows)
virtual INT FireError(PGPKeyringErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} PGPKeyringErrorEventParams;
```

## Remarks

The event is fired in case of exceptional conditions during key management.

*ErrorCode* contains an error code and *Description* contains a textual description of the error.

# Notification Event ([PGPKeyring](#pgpkeyring-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireNotification(PGPKeyringNotificationEventParams *e);
typedef struct {  const char *EventID;  const char *EventParam;
  int reserved;
} PGPKeyringNotificationEventParams;

Unicode (Windows)
virtual INT FireNotification(PGPKeyringNotificationEventParams *e);
typedef struct {  LPCWSTR EventID;  LPCWSTR EventParam;
  INT reserved;
} PGPKeyringNotificationEventParams;
```

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

# PGPKey Type

This container represents a PGP key.

## Syntax

 *SecureBlackboxPGPKey* (declared in *secureblackbox.h*)

## 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](#PGPKey_f_BitsInKey)

- [CanEncrypt](#PGPKey_f_CanEncrypt)

- [CanSign](#PGPKey_f_CanSign)

- [Curve](#PGPKey_f_Curve)

- [Enabled](#PGPKey_f_Enabled)

- [EncryptionAlgorithm](#PGPKey_f_EncryptionAlgorithm)

- [Handle](#PGPKey_f_Handle)

- [IsPublic](#PGPKey_f_IsPublic)

- [IsSecret](#PGPKey_f_IsSecret)

- [IsSubkey](#PGPKey_f_IsSubkey)

- [KeyFP](#PGPKey_f_KeyFP)

- [KeyID](#PGPKey_f_KeyID)

- [Passphrase](#PGPKey_f_Passphrase)

- [PassphraseValid](#PGPKey_f_PassphraseValid)

- [PrimaryKeyID](#PGPKey_f_PrimaryKeyID)

- [Protection](#PGPKey_f_Protection)

- [PublicKeyAlgorithm](#PGPKey_f_PublicKeyAlgorithm)

- [QBits](#PGPKey_f_QBits)

- [Timestamp](#PGPKey_f_Timestamp)

- [Username](#PGPKey_f_Username)

- [ValidTo](#PGPKey_f_ValidTo)

- [Version](#PGPKey_f_Version)

## Fields

 **BitsInKey** *int (read-only)*
*Default Value: 2048*

Indicates the key length in bits.

 **CanEncrypt** *int (read-only)*
*Default Value: FALSE*

Returns True if this key can be used for encryption.

 **CanSign** *int (read-only)*
*Default Value: FALSE*

Returns True if this key can be used for signing.

 **Curve** *char* (read-only)*
*Default Value: ""*

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

 **Enabled** *int*
*Default Value: FALSE*

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

 **EncryptionAlgorithm** *char* (read-only)*
*Default Value: "AES128"*

Indicates the symmetric algorithm used to encrypt the secret key.

 **Handle** *int64*
*Default Value: 0*

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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **IsPublic** *int (read-only)*
*Default Value: FALSE*

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

 **IsSecret** *int (read-only)*
*Default Value: FALSE*

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

 **IsSubkey** *int (read-only)*
*Default Value: FALSE*

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

 **KeyFP** *char* (read-only)*
*Default Value: ""*

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

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

 **KeyID** *char* (read-only)*
*Default Value: ""*

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** *char**
*Default Value: ""*

The key protection password.

 **PassphraseValid** *int (read-only)*
*Default Value: FALSE*

Use this property to check whether the specified [Passphrase](#PGPKey_f_Passphrase) is valid and can be used to unlock the secret key.

 **PrimaryKeyID** *char* (read-only)*
*Default Value: ""*

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

 **Protection** *int (read-only)*
*Default Value: 0*

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 |

 **PublicKeyAlgorithm** *char* (read-only)*
*Default Value: ""*

Specifies the asymmetric algorithm of the key.

 **QBits** *int (read-only)*
*Default Value: 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** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: ""*

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** *char* (read-only)*
*Default Value: "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 Value: 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

```text
PGPKey()
```

 Creates an empty PGP key object.

# SecureBlackboxList Type

## Syntax

 *SecureBlackboxList<T>* (declared in *secureblackbox.h*)

## Remarks

 *SecureBlackboxList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the PGPKeyring class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |

# SecureBlackboxStream Type

## Syntax

 *SecureBlackboxStream* (declared in *secureblackbox.h*)

## Remarks

 The PGPKeyring class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the PGPKeyring class an instance of that concrete class.

 When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

```text
int Read(void* buffer, int count) = 0;
```

```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```

```text
int Write(const void* buffer, int count) = 0;
```

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a SecureBlackboxStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([PGPKeyring](#pgpkeyring-class) Class)

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

### PGPKeyring 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.

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

**SaveKeyTrust**: Tells the component to include the trust packets with the serialized keys.Enables or disables inclusion of trust markers in the output keyring files. The default value is true.

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

**UseLongKeyIDs**: Enables long (8-byte) KeyID representation.Switch this setting on to enable long (8-byte/16-char) representation of KeyIDs. The components use the abbreviated 4-byte/8-char representation by default.

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

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

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

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

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

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

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

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

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

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

**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:

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

**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:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
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:

```text
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 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 divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the 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 cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the 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).

**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:

```text
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:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
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 ([PGPKeyring](#pgpkeyring-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### PGPKeyring Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |
| 27262977 | The file was not found ([SB_ERROR_PGP_FILE_NOT_EXISTS](constants.md#const_SBERRORPGPFILENOTEXISTS)) |
| 27262978 | Invalid signing key ([SB_ERROR_PGP_INVALID_KEY](constants.md#const_SBERRORPGPINVALIDKEY)) |
| 27262980 | No secret key is available ([SB_ERROR_PGP_NO_SECRET_KEY](constants.md#const_SBERRORPGPNOSECRETKEY)) |
| 27262982 | The operation is not supported on a subkey ([SB_ERROR_PGP_OPERATION_ON_SUBKEY](constants.md#const_SBERRORPGPOPERATIONONSUBKEY)) |