Skip to content

CHANGELOG.md

Latest commit

 

History

History
284 lines (179 loc) · 12.2 KB

CHANGELOG.md

File metadata and controls

284 lines (179 loc) · 12.2 KB
Raw

Changelog

Unreleased

All Changes

v3.0.0-rc.1 (2026-08-26)

Breaking Changes

  • Return FullClusterJoinData instead of ClusterJoinData from add_cluster_member (requires NetHSM v5)

Changes

  • Update for NetHSM v5:
    • Add State.FAILED variant
    • Update clustering functionality:
      • Add FullClusterJoinData, ClusterDiagnostics, ClusterLogItem, ClusterState and ClusterSnapshot classes
      • Change NetHSM.join_cluster to also accept FullClusterJoinData
      • Add force_new_cluster, get_cluster_diagnostics, promote_cluster_member functions to NetHSM
      • Add learner field to ClusterMember
    • Add support for key labels:
      • Add label argument to add_key, add_key_pem, generate_key, list_keys functions
      • Add NetHSM.set_key_label function
      • Add optional label field to Key
    • Add support for NTP configuration:
      • Add NtpConfig class
      • Add get_config_ntp, set_ntp_config functions to NetHSM

All Changes

v2.1.2 (2026-06-22)

Changes

  • Patch generated client to remove the python-dateutil dependency.

All Changes

v2.1.1 (2026-05-11)

Bugfixes

  • Fix endpoint path in NetHSM.set_cluster_ca_certificate

All Changes

v2.1.0 (2026-03-25)

Features

  • Add support for backup format v1.
  • Add support for clustering (requires NetHSM v4):
    • Add ClusterMember, InitialClusterMember and ClusterJoinData classes
    • Add add_cluster_member, list_cluster_members, set_cluster_member_urls, remove_cluster_member, join_cluster, get_cluster_ca_certificate, set_cluster_ca_certificate functions to NetHSM
  • Add support for IPv6 configuration (requires NetHSM v4):
    • Add Ipv6Config class
    • NetworkConfig: Add optional ipv6 field
    • NetHSM.set_network_config: Add optional ipv6 argument

Changes

  • Improve backup parsing speed
  • Use poetry as build backend

All Changes

v2.0.1 (2025-11-06)

  • Add support for unauthenticated shutdown.

All Changes

v2.0.0 (2025-10-15)

Breaking Changes

  • Remove KeyType.EC_P224
  • Change arguments for NetHSM.csr and NetHSM.key_csr:
    • Require common_name argument
    • Require using keywords for all arguments (except for key_id)

Features

  • Add new enum values (requires NetHSM v3.0):
    • KeyType: EC_P256K1, BrainpoolP256, BrainpoolP384, BrainpoolP512
    • KeyMechanism: BIP340_Signature
    • SignMode: BIP340
    • TlsKeyType: BrainpoolP256, BrainpoolP384, BrainpoolP512
  • Add support for dots, dashes and underscores in user and key IDs (requires NetHSM v3.0)
  • Add NetHSM.move_key function for changing key IDs (requires NetHSM v3.0)
  • Add optional subject_alt_names argument for NetHSM.csr and NetHSM.key_csr (requires NetHSM v3.0)
  • Add optional prefix argument for NetHSM.list_keys (requires NetHSM v3.0)
  • Always show the message returned by the NetHSM as part of the error message

All Changes

v1.4.1 (2025-06-05)

  • Relax urllib3 version requirement to >= 2, <3

All Changes

v1.4.0 (2025-04-25)

  • Add support for custom CA certificates

All Changes

v1.3.0 (2025-03-13)

