API reference
This is the API reference for pyHanko, compiled from the docstrings present in the Python source files. For a more high-level overview, see the library user guide. If you are interested in using pyHanko as a command-line application, please refer to the CLI user guide.
Warning
Any function, class or method that is not covered by this documentation is considered private API by definition.
Until pyHanko goes into beta, any part of the API is subject to change without notice, but this applies doubly to the undocumented parts. Tread with caution.
- pyhanko package
- Subpackages
- pyhanko.config package
- pyhanko.cli package
- pyhanko.pdf_utils package
- Subpackages
- Submodules
- pyhanko.pdf_utils.barcodes module
- pyhanko.pdf_utils.content module
- pyhanko.pdf_utils.embed module
- pyhanko.pdf_utils.extensions module
- pyhanko.pdf_utils.filters module
- pyhanko.pdf_utils.generic module
- pyhanko.pdf_utils.images module
- pyhanko.pdf_utils.incremental_writer module
- pyhanko.pdf_utils.layout module
- pyhanko.pdf_utils.misc module
- pyhanko.pdf_utils.qr module
- pyhanko.pdf_utils.reader module
- pyhanko.pdf_utils.rw_common module
- pyhanko.pdf_utils.text module
- pyhanko.pdf_utils.writer module
- pyhanko.pdf_utils.xref module
- Module contents
- pyhanko.sign package
- Submodules
- pyhanko.keys module
- pyhanko.stamp module
- pyhanko.version module
- Subpackages
- pyhanko_certvalidator package
- Subpackages
- Submodules
- pyhanko_certvalidator.asn1_types module
- pyhanko_certvalidator.authority module
- pyhanko_certvalidator.context module
ACTargetDescriptionValidationContextValidationContext.revinfo_managerValidationContext.revinfo_policyValidationContext.retroactive_revinfoValidationContext.time_toleranceValidationContext.momentValidationContext.best_signature_timeValidationContext.fetching_allowedValidationContext.crlsValidationContext.ocspsValidationContext.soft_fail_exceptionsValidationContext.is_whitelisted()ValidationContext.async_retrieve_crls()ValidationContext.retrieve_crls()ValidationContext.async_retrieve_ocsps()ValidationContext.retrieve_ocsps()ValidationContext.record_validation()ValidationContext.check_validation()ValidationContext.clear_validation()ValidationContext.acceptable_ac_targets
ValidationDataHandlersbootstrap_validation_data_handlers()CertValidationPolicySpecCertValidationPolicySpec.trust_managerCertValidationPolicySpec.revinfo_policyCertValidationPolicySpec.time_toleranceCertValidationPolicySpec.acceptable_ac_targetsCertValidationPolicySpec.algorithm_usage_policyCertValidationPolicySpec.pkix_validation_paramsCertValidationPolicySpec.build_validation_context()
- pyhanko_certvalidator.errors module
PathErrorPathBuildingErrorCertificateFetchErrorCRLValidationErrorCRLNoMatchesErrorCRLFetchErrorCRLValidationIndeterminateErrorOCSPValidationErrorOCSPNoMatchesErrorOCSPValidationIndeterminateErrorOCSPFetchErrorValidationErrorPathValidationErrorRevokedErrorInsufficientRevinfoErrorStaleRevinfoErrorInsufficientPOEErrorExpiredErrorNotYetValidErrorInvalidCertificateErrorDisallowedAlgorithmErrorInvalidAttrCertificateErrorPSSParameterMismatchDSAParametersUnavailable
- pyhanko_certvalidator.name_trees module
NameConstraintErrorhost_tree_contains()uri_tree_contains()dns_tree_contains()email_tree_contains()dirname_tree_contains()GeneralNameTypeGeneralNameType.OTHER_NAMEGeneralNameType.RFC822_NAMEGeneralNameType.DNS_NAMEGeneralNameType.X400_ADDRESSGeneralNameType.DIRECTORY_NAMEGeneralNameType.EDI_PARTY_NAMEGeneralNameType.UNIFORM_RESOURCE_IDENTIFIERGeneralNameType.IP_ADDRESSGeneralNameType.REGISTERED_IDGeneralNameType.check_membershipGeneralNameType.from_choice()
UnsupportedNameTypeErrorNameSubtreex509_names_to_subtrees()process_general_subtrees()NameConstraintValidationResultPermittedSubtreesExcludedSubtreesdefault_permitted_subtrees()default_excluded_subtrees()
- pyhanko_certvalidator.path module
QualifiedPolicyValidationPathValidationPath.trust_anchorValidationPath.firstValidationPath.leafValidationPath.describe_leaf()ValidationPath.get_ee_cert_safe()ValidationPath.lastValidationPath.iter_authorities()ValidationPath.find_issuing_authority()ValidationPath.truncate_to_and_append()ValidationPath.truncate_to_issuer_and_append()ValidationPath.copy_and_append()ValidationPath.copy_and_drop_leaf()ValidationPath.qualified_policies()ValidationPath.aa_attr_in_scope()ValidationPath.pkix_lenValidationPath.iter_certs()
- pyhanko_certvalidator.policy_decl module
RevocationCheckingRuleRevocationCheckingRule.CRL_REQUIREDRevocationCheckingRule.OCSP_REQUIREDRevocationCheckingRule.CRL_AND_OCSP_REQUIREDRevocationCheckingRule.CRL_OR_OCSP_REQUIREDRevocationCheckingRule.NO_CHECKRevocationCheckingRule.CHECK_IF_DECLAREDRevocationCheckingRule.CHECK_IF_DECLARED_SOFTRevocationCheckingRule.strictRevocationCheckingRule.tolerantRevocationCheckingRule.crl_mandatoryRevocationCheckingRule.crl_relevantRevocationCheckingRule.ocsp_mandatoryRevocationCheckingRule.ocsp_relevant
RevocationCheckingPolicyFreshnessReqTypeCertRevTrustPolicyPKIXValidationParamsPKIXValidationParams.user_initial_policy_setPKIXValidationParams.initial_policy_mapping_inhibitPKIXValidationParams.initial_explicit_policyPKIXValidationParams.initial_any_policy_inhibitPKIXValidationParams.initial_permitted_subtreesPKIXValidationParams.initial_excluded_subtreesPKIXValidationParams.merge()
AlgorithmUsageConstraintAlgorithmUsagePolicyDisallowWeakAlgorithmsPolicyAcceptAllAlgorithmsNonRevokedStatusAssertionDEFAULT_WEAK_HASH_ALGOSREQUIRE_REVINFONO_REVOCATION
- pyhanko_certvalidator.policy_tree module
- pyhanko_certvalidator.registry module
- pyhanko_certvalidator.util module
- pyhanko_certvalidator.validate module
- pyhanko_certvalidator.version module
- Module contents
CertificateValidatorValidationContextValidationContext.revinfo_managerValidationContext.revinfo_policyValidationContext.retroactive_revinfoValidationContext.time_toleranceValidationContext.momentValidationContext.best_signature_timeValidationContext.fetching_allowedValidationContext.crlsValidationContext.ocspsValidationContext.soft_fail_exceptionsValidationContext.is_whitelisted()ValidationContext.async_retrieve_crls()ValidationContext.retrieve_crls()ValidationContext.async_retrieve_ocsps()ValidationContext.retrieve_ocsps()ValidationContext.record_validation()ValidationContext.check_validation()ValidationContext.clear_validation()ValidationContext.acceptable_ac_targets
PKIXValidationParamsPKIXValidationParams.user_initial_policy_setPKIXValidationParams.initial_policy_mapping_inhibitPKIXValidationParams.initial_explicit_policyPKIXValidationParams.initial_any_policy_inhibitPKIXValidationParams.initial_permitted_subtreesPKIXValidationParams.initial_excluded_subtreesPKIXValidationParams.merge()
find_valid_path()