PGPKeyManager Class
Properties Methods Events Configuration Settings Errors
The PGPKeyManager class manages PGP keys.
Syntax
SecureBlackboxPGPKeyManager
SecureBlackboxPGPKeyManagerSwift
Remarks
PGPKeyManager allows you to load, save, generate, import, and export PGP keys.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| - keyBitsInKey | Indicates the key length in bits. |
| - keyCurve | Indicates the elliptic curve associated with a EC key. |
| - keyEncryptionAlgorithm | Indicates the symmetric algorithm used to encrypt the secret key. |
| - keyExpires | Indicates key expiration time in whole days from its generation moment. |
| - keyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - keyHashAlgorithm | Specifies the hash algorithm associated with the key. |
| - keyOldPacketFormat | Indicates whether legacy (PGP 2. |
| - keyPassphrase | The key protection password. |
| - keyProtection | Specifies the level of protection applied to the secret key. |
| - keyPublicKeyAlgorithm | Specifies the asymmetric algorithm of the key. |
| - keyQBits | The length of the DSA Q (legitimate range: 160-512). |
| - keyUsername | Specifies the name of the user bound to this key. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| - addSubkey | Adds a new subkey to the Key. |
| - bindUser | Binds a new UserID to the Key. |
| - changePassphrase | Changes the password of the secret key. |
| - changeProtection | Changes the protection level of the secret key. |
| - checkPassphrase | Checks if the password matches the secret key. |
| - config | Sets or retrieves a configuration setting. |
| - exportKey | Serializes the key to a byte array. |
| - exportPublicKey | Exports the public key to a byte array. |
| - exportPublicToFile | Exports the public key to a file. |
| - exportToFile | Exports the key to a file. |
| - generate | Generates a new single PGP key. |
| - generateLegacy | Generates a new key in the old format. |
| - generatePair | Generates a new pair of PGP keys. |
| - importFromFile | Loads a key from a file. |
| - importKey | Loads a key from a byte array. |
| - removeSubkey | Removes the specified subkey from the key. |
| - removeUser | Unbinds the specified user from the key. |
| - revokeKey | Revokes the key. |
| - revokeSubkey | Revokes the key's subkey. |
| - revokeSubkeybyID | Revokes the key's subkey. |
| - revokeUser | Revokes a user certification. |
| - revokeUserByName | Revokes a user certification. |
| - validate | Validates the key. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| - onError | Information about errors during PGP key management. |
| - onNotification | 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 | Path for storing temporary files. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (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. |