SecureBlackbox 2020 .NET Edition

Questions / Feedback?

PGPWriter Component

Properties   Methods   Events   Configuration Settings   Errors  

The PGPWriter component protects data using PGP keys and certificates.

Syntax

nsoftware.SecureBlackbox.Pgpwriter

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 component 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.
EncryptingKeysThe keys to be used for data encryption.
EncryptionAlgorithmA symmetric algorithm to use for data encryption.
ExternalCryptoProvides access to external signing and DC parameters.
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.
SigningKeysThe keys to be used for signing.
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 component 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.
ClearTextSignStreamCreates 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.
EncryptAndSignStreamEncrypts and signs a stream.
EncryptAndSignStringEncrypts and signs a string.
EncryptFileEncrypts a file.
EncryptFolderEncrypts a folder.
EncryptStreamEncrypts a stream.
EncryptStringEncrypts a string.
SignSigns a buffer.
SignFileSigns a file.
SignFolderSigns a folder.
SignStreamSigns a stream.
SignStringSigns a string.

Event List


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

ErrorInformation about errors during PGP encryption.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
KeyPassphraseNeededRequests a key protection password from the application.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the progress of the decryption operation.

Configuration Settings


The following is a list of configuration settings for the component 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 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 .NET Edition - Version 20.0 [Build 8165]