MessageDecryptor Component

Properties   Methods   Events   Config Settings   Errors  

The MessageDecryptor component decrypts data that is stored in the PKCS#7 format.

Syntax

nsoftware.SecureBlackbox.Messagedecryptor

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

Property List

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

Method List

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

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.

Config Settings

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

Certificate Property (MessageDecryptor Component)

The certificate that was used to decrypt the message.

Syntax

• C#
• VB.NET

public Certificate Certificate { get; }

Public ReadOnly Property Certificate As Certificate

Remarks

This property contains the certificate (one of those residing in Certificates collection) that was used to decrypt the message.

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

Certificates Property (MessageDecryptor Component)

A collection of certificates that can be used for message decryption.

Syntax

• C#
• VB.NET

public CertificateList Certificates { get; }

Public Property Certificates As CertificateList

Remarks

Use this collection to provide certificates that should be attempted to decrypt the message. The certificates can be provided before calling the Decrypt method, or later from RecipientFound event handler.

Note that the certificates need to have a private key associated with them to be usable for decryption.

This property is not available at design time.

EncryptionAlgorithm Property (MessageDecryptor Component)

The symmetric cipher that was used to encrypt the data.

Syntax

• C#
• VB.NET

public string EncryptionAlgorithm { get; }

Public ReadOnly Property EncryptionAlgorithm As String

Default Value

""

Remarks

This property contains the symmetric algorithm that the creator had used to encrypt the message.

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

EncryptionType Property (MessageDecryptor Component)

Specifies the kind of encrypted message to create.

Syntax

• C#
• VB.NET

public MessagedecryptorEncryptionTypes EncryptionType { get; }

enum MessagedecryptorEncryptionTypes {
  metUnknown,
  metCertEncrypted,
  metKeyEncrypted,
  metCertEncryptedAndAuthenticated
}

Public ReadOnly Property EncryptionType As MessagedecryptorEncryptionTypes

Enum MessagedecryptorEncryptionTypes
  metUnknown
  metCertEncrypted
  metKeyEncrypted
  metCertEncryptedAndAuthenticated
End Enum

Default Value

0

Remarks

Possible values:

This property is read-only.

