EnvelopedData object

Article
03/22/2021

[CAPICOM is a 32-bit only component that is available for use in the following operating systems: Windows Server 2008, Windows Vista, and Windows XP. Instead, use the EnvelopedCms Class in the System.Security.Cryptography.Pkcs namespace.]

The EnvelopedData object provides properties and methods to envelop data for privacy by encryption. To envelop data, a session cryptographic key is generated. That session key is then encrypted for each intended recipient using the public key of that intended recipient from the recipient's certificate. The encrypted data and the set of encrypted session keys can be sent to all intended recipients. The message generated is in PKCS #7 format.

Members

The EnvelopedData object has these types of members:

Methods
Properties

Methods

The EnvelopedData object has these methods.

Method	Description
Decrypt	Decrypts enveloped content.
Encrypt	Encrypts the content, encrypts a session key for each recipient, and returns the encrypted BLOB.

Properties

The EnvelopedData object has these properties.

Property	Access type	Description
Algorithm	Read/write	Encryption algorithm and key length.
Content	Read/write	The plaintext content of a message to be enveloped. Setting this property must be done before the Encrypt method is called. When the value of this property is reset, directly or indirectly, the whole state of the object is reset, and any encrypted content in the object is lost. This is the default property.
Recipients	Read-only	Collection of Certificate objects to receive the enveloped message.

Remarks

The EnvelopedData object can be created, and it is safe for scripting. The ProgID for the EnvelopedData object is CAPICOM.EnvelopedData.1.

Requirements

Requirement	Value
End of client support	Windows Vista
End of server support	Windows Server 2008
Redistributable	CAPICOM 2.0 or later on Windows Server 2003 and Windows XP
DLL	Capicom.dll