pyhanko package
Subpackages
- pyhanko.pdf_utils package
- pyhanko.pdf_utils.barcodes module
- pyhanko.pdf_utils.config_utils module
- pyhanko.pdf_utils.content module
- pyhanko.pdf_utils.crypt package
- About crypt filters
SecurityHandler
SecurityHandler.register()
SecurityHandler.build()
SecurityHandler.get_name()
SecurityHandler.extract_credential()
SecurityHandler.support_generic_subfilters()
SecurityHandler.instantiate_from_pdf_object()
SecurityHandler.is_authenticated()
SecurityHandler.as_pdf_object()
SecurityHandler.authenticate()
SecurityHandler.get_string_filter()
SecurityHandler.get_stream_filter()
SecurityHandler.get_embedded_file_filter()
SecurityHandler.get_file_encryption_key()
SecurityHandler.read_cf_dictionary()
SecurityHandler.process_crypt_filters()
SecurityHandler.register_crypt_filter()
SecurityHandler.get_min_pdf_version()
StandardSecurityHandler
StandardSecurityHandler.get_name()
StandardSecurityHandler.build_from_pw_legacy()
StandardSecurityHandler.build_from_pw()
StandardSecurityHandler.gather_encryption_metadata()
StandardSecurityHandler.instantiate_from_pdf_object()
StandardSecurityHandler.as_pdf_object()
StandardSecurityHandler.authenticate()
StandardSecurityHandler.get_file_encryption_key()
PubKeySecurityHandler
PubKeySecurityHandler.build_from_certs()
PubKeySecurityHandler.get_name()
PubKeySecurityHandler.support_generic_subfilters()
PubKeySecurityHandler.read_cf_dictionary()
PubKeySecurityHandler.process_crypt_filters()
PubKeySecurityHandler.gather_pub_key_metadata()
PubKeySecurityHandler.instantiate_from_pdf_object()
PubKeySecurityHandler.as_pdf_object()
PubKeySecurityHandler.add_recipients()
PubKeySecurityHandler.authenticate()
PubKeySecurityHandler.get_file_encryption_key()
AuthResult
AuthStatus
SecurityHandlerVersion
StandardSecuritySettingsRevision
StandardSecuritySettingsRevision.RC4_BASIC
StandardSecuritySettingsRevision.RC4_EXTENDED
StandardSecuritySettingsRevision.RC4_OR_AES128
StandardSecuritySettingsRevision.AES256
StandardSecuritySettingsRevision.OTHER
StandardSecuritySettingsRevision.as_pdf_object()
StandardSecuritySettingsRevision.from_number()
PubKeyAdbeSubFilter
CryptFilterConfiguration
CryptFilterConfiguration.filters()
CryptFilterConfiguration.set_security_handler()
CryptFilterConfiguration.get_for_stream()
CryptFilterConfiguration.get_for_string()
CryptFilterConfiguration.get_for_embedded_file()
CryptFilterConfiguration.stream_filter_name
CryptFilterConfiguration.string_filter_name
CryptFilterConfiguration.embedded_file_filter_name
CryptFilterConfiguration.as_pdf_object()
CryptFilterConfiguration.standard_filters()
CryptFilter
StandardCryptFilter
PubKeyCryptFilter
IdentityCryptFilter
RC4CryptFilterMixin
AESCryptFilterMixin
StandardAESCryptFilter
StandardRC4CryptFilter
PubKeyAESCryptFilter
PubKeyRC4CryptFilter
EnvelopeKeyDecrypter
SimpleEnvelopeKeyDecrypter
SerialisedCredential
SerialisableCredential
build_crypt_filter()
PdfKeyNotAvailableError
- pyhanko.pdf_utils.embed module
- pyhanko.pdf_utils.extensions module
DevExtensionMultivalued
DeveloperExtension
DeveloperExtension.prefix_name
DeveloperExtension.base_version
DeveloperExtension.extension_level
DeveloperExtension.url
DeveloperExtension.extension_revision
DeveloperExtension.compare_by_level
DeveloperExtension.subsumed_by
DeveloperExtension.subsumes
DeveloperExtension.multivalued
DeveloperExtension.as_pdf_object()
- pyhanko.pdf_utils.filters module
- pyhanko.pdf_utils.font package
- pyhanko.pdf_utils.generic module
Dereferenceable
Reference
TrailerReference
PdfObject
IndirectObject
NullObject
BooleanObject
FloatObject
NumberObject
ByteStringObject
TextStringObject
NameObject
ArrayObject
DictionaryObject
StreamObject
read_object()
pdf_name
pdf_string()
pdf_date()
TextStringEncoding
EncryptedObjAccess
DecryptedObjectProxy
- pyhanko.pdf_utils.images module
- pyhanko.pdf_utils.incremental_writer module
IncrementalPdfFileWriter
IncrementalPdfFileWriter.IO_CHUNK_SIZE
IncrementalPdfFileWriter.from_reader()
IncrementalPdfFileWriter.ensure_output_version()
IncrementalPdfFileWriter.get_object()
IncrementalPdfFileWriter.mark_update()
IncrementalPdfFileWriter.update_container()
IncrementalPdfFileWriter.update_root()
IncrementalPdfFileWriter.set_info()
IncrementalPdfFileWriter.set_custom_trailer_entry()
IncrementalPdfFileWriter.write()
IncrementalPdfFileWriter.document_meta_view
IncrementalPdfFileWriter.write_in_place()
IncrementalPdfFileWriter.encrypt()
IncrementalPdfFileWriter.encrypt_pubkey()
IncrementalPdfFileWriter.stream_xrefs
- pyhanko.pdf_utils.layout module
- pyhanko.pdf_utils.metadata package
- pyhanko.pdf_utils.metadata.model module
DocumentMetadata
VENDOR
MetaString
ExpandedName
Qualifiers
XmpValue
XmpStructure
XmpArrayType
XmpArray
NS
XML_LANG
RDF_RDF
RDF_SEQ
RDF_BAG
RDF_ALT
RDF_LI
RDF_VALUE
RDF_RESOURCE
RDF_PARSE_TYPE
RDF_ABOUT
RDF_DESCRIPTION
DC_TITLE
DC_CREATOR
DC_DESCRIPTION
PDF_PRODUCER
PDF_KEYWORDS
X_XMPMETA
X_XMPTK
XMP_CREATORTOOL
XMP_CREATEDATE
XMP_MODDATE
- pyhanko.pdf_utils.metadata.model module
- pyhanko.pdf_utils.misc module
PdfError
PdfReadError
PdfStrictReadError
PdfWriteError
PdfStreamError
IndirectObjectExpected
get_and_apply()
OrderedEnum
StringWithLanguage
is_regular_character()
read_non_whitespace()
read_until_whitespace()
read_until_delimiter()
read_until_regex()
skip_over_whitespace()
skip_over_comment()
instance_test()
peek()
assert_writable_and_random_access()
prepare_rw_output_stream()
finalise_output()
DEFAULT_CHUNK_SIZE
chunked_write()
chunked_digest()
chunk_stream()
ConsList
Singleton
rd()
isoparse()
lift_iterable_async()
- pyhanko.pdf_utils.reader module
PdfFileReader
PdfFileReader.last_startxref
PdfFileReader.has_xref_stream
PdfFileReader.xrefs
PdfFileReader.document_meta_view
PdfFileReader.input_version
PdfFileReader.trailer_view
PdfFileReader.root_ref
PdfFileReader.document_id
PdfFileReader.get_historical_root()
PdfFileReader.total_revisions
PdfFileReader.get_object()
PdfFileReader.cache_get_indirect_object()
PdfFileReader.cache_indirect_object()
PdfFileReader.read()
PdfFileReader.decrypt()
PdfFileReader.decrypt_pubkey()
PdfFileReader.encrypted
PdfFileReader.get_historical_resolver()
PdfFileReader.embedded_signatures
PdfFileReader.embedded_regular_signatures
PdfFileReader.embedded_timestamp_signatures
HistoricalResolver
HistoricalResolver.document_meta_view
HistoricalResolver.document_id
HistoricalResolver.trailer_view
HistoricalResolver.get_object()
HistoricalResolver.root_ref
HistoricalResolver.explicit_refs_in_revision()
HistoricalResolver.refs_freed_in_revision()
HistoricalResolver.object_streams_used()
HistoricalResolver.is_ref_available()
HistoricalResolver.collect_dependencies()
parse_catalog_version()
RawPdfPath
process_data_at_eof()
- pyhanko.pdf_utils.rw_common module
- pyhanko.pdf_utils.text module
- pyhanko.pdf_utils.writer module
BasePdfFileWriter
BasePdfFileWriter.output_version
BasePdfFileWriter.stream_xrefs
BasePdfFileWriter.get_subset_collection()
BasePdfFileWriter.document_meta
BasePdfFileWriter.document_meta_view
BasePdfFileWriter.ensure_output_version()
BasePdfFileWriter.set_info()
BasePdfFileWriter.set_custom_trailer_entry()
BasePdfFileWriter.document_id
BasePdfFileWriter.mark_update()
BasePdfFileWriter.update_container()
BasePdfFileWriter.root_ref
BasePdfFileWriter.update_root()
BasePdfFileWriter.register_extension()
BasePdfFileWriter.get_object()
BasePdfFileWriter.allocate_placeholder()
BasePdfFileWriter.add_object()
BasePdfFileWriter.prepare_object_stream()
BasePdfFileWriter.trailer_view
BasePdfFileWriter.write()
BasePdfFileWriter.register_annotation()
BasePdfFileWriter.insert_page()
BasePdfFileWriter.import_object()
BasePdfFileWriter.import_page_as_xobject()
BasePdfFileWriter.add_stream_to_page()
BasePdfFileWriter.add_content_to_page()
BasePdfFileWriter.merge_resources()
PageObject
PdfFileWriter
init_xobject_dictionary()
copy_into_new_writer()
- pyhanko.pdf_utils.xref module
XRefCache
XRefCache.total_revisions
XRefCache.get_last_change()
XRefCache.object_streams_used_in()
XRefCache.get_introducing_revision()
XRefCache.get_xref_container_info()
XRefCache.get_xref_data()
XRefCache.explicit_refs_in_revision()
XRefCache.refs_freed_in_revision()
XRefCache.get_startxref_for_revision()
XRefCache.get_historical_ref()
XRefCache.hybrid_xrefs_present
XRefBuilder
XRefType
XRefEntry
ObjStreamRef
ObjectHeaderReadError
XRefSection
XRefSectionData
XRefSectionType
XRefSectionMetaInfo
TrailerDictionary
read_object_header()
parse_xref_stream()
parse_xref_table()
write_xref_table()
ObjectStream
XRefStream
- pyhanko.sign package
- pyhanko.sign.ades package
- pyhanko.sign.ades.api module
- pyhanko.sign.ades.asn1_util module
- pyhanko.sign.ades.cades_asn1 module
CommitmentTypeIdentifier
CommitmentTypeQualifier
CommitmentTypeQualifiers
CommitmentTypeIndication
SigPolicyQualifierId
NoticeNumbers
NoticeReference
SPUserNotice
SPDocSpecification
SigPolicyQualifierInfo
SigPolicyQualifierInfos
SignaturePolicyId
SignaturePolicyIdentifier
SignaturePolicyDocument
SignaturePolicyStore
DisplayText
SignerAttributesV2
CertifiedAttributesV2
CertifiedAttributeChoices
OtherAttrCert
OtherAttrCertId
SignedAssertions
SignedAssertion
SignedAssertionId
- pyhanko.sign.ades.report module
- pyhanko.sign.attributes module
- pyhanko.sign.beid module
- pyhanko.sign.diff_analysis package
- Guidelines for developing rules for use with
StandardDiffPolicy
- pyhanko.sign.diff_analysis.commons module
- pyhanko.sign.diff_analysis.form_rules_api module
- pyhanko.sign.diff_analysis.policies module
- pyhanko.sign.diff_analysis.policy_api module
- pyhanko.sign.diff_analysis.rules.file_structure_rules module
- pyhanko.sign.diff_analysis.rules.form_field_rules module
- pyhanko.sign.diff_analysis.rules.metadata_rules module
- pyhanko.sign.diff_analysis.rules_api module
- Guidelines for developing rules for use with
- pyhanko.sign.fields module
SigFieldSpec
SigFieldSpec.sig_field_name
SigFieldSpec.on_page
SigFieldSpec.box
SigFieldSpec.seed_value_dict
SigFieldSpec.field_mdp_spec
SigFieldSpec.doc_mdp_update_value
SigFieldSpec.combine_annotation
SigFieldSpec.empty_field_appearance
SigFieldSpec.invis_sig_settings
SigFieldSpec.readable_field_name
SigFieldSpec.visible_sig_settings
SigFieldSpec.format_lock_dictionary()
SigSeedValFlags
SigCertConstraints
SigCertConstraints.flags
SigCertConstraints.subjects
SigCertConstraints.subject_dn
SigCertConstraints.issuers
SigCertConstraints.info_url
SigCertConstraints.url_type
SigCertConstraints.key_usage
SigCertConstraints.from_pdf_object()
SigCertConstraints.as_pdf_object()
SigCertConstraints.satisfied_by()
SigSeedValueSpec
SigSeedValueSpec.flags
SigSeedValueSpec.reasons
SigSeedValueSpec.timestamp_server_url
SigSeedValueSpec.timestamp_required
SigSeedValueSpec.cert
SigSeedValueSpec.subfilters
SigSeedValueSpec.digest_methods
SigSeedValueSpec.add_rev_info
SigSeedValueSpec.seed_signature_type
SigSeedValueSpec.sv_dict_version
SigSeedValueSpec.legal_attestations
SigSeedValueSpec.lock_document
SigSeedValueSpec.appearance
SigSeedValueSpec.as_pdf_object()
SigSeedValueSpec.from_pdf_object()
SigSeedValueSpec.build_timestamper()
SigCertConstraintFlags
SigSeedSubFilter
SeedValueDictVersion
SeedLockDocument
SigCertKeyUsage
MDPPerm
FieldMDPAction
FieldMDPSpec
SignatureFormField
InvisSigSettings
VisibleSigSettings
enumerate_sig_fields()
append_signature_field()
ensure_sig_flags()
prepare_sig_field()
apply_sig_field_spec_properties()
- pyhanko.sign.general module
simple_cms_attribute()
find_cms_attribute()
find_unique_cms_attribute()
NonexistentAttributeError
MultivaluedAttributeError
CertificateStore
SimpleCertificateStore
SigningError
UnacceptableSignerError
SignedDataCerts
extract_signer_info()
extract_certificate_info()
load_certs_from_pemder()
load_cert_from_pemder()
load_private_key_from_pemder()
load_certs_from_pemder_data()
load_private_key_from_pemder_data()
get_cms_hash_algo_for_mechanism()
get_pyca_cryptography_hash()
optimal_pss_params()
process_pss_params()
as_signing_certificate()
as_signing_certificate_v2()
match_issuer_serial()
check_ess_certid()
CMSExtractionError
byte_range_digest()
ValueErrorWithMessage
CMSStructuralError
- pyhanko.sign.pkcs11 module
- pyhanko.sign.signers package
- pyhanko.sign.timestamps package
- pyhanko.sign.validation package
- pyhanko.sign.validation.ades module
- pyhanko.sign.validation.dss module
- pyhanko.sign.validation.errors module
- pyhanko.sign.validation.generic_cms module
validate_sig_integrity()
async_validate_cms_signature()
collect_timing_info()
validate_tst_signed_data()
async_validate_detached_cms()
cms_basic_validation()
compute_signature_tst_digest()
extract_tst_data()
extract_self_reported_ts()
extract_certs_for_validation()
collect_signer_attr_status()
validate_algorithm_protection()
- pyhanko.sign.validation.ltv module
- pyhanko.sign.validation.pdf_embedded module
- pyhanko.sign.validation.settings module
- pyhanko.sign.validation.status module
SignatureStatus
TimestampSignatureStatus
X509AttributeInfo
CertifiedAttributeInfo
ClaimedAttributes
CertifiedAttributes
CAdESSignerAttributeAssertions
StandardCMSSignatureStatus
SignatureCoverageLevel
ModificationInfo
PdfSignatureStatus
DocumentTimestampStatus
RevocationDetails
SignerAttributeStatus
- pyhanko.sign.validation.utils module
- Direct members
- pyhanko.sign.ades package
Submodules
- pyhanko.config module
StdLogOutput
LogConfig
CLIConfig
CLIConfig.validation_contexts
CLIConfig.stamp_styles
CLIConfig.default_validation_context
CLIConfig.default_stamp_style
CLIConfig.time_tolerance
CLIConfig.retroactive_revinfo
CLIConfig.log_config
CLIConfig.pemder_setups
CLIConfig.pkcs12_setups
CLIConfig.pkcs11_setups
CLIConfig.beid_module_path
CLIConfig.get_validation_context()
CLIConfig.get_signer_key_usages()
CLIConfig.get_stamp_style()
CLIConfig.get_pkcs11_config()
CLIConfig.get_pkcs12_config()
CLIConfig.get_pemder_config()
init_validation_context_kwargs()
parse_trust_config()
parse_logging_config()
PKCS12SignatureConfig
PemDerSignatureConfig
TokenCriteria
PKCS11PinEntryMode
PKCS11SignatureConfig
PKCS11SignatureConfig.module_path
PKCS11SignatureConfig.cert_label
PKCS11SignatureConfig.cert_id
PKCS11SignatureConfig.signing_certificate
PKCS11SignatureConfig.token_criteria
PKCS11SignatureConfig.other_certs
PKCS11SignatureConfig.key_label
PKCS11SignatureConfig.key_id
PKCS11SignatureConfig.slot_no
PKCS11SignatureConfig.user_pin
PKCS11SignatureConfig.prompt_pin
PKCS11SignatureConfig.other_certs_to_pull
PKCS11SignatureConfig.bulk_fetch
PKCS11SignatureConfig.prefer_pss
PKCS11SignatureConfig.raw_mechanism
PKCS11SignatureConfig.check_config_keys()
PKCS11SignatureConfig.process_entries()
parse_cli_config()
process_config_dict()
- pyhanko.stamp module