ExternalCrypto Property (MessageDecryptor Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

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 the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

FIPSMode Property (MessageDecryptor Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

InputBytes Property (MessageDecryptor Component)

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

Syntax

• C#
• VB.NET

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 (MessageDecryptor Component)

Path to the file containing the encrypted message.

Syntax

• C#
• VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

""

Remarks

Use this property to provide a file containing the encrypted data.

InputStream Property (MessageDecryptor Component)

The stream containing the encrypted message.

Syntax

• C#
• VB.NET

public System.IO.Stream InputStream { get; set; }

Public Property InputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to provide a stream containing the encrypted message.

This property is not available at design time.

Key Property (MessageDecryptor Component)

The symmetric key to use for decryption.

Syntax

• C#
• VB.NET

public byte[] Key { get; set; }

Public Property Key As Byte()

Remarks

Use this property to provide the symmetric key to decrypt the data. This property is only applicable for processing data of EncryptedData subtype.

Assign this property before calling Decrypt.

This property is not available at design time.

OutputBytes Property (MessageDecryptor Component)

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

Syntax

• C#
• VB.NET

public byte[] OutputBytes { get; }

Public ReadOnly Property OutputBytes As Byte()

Remarks

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

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

OutputFile Property (MessageDecryptor Component)

Path to the file to save the decrypted data to.

Syntax

• C#
• VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

""

Remarks

Use this property to specify the output file where the decrypted message should be saved.

OutputStream Property (MessageDecryptor Component)

The stream to save the decrypted data to.

Syntax

• C#
• VB.NET

public System.IO.Stream OutputStream { get; set; }

Public Property OutputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to provide the stream to save the decrypted message to.

This property is not available at design time.

SignedAttributes Property (MessageDecryptor Component)

Custom signature attributes that are covered by the electronic signature.

Syntax

• C#
• VB.NET

public SignatureAttributeList SignedAttributes { get; }

Public ReadOnly Property SignedAttributes As SignatureAttributeList

Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as signed attributes are covered by the signature.

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

UnsignedAttributes Property (MessageDecryptor Component)

Custom unsigned attributes included in the electronic signature.

Syntax

• C#
• VB.NET

public SignatureAttributeList UnsignedAttributes { get; }

Public ReadOnly Property UnsignedAttributes As SignatureAttributeList

Remarks

Signature attributes are used to store auxiliary information in the signature. Values included as unsigned attributes are not covered by the signature and can be changed or removed without affecting the signature.

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

CheckEncryptionType Method (MessageDecryptor Component)

Determines the type of encrypted message in the supplied file.

Syntax

• C#
• VB.NET

public int CheckEncryptionType();

Public Function CheckEncryptionType() As Integer

Remarks

Use this method to determine the kind of the signature stored in InputFile (InputStream).

Config Method (MessageDecryptor Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

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.

Decrypt Method (MessageDecryptor Component)

Attempts to decrypt an encrypted PKCS#7 message.

Syntax

• C#
• VB.NET

public void Decrypt();

Public Sub Decrypt()

Remarks

Call this method to attempt to decrypt the PKCS#7 encrypted data. This call supports EnvelopedData and EncryptedData subtypes on input.

Use InputFile or InputStream property to provide the data, and either Certificates or Key to supply the decryption key material.

When processing enveloped data, the component may fire RecipientFound event to report recipient information.

DoAction Method (MessageDecryptor Component)

Performs an additional action.

Syntax

• C#
• VB.NET

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 (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Event (MessageDecryptor Component)

Information about errors during PKCS#7 message decryption.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

public class MessagedecryptorErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

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

Public Class MessagedecryptorErrorEventArgs 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 message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Messages section.

ExternalDecrypt Event (MessageDecryptor Component)

Handles remote or external decryption.

Syntax

• C#
• VB.NET

public event OnExternalDecryptHandler OnExternalDecrypt;

public delegate void OnExternalDecryptHandler(object sender, MessagedecryptorExternalDecryptEventArgs e);

public class MessagedecryptorExternalDecryptEventArgs : EventArgs {
  public string OperationId { get; }
  public string Algorithm { get; }
  public string Pars { get; }
  public string EncryptedData { get; }
  public string Data { get; set; }
}

Public Event OnExternalDecrypt As OnExternalDecryptHandler

Public Delegate Sub OnExternalDecryptHandler(sender As Object, e As MessagedecryptorExternalDecryptEventArgs)

Public Class MessagedecryptorExternalDecryptEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property Algorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property EncryptedData As String
  Public Property Data As String
End Class

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

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

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

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

Notification Event (MessageDecryptor Component)

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

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

public class MessagedecryptorNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

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

Public Class MessagedecryptorNotificationEventArgs 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 the 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.

RecipientFound Event (MessageDecryptor Component)

Fires to report a message addressee parameters.

Syntax

• C#
• VB.NET

public event OnRecipientFoundHandler OnRecipientFound;

public delegate void OnRecipientFoundHandler(object sender, MessagedecryptorRecipientFoundEventArgs e);

public class MessagedecryptorRecipientFoundEventArgs : EventArgs {
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public bool CertFound { get; }
}

Public Event OnRecipientFound As OnRecipientFoundHandler

Public Delegate Sub OnRecipientFoundHandler(sender As Object, e As MessagedecryptorRecipientFoundEventArgs)

Public Class MessagedecryptorRecipientFoundEventArgs Inherits EventArgs
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property CertFound As Boolean
End Class

Remarks

This event is fired for each addressee the message is encrypted for. It may fire several times in a row if the message is encrypted for more than one recipient.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters to identify the recipient's certificate. CertFound indicates if the specified certificate has been located in Certificates collection. If it wasn't, you might want to look up the certificate manually, and add it to the collection inside the event handler.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a new object with default field values.

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

Constructors

• C#
• VB.NET

public ExternalCrypto();

Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

SignatureAttribute Type

Represents an attribute of a digital PKCS#7/CMS signature.

Remarks

Attributes store auxiliary information about the signed message, the signature, or the owner. Each attribute is a OID=Value pair.

Common attributes are signing time, a content type, a policy identifier, and a signature timestamp.

Fields

Constructors

• C#
• VB.NET

public SignatureAttribute();

Public SignatureAttribute()

Creates a new, empty, signature attribute.

Config Settings (MessageDecryptor Component)

MessageDecryptor Config Settings

Base Config Settings

Trappable Errors (MessageDecryptor Component)

MessageDecryptor Errors