Docs

SecureBlackbox 2022 .NET Edition

Version 22.0 [Build 8174]

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.
FIPSModeReserved.
HashAlgorithmThe hash algorithm to use for signing.
InputBytesUse this property to pass the input to component in the byte array form.
InputFileProvides a filename of a file to process.
InputIsTextWhether the input data is text.
InputStreamA stream containing the input to process.
OutputBytesUse this property to read the output the component object has produced.
OutputFileThe file where the encrypted and/or signed data will be saved.
OutputStreamThe stream where the encrypted and/or signed data will be saved.
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.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
EncryptEncrypts data.
EncryptAndSignEncrypts and signs data.
SignSigns data.

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.
TagAllows to store any custom data.
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.

Armor Property (PGPWriter Component)

Specifies whether the data should be armored.

Syntax

public bool Armor { get; set; }
Public Property Armor As Boolean

Default Value

False

Remarks

Switch this property on to armor the protected data by encoding it in base64 and enveloping with BEGIN and END markings.

ArmorBoundary Property (PGPWriter Component)

A boundary to put around the base64 armor.

Syntax

public string ArmorBoundary { get; set; }
Public Property ArmorBoundary As String

Default Value

""

Remarks

Use this property to specify the boundary to put around the base64 armor. If set to 'PGP MESSAGE', the armored data will be enveloped with '-----BEGIN PGP MESSAGE-----' and '-----END PGP MESSAGE-----' lines.

This property only makes sense if Armor is set True.

ArmorHeaders Property (PGPWriter Component)

Additional headers to include with the armored message.

Syntax

public string ArmorHeaders { get; set; }
Public Property ArmorHeaders As String

Default Value

""

Remarks

Use this property to specify additional headers to be included with the armored message.

Assign this property with a multi-line text, with each line being of "header: value" form (without quotes).

Compress Property (PGPWriter Component)

Whether to compress the data before encrypting it.

Syntax

public bool Compress { get; set; }
Public Property Compress As Boolean

Default Value

False

Remarks

Set this property to True to compress the data before encryption. Use CompressionAlgorithm and CompressionLevel to tune up compression parameters.

CompressionAlgorithm Property (PGPWriter Component)

The compression algorithm to use.

Syntax

public string CompressionAlgorithm { get; set; }
Public Property CompressionAlgorithm As String

Default Value

"Uncompressed"

Remarks

Use this property to specify the compression algorithm to use before encrypting the data. This property only makes sense if Compress is True.

SB_PGP_COMPRESSION_ALGORITHM_NONEUncompressed
SB_PGP_COMPRESSION_ALGORITHM_ZIPZIP
SB_PGP_COMPRESSION_ALGORITHM_ZLIBZlib
SB_PGP_COMPRESSION_ALGORITHM_BZIP2Bzip2

CompressionLevel Property (PGPWriter Component)

The compression level to use.

Syntax

public int CompressionLevel { get; set; }
Public Property CompressionLevel As Integer

Default Value

0

Remarks

Use this property to specify the compression level, from 1 (fastest) to 9 (best).

EncryptingKeys Property (PGPWriter Component)

The keys to be used for data encryption.

Syntax

public PGPKeyList EncryptingKeys { get; }
Public Property EncryptingKeys As PGPKeyList

Remarks

Use this property to set the keys to encrypt the message for. You only need public keys to encrypt data.

This property is not available at design time.

EncryptionAlgorithm Property (PGPWriter Component)

A symmetric algorithm to use for data encryption.

Syntax

public string EncryptionAlgorithm { get; set; }
Public Property EncryptionAlgorithm As String

Default Value

"CAST5"

Remarks

Use this property to specify a symmetric algorithm to use for data encryption.

SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXTPlaintext
SB_PGP_SYMMETRIC_ALGORITHM_IDEAIdea
SB_PGP_SYMMETRIC_ALGORITHM_3DES3DES
SB_PGP_SYMMETRIC_ALGORITHM_CAST5CAST5
SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISHBlowfish
SB_PGP_SYMMETRIC_ALGORITHM_AES128AES128
SB_PGP_SYMMETRIC_ALGORITHM_AES192AES192
SB_PGP_SYMMETRIC_ALGORITHM_AES256AES256
SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256Twofish256

ExternalCrypto Property (PGPWriter Component)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto ExternalCrypto { get; }
Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

This property is read-only.

Filename Property (PGPWriter Component)

Specifies the name of the file being protected.

Syntax

public string Filename { get; set; }
Public Property Filename As String

Default Value

""

Remarks

Use this property to set the name of the file being protected, such as 'document.txt'. If Filename is empty or its value is "_CONSOLE", the data will be protected for-your-eyes-only, meaning the decryptor will only be able to read it on their screen, but not save.

FIPSMode Property (PGPWriter Component)

Reserved.

Syntax

public bool FIPSMode { get; set; }
Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (PGPWriter Component)

The hash algorithm to use for signing.

Syntax

public string HashAlgorithm { get; set; }
Public Property HashAlgorithm As String

Default Value

""

Remarks

Use this property to specify the hash algorithm to use for calculating signatures.

SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

InputBytes Property (PGPWriter Component)

Use this property to pass the input to component in the byte array form.

Syntax

public byte[] InputBytes { get; set; }
Public Property InputBytes As Byte()

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

InputFile Property (PGPWriter Component)

Provides a filename of a file to process.

Syntax

public string InputFile { get; set; }
Public Property InputFile As String

Default Value

""

Remarks

Use this property to provide a path to the file to be encrypted and/or signed.

InputIsText Property (PGPWriter Component)

Whether the input data is text.

Syntax

public bool InputIsText { get; set; }
Public Property InputIsText As Boolean

Default Value

False

Remarks

Set this property to true to indicate that the supplied data should be treated as text.

InputStream Property (PGPWriter Component)

A stream containing the input to process.

Syntax

public System.IO.Stream InputStream { get; set; }
Public Property InputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to feed the input data to the component from a stream object.

This property is not available at design time.

OutputBytes Property (PGPWriter Component)

Use this property to read the output the component object has produced.

Syntax

public byte[] OutputBytes { get; }
Public ReadOnly Property OutputBytes As Byte()

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

OutputFile Property (PGPWriter Component)

The file where the encrypted and/or signed data will be saved.

Syntax

public string OutputFile { get; set; }
Public Property OutputFile As String

Default Value

""

Remarks

Use this property to provide a path to the file where the component should store the encrypted and/or signed data.

OutputStream Property (PGPWriter Component)

The stream where the encrypted and/or signed data will be saved.

Syntax

public System.IO.Stream OutputStream { get; set; }
Public Property OutputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to specify the stream to take the resulting encrypted and/or signed data.

This property is not available at design time.

Passphrase Property (PGPWriter Component)

The encryption password.

Syntax

public string Passphrase { get; set; }
Public Property Passphrase As String

Default Value

""

Remarks

Use this property to provide the encryption password. If an encryption password is used, no key will be needed to decrypt the data.

