pdftools_sdk.sign.output_options

Classes

OutputOptions()

Additional document level options
class pdftools_sdk.sign.output_options.OutputOptions[source]

Bases: OutputOptions

Additional document level options

These options are available for all signature operations of the pdftools_sdk.sign.signer.Signer . They can also be used without a signature operation with the method pdftools_sdk.sign.signer.Signer.process() .

Notes on document encryption when processing files with the pdftools_sdk.sign.signer.Signer :

  • PDF/A conformance is removed from input files. In this case, a pdftools_sdk.sign.signer.WarningFunc() with an pdftools_sdk.sign.warning_category.WarningCategory.PDFAREMOVED is generated.

  • Signed documents cannot be encrypted or decrypted. In this case, a pdftools_sdk.sign.signer.WarningFunc() with an pdftools_sdk.sign.warning_category.WarningCategory.SIGNEDDOCENCRYPTIONUNCHANGED is generated.

__init__()[source]
property remove_signatures: SignatureRemoval

Whether to remove any signatures

By default, all signatures of the input document are preserved. Optionally, some or all of them can be removed.

Default is pdftools_sdk.sign.signature_removal.SignatureRemoval.NONE

Returns:

pdftools_sdk.sign.signature_removal.SignatureRemoval

property add_validation_information: AddValidationInformation

Add validation information to existing signatures of input document

Add signature validation information to the document security store (DSS). This information includes:

  • All certificates of the signing certificate’s trust chain, unless they are already embedded into the signature.

  • Revocation data (OCSP or CRL) for all certificates that support revocation information.

This method can be used to create signatures with long-term validation material or to enlarge the longevity of existing signatures. For more details on validation information, see also pdftools_sdk.crypto.validation_information.ValidationInformation .

Validation information for embedded time-stamp tokens is added as well.

If adding validation information fails, an pdftools_sdk.sign.signer.WarningFunc() with an pdftools_sdk.sign.warning_category.WarningCategory.ADDVALIDATIONINFORMATIONFAILED is generated.

All types of cryptographic providers support this method. However, this method fails when using a provider whose certificate store is missing a required certificate.

Note: This property has no effect on any new signatures or time-stamp that may also be added. The validation information of signatures and time-stamps is controlled by the respective property in the signature or time-stamp configuration object.

Note: This method does not validate the signatures, but only downloads the information required.

Note: Adding validation information for expired certificates is not possible. Therefore, it is crucial to enlarge the longevity of signatures before they expire.

Note: Adding validation information to document certification (MDP) signatures is not possible, because it would break the signature. Validation information must be added to certification signatures when creating them.

Default is pdftools_sdk.sign.add_validation_information.AddValidationInformation.NONE

Returns:

pdftools_sdk.sign.add_validation_information.AddValidationInformation