SecureBlackbox 2020 macOS Edition

Questions / Feedback?

PGPKeyring Module

Properties   Methods   Events   Configuration Settings   Errors  

The PGPKeyring component accesses and manages PGP keyring files.




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 module with short descriptions. Click on the links for further details.

OpenedIndicates if the keyring is in an opened state.
PinnedKeyA PGP key that is being manipulated on.
PublicKeysPublic keys available in the keyring.
SecretKeysSecret keys available in the keyring.
SelectedPublicKeysThe public keys matching the selection criteria.
SelectedSecretKeysThe secret keys matching the selection criteria.

Method List

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

AddFromFileAdds an existing key to the keyring.
AddFromFilesAdds a collection of keys to the keyring.
AddPinnedAdds a pinned secret key to the keyring.
ClearRemoves all the keys from the keyring.
CloseCloses the keyring.
ConfigSets or retrieves a configuration setting.
CreateNewCreates a new empty keyring.
LoadLoads a keyring from disk.
LoadFromBytesLoads a keyring from two byte arrays.
RemoveByIDRemoves key by its ID.
RemovePublicRemoves the specified public key from the keyring.
RemoveSecretRemoves the specified secret key from the keyring.
SaveSaves the keyring to disk.
SaveToBytesSaves the keyring to a byte array.
SelectFilters a selection of keys from the keyring using a template.

Event List

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

ErrorInformation about errors during PGP key management.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings

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

TempPathLocation where the temporary files are stored.
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 (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
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.
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.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]