Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SignedCms Class

The SignedCms class enables signing and verifying of CMS/PKCS #7 messages.

System.Object
  System.Security.Cryptography.Pkcs.SignedCms

Namespace:  System.Security.Cryptography.Pkcs
Assembly:  System.Security (in System.Security.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class SignedCms

The SignedCms type exposes the following members.

  NameDescription
Public methodSignedCms()The SignedCms() constructor creates an instance of the SignedCms class.
Public methodSignedCms(ContentInfo)The SignedCms(ContentInfo) constructor creates an instance of the SignedCms class by using the specified content information as the inner content.
Public methodSignedCms(SubjectIdentifierType)The SignedCms(SubjectIdentifierType) constructor creates an instance of the SignedCms class by using the specified subject identifier type as the default subject identifier type for signers.
Public methodSignedCms(ContentInfo, Boolean)The SignedCms(ContentInfo, Boolean) constructor creates an instance of the SignedCms class by using the specified content information as the inner content and by using the detached state.
Public methodSignedCms(SubjectIdentifierType, ContentInfo)The SignedCms(SubjectIdentifierType, ContentInfo) constructor creates an instance of the SignedCms class by using the specified subject identifier type as the default subject identifier type for signers and content information as the inner content.
Public methodSignedCms(SubjectIdentifierType, ContentInfo, Boolean)The SignedCms(SubjectIdentifierType, ContentInfo, Boolean) constructor creates an instance of the SignedCms class by using the specified subject identifier type as the default subject identifier type for signers, the content information as the inner content, and by using the detached state.
Top
  NameDescription
Public propertyCertificatesThe Certificates property retrieves the certificates associated with the encoded CMS/PKCS #7 message.
Public propertyContentInfoThe ContentInfo property retrieves the inner contents of the encoded CMS/PKCS #7 message.
Public propertyDetachedThe Detached property retrieves whether the SignedCms object is for a detached signature.
Public propertySignerInfosThe SignerInfos property retrieves the SignerInfoCollection collection associated with the CMS/PKCS #7 message.
Public propertyVersionThe Version property retrieves the version of the CMS/PKCS #7 message.
Top
  NameDescription
Public methodCheckHashThe CheckHash method verifies the data integrity of the CMS/PKCS #7 message. CheckHash is a specialized method used in specific security infrastructure applications that only wish to check the hash of the CMS message, rather than perform a full digital signature verification. CheckHash does not authenticate the author nor sender of the message because this method does not involve verifying a digital signature. For general-purpose checking of the integrity and authenticity of a CMS/PKCS #7 message, use the CheckSignature(Boolean) or CheckSignature(X509Certificate2Collection, Boolean) methods.
Public methodCheckSignature(Boolean)The CheckSignature(Boolean) method verifies the digital signatures on the signed CMS/PKCS #7 message and, optionally, validates the signers' certificates.
Public methodCheckSignature(X509Certificate2Collection, Boolean)The CheckSignature(X509Certificate2Collection, Boolean) method verifies the digital signatures on the signed CMS/PKCS #7 message by using the specified collection of certificates and, optionally, validates the signers' certificates.
Public methodComputeSignature()The ComputeSignature() method prompts the user to select a signing certificate, creates a signature, and adds the signature to the CMS/PKCS #7 message.
Public methodComputeSignature(CmsSigner)The ComputeSignature(CmsSigner) method creates a signature using the specified signer and adds the signature to the CMS/PKCS #7 message.
Public methodComputeSignature(CmsSigner, Boolean)Creates a signature using the specified signer and adds the signature to the CMS/PKCS #7 message. If the value of the silent parameter is false and the Certificate property of the CmsSigner object specified by the signer parameter is not set to a valid certificate, this method prompts the user to select a signing certificate.
Public methodDecodeThe Decode method decodes an encoded SignedCms message. Upon successful decoding, the decoded information can be retrieved from the properties of the SignedCms object.
Public methodEncodeThe Encode method encodes the information in the object into a CMS/PKCS #7 message.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodRemoveSignature(Int32)Removes the signature at the specified index of the SignerInfos collection.
Public methodRemoveSignature(SignerInfo)The RemoveSignature method removes the signature for the specified SignerInfo object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The Cryptographic Message Syntax RFC specifies the following MIME types and file name extensions for CMS/PKCS #7 messages with these content types.

Content type

MIME type

Extension

envelopedData

application/pkcs7-mime

.p7m

signedData

application/pkcs7-signature

.p7s.p7c

NoteNote

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.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft. All rights reserved.