Features

  • Add TPM attestation keys and platform configuration registers to SystemInfo (#128)

All Changes

v1.2.1 (2024-07-31)

Bugfixes

  • Fix authentication for partial restore, i.e. on an operational instance (#124)

All Changes

v1.2.0 (2024-07-16)

Features

  • Add support for namespaces (#110)

Bugfixes

  • Fix authentication for partial restore, i. e. on an operational instance (#120)

All Changes

v1.1.0 (2024-05-03)

Features

  • Support key import from PEM files (#99)
  • Add ignore_whitespace option to Base64.from_encoded (#108)

All Changes

v1.0.0 (2023-11-27)

This release defines the stable API for the SDK based on the NetHSM v1.0 release. It also improves the handling of base64-encoded data and simplifies the provision and restore methods.

Breaking Changes

  • Introduce custom type for Base64-encoded data by @robin-nitrokey (#104)

Other Changes

  • Make system time optional in provision and restore by @robin-nitrokey (#105)

All Changes

v0.5.0 (2023-11-23)

This release updates the API specification and improves the Python API.

Changes

  • NetHSM API changes
    • Adjust to /keys/{KeyID}/cert only one MIME type API change. by @q-nk (#60)
    • Incorporate API specification changes on /keys/{KeyID}/cert type. by @q-nk (#62)
    • Use generated client for set_key_certificate by @robin-nitrokey (#64)
    • Fix return type for get_key_certificate by @robin-nitrokey (#66)
    • Update OpenAPI generator and remove schema patches by @robin-nitrokey (#55)
    • Adjust system restore code to system restore multipart api by @q-nk (#73)
    • Pass old passphrase when setting unlock or backup passphrase by @robin-nitrokey (#72)
    • Update API spec by @robin-nitrokey (#98)
  • Python API refinements
    • Use lazy imports for generated client by @robin-nitrokey (#67)
    • Support different types of bytes input by @robin-nitrokey (#82)
    • Use enums instead of literals by @robin-nitrokey (#81)
    • Test enum completeness by @robin-nitrokey (#84)
    • Return dataclasses from get_info and encrypt by @robin-nitrokey (#85)
    • Mark helpers with underscore prefix by @robin-nitrokey (#87)
    • Refactor get_key and Key by @robin-nitrokey (#89)
    • Use dataclasses for add_key by @robin-nitrokey (#91)
    • Always use API version from API spec by @robin-nitrokey (#92)
    • Make authentication optional by @robin-nitrokey (#94)
    • Parse system time into datetime object by @robin-nitrokey (#95)
    • Fix type annotations for add_key by @robin-nitrokey (#101)

All Changes

v0.4.0 (2023-10-27)

This release updates the API specification and adds support for validating backup files.

Changes

  • Fix and extend typing checks
    • #35: fix: type error whith mime_type (@nponsard)
    • #42: Update OpenAPI client and extend mypy checks (@robin-nitrokey)
    • 44: Enable strict mypy checks for nethsm module (@robin-nitrokey)
  • Improve tests
    • #37: Allow a time delta in the time test (@q-nk)
    • #51: Extend backup/restore tests (@robin-nitrokey)
  • Adapt to API changes
    • #41: Removed double Content-Type workaround (@q-nk)
    • #43: Adjust API delete certificate error message & status code (@q-nk)
  • #47: Add certifi dependency (@robin-nitrokey)
  • #52: Add backup validation (@robin-nitrokey)

All Changes

v0.3.2 (2023-09-29)

This release fixes a warning if TLS verification is disabled.

Changes

  • fix: disable warnings when tls verification is disabled by @nponsard (#31)

All Changes

v0.3.1 (2023-09-29)

This release fixes the exception data.

Changes

  • fix: exception data by @nponsard (#30)

All Changes

v0.3.0 (2023-09-29)

This release improves the exception handling.

Changes

  • refactor: exception handling by @nponsard (#27)

All Changes

v0.2.0 (2023-09-28)

This release improves the documentation, removes an unused dependency and updates the API specification.

Changes

  • doc: document lib usage by @nponsard (#11)
  • fix: remove request dependency by @nponsard (#12)
  • feat: update api spec with format: binary by @nponsard (#19)
  • doc: document update() workaround by @nponsard (#20)

All Changes

v0.1.0 (2023-09-26)

Initial release.