digital_signatures property
Document.digital_signatures property
Gets the collection of digital signatures for this document and their validation results.
@property
def digital_signatures(self) -> aspose.words.digitalsignatures.DigitalSignatureCollection:
...
Remarks
This collection contains digital signatures that were loaded from the original document. These digital signatures will not be saved when you save this Document object into a file or stream because saving or converting will produce a document that is different from the original and the original digital signatures will no longer be valid.
This collection is never None
. If the document is not signed, it will contain zero elements.
Examples
Shows how to validate and display information about each signature in a document.
doc = aw.Document(MY_DIR + "Digitally signed.docx")
for signature in doc.digital_signatures:
print(f"\n{'Valid' if signature.is_valid else 'Invalid'} signature: ")
print(f"\tReason:\t{signature.comments}")
print(f"\tType:\t{signature.signature_type}")
print(f"\tSign time:\t{signature.sign_time}")
# System.Security.Cryptography.X509Certificates.X509Certificate2 is not supported. That is why the following information is not accesible.
#print(f"\tSubject name:\t{signature.certificate_holder.certificate.subject_name}")
#print(f"\tIssuer name:\t{signature.certificate_holder.certificate.issuer_name.name}")
print()
Shows how to sign documents with X.509 certificates.
# Verify that a document is not signed.
self.assertFalse(aw.FileFormatUtil.detect_file_format(MY_DIR + "Document.docx").has_digital_signature)
# Create a CertificateHolder object from a PKCS12 file, which we will use to sign the document.
certificate_holder = aw.digitalsignatures.CertificateHolder.create(MY_DIR + "morzal.pfx", "aw", None)
# There are two ways of saving a signed copy of a document to the local file system:
# 1 - Designate a document by a local system filename and save a signed copy at a location specified by another filename.
sign_options = aw.digitalsignatures.SignOptions()
sign_options.sign_time = datetime.utcnow()
aw.digitalsignatures.DigitalSignatureUtil.sign(
MY_DIR + "Document.docx", ARTIFACTS_DIR + "Document.digital_signature.docx",
certificate_holder, sign_options)
self.assertTrue(aw.FileFormatUtil.detect_file_format(ARTIFACTS_DIR + "Document.digital_signature.docx").has_digital_signature)
# 2 - Take a document from a stream and save a signed copy to another stream.
with open(MY_DIR + "Document.docx", "rb") as in_doc:
with open(ARTIFACTS_DIR + "Document.digital_signature.docx", "wb") as out_doc:
aw.digitalsignatures.DigitalSignatureUtil.sign(in_doc, out_doc, certificate_holder)
self.assertTrue(aw.FileFormatUtil.detect_file_format(ARTIFACTS_DIR + "Document.digital_signature.docx").has_digital_signature)
# Please verify that all of the document's digital signatures are valid and check their details.
signed_doc = aw.Document(ARTIFACTS_DIR + "Document.digital_signature.docx")
digital_signature_collection = signed_doc.digital_signatures
self.assertTrue(digital_signature_collection.is_valid)
self.assertEqual(1, digital_signature_collection.count)
self.assertEqual(aw.digitalsignatures.DigitalSignatureType.XML_DSIG, digital_signature_collection[0].signature_type)
self.assertEqual("CN=Morzal.Me", signed_doc.digital_signatures[0].issuer_name)
self.assertEqual("CN=Morzal.Me", signed_doc.digital_signatures[0].subject_name)
See Also
- module aspose.words
- class Document