adobe.pdfservices.operation.pdfjobs.params.eseal package

Submodules

adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options module

class adobe.pdfservices.operation.pdfjobs.params.eseal.RFC3161_tsa_options.RFC3161TSAOptions(url: str, *, tsa_basic_auth_credentials: TSABasicAuthCredentials | None = None)

Bases: TSAOptions

Parameters specifying RFC3161 compliant time stamp authority options required for PDFElectronicSealParams.

Constructs a new RFC3161TSAOptions instance from url.

Parameters:

• url (str) – url to be used for timestamping, can not be None.

• tsa_basic_auth_credentials (TSABasicAuthCredentials) – Credentials to be used for timestamping. (Optional, use key-value)

get_tsa_basic_auth_credentials()

Returns the intended TSA authorization credentials to be used.

Returns:

A TSABasicAuthCredentials instance

Return type:

TSABasicAuthCredentials

get_url()

Returns the timestamp url to be used.

Returns:

The timestamp url

Return type:

str

to_dict()

Returns a dictionary representation of the RFC3161TSAOptions instance.

Returns:

A dictionary representing the RFC3161TSAOptions instance

adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item module

class adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_item.AppearanceItem(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Supported elements to represent electronic seal required for AppearanceOptions.

DATE = 'DATE'

Represents the date of applying the electronic seal.

DISTINGUISHED_NAME = 'DISTINGUISHED_NAME'

Represents the distinguished name information of the certificate.

LABELS = 'LABELS'

Represents labels for seal information.

NAME = 'NAME'

Represents the name of the certificate owner.

SEAL_IMAGE = 'SEAL_IMAGE'

Represents the background image to be used for sealing.

get_appearance_item() → str

adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options module

class adobe.pdfservices.operation.pdfjobs.params.eseal.appearance_options.AppearanceOptions

Bases: object

Parameters specifying set of elements (i.e. appearance items) to represent electronic seal required for PDFElectronicSealParams.

add_item(appearance_option: AppearanceItem)

Parameters:

appearance_option (AppearanceItem) – AppearanceItem to be added to AppearanceOptions, can not be None.

get_appearance_options()

Returns:

List of Appearance Items

adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context module

class adobe.pdfservices.operation.pdfjobs.params.eseal.csc_auth_context.CSCAuthContext(access_token: str, token_type: str = 'Bearer')

Bases: object

Parameters for representing CSC authorization context.

Constructs a new instance of CSCAuthContext

Parameters:

• access_token (str) – The service access token used to authorize access to the CSC provider hosted APIs. Cannot be None.

• token_type (str) – The type of service access token used to authorize access to the CSC provider hosted APIs. Default value is “Bearer”.

get_access_token()

Returns:

The service access token.

Return type:

str

get_token_type()

Returns:

The type of service access token used.

Return type:

str

to_dict()

adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials module

class adobe.pdfservices.operation.pdfjobs.params.eseal.csc_credentials.CSCCredentials(provider_name: str, credential_id: str, pin: str, csc_auth_context: CSCAuthContext)

Bases: object

Parameters for representing the CSC Provider based credentials as a subtype

Creates an instance of CSCCredentials.

Parameters:

• provider_name (str) – The name of the Trust Service Provider to be used for applying electronic seal. Can not be None.

• credential_id (str) – The digital ID stored with the TSP provider to be used for applying electronic seal. Can not be None.

• pin (str) – The pin associated with the credential ID. Can not be None.

• csc_auth_context (CSCAuthContext) – The service authorization data required to communicate with the TSP. Can not be None.

get_credential_id()

Returns:

The digital ID stored with the TSP provider.

Return type:

str

get_csc_auth_context()

Returns:

The service authorization data.

Return type:

CSCAuthContext

get_pin()

Returns:

The pin associated with the credential ID.

Return type:

str

get_provider_name()

Returns:

The name of the Trust Service Provider.

Return type:

str

to_dict()

adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission module

class adobe.pdfservices.operation.pdfjobs.params.eseal.document_level_permission.DocumentLevelPermission(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

A mapping of Document Level Permission used in PDFElectronicSealParams.

FORM_FILLING = 'FORM_FILLING'

Represents FORM_FILLING document level permission. Allowed changes in output document are filling in forms, instantiating page templates, and performing approval signatures.

FORM_FILLING_AND_ANNOTATIONS = 'FORM_FILLING_AND_ANNOTATIONS'

Represents FORM_FILLING_AND_ANNOTATIONS document level permission. In addition to changes allowed in FORM_FILLING, annotation creation, deletion, and modification are also allowed.

NO_CHANGES_ALLOWED = 'NO_CHANGES_ALLOWED'

Represents NO_CHANGES_ALLOWED document level permission. No changes to the output document are permitted.

adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params module

class adobe.pdfservices.operation.pdfjobs.params.eseal.electronic_seal_params.PDFElectronicSealParams(seal_certificate_credentials: CSCCredentials, seal_field_options: FieldOptions, *, seal_signature_format: SignatureFormat = SignatureFormat.PKCS7, document_level_permissions: DocumentLevelPermission = DocumentLevelPermission.FORM_FILLING, seal_appearance_options: AppearanceOptions | None = None, tsa_options: TSAOptions | None = None)

Bases: object

Parameters for electronically seal PDFs using PDFElectronicSealJob.

Constructs a new PDFElectronicSealParams instance.

Parameters:

• seal_certificate_credentials (CSCCredentials) – CertificateCredentials to be used for applying electronic seal; can not be None.

• seal_field_options (FieldOptions) – FieldOptions to be used for applying electronic seal; can not be None.

• seal_signature_format (SignatureFormat) – SignatureFormat to be used for applying electronic seal. (Optional, use key-value)

• document_level_permissions (DocumentLevelPermission) – Document level permission for changes allowed after sealing. (Optional, use key-value)

• seal_appearance_options (AppearanceOptions) – AppearanceOptions for the seal. (Optional, use key-value)

• tsa_options (TSAOptions) – Time stamp authority options. (Optional, use key-value)

Returns:

A new instance of PDFElectronicSealParams

Return type:

PDFElectronicSealParams

get_seal_appearance_options()

Returns:

AppearanceOptions for the seal.

Return type:

AppearanceOptions

get_seal_certificate_credentials()

Returns:

CertificateCredentials to be used for applying electronic seal

Return type:

CSCCredentials

get_seal_field_options()

Returns:

FieldOptions to be used for applying electronic seal.

Return type:

FieldOptions

get_signature_format()

Returns:

SignatureFormat to be used for applying electronic seal.

Return type:

SignatureFormat

to_dict()

For SDK’s internal use

Returns:

ElectronicSealParams as a dictionary.

Return type:

dict

adobe.pdfservices.operation.pdfjobs.params.eseal.field_location module

class adobe.pdfservices.operation.pdfjobs.params.eseal.field_location.FieldLocation(left: int, top: int, right: int, bottom: int)

Bases: object

Parameters specifying options related to seal field location coordinates required for FieldOptions

Parameters:

• left (int) – the left coordinate of field location

• top (int) – the top coordinate of field location

• right (int) – the right coordinate of field location

• bottom (int) – the bottom coordinate of field location

get_bottom()

Returns:

the bottom coordinate of field location

Return type:

int

get_left()

Returns:

the left coordinate of field location

Return type:

int

get_right()

Returns:

the right coordinate of field location

Return type:

int

get_top()

Returns:

the top coordinate of field location

Return type:

int

to_dict()

adobe.pdfservices.operation.pdfjobs.params.eseal.field_options module

class adobe.pdfservices.operation.pdfjobs.params.eseal.field_options.FieldOptions(field_name: str, *, field_location: FieldLocation | None = None, page_number: int | None = None, visible: bool | None = True)

Bases: object

Parameters specifying options related to the seal field required for PDFElectronicSealParams.

Constructs a new instance of FieldOptions.

Parameters:

• field_name (str) – The name of the field to be used for applying the electronic seal. If signature field with this field name already exist, that field will be used. If it does not exist, a signature field with this field name will be created. Can not be None.

• field_location (FieldLocation) – A FieldLocation instance specifying coordinates for the electronic seal. The location is only required for visible signatures if the signature field does not already exist in the PDF document. If location is provided along with the existing signature field then it is ignored. (Optional, use key-value)

• page_number (int) – The page number to which the signature field should be attached. Page numbers are 1-based. The page number is only required for visible signatures if the signature field does not already exist in the PDF document. If page number is provided along with the existing signature field then the page number should be same on which signature field is present in the document, else an error is thrown. (Optional, use key-value)

• visible (bool) – The intended visibility flag for the electronic seal. Default value is true. (Optional, use key-value)

get_field_location()

Returns:

Field Location

Return type:

FieldLocation

get_field_name()

Returns:

Field Name

Return type:

str

get_page_number()

Returns:

Page Number

Return type:

int

get_visible()

Returns:

Visibility flag for the electronic seal

Return type:

bool

to_dict()

adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format module

class adobe.pdfservices.operation.pdfjobs.params.eseal.signature_format.SignatureFormat(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Supported signature formats to create electronic seal required for PDFElectronicSealParams.

PADES = 'PADES'

Represents PADES format.

PKCS7 = 'PKCS7'

Represents PKCS7 format.

get_signature_format()

Returns:

String value of SignatureFormat

Return type:

str

adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials module

class adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_basic_auth_credentials.TSABasicAuthCredentials(username: str, password: str)

Bases: object

Parameters specifying options related to the time stamp authority credentials required for RFC3161TSAOptions

Constructs a TSABasicAuthCredentials instance.

Parameters:

• username (str) – username to be used for timestamping

• password (str) – password to be used for timestamping

get_password()

Returns the intended password to be used for timestamping.

Returns:

The password

Return type:

str

get_username()

Returns the intended username to be used for timestamping.

Returns:

The username

Return type:

str

to_dict()

Returns a dictionary representation of the TSABasicAuthCredentials instance.

Returns:

A dictionary representing the TSABasicAuthCredentials instance

adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options module

class adobe.pdfservices.operation.pdfjobs.params.eseal.tsa_options.TSAOptions

Bases: ABC

This abstract class represents the basic contract for the timestamp authority options to be used with PDFElectronicSealParams.

abstract to_dict()

Module contents