PGPKeyring Class
Properties Methods Events Configuration Settings Errors
The PGPKeyring class accesses and manages PGP keyring files.
Syntax
secureblackbox.Pgpkeyring
Remarks
PGPKeyring is used to hold and access PGP keys. It contains information about both public keys and secret keys, which are usually stored in two separate files: "public keyring" and "secret keyring", respectively.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| Opened | Indicates if the keyring is in an opened state. |
| PinnedKey | A PGP key that is being manipulated on. |
| PublicKeys | Public keys available in the keyring. |
| SecretKeys | Secret keys available in the keyring. |
| SelectedPublicKeys | The public keys matching the selection criteria. |
| SelectedSecretKeys | The secret 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.
| AddFromFile | Adds an existing key to the keyring. |
| AddFromFiles | Adds a collection of keys to the keyring. |
| AddFromStream | Adds a key to the keyring. |
| AddFromStreams | Adds a collection of keys to the keyring. |
| AddPinned | Adds a pinned secret key to the keyring. |
| Clear | Removes all the keys from the keyring. |
| Close | Closes the keyring. |
| Config | Sets or retrieves a configuration setting. |
| CreateNew | Creates a new empty keyring. |
| Load | Loads a keyring from disk. |
| LoadFromBytes | Loads a keyring from two byte arrays. |
| LoadFromStreams | Loads a keyring from two streams. |
| RemoveByID | Removes key by its ID. |
| RemovePublic | Removes the specified public key from the keyring. |
| RemoveSecret | Removes the specified secret key from the keyring. |
| Save | Saves the keyring to disk. |
| SaveToBytes | Saves the keyring to a byte array. |
| SaveToStreams | Saves the keyring to streams. |
| Select | Filters a selection of keys from the keyring using a template. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Information about errors during PGP key management. |
| Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| TempPath | Location where the temporary files are stored. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |