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
SecurityHandlerSecurityHandler.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()
StandardSecurityHandlerStandardSecurityHandler.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()
PubKeySecurityHandlerPubKeySecurityHandler.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()
AuthResultAuthStatusSecurityHandlerVersionStandardSecuritySettingsRevisionStandardSecuritySettingsRevision.RC4_BASICStandardSecuritySettingsRevision.RC4_EXTENDEDStandardSecuritySettingsRevision.RC4_OR_AES128StandardSecuritySettingsRevision.AES256StandardSecuritySettingsRevision.OTHERStandardSecuritySettingsRevision.as_pdf_object()StandardSecuritySettingsRevision.from_number()
PubKeyAdbeSubFilterCryptFilterConfigurationCryptFilterConfiguration.filters()CryptFilterConfiguration.set_security_handler()CryptFilterConfiguration.get_for_stream()CryptFilterConfiguration.get_for_string()CryptFilterConfiguration.get_for_embedded_file()CryptFilterConfiguration.stream_filter_nameCryptFilterConfiguration.string_filter_nameCryptFilterConfiguration.embedded_file_filter_nameCryptFilterConfiguration.as_pdf_object()CryptFilterConfiguration.standard_filters()
CryptFilterStandardCryptFilterPubKeyCryptFilterIdentityCryptFilterRC4CryptFilterMixinAESCryptFilterMixinStandardAESCryptFilterStandardRC4CryptFilterPubKeyAESCryptFilterPubKeyRC4CryptFilterEnvelopeKeyDecrypterSimpleEnvelopeKeyDecrypterSerialisedCredentialSerialisableCredentialbuild_crypt_filter()PdfKeyNotAvailableError
- pyhanko.pdf_utils.embed module
- pyhanko.pdf_utils.extensions module
DevExtensionMultivaluedDeveloperExtensionDeveloperExtension.prefix_nameDeveloperExtension.base_versionDeveloperExtension.extension_levelDeveloperExtension.urlDeveloperExtension.extension_revisionDeveloperExtension.compare_by_levelDeveloperExtension.subsumed_byDeveloperExtension.subsumesDeveloperExtension.multivaluedDeveloperExtension.as_pdf_object()
- pyhanko.pdf_utils.filters module
- pyhanko.pdf_utils.font package
- pyhanko.pdf_utils.generic module
DereferenceableReferenceTrailerReferencePdfObjectIndirectObjectNullObjectBooleanObjectFloatObjectNumberObjectByteStringObjectTextStringObjectNameObjectArrayObjectDictionaryObjectStreamObjectread_object()pdf_namepdf_string()pdf_date()TextStringEncodingEncryptedObjAccessDecryptedObjectProxy
- pyhanko.pdf_utils.images module
- pyhanko.pdf_utils.incremental_writer module
IncrementalPdfFileWriterIncrementalPdfFileWriter.IO_CHUNK_SIZEIncrementalPdfFileWriter.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_viewIncrementalPdfFileWriter.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
DocumentMetadataVENDORMetaStringExpandedNameQualifiersXmpValueXmpStructureXmpArrayTypeXmpArrayNSXML_LANGRDF_RDFRDF_SEQRDF_BAGRDF_ALTRDF_LIRDF_VALUERDF_RESOURCERDF_PARSE_TYPERDF_ABOUTRDF_DESCRIPTIONDC_TITLEDC_CREATORDC_DESCRIPTIONPDF_PRODUCERPDF_KEYWORDSX_XMPMETAX_XMPTKXMP_CREATORTOOLXMP_CREATEDATEXMP_MODDATE
- pyhanko.pdf_utils.metadata.model module
- pyhanko.pdf_utils.misc module
PdfErrorPdfReadErrorPdfStrictReadErrorPdfWriteErrorPdfStreamErrorIndirectObjectExpectedget_and_apply()OrderedEnumStringWithLanguageis_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_SIZEchunked_write()chunked_digest()chunk_stream()ConsListSingletonrd()isoparse()lift_iterable_async()
- pyhanko.pdf_utils.reader module
PdfFileReaderPdfFileReader.last_startxrefPdfFileReader.has_xref_streamPdfFileReader.xrefsPdfFileReader.document_meta_viewPdfFileReader.input_versionPdfFileReader.trailer_viewPdfFileReader.root_refPdfFileReader.document_idPdfFileReader.get_historical_root()PdfFileReader.total_revisionsPdfFileReader.get_object()PdfFileReader.cache_get_indirect_object()PdfFileReader.cache_indirect_object()PdfFileReader.read()PdfFileReader.decrypt()PdfFileReader.decrypt_pubkey()PdfFileReader.encryptedPdfFileReader.get_historical_resolver()PdfFileReader.embedded_signaturesPdfFileReader.embedded_regular_signaturesPdfFileReader.embedded_timestamp_signatures
HistoricalResolverHistoricalResolver.document_meta_viewHistoricalResolver.document_idHistoricalResolver.trailer_viewHistoricalResolver.get_object()HistoricalResolver.root_refHistoricalResolver.explicit_refs_in_revision()HistoricalResolver.refs_freed_in_revision()HistoricalResolver.object_streams_used()HistoricalResolver.is_ref_available()HistoricalResolver.collect_dependencies()
parse_catalog_version()RawPdfPathprocess_data_at_eof()
- pyhanko.pdf_utils.rw_common module
- pyhanko.pdf_utils.text module
- pyhanko.pdf_utils.writer module
BasePdfFileWriterBasePdfFileWriter.output_versionBasePdfFileWriter.stream_xrefsBasePdfFileWriter.get_subset_collection()BasePdfFileWriter.document_metaBasePdfFileWriter.document_meta_viewBasePdfFileWriter.ensure_output_version()BasePdfFileWriter.set_info()BasePdfFileWriter.set_custom_trailer_entry()BasePdfFileWriter.document_idBasePdfFileWriter.mark_update()BasePdfFileWriter.update_container()BasePdfFileWriter.root_refBasePdfFileWriter.update_root()BasePdfFileWriter.register_extension()BasePdfFileWriter.get_object()BasePdfFileWriter.allocate_placeholder()BasePdfFileWriter.add_object()BasePdfFileWriter.prepare_object_stream()BasePdfFileWriter.trailer_viewBasePdfFileWriter.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()
PageObjectPdfFileWriterinit_xobject_dictionary()copy_into_new_writer()
- pyhanko.pdf_utils.xref module
XRefCacheXRefCache.total_revisionsXRefCache.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
XRefBuilderXRefTypeXRefEntryObjStreamRefObjectHeaderReadErrorXRefSectionXRefSectionDataXRefSectionTypeXRefSectionMetaInfoTrailerDictionaryread_object_header()parse_xref_stream()parse_xref_table()write_xref_table()ObjectStreamXRefStream
- pyhanko.sign package
- pyhanko.sign.ades package
- pyhanko.sign.ades.api module
- pyhanko.sign.ades.asn1_util module
- pyhanko.sign.ades.cades_asn1 module
CommitmentTypeIdentifierCommitmentTypeQualifierCommitmentTypeQualifiersCommitmentTypeIndicationSigPolicyQualifierIdNoticeNumbersNoticeReferenceSPUserNoticeSPDocSpecificationSigPolicyQualifierInfoSigPolicyQualifierInfosSignaturePolicyIdSignaturePolicyIdentifierSignaturePolicyDocumentSignaturePolicyStoreDisplayTextSignerAttributesV2CertifiedAttributesV2CertifiedAttributeChoicesOtherAttrCertOtherAttrCertIdSignedAssertionsSignedAssertionSignedAssertionId
- 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
SigFieldSpecSigFieldSpec.sig_field_nameSigFieldSpec.on_pageSigFieldSpec.boxSigFieldSpec.seed_value_dictSigFieldSpec.field_mdp_specSigFieldSpec.doc_mdp_update_valueSigFieldSpec.combine_annotationSigFieldSpec.empty_field_appearanceSigFieldSpec.invis_sig_settingsSigFieldSpec.readable_field_nameSigFieldSpec.visible_sig_settingsSigFieldSpec.format_lock_dictionary()
SigSeedValFlagsSigCertConstraintsSigCertConstraints.flagsSigCertConstraints.subjectsSigCertConstraints.subject_dnSigCertConstraints.issuersSigCertConstraints.info_urlSigCertConstraints.url_typeSigCertConstraints.key_usageSigCertConstraints.from_pdf_object()SigCertConstraints.as_pdf_object()SigCertConstraints.satisfied_by()
SigSeedValueSpecSigSeedValueSpec.flagsSigSeedValueSpec.reasonsSigSeedValueSpec.timestamp_server_urlSigSeedValueSpec.timestamp_requiredSigSeedValueSpec.certSigSeedValueSpec.subfiltersSigSeedValueSpec.digest_methodsSigSeedValueSpec.add_rev_infoSigSeedValueSpec.seed_signature_typeSigSeedValueSpec.sv_dict_versionSigSeedValueSpec.legal_attestationsSigSeedValueSpec.lock_documentSigSeedValueSpec.appearanceSigSeedValueSpec.as_pdf_object()SigSeedValueSpec.from_pdf_object()SigSeedValueSpec.build_timestamper()
SigCertConstraintFlagsSigSeedSubFilterSeedValueDictVersionSeedLockDocumentSigCertKeyUsageMDPPermFieldMDPActionFieldMDPSpecSignatureFormFieldInvisSigSettingsVisibleSigSettingsenumerate_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()NonexistentAttributeErrorMultivaluedAttributeErrorCertificateStoreSimpleCertificateStoreSigningErrorUnacceptableSignerErrorSignedDataCertsextract_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()CMSExtractionErrorbyte_range_digest()ValueErrorWithMessageCMSStructuralError
- 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
SignatureStatusTimestampSignatureStatusX509AttributeInfoCertifiedAttributeInfoClaimedAttributesCertifiedAttributesCAdESSignerAttributeAssertionsStandardCMSSignatureStatusSignatureCoverageLevelModificationInfoPdfSignatureStatusDocumentTimestampStatusRevocationDetailsSignerAttributeStatus
- pyhanko.sign.validation.utils module
- Direct members
- pyhanko.sign.ades package
Submodules
- pyhanko.config module
StdLogOutputLogConfigCLIConfigCLIConfig.validation_contextsCLIConfig.stamp_stylesCLIConfig.default_validation_contextCLIConfig.default_stamp_styleCLIConfig.time_toleranceCLIConfig.retroactive_revinfoCLIConfig.log_configCLIConfig.pemder_setupsCLIConfig.pkcs12_setupsCLIConfig.pkcs11_setupsCLIConfig.beid_module_pathCLIConfig.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()PKCS12SignatureConfigPemDerSignatureConfigTokenCriteriaPKCS11PinEntryModePKCS11SignatureConfigPKCS11SignatureConfig.module_pathPKCS11SignatureConfig.cert_labelPKCS11SignatureConfig.cert_idPKCS11SignatureConfig.signing_certificatePKCS11SignatureConfig.token_criteriaPKCS11SignatureConfig.other_certsPKCS11SignatureConfig.key_labelPKCS11SignatureConfig.key_idPKCS11SignatureConfig.slot_noPKCS11SignatureConfig.user_pinPKCS11SignatureConfig.prompt_pinPKCS11SignatureConfig.other_certs_to_pullPKCS11SignatureConfig.bulk_fetchPKCS11SignatureConfig.prefer_pssPKCS11SignatureConfig.raw_mechanismPKCS11SignatureConfig.check_config_keys()PKCS11SignatureConfig.process_entries()
parse_cli_config()process_config_dict()
- pyhanko.stamp module