Skip to content

CHANGELOG.md

Latest commit

 

History

History
154 lines (132 loc) · 6.76 KB

CHANGELOG.md

File metadata and controls

154 lines (132 loc) · 6.76 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

3.0.0-rc1 - 2025-07-18

Fixed

  • Restore environment when exiting FAPIConfig
  • Fix ESAPI.hierarchy_control support for PLATFORM_NV hierarchy
  • Fix FAPI callback buffer lifetimes (fixes issues on free-threaded python)
  • Fix ECC seed length calculation in __ecc_secret_to_seed
  • Fix memory leak in FAPI

Added

  • Add a context manager for ESYS handles, which flushes the handle at exit.
  • Add SVN, ACT and other missing constants.
  • Add the ESAPI command certify_x509.
  • Add the ESAPI command act_set_timeout.
  • Add copy dunder for cryptography private keys.
  • Add the ESAPI command trsess_get_attributes.
  • Add signature scheme structures.
  • Add marshal/unmarshal structures for TPM2_HANDLE.
  • Add the command_parser module, which can decode TPM 2.0 command/response byte streams.
  • Add support for passing prehashed data to TPMT_SIGNATURE.verify_signature.
  • Add the marshal/unmarshal methods to union types, as they require a selector.
  • Add the equal dunder to struct types, allowing comparing two different instances of the same type.
  • Add support for python 3.14

Changed

  • Make the symmetric argument to start_auth_session optional.
  • Accept None for the pcr_digest argument for policy_pcr.
  • Support looking up EK templates by other names, such as L-1 or H-2.
  • Make the validition ticket for the sign command optional, defaults to a NULL ticket.
  • The argument order for ESAPI.policy_signed, ESAPI.policy_ticket and ESAPI.policy_authorize has changed. This is to make expiration, nonce_tpm, policy_ref and cp_hash_a arguments optional, with expiration being set to the max value and the rest are empty buffers by default.
  • Drop asn1crypto and use the new ASN.1 serializer/deserializer in cryptography

Removed

  • Remove support for the tools encoder/decoder.
  • Drop support for python 3.9

2.3.0 - 2024-06-26

Fixed

  • Fix builds for tpm2-tss > 4.0.1.
  • Support newer releases of the cryptography package.

Added

  • Add module to use TPM keys with the cryptography package.
  • Support for exists_ok for FAPI.create_nv, behaves the same as for FAPI.create_key.

Changed

  • Support for the tpm2-tools encoder/decoder will be removed in the future and a warning has been added.

2.2.1 - 2024-01-07

Fixed

  • Fix tests pcr_set_auth_value and pcr_set_auth_policy tests when running against libtpms-based simulators.
  • Fix integration with cryptography >= 42.0.1

2.2.0 - 2023-11-30

Fixed

  • Fix pycparse error for __float128.
  • Fix check on ESYS_TR in policy_secret.
  • Fix readthedocs builds.
  • Fix hardcoded sizes in the policy module.

Added

  • Add routine for making ESYS_TR from parts.
  • Support unmarshal and marshal routines for constants.
  • Provide a better error message for missing symbols.
  • Add support for python 3.12.

Removed

  • Drop support for python 3.7.
  • Remove references to TPMS_ALGORITHM_DESCRIPTION.

2.1.0 - 2022-01-09

Fixed

  • using tpm2-pytss in unit tests within a mocked environment see #481.

Added

  • tpm2-tools like strings via parse for TPM2_SYM_DEF and TPM2_SYM_DEF_OBJECT structures.
  • support for algorithms strings in ESAPI start_auth_session.
  • utils: credential_to_tools and tools_to_credential to convert to and from tpm2-tools makecredential outputs.
  • TCTI: Add bindings to TCTISpiHelper.

2.0.0 - 2022-12-05

Fixed

  • Resolution of include directory search paths when building CFFI bindings.
  • Typo in pip package name in README.
  • Missing package pycparser dependency in setup.cfg.
  • Minimum version of tss2-esys as 2.4.0.
  • Reproducible documentation builds using SOURCE_DATE_EPOCH. See #376.
  • documentation issues, such as cross linking, indentation and style.
  • test/test_utils.py::TestUtils::test_make_credential_ecc_camellia when CAMELLIA is not supported.
  • Stop leaking tpm simulator references in test harness.
  • Limitation on 10 set policy callbacks, now has no hard limit, see #473

Added

  • Experimental bindings to the policy library tss2-policy. Require version 3.3+ of tpm2-tss to enable.
  • Support for Python 3.11.
  • Testing on CI for built wheel.
  • PyTCTI class for writing Python Native TCTIs.

Changed

  • TCTI get_poll_handles now returning PollData object instead of ffi.CData.
  • TCTI magic is now byte string eg b"\x1" of up to 8 bytes.

1.2.0 - 2022-06-14

Added

  • utils function to parse tpm2-tools PCR values as function: unmarshal_tools_pcr_values.
  • official python 3.10 support.
  • sm2 and sm4 tools like parsing support for TPMT_PUBLIC and TPM2B_PUBLIC structures.
  • tpm2-tools compatible YAML encoding and decoding of TPM structures

Removed

  • pkgconfig as runtime dependency
  • Official Python 3.6 support.
  • internal distutils usage.
  • sm3 and sm4 support IF the backing cryptography package supports it.

Fixed:

  • trsess_set_attributes attributes parameter should be a TPMA_SESSION or int, not just int.
  • setup.cfg install_requires requirement that cryptography be version 3.0 or greater.
  • Note in documentation incorrectly called None.
  • ability to build a wheel and run tests from directory root. Note code for package is now under src folder.

1.1.0 - 2022-03-29

Fixed

  • Spelling of "Enhanced" in CHANGELOG for 1.0.0 release.
  • Ensure that TPM2_GENERATED.VALUE is encoded the same way as other constants.
  • Add support to unmarshal simple TPM2B types (such as TPM2B_ATTEST and TPM2B_NAME) directly using the unmarshal method
  • utils: catch the ImportError as "e" enabling raising the exception later
  • types: add check in TPMS_CONTEXT.to_tools for session handles

Changed

  • Drop pkgconfig from runtime dependencies, thus no longer need dev packages of built bindings at runtime.
    • NOTE: Version information is cached, a change in the TSS libraries requires a rebuild of the bindings.

Added

  • Support session contexts from tpm2-tools as well as function to marshal context to tpm2-tools format.
  • Support two new encoding/decoding classes to go to/from hex or json representation of objects.
  • Support for creating EK from templates and optionally NV index based templates.
  • Binding to Esys_TR_GetTpmHandle as ESAPI method tr_get_tpm_handle.

[1.0.0] - 2022-01-24

Added

  • Bindings to the Enhanced System (ESAPI) API.
  • Bindings to the Feature (FAPI) API .
  • Bindings to Dynamic TCTI Loading (TCTILdr) API .
  • Bindings to Marshalling and Unmarshalling (MU) API.
  • Bindings to rc-decode.
  • tpm2-tools context file loading support.
  • TSS2 PEM format support. This file format is used in OpenSSL Engine and Provider projects.
  • Utility routines for: TPM Less Make Credential, sensitive wrapping and unwrapping (import and duplication helpers).