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
ACTargetDescription
ValidationContext
ValidationContext.revinfo_manager
ValidationContext.revinfo_policy
ValidationContext.retroactive_revinfo
ValidationContext.time_tolerance
ValidationContext.moment
ValidationContext.best_signature_time
ValidationContext.fetching_allowed
ValidationContext.crls
ValidationContext.ocsps
ValidationContext.soft_fail_exceptions
ValidationContext.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
ValidationDataHandlers
bootstrap_validation_data_handlers()
CertValidationPolicySpec
CertValidationPolicySpec.trust_manager
CertValidationPolicySpec.revinfo_policy
CertValidationPolicySpec.time_tolerance
CertValidationPolicySpec.acceptable_ac_targets
CertValidationPolicySpec.algorithm_usage_policy
CertValidationPolicySpec.pkix_validation_params
CertValidationPolicySpec.build_validation_context()
- pyhanko_certvalidator.errors module
PathError
PathBuildingError
CertificateFetchError
CRLValidationError
CRLNoMatchesError
CRLFetchError
CRLValidationIndeterminateError
OCSPValidationError
OCSPNoMatchesError
OCSPValidationIndeterminateError
OCSPFetchError
ValidationError
PathValidationError
RevokedError
InsufficientRevinfoError
InsufficientPOEError
ExpiredError
NotYetValidError
InvalidCertificateError
DisallowedAlgorithmError
InvalidAttrCertificateError
PSSParameterMismatch
DSAParametersUnavailable
- pyhanko_certvalidator.name_trees module
NameConstraintError
host_tree_contains()
uri_tree_contains()
dns_tree_contains()
email_tree_contains()
dirname_tree_contains()
GeneralNameType
GeneralNameType.OTHER_NAME
GeneralNameType.RFC822_NAME
GeneralNameType.DNS_NAME
GeneralNameType.X400_ADDRESS
GeneralNameType.DIRECTORY_NAME
GeneralNameType.EDI_PARTY_NAME
GeneralNameType.UNIFORM_RESOURCE_IDENTIFIER
GeneralNameType.IP_ADDRESS
GeneralNameType.REGISTERED_ID
GeneralNameType.check_membership
GeneralNameType.from_choice()
UnsupportedNameTypeError
NameSubtree
x509_names_to_subtrees()
process_general_subtrees()
NameConstraintValidationResult
PermittedSubtrees
ExcludedSubtrees
default_permitted_subtrees()
default_excluded_subtrees()
- pyhanko_certvalidator.path module
QualifiedPolicy
ValidationPath
ValidationPath.trust_anchor
ValidationPath.first
ValidationPath.leaf
ValidationPath.describe_leaf()
ValidationPath.get_ee_cert_safe()
ValidationPath.last
ValidationPath.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_len
ValidationPath.iter_certs()
- pyhanko_certvalidator.policy_decl module
RevocationCheckingRule
RevocationCheckingRule.CRL_REQUIRED
RevocationCheckingRule.OCSP_REQUIRED
RevocationCheckingRule.CRL_AND_OCSP_REQUIRED
RevocationCheckingRule.CRL_OR_OCSP_REQUIRED
RevocationCheckingRule.NO_CHECK
RevocationCheckingRule.CHECK_IF_DECLARED
RevocationCheckingRule.CHECK_IF_DECLARED_SOFT
RevocationCheckingRule.strict
RevocationCheckingRule.tolerant
RevocationCheckingRule.crl_mandatory
RevocationCheckingRule.crl_relevant
RevocationCheckingRule.ocsp_mandatory
RevocationCheckingRule.ocsp_relevant
RevocationCheckingPolicy
FreshnessReqType
CertRevTrustPolicy
PKIXValidationParams
PKIXValidationParams.user_initial_policy_set
PKIXValidationParams.initial_policy_mapping_inhibit
PKIXValidationParams.initial_explicit_policy
PKIXValidationParams.initial_any_policy_inhibit
PKIXValidationParams.initial_permitted_subtrees
PKIXValidationParams.initial_excluded_subtrees
PKIXValidationParams.merge()
AlgorithmUsageConstraint
AlgorithmUsagePolicy
DisallowWeakAlgorithmsPolicy
AcceptAllAlgorithms
DEFAULT_WEAK_HASH_ALGOS
REQUIRE_REVINFO
NO_REVOCATION
- pyhanko_certvalidator.policy_tree module
- pyhanko_certvalidator.registry module
- pyhanko_certvalidator.util module
- pyhanko_certvalidator.validate module
- pyhanko_certvalidator.version module
- Module contents
CertificateValidator
ValidationContext
ValidationContext.revinfo_manager
ValidationContext.revinfo_policy
ValidationContext.retroactive_revinfo
ValidationContext.time_tolerance
ValidationContext.moment
ValidationContext.best_signature_time
ValidationContext.fetching_allowed
ValidationContext.crls
ValidationContext.ocsps
ValidationContext.soft_fail_exceptions
ValidationContext.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
PKIXValidationParams
PKIXValidationParams.user_initial_policy_set
PKIXValidationParams.initial_policy_mapping_inhibit
PKIXValidationParams.initial_explicit_policy
PKIXValidationParams.initial_any_policy_inhibit
PKIXValidationParams.initial_permitted_subtrees
PKIXValidationParams.initial_excluded_subtrees
PKIXValidationParams.merge()
find_valid_path()