pyHanko

PyHanko is a tool for signing and stamping PDF files.

Contents:

• CLI user’s guide
  • Signing PDF files
    • Some background on PDF signatures
    • Creating signature fields
    • Creating simple signatures
    • Creating signatures with long lifetimes
    • Customising signature appearances
  • Validating PDF signatures
    • Basic use
    • Factors in play when validating a signature
  • Stamping PDF files
  • Configuration options
    • Config file location
    • Configuration options
• Library (SDK) user’s guide
  • Reading and writing PDF files
    • Reading files
    • Modifying files
  • Signature fields
    • General API design
    • Positioning
    • Seed value settings
    • Document modification policy settings
  • Signing functionality
    • General API design
    • A simple example
    • Signature appearance generation
    • Timestamp handling
    • Creating PAdES signatures
    • Using aiohttp for network I/O
    • Extending Signer
    • The low-level PdfCMSEmbedder API
    • Interrupted signing
    • Generic data signing
  • Validation functionality
    • General API design
    • Accessing signatures in a document
    • Validating a PDF signature
    • Long-term verifiability checking
    • Incremental update analysis
    • Probing different aspects of the validity of a signature
  • The pdf-utils package
    • Background and future perspectives
    • PDF object model
    • PDF content abstractions
  • Developing CLI plugins
    • General principles
    • The plugin API
    • Plugin discovery and registration
  • Advanced examples
    • A custom Signer to use AWS KMS asynchronously
• API reference
  • pyhanko package
    • Subpackages
    • Submodules
    • pyhanko.keys module
    • pyhanko.stamp module
    • pyhanko.version module
  • pyhanko_certvalidator package
    • Subpackages
    • Submodules
    • pyhanko_certvalidator.asn1_types module
    • pyhanko_certvalidator.authority module
    • pyhanko_certvalidator.context module
    • pyhanko_certvalidator.errors module
    • pyhanko_certvalidator.name_trees module
    • pyhanko_certvalidator.path module
    • pyhanko_certvalidator.policy_decl module
    • pyhanko_certvalidator.policy_tree module
    • pyhanko_certvalidator.registry module
    • pyhanko_certvalidator.util module
    • pyhanko_certvalidator.validate module
    • pyhanko_certvalidator.version module
    • Module contents
• Release history
  • 0.20.1
    • Dependency changes
    • Miscellaneous
  • 0.20.0
    • Dependency changes
    • Miscellaneous
  • 0.19.0
    • Dependency changes
    • Breaking changes
    • New features and enhancements
    • Bugs fixed
  • 0.18.1
    • Dependency changes
  • 0.18.0
    • Note
    • Breaking changes
    • Organisational changes
    • Dependency changes
    • Bugs fixed
    • New features and enhancements
  • 0.17.2
    • Note
    • Bugs fixed
  • 0.17.1
    • Note
    • Bugs fixed
  • 0.17.0
    • Note
    • Dependency updates
    • Breaking changes
    • New features and enhancements
  • 0.16.0
    • Dependency updates
    • Breaking changes
    • New features and enhancements
    • Bugs fixed
  • 0.15.1
    • Note
    • Dependency updates
    • Bugs fixed
  • 0.15.0
    • Note
    • Bugs fixed
    • New features and enhancements
  • 0.14.0
    • Note
    • Breaking changes
    • Dependency updates
    • Bugs fixed
    • New features and enhancements
  • 0.13.2
    • Note
    • Dependency updates
    • Bugs fixed
  • 0.13.1
    • Note
    • Dependency updates
  • 0.13.0
    • Note
    • Dependency updates
    • Bugs fixed
    • New features and enhancements
  • 0.12.1
    • Dependency updates
    • Bugs fixed
  • 0.12.0
    • Note
    • New features and enhancements
    • Bugs fixed
  • 0.11.0
    • Dependency changes
    • Breaking changes
    • New features and enhancements
    • Bugs fixed
  • 0.10.0
    • Dependency changes
    • New features and enhancements
    • Bugs fixed
  • 0.9.0
    • Dependency changes
    • API-breaking changes
    • New features and enhancements
    • Bugs fixed
  • 0.8.0
    • Dependency changes
    • API-breaking changes
    • New features and enhancements
    • Bugs fixed
  • 0.7.0
    • Dependency changes
    • API-breaking changes
    • New features and enhancements
    • Bugs fixed
  • 0.6.1
    • Dependency changes
    • Bugs fixed
  • 0.6.0
    • Dependency changes
    • New features and enhancements
    • Bugs fixed
  • 0.5.1
    • Bugs fixed
  • 0.5.0
    • Dependency changes
    • New features and enhancements
    • Bugs fixed
  • 0.4.0
    • New features and enhancements
    • Bugs fixed
  • 0.3.0
    • New features and enhancements
    • Bugs fixed
  • 0.2.0
    • New features and enhancements
    • Bugs fixed
  • 0.1.0
• Frequently asked questions (FAQ)
  • Errors and other unexpected behaviour
    • I’m getting an error about hybrid reference files when trying to sign / validate a file. What gives?
    • Why am I getting path building errors?
  • Features & customisation
    • How do I use pyHanko to sign PDFs with a remote signing service?
    • I can’t get pyHanko to work with <insert PKCS#11 device here>. Can you help me?
    • I want to put Unicode text in my signatures, but I’m only seeing blanks. What gives?
• Known issues
• Release artifact authenticity
  • Overview
  • PGP signatures
    • Scope
    • Verifying PGP signatures using GnuPG
  • Sigstore signatures
    • Scope
    • Verifying Sigstore signatures issued through GitHub Actions OIDC
  • SLSA provenance data
    • Scope
    • Verifying SLSA provenance data on release builds
• Licenses
  • pyHanko License
  • Original PyPDF2 license

Indices and tables

• Index

• Module Index

• Search Page