SecureBlackbox 2020 iOS Edition

Questions / Feedback?

PGPWriter Class

Properties   Methods   Events   Configuration Settings   Errors  

The PGPWriter class protects data using PGP keys and certificates.

Syntax

SecureBlackboxPGPWriter
SecureBlackboxPGPWriterSwift

Remarks

PGPWriter allows you to encrypt, sign, armor, and compress the input data.

Property List


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

- armorSpecifies whether the data should be armored.
- armorBoundaryA boundary to put around the base64 armor.
- armorHeadersAdditional headers to include with the armored message.
- compressWhether to compress the data before encrypting it.
- compressionAlgorithmThe compression algorithm to use.
- compressionLevelThe compression level to use.
- encryptingKeyCountThe number of records in the EncryptingKey arrays.
- encryptingKeyHandle:(int)encryptingKeyIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- encryptingKeyKeyFP:(int)encryptingKeyIndexThe 20-byte fingerprint (hash value) of this key.
- encryptingKeyKeyID:(int)encryptingKeyIndexContains a 8-byte key identifier.
- encryptingKeyUsername:(int)encryptingKeyIndexSpecifies the name of the user bound to this key.
- encryptionAlgorithmA symmetric algorithm to use for data encryption.
- externalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
- externalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
- externalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
- externalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
- externalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
- externalCryptoKeySecretThe pre-shared key used for DC request authentication.
- externalCryptoMethodSpecifies the asynchronous signing method.
- externalCryptoModeSpecifies the external cryptography mode.
- externalCryptoPublicKeyAlgorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
- filenameSpecifies the name of the file being protected.
- hashAlgorithmThe hash algorithm to use for signing.
- inputIsTextWhether the input data is text.
- passphraseThe encryption password.
- profileSpecifies a pre-defined profile to apply when creating the signature.
- protectionSpecifies a password protection level.
- signingKeyCountThe number of records in the SigningKey arrays.
- signingKeyHandle:(int)signingKeyIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- signingKeyKeyFP:(int)signingKeyIndexThe 20-byte fingerprint (hash value) of this key.
- signingKeyKeyID:(int)signingKeyIndexContains a 8-byte key identifier.
- signingKeyPassphrase:(int)signingKeyIndexThe key protection password.
- signingKeyPassphraseValid:(int)signingKeyIndexUse this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
- signingKeyUsername:(int)signingKeyIndexSpecifies the name of the user bound to this key.
- timestampThe date and time of the last modification of the protected data file (in UTC).

Method List


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

- clearTextSignCreates a cleartext signature over the provided data.
- clearTextSignFileCreates a cleartext signature over the provided data.
- clearTextSignStringCreates a cleartext signature over the provided data.
- configSets or retrieves a configuration setting.
- encryptEncrypts a buffer.
- encryptAndSignEncrypts and signs a buffer.
- encryptAndSignFileEncrypts and signs a file.
- encryptAndSignFolderEncrypts and signs a folder.
- encryptAndSignStringEncrypts and signs a string.
- encryptFileEncrypts a file.
- encryptFolderEncrypts a folder.
- encryptStringEncrypts a string.
- signSigns a buffer.
- signFileSigns a file.
- signFolderSigns a folder.
- signStringSigns a string.

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.

- onErrorInformation about errors during PGP encryption.
- onExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
- onKeyPassphraseNeededRequests a key protection password from the application.
- onNotificationThis event notifies the application about an underlying control flow event.
- onProgressReports the progress of the decryption operation.

Configuration Settings


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

PasswordAttemptsThe number of attempts allowed for entering password.
PreserveFilePathsWhether to preserve full file names when saving the PGP file.
SignBufferingMethodThe type of buffering used during signing.
TempPathPath for storing temporary files.
TextCompatibilityModeWhether whitespaces must be trimmed from the signature.
UndefInputLengthSet this property if you are working with non-seekable streams.
UseNewFeaturesWhether the new algorithms, or only the algorithms compatible with PGP 2.6.x, are allowed.
UseOldPacketsWhether signature packets of old format, compatible with PGP 2.6.3, should be used.
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 class (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 classes 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 iOS Edition - Version 20.0 [Build 8166]