Profile Property (PGPWriter Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

public string Profile { get; set; }
Public Property Profile As String

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Protection Property (PGPWriter Component)

Specifies a password protection level.

Syntax

public PgpwriterProtections Protection { get; set; }

enum PgpwriterProtections { pptNone, pptLow, pptNormal, pptHigh }
Public Property Protection As PgpwriterProtections

Enum PgpwriterProtections pptNone pptLow pptNormal pptHigh End Enum

Default Value

0

Remarks

This property specifies the complexity of key derivation function for password-protected documents.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash from multiple passwords and salt are used for key derivation

SigningKeys Property (PGPWriter Component)

The keys to be used for signing.

Syntax

public PGPKeyList SigningKeys { get; }
Public Property SigningKeys As PGPKeyList

Remarks

Use this property to set the keys to sign the message with. The keys need to contain their secret compound.

In most cases you will also need to supply a passphrase for the chosen signing keys. Use this by subscribing to KeyPassphraseNeeded event, or setting the Passphrase property of the relevant key object.

This property is not available at design time.

Timestamp Property (PGPWriter Component)

The date and time of the last modification of the protected data file (in UTC).

Syntax

public string Timestamp { get; set; }
Public Property Timestamp As String

Default Value

""

Remarks

Use this property to set a timestamp for the data being protected.

ClearTextSign Method (PGPWriter Component)

Creates a cleartext signature over the provided data.

Syntax

public void ClearTextSign();
Public Sub ClearTextSign()

Remarks

Call this method to create a cleartext signature over the provided data buffer (InputBytes). Only textual data can be signed in cleartext.

Pass the signing key(s) via SigningKeys property.

Config Method (PGPWriter Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);
Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (PGPWriter Component)

Performs an additional action.

Syntax

public string DoAction(string actionID, string actionParams);
Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Encrypt Method (PGPWriter Component)

Encrypts data.

Syntax

public void Encrypt();
Public Sub Encrypt()

Remarks

Use this method to encrypt input data from a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase property.

EncryptAndSign Method (PGPWriter Component)

Encrypts and signs data.

Syntax

public void EncryptAndSign();
Public Sub EncryptAndSign()

Remarks

Use this method to encrypt and sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase property. Use SigningKeys to provide the signing keys.

Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase property.

Sign Method (PGPWriter Component)

Signs data.

Syntax

public void Sign(bool detached);
Public Sub Sign(ByVal Detached As Boolean)

Remarks

Use this method to sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the signed message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).

Use SigningKeys to provide the signing keys.

Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase property.

Error Event (PGPWriter Component)

Information about errors during PGP encryption.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PgpwriterErrorEventArgs e);

public class PgpwriterErrorEventArgs : EventArgs {
  public int ErrorCode { get; }

  public string Description { get; }

}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As PgpwriterErrorEventArgs)

Public Class PgpwriterErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer

  Public ReadOnly Property Description As String

End Class

Remarks

The event is fired in case of exceptional conditions during data encryption or signing.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalSign Event (PGPWriter Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, PgpwriterExternalSignEventArgs e);

public class PgpwriterExternalSignEventArgs : EventArgs {
  public string OperationId { get; }

  public string HashAlgorithm { get; }

  public string Pars { get; }

  public string Data { get; }

  public string SignedData { get; set; }

}
Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As PgpwriterExternalSignEventArgs)

Public Class PgpwriterExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String

  Public ReadOnly Property HashAlgorithm As String

  Public ReadOnly Property Pars As String

  Public ReadOnly Property Data As String

  Public Property SignedData As String

End Class

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

KeyPassphraseNeeded Event (PGPWriter Component)

Requests a key protection password from the application.

Syntax

public event OnKeyPassphraseNeededHandler OnKeyPassphraseNeeded;

public delegate void OnKeyPassphraseNeededHandler(object sender, PgpwriterKeyPassphraseNeededEventArgs e);

public class PgpwriterKeyPassphraseNeededEventArgs : EventArgs {
  public string KeyID { get; }

  public string UserID { get; }

  public bool MainKey { get; }

  public string Passphrase { get; set; }

  public bool Skip { get; set; }

}
Public Event OnKeyPassphraseNeeded As OnKeyPassphraseNeededHandler

Public Delegate Sub OnKeyPassphraseNeededHandler(sender As Object, e As PgpwriterKeyPassphraseNeededEventArgs)

Public Class PgpwriterKeyPassphraseNeededEventArgs Inherits EventArgs
  Public ReadOnly Property KeyID As String

  Public ReadOnly Property UserID As String

  Public ReadOnly Property MainKey As Boolean

  Public Property Passphrase As String

  Public Property Skip As Boolean

End Class

Remarks

The component fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The component fires it when it attempts to use a secret key to sign the data.

