Documentazione API

digital_signature.client_config

class digital_signature.client_config.ClientConfig

Basi: object

APP_NAME = 'DigitalSignature'

COMPANY_NAME = 'Next'

HTTP_TIMEOUT = 30

MAX_DOWNLOAD_RETRIES = 3

PUBLIC_KEY = '5I/Y7+qrz71l8xrk9vKbti0RUPHObOLIL36L4R4V/DU'

UPDATE_URLS = ['http://localhost:8091/deploy/']

digital_signature.digiSign_lib

digital_signature.digiSign_server

digital_signature.my_config_loader

class digital_signature.my_config_loader.MyConfigLoader

Basi: object

get_logger_config()

get_pdf_config()

get_rev_checker_apis()

get_server_config()

digital_signature.my_logger

class digital_signature.my_logger.MyLogger

Basi: object

my_logger()

digital_signature.p7m_encoder

class digital_signature.p7m_encoder.P7mAttributes(algos, certificates, signer_infos)

Basi: object

class digital_signature.p7m_encoder.P7mEncoder

Basi: object

static bytes_to_sign(content_hash, certificate_hash, timestamp)

Return the p7m part that needs to be signed

Params:

content_hash: content digest certificate_hash: certificate digest

static encode_signed_attributes(content_hash, certificate_hash, timestamp)

Return a well formed signed attributes p7m field

Params:

content_hash: content digest certificate_hash: certificate digest

static encode_signer_info(issuer, serial_number, signed_attributes, signed_bytes, existing_sig_infos)

Return a well formed signer info p7m field

Params:

issuer: smart card certificate issuer (bytes) serial_number: smart card serial number (int) signed_attributes: signed attributes p7m field signed_bytes: signature (bytes)

static make_a_p7m(content, certificate_value, signer_info, p7m_sig_attrs: digital_signature.p7m_encoder.P7mAttributes)

Return a well formed complete p7m

Param:

content: file content to sign certificate_value: value field of the smart card certificate signer_info: signer info in asn1 form

digital_signature.pdf_builder

exception digital_signature.pdf_builder.PDFCreationError

Basi: Exception

Raised when failing to create pdf

exception digital_signature.pdf_builder.PDFLinearizedError

Basi: Exception

Raised when the pdf is linearized

exception digital_signature.pdf_builder.PDFSigningError

Basi: Exception

Raised when failing to sign pdf

class digital_signature.pdf_builder.Signature(name, pos)

Basi: object

class digital_signature.pdf_builder.SignedData

Basi: object

aligned(data)

get_acrofields(document)

get_annots_fields_values(acrofields)

get_new_pagedata(pagedata)

get_new_rootdata(rootdata)

get_rect_array(pagedata, position)

get_sig_names()

get_signature_names(document)

getdata(pdfdata1, objid, startxref, document)

make_invisible_sig_objs(udct, no, page, pagedata, infodata, rootdata, zeros)

make_invisible_xref()

make_multi_inv_sig_objs(document, udct, no, page, pagedata, infodata, rootdata, zeros, sig_number)

make_multi_inv_xref()

make_multi_visible_sig_objs(document, udct, no, page, pagedata, infodata, rootdata, stream_name, rect, zeros)

make_multi_visible_xref()

make_visible_sig_objs(udct, no, page, pagedata, infodata, rootdata, stream_name, rect, zeros)

make_visible_xref()

makeobj(no, data)

makeobj_font_stream(no, data, stream)

makeobj_stream(no, data, stream)

makepdf(pdfdata1, udct, zeros, sig_attributes)

sign(datau, session, cert, cert_value, algomd, sig_attributes, timestamp)

digital_signature.pdf_builder.sign(datau, session, cert, cert_value, algomd, sig_attributes, timestamp)

digital_signature.pdf_signer

digital_signature.pdf_signer.sign(datau, session, cert, cert_value, hashalgo, attrs=True, signed_value=None)

digital_signature.revocation_checker

class digital_signature.revocation_checker.RevocationChecker

Basi: object

check(revocation_checker_url, certificate_value, params)

digital_signature.signature_util

class digital_signature.signature_util.SignatureUtils

Basi: object

static close_session(session)

Close smart card session

static digest(session, content)

Return content hash

Params:

session: smart card session content: content to hash

static fetch_certificate(session)

Return smart card certificate

Params:

session: smart card session

static fetch_private_key(session, certificate)

Return smart card private key reference

Params:

session: smart card session certificate: certificate connected to the key

static fetch_public_key(session, certificate)

Return smart card public key reference

Params:

session: smart card session certificate: certificate connected to the key

static fetch_smart_card_sessions()

Return a session list for the connected smart cards

static get_certificate_issuer(session, certificate)

Return the issuer of certificate

Params:

session: smart card session certificate: smart card certificate

static get_certificate_serial_number(session, certificate)

Return the serial number of certificate

Params:

session: smart card session certificate: smart card certificate

static get_certificate_value(session, certificate)

Return the value of certificate

Params:

session: smart card session certificate: smart card certificate

static signature(session, priv_key, content)

Sign content with privKey reference

Reurn:

signature in bytearray

Params:

session: smart card session. privKey: reference to the smart card private key. content: bytes to hash and sign

static user_login(sessions, pin)

User login on a session using pin

Params:

sessions: smart card session list pin: user pin

Ritorna:the logged in session

static user_logout(session)

User logout from a session

Params:

session: smart card session

exception digital_signature.signature_util.SmartCardConnectionError

Basi: ConnectionError

Raised when something goes wrong with the smart card

digital_signature.singleton_type

class digital_signature.singleton_type.SingletonType

Basi: type

digital_signature.update_checker

digital_signature.update_checker.UpdatePyUpdaterClientConfig(revocation_checker_url)

class digital_signature.update_checker.UpdateStatus

Basi: object

Enumerated data type

COULDNT_CHECK_FOR_UPDATES = 5

EXTRACTING_UPDATE_AND_RESTARTING = 3

NO_AVAILABLE_UPDATES = 1

UNKNOWN = 0

UPDATE_AVAILABLE_BUT_APP_NOT_FROZEN = 4

UPDATE_DOWNLOAD_FAILED = 2

digital_signature.update_checker.check_for_updates(rev_checker_url=None)

Controllo nuovi aggiornamenti.

Parametri:update_checker_url (str, optional) – Url server degli aggiornamenti, defaults to None Ritorna:UpdateObject utilizzato per aggiornare i binari Tipo di ritorno:  AppUpdate

digital_signature.update_checker.progress(data)

digital_signature.update_checker.run_updates(app_update)

Lancia il download dell’aggiornamento e al completamento estrae il file dal zip e riavvia l’applicazione

Parametri:app_update (AppUpdate) – UpdateObject utilizzato per aggiornare i binari Ritorna:Lo stato dell’aggiornamento Tipo di ritorno:  UpdateStatus

digital_signature.verifier

class digital_signature.verifier.VerifyData(trustedCerts=None)

Basi: object

add_cert(trusted_cert)

verify(datas, datau)

verify_cert(cert_pem)

digital_signature.verifier.verify(datas, datau, certs)

digital_signature.verify

digital_signature.verify.verify(pdfdata, certs=None)

Return the Hash, Signature and Cert verification result for each signature in the pdf

Params:

pdfdata: Pdf content as bytes certs: List of certificates

Module contents

FirmaJR version 0.0.4