Cms class

Cms class

Represents a digital sign created with Cryptographic Message Syntax (CMS) - IETF’s standard for cryptographically protected messages. CMS is based on the syntax of PKCS #7, specified in RFC 5652. Please see https://tools.ietf.org/html/rfc5652 for more information.

Inheritance: Cms → DigitalSignature → CustomPackage → MetadataPackage

The Cms type exposes the following members:

Properties

Property Description
metadata_type Gets the metadata type.
keys Gets a collection of the metadata property names.
property_descriptors Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count Gets the number of metadata properties.
comments Gets the signing purpose comment.
is_valid Gets a value indicating whether the signature is valid.
sign_time Gets the time at which the signer (purportedly) performed the signing process.
certificate_subject Gets the subject distinguished name from a certificate.
certificate_raw_data Gets the certificate raw data.
digest_algorithms Gets the array of message-digest algorithm identifiers. There may be any number of elements in the collection, including zero.
encapsulated_content Gets the signed content, consisting of a content type identifier and the content itself.
certificates Gets the collection of certificates.
signers Gets the collection of per-signer information packages.

Methods

Method Description
contains(self, property_name) Determines whether the package contains a metadata property with the specified name.
find_properties(self, specification) Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties(self, specification, value) Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties(self, specification) Removes metadata properties satisfying a specification.
add_properties(self, specification, value) Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties(self, specification, value) Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.
sanitize(self) Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

See Also

CmsAttribute class