This event is fired for every protected secret key residing in SigningKeys. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.

The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.

For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.

Notification Event (PGPWriter Component)

This event notifies the application about an underlying control flow event.

Syntax

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, PgpwriterNotificationEventArgs e);

public class PgpwriterNotificationEventArgs : EventArgs {
  public string EventID { get; }

  public string EventParam { get; }

}
Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As PgpwriterNotificationEventArgs)

Public Class PgpwriterNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String

  Public ReadOnly Property EventParam As String

End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (PGPWriter Component)

Reports the progress of the decryption operation.

Syntax

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, PgpwriterProgressEventArgs e);

public class PgpwriterProgressEventArgs : EventArgs {
  public long Current { get; }

  public long Total { get; }

  public bool Cancel { get; set; }

}
Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As PgpwriterProgressEventArgs)

Public Class PgpwriterProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Current As Long

  Public ReadOnly Property Total As Long

  Public Property Cancel As Boolean

End Class

Remarks

The component fires this event repeatedly to report the progress of the file protection operation.

Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the protection process.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

AsyncDocumentID
String

Specifies the document ID for SignAsyncEnd() call

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CustomParams
String

Custom parameters to be passed to the signing service (uninterpreted).

Data
String

Additional data to be included in the async state and mirrored back by the requestor

ExternalHashCalculation
Boolean

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

HashAlgorithm
String

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

KeyID
String

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
String

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the KeyID topic.

Method
AsyncSignMethods

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

Mode
ExternalCryptoModes

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

PublicKeyAlgorithm
String

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

public ExternalCrypto();
Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

PGPKey Type

This container represents a PGP key.

Remarks

OpenPGP standard supports several types of keys. In our days, a typical OpenPGP keypair actually consists of two cryptographic keys: a primary key and a subkey. The primary key is normally used for signing, while the subkey is used for encryption.

While it is typical for PGP environments to use a primary key/subkey bundle, this is not a must. Sometimes you may come across standalone keys (mainly when dealing with older implementations), as well as whole key trees, each of those carrying a bunch of differently-purposed subkeys bound to the same primary key.

Algorithm-wise, OpenPGP keys also differ. Generally speaking, OpenPGP supports the following public key algorithms: RSA, Elgamal (often incorrectly referred to as DH), DSA, ECDH and ECDSA. When it comes to primary key/subkey bundles, DSA/Elgamal, RSA/RSA and ECDSA/ECDH pairs are typically used. Although there's no restriction on algorithm bundles, and, e.g. a ECDSA/Elgamal key bundle is perfectly possible, such combination is rarely used in practice.

A typical OpenPGP key is associated with some kind of user ID (Username). It is normally represented with a user's e-mail address, while in theory can be any piece of text. The secret part of the OpenPGP keypair is protected with a password (Passphrase).

Fields

BitsInKey
Integer

Indicates the key length in bits.

CanEncrypt
Boolean

Returns True if this key can be used for encryption.

CanSign
Boolean

Returns True if this key can be used for signing.

Curve
String

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

Enabled
Boolean

Enables or disables this key for use in encryption or signing operation.

EncryptionAlgorithm
String

Indicates the symmetric algorithm used to encrypt the secret key.

Expires
Integer

Indicates key expiration time in whole days from its generation moment. The value of 0 indicates that the key does not expire.

HashAlgorithm
String

Specifies the hash algorithm associated with the key.

IsPublic
Boolean

Returns True if this key is a public key, and False otherwise.

IsSecret
Boolean

Returns True if this key is a secret key, and False otherwise.

IsSubkey
Boolean

Returns True if this key is a subkey of another key, and False otherwise.

KeyFP
String

The 20-byte fingerprint (hash value) of this key.

KeyFP could be used to distinguish two keys with the same KeyID.

KeyHashAlgorithm
String

Specifies the hash algorithm used with DSA keys to calculate signatures.

KeyID
String

Contains a 8-byte key identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

