This documentation is archived and is not being maintained.

KeyAgreeRecipientInfo Class

The KeyAgreeRecipientInfo class defines key agreement recipient information. Key agreement algorithms typically use the Diffie-Hellman key agreement algorithm, in which the two parties that establish a shared cryptographic key both take part in its generation and, by definition, agree on that key. This is in contrast to key transport algorithms, in which one party generates the key unilaterally and sends, or transports it, to the other party.


Namespace:  System.Security.Cryptography.Pkcs
Assembly:  System.Security (in System.Security.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class KeyAgreeRecipientInfo : RecipientInfo

The KeyAgreeRecipientInfo type exposes the following members.

Public propertyDateThe Date property retrieves the date and time of the start of the key agreement protocol by the originator.
Public propertyEncryptedKeyThe EncryptedKey property retrieves the encrypted recipient keying material. (Overrides RecipientInfo.EncryptedKey.)
Public propertyKeyEncryptionAlgorithmThe KeyEncryptionAlgorithm property retrieves the algorithm used to perform the key agreement. (Overrides RecipientInfo.KeyEncryptionAlgorithm.)
Public propertyOriginatorIdentifierOrKeyThe OriginatorIdentifierOrKey property retrieves information about the originator of the key agreement for key agreement algorithms that warrant it.
Public propertyOtherKeyAttributeThe OtherKeyAttribute property retrieves attributes of the keying material.
Public propertyRecipientIdentifierThe RecipientIdentifier property retrieves the identifier of the recipient. (Overrides RecipientInfo.RecipientIdentifier.)
Public propertyTypeThe Type property retrieves the type of the recipient. The type of the recipient determines which of two major protocols is used to establish a key between the originator and the recipient of a CMS/PKCS #7 message. (Inherited from RecipientInfo.)
Public propertyVersionThe Version property retrieves the version of the key agreement recipient. This is automatically set for objects in this class, and the value implies that the recipient is taking part in a key agreement algorithm. (Overrides RecipientInfo.Version.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class does not have a public constructor; therefore, it cannot be publicly instantiated. It is a read-only class accessible from the EnvelopedCms.RecipientInfos property.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.