OldPacketFormat
Boolean

Indicates whether legacy (PGP 2.6.x) packet format should be used.

Passphrase
String

The key protection password.

PassphraseValid
Boolean

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

PrimaryKeyID
String

If this key is a subkey (IsSubkey returns True), this field contains the identifier of the subkey's primary key.

Protection
PGPProtectionTypes

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash from multiple passwords and salt are used for key derivation

PublicKeyAlgorithm
String

Specifies the asymmetric algorithm of the key.

QBits
Integer

The length of the DSA Q (legitimate range: 160-512).

This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.

Revoked
Boolean

Returns True if the key has been revoked, and False otherwise.

SubkeyFP
String

The 20-byte fingerprint (hash value) of this key's subkey.

KeyFP could be used to distinguish two subkeys with the same SubkeyID.

SubkeyID
String

Contains a 8-byte subkey identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (SubkeyFP) can be used to distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

Timestamp
String

Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).

Username
String

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

Valid
PGPKeyValidities

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

ValidTo
String

Provide accurate expiration moment indication. This is different to Expires property which only contains expiration time in days in old keys.

Version
Integer

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only two versions are currently allowed here: 3 and 4. It is recommended that all new keys are created with version of 4.

Constructors

public PGPKey();
Public PGPKey()

Creates an empty PGP key object.

public PGPKey(string filename);
Public PGPKey(ByVal Filename As String)

Create a PGP key object from a key file.

Configuration Settings (PGPWriter Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PGPWriter Configuration Settings

PasswordAttempts:   The number of attempts allowed for entering password.

Use this property to specify how many times a wrong password may be entered.

PreserveFilePaths:   Whether to preserve full file names when saving the PGP file.

When this property is False, the Encrypt and Sign methods save only the file names (without full paths) to the PGP file.

When this property is True, the file names are saved exactly as they are passed to the above mentioned methods, including full paths. This lets you to save directory structures to the encrypted and/or signed PGP files.

SignBufferingMethod:   The type of buffering used during signing.

Specifies the behaviour of the signer when operating with the input stream. Allowed values are: 0 - create a temporary stream and copy all data into it; 1 - rewind the input stream. The last option is useful when you have a stream which doesn't support seek operation such as a network stream or a decompressor stream.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TextCompatibilityMode:   Whether whitespaces must be trimmed from the signature.

Several versions of PGP have a bug in their implementations which results in creation of incorrect text signatures because they only remove trailing whitespaces from cleartext signatures. Technically, such signatures are not OpenPGP-compliant. Set this property to True if you want to interoperate with these implementations. Set this property to False if you need to create only OpenPGP-compliant messages.

UndefInputLength:   Set this property if you are working with non-seekable streams.

Use this property to turn on support for streams with unknown length and position parameters, such as network or database streams. It prevents the component from checking input stream length or position.

UseNewFeatures:   Whether the new algorithms, or only the algorithms compatible with PGP 2.6.x, are allowed.

Use this property for compatibility with old versions of PGP-compatible software. If this property is set to True, then newer and stronger algorithms will be used. In this case ClearTextSign and Sign will be compatible with PGP 2.6.x, while Encrypt and EncryptAndSign will not. If the property is set to False, then the result will be compatible with PGP 2.6.x, while the keys are compatible (i.e. don't use features not supported by PGP 2.6.x).

UseOldPackets:   Whether signature packets of old format, compatible with PGP 2.6.3, should be used.

The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.

Base Configuration Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the component.

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (PGPWriter Component)

PGPWriter Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
27262977   File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS)
27262978   Invalid key (SB_ERROR_PGP_INVALID_KEY)
27262979   No public key (SB_ERROR_PGP_NO_PUBLIC_KEY)
27262980   No secret key (SB_ERROR_PGP_NO_SECRET_KEY)
27262981   Not found (SB_ERROR_PGP_NOT_FOUND)
27262982   Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 .NET Edition - Version 22.0 [Build 8174]