# Changelog

## securesystemslib v1.4.0

### Fixed

* HSMSigner: Fix usage with multi-byte keyids (#1107)

### Changed

* SigstoreSigner: Update to current sigstore-python API (#1035)
* Deprecate Python 3.9 support (#1069)
* Various testing changes -- note that AWS is currently not tested
  in CI (see #1104)

## securesystemslib v1.3.1

### Fixed
* AWSSigner: Don't send payload to AWS for signing, send hash only (#1026)
* Set Development status classifier to "production/stable" in Python
  packaging (#1030)

### Internals
* Minor infrastructure changes (#1005, #1013)

## securesystemslib v1.3.0

The `hash` module will be removed in the next major version. Consider using
`hashlib` from the standard library directly instead.

### Added
* Annotate library (#970)

### Changed
* Deprecate hash module (#977)
* Modernize license metadata (#942)

### Internals
* Refactor signing scheme parsing (#981)
* Misc test and ci/cd improvements (#926, #953, #958, #965, #966)

## securesystemslib v1.2.0

Small release with mostly internal changes.

Thanks to @L77H and @NicholasTanz for the bulk of the work on this release.

### Added
* ecdsa-sha2-nistp521 supported in signer API (#852)
* SigstoreSigner now has a convenience function for creating a signing
  identity for GitHub Actions workflow (#842)

### Internals
* Linting refactoring, switched to ruff
* Modern annotations used in most of the code base

## securesystemslib v1.1.0

This is a small release that only re-enables the use of SigstoreSigner.
Note that SigstoreSigner and SigstoreKey are still not part of the default
set of supported signers & keys but now they can be enabled.

### Changed
* SigstoreSigner: Re-enable compatibility with Sigstore (#781)

## securesystemslib v1.0.0

Securesystemslib API is now considered stable. The core functionality is
provided in the _Signer_ interface and the half a dozen integrated _Signer_
implementations that can be found in the `signer` module. Smaller helper
modules `dsse`, `formats`, `hash` and `storage` are also part of the API.
Several legacy modules have been removed.

### Added
* Signer: add public_key attribute to interface (#756)
* VaultSigner: Signer implementation for HashiCorp Vault (#800)
* CryptoSigner: support ecdsa keytype that is no longer in spec (#711)
* CryptoSigner: add private_bytes property (#799)
* CryptoSigner: add `"file2"` signer uri (#759)
* test: use localstack to test AWSSigner (#777)

### Removed
* CryptoSigner: remove `"file"` signer uri (#759)
* migration script for legacy keys  (#770)
* `SSlibSigner` class and `*_securesystemslib_key` methods (#771)
* legacy key `key*`, `interface`, `util` and `schema` modules (#772, #773, #776)
* unused functions in `hash`, and `formats` module (#774, #776)
* unused global key constants (#806)

### Changed
* SSlibKey: strengthen input validation (#780, #795)
* AWSSigner: support default scheme and add stronger input validation (#724, #778)
* dsse: change Envelope.signatures type to dict (#743)
* vendor: update ed25519 copy (#793)
* docs: improve user and contributor docs (#744, #745, #746, #749, #759, #796)
* test: improve and temporarily disable SigstoreSigner test (#779, #785)
* ci: use dependabot groups, update weekly (#735)
* ci: test macOS and Windows on latest Python only (#797)
* Make securessystemslib.gpg internal (#792)

### Fixed
* Fix check-upstream-ed25519 workflow permission (#706)
* SSlibKey: fix default scheme and test for ecdsa nistp384 key (#763 #794)


## securesystemslib v0.31.0

### Added
* CryptoSigner: create from `cryptography` private key with new constructor (#675)
* SSlibKey: create from `cryptography` public key with new `from_crypto` method (#678)
* Release: auto-release with PyPI Trusted Publishing (#683)
* Docs to migrate legacy key files (#658)

### Removed
* Removed `SSlibKey.from_pem` factory method in favor of `from_crypto` (#678)

## securesystemslib v0.30.0

This release contains improved Sigstore support.

### Changed

* SigstoreSigner adapted to sigstore-python 2.0 API: This allows
  improved UX where a new signing identity can be defined using
  interactive credentials (browser login):
  `SigstoreSigner.import_via_auth()`
* Documentation improvements

### Removed

* Python 3.7 is no longer supported

## securesystemslib v0.29.0

This release is reaping the rewards of the new signer API with four(!) new
signing methods: Two cloud based KMSs, post-quantum crypto support and a
"keyless" signing system.

Advance notice to folks using the `keys`, `ecdsa_keys`, `rsa_keys` and
`ed25519_keys` modules: these modules are headed for deprecation. Please have
a look at the `signer` API and get in touch if the functionality you need
isn't there (or if more documentation is needed).

### Added
* Sigstore as a new experimental signing method (#552)
* SPHINCS+ as a new experimental signing method (#568)
* Azure Key Vault as a new signing method (#588)
* AWS KMS  as a new signing method (#609)
* `CryptoSigner` as a more featureful replacement for `SSLibSigner` (#604)
* Documentation that focuses on the signer API (#634, #622)

### Changed
* `SSLibSigner` has been deprecated: Please use `CryptoSigner` instead (#604)
* `keys` module is not used for signature verification in `signer` API (#585)
* Various minor fixes, please see git log for details

## securesystemslib v0.28.0

### Added
* Signer: auto-keyid helper (#557)
* Signer: de/serialization helpers (#558)
* Signer: tests (#555, #556)
* Sigstore Signer: import methods (#535)

### Changed
* HSMSigner: pre-hash data (#548)
* GCP Signer, HSM Signer: auto-keyid computation (#557)
* DSSE: serialize signature data as base64 for compliance (#565)

### Removed
* Obsolete shebangs (#544, #545)
* Outdated schemes: md5, sha1 (#554)

### Fixed
* Various test and CI fixes (#538, #541, #542, #543, #546)
* Minor SSlibKey.verify_signature error handling bug (#556)


## securesystemslib v0.27.0

### Added
* EXPERIMENTAL DSSE implementation (#487)
* EXPERIMENTAL sigstore signer and verifier (#522)
* Minimal TUF/in-toto spec-compliant GPG verifier (#488)
* API-typical 'import' and 'from URI' GPG signer methods (#488)

### Changed
* Require public key in GPG signer and disallow subkey signatures (#488)
* Increase GPG subprocess timeout (#502)
* Rename default branch to 'main' (#523)
* Make HSM signer URI configurable (#526)
* Allow tox to skip virtual HSM tests (#528)
* Strip PEM keys to compute keyids consistently (#453)

### Removed
* Internal GPG version utils (#504)
* Custom subprocess interface (#505)
* Vendored ssl module (#506)

### Fixed
* Windows compatibility issues and re-enable Windows CI (#518)
* GPG subprocess timeout configurability (#502)


## securesystemslib v0.26.0

### Added
* Private key URI schemes for signer instantiation (#456)
* Public key container class for signature verification (#456)
* Post-quantum sphincs+ signing scheme (#427)
* Hardware Security Module (HSM) signing (#472)
* Google Cloud KMS signing (#442, #480)

### Changed
* Use pyproject.toml for build configuration (#253)
* Use hatchling as build backend (#484)
* Auto-format and lint all code (#439, #490)
* Various CI and build improvements (#459, #460, #476, #493, #464)

### Removed
* Drop colorama optional dependency and colorized output support (#443)

### Fixed
* Don't shell out to gpg on import (#437)
* Fix metaclass definition (#473)
* Make GPGSigner signatures specification compliant (#486)


## securesystemslib v0.25.0

### Changed
* Do not use max salt lengths in RSA PSS signature creation (#436)
* Restrict read and write access for new private keys (#231)
* Replaced deprecated `distutils.version.StrictVersion` (#433)
* Bumped dependencies: cryptography (#435)

### Fixed
* GPG availability check in tests (#434)


## securesystemslib v0.24.0

### Added
* GPGSigner to support gpg signing via Signer interface (#341, #419)

### Changed
* Use max salt lengths in RSA PSS signature creation & automatically verify previous/new
  sigs (#422)
* Speed up canonical json encoding (#410)
* Bumped dependencies: cffi (#415), colorama (#413), cryptography (#405, #406, #414,
  #417, #424, #425), ed25519 (#412)
* Changed Debian packaging metadata (#392)

### Fixed
* Minor test fixes (#403, #420)


## securesystemslib v0.23.0

### Fixed
* Race condition in gpg test cleanup function (#397)

### Changed
* Consistently raise custom `FormatError` in `keys.verify_signature()` (#391)
* Bumped dependencies: cryptography (#396), ed25519 (#394, #398)
* Updated Debian packaging metadata (#392)


## securesystemslib v0.22.0

### Fixed
* Removed broken Dependabot badge in README (#377)

### Added
* Python 3.10 support (#380)
* `__eq__` method for Signature objects (#383)
* `unrecognized_fields` attribute for Signature objects (#387)

### Changed
* Bumped dependencies: cffi (#373), cryptography (#376, #379), ed25519 (#378,
  #390), pycparser (#375), pynacl (#382)
* Misc docstring improvements (#380, #381, #384)

### Removed
- Python 3.6 support (#385)


## securesystemslib v0.21.0
**NOTE**: This is the first release of securesystemslib to require Python 3.6
or newer.

### Fixed
* Clarified licensing and copyright notices with regards to code that is
  derived from Thandy (#366)

### Added
* Added machinery for static type checking with mypy, including type annotation
  of the util module (#361)
* Added type annotations to storage module (#362)

### Changed
* Bumped dependencies: six (#350), cffi (#364), ed25519 (#356),
  cryptography (#369)

### Removed
* Removed support for Python 2.7 (#352) and the use of future and six modules
  which were required to support code running on both Python 2 and 3 (#359)

## securesystemslib v0.20.1
**NOTE**: this will be the final release of securesystemslib that supports
Python 2.7.
This is because Python 2.7 was marked [end-of-life](
https://www.python.org/dev/peps/pep-0373/) in January of 2020, and
since then several of securesystemslib's direct and transitive dependencies
have stopped supporting Python 2.7. securesystemslib's major users, the Python
implementations of tuf (v0.167.0) and in-toto (v1.1.0), have already dropped
support for Python 2.7.

### Changed
* Switched to GitHub-native Dependabot (#349)
* Updated Debian packaging metadata (#343)
* Bump cryptography dependency (#346)

### Fixed
* Fix the Signer abstract base class's method signature to include self (#348)

## securesystemslib v0.20.0

### Added
* Add signing abstraction to facilitate custom implementations (#319)

### Changed
* Refactor imports to allow vendoring for pip (#316)
* Limit GitHub Actions to avoid duplicate Dependabot builds (#335)
* Enhance GitHub Action reporting for ed25519 upstream check (#338)
* Bump dependencies: cryptography (#336)

### Fixed
* Pad OpenPGP EdDSA signatures to avoid sporadic verification failures (#340)

## securesystemslib v0.19.0

### Added
* Enable setting which GPG client to use through an environment variable (#315)

### Changed
* Dropped support for EOL Python 3.5 and add support for Python 3.9 (#314)
* Converted the default local storage backend, FilesystemBackend, to be a
  singleton (#302)
* Migrated CI from travis-ci.org to travis-ci.com (#303) then later to GitHub
  Actions (#324)
* Bump dependencies: cffi (#306, #329), cryptography (#322, #333). NOTE: the
  latest version of cryptography is no longer used on Python 2, as that is not
  supported.
* Updated Debian packaging metadata (#313 & #318)
* Improved messaging for issues automatically filed on upstream changes to our
  vendored ed25519 dependency (#317)
* Updated the ed25519 tracking script for upstream's branch name change (#331)

### Fixed
* Empty lists should not be used as the default argument for a function (#304)

## securesystemslib v0.18.0

### Added
* `interface.generate_and_write_unencrypted_{rsa,ed25519,ecdsa}_keypair` (#288)
* `interface.generate_and_write_{rsa,ed25519,ecdsa}_keypair_with_prompt` (#288)
* `interface.import_privatekey_from_file`(#288)
* GitHub Action to auto-check upstream changes for vendored ed25519 (#294)

### Changed
* `interface.generate_and_write_{rsa,ed25519,ecdsa}_keypair` require a password
  as first positional argument (#288)
* `interface.import_{rsa,ed25519,ecdsa}_privatekey_from_file` do not error on
  empty password, but pass it on to lower level decryption routines (#288)
* `interface.import_ecdsa_privatekey_from_file` supports loading unencrypted
  private keys (#288)
* Revise `interface` and `gpg.functions` docstrings, and example snippets, and
  use Sphinx compatible Google Style docstring format (#288, #300)
* Linter-flagged cosmetic changes (#292, #295, #296)
* Bump dependencies: cryptography (#291, #293)
* Bump vendor copy of ed25519 (#299)

## securesystemslib v0.17.0

### Added
* Add `interface.import_publickeys_from_file()` convenience function (#278, #285)
* Add `gpg.export_pubkeys()` convenience function (#277)
* Add support to `hash` module for blake2b-256 algorithm (#283)

### Changed
* Use ecdsa as keytype for ECDSA keys to better distinguish between keytype
  and scheme (#267)
* Bump dependencies: cffi (#266, #273), cryptography (#269, #274),
  and colorama (#284)
* Removed python-dateutil dependency (#268)
* Prepare Debian downstream releases (#198)
* Remove unused helper (`_prompt`) and global (`SUPPORTED_KEY_TYPES`) from
  interface module (#276)
* Refactored and extended interface tests (#279, #287)

## securesystemslib v0.16.0

### Added
* Added new, self-explanatory, AnyNonEmptyString schema (#244)
* Separate functions for getting a file's length, `util.get_file_length()`, and
  a file's hashes, `util.get_file_hashes()`  (#259)

### Changed
* Improved documentation for abstract storage interface (#240)
* Change PATHS_SCHEMA to be any non-empty string (#244)
* Updated `keys.format_metadata_to_key()` to take an optional list of hashing
  algorithms rather than requiring users modify `settings.HASH_ALGORITHMS` to
  change this behaviour (#227)
* Rather than silently ignoring empty paths, throw an exception on empty file
  path in `storage.FileSystemBackend.create_folder` (#252)

### Fixed
* Proper tearing down of storage tests (#249)
* Handle empty directories in `util.ensure_parent_dir()` (#260)
* Fix tests to work with newer versions (3.0 or newer) of the cryptography
  module (#264)

## securesystemslib v0.15.0

* Allow Blake (blake2s and blake2b) hashing algorithms (#218)
* *new features*
  * Add nistp384 signature verification support (#228)
  * Allow callers to provide a default keyid in format_metadata_to_key, rather
    than using the default keyid value of a hash of the canonical JSON of the
	key metadata (#225)
  * Implement files and directories abstraction as an abstract base class;
    StorageBackendInterface, with a concrete implementation for local
	filesystems; FilesystemBackend  (#232). This enables users, such as tuf,
	to support non-local/non-traditional filesystems, so long as they provide
	an object implementing securesystemslib.storage.StorageBackendInterface.
	All functions which take a StorageBackendInterface default to creating a
	FilesystemBackend object for local filesystem interaction when an object
	isn't provided. This means that behaviour remains the same as in prior
	(0.14.x) releases of securesystemslib, only instead of throwing exceptions
	from the Python standard library a custom, generic, error is thrown:
	securesystemslib.exceptions.StorageError
* *removed features*
  * Remove support for gzipped files in load_json_file (#230)

## securesystemslib v0.14.2

* Re-enable OpenPGP signature verification without GnuPG (#215)

## securesystemslib v0.14.1

* Improve logging (#212, #211)
* Fix dependency monitoring and revise requirements files (#209)
* Further improve optional dependency handling (#206)
* Update release metadata (#205)

## securesystemslib v0.14.0

* *behavior change*
  * Default to pure Python ed25519 signature verification when nacl is unavailable (#200)
  * Fix settings.SUBPROCESS_TIMEOUT access in process module (#202)
* Improve schema-related error message (#199)
* Generally improve optional dependency handling (#200)
* Enhance test configuration, fix typos and remove unused code (#201)
* Fix improper identity check (#203)

## securesystemslib v0.13.1

* Fix MANIFEST.in to include all test data in source release (#196)

## securesystemslib v0.13.0

* Add support for *OpenPGP* EdDSA/ed25519 keys and signatures (#188)
bump
## securesystemslib v0.12.2

* Remove unnecessary `python-dateutil==2.8.0` version pinning to not cause
  downstream dependency conflicts (#192)

## securesystemslib v0.12.1

* Fix stream duplication race conditions in subprocess interface (#186)

## securesystemslib v0.12.0

* *backwards incompatible*
  * Remove data serialization in `create_signature` and `verify_signature` (#162)
  * Replace mostly obsolete `TempFile` utility with single helper function (#181)
  * Remove *TUF*-specific code and comments (#165)
* *new features*
  * Add support for *pkcs1v15* RSA signature scheme and additional hash algorithms (#173, #175)
  * Add basic *OpenPGP* support, transferred from [in-toto](https://github.com/in-toto/in-toto) (#174, #176, #185)
* *miscellaneous*
  * Fix publishing of code coverage  and enhance test configuration (#171)
  * Make colorama a strict dependency (#178)
  * Enhance source distribution metadata (#168)
  * Update downstream Debian metadata (#177)

## securesystemslib v0.11.3

* Provide option to normalize line endings (`\r\n` -> `\n`, `\r` -> `\n`) when
calculating the hash of a file (default: do not normalize).
* Update developer dependencies (dev-requirements.txt):
  * cryptography 2.2.2 to 2.3.1
  * tox 3.0.0 to 3.2.1

## securesystemslib v0.11.2

* No (en|de)cryption of ed25519 key files when given empty password (pr #148).

* Support ed25519 crypto in pure python with default installation (pr #149).

* Update installation instructions to indicate commands needed to install
  optional dependencies for RSA and ECDSA support (pr #150).

* Edit setup.py's license classifier to `OSI LIcense :: MIT` (pr #151).

## securesystemslib v0.11.1

* Convert `\r\n` newline characters to `\n`, so that the same KEYID is
  generated for key data regardless of the newline style used (pr #146).

## securesystemslib v0.11.0

* Add `prompt` parameter to interface.import_rsa_privatekey_from_file() (pr #124).

* Update dependencies

## securesystemslib v0.10.11

* Replace deprecated `cryptography` methods.  signer() and verifier()
  should be replaced with sign() and verify(), respectively.

* Update dependencies.

## securesystemslib v0.10.10

* Add get_password() to API.

* Enable password confirmation in all `generate_and_write_XXX_keypair()`
  functions.

* Minor:
  Fix broken link in comment (recommended # of bits for RSA keys).
  Add `TEXT_SCHEMA`.
  Remove obsolete function (check_crypto_libaries) from `.coveragerc`.

## securesystemslib v0.10.9

* Add `debian` directory (and files) that can be used to package a .deb file.

* Modify functions that generate or import keys so that the key file's path is
  shown if the function prompts for a password.

* Add colorama dependency.  It is used to colorize some of the prompts.

* Update dependencies to their latest version.

* Support KEYID filenames for generated key files.  KEYID filenames are used
  if a filename is not specified.

* Minor edits to comments, indentation, whitespace, etc.

* Modify generate_rsa_key() so that leading and trailing newline characters
  are stripped before generating the KEYID.  This is done so that the
  KEYID generated from imported keys match. Imported PEM keys are
  stripped of any leading and trailing newline characters before the KEYID is
  generated.

## securesystemslib v0.10.8

* Drop support for Python 2.6 and 3.3

* Add support for Python 3.6

* Fix bug in PEM parser. See https://github.com/secure-systems-lab/securesystemslib/issues/54

* Drop PyCrypto and multiple-library support

* Update dependencies

* Verify that the arguments to verify_signature() have matching KEYIDs

* Add a changelog file (this one :)

## securesystemslib v0.10.7
@vladimir-v-diaz vladimir-v-diaz released this on Aug 23 · 79 commits to master since this release

* Implement TAP 9

## securesystemslib v0.10.6
@vladimir-v-diaz vladimir-v-diaz released this on Jul 17 · 127 commits to master since this release

* Fix bug in _get_keyid(), where the hash_algorithm argument to _get_keyid()
was not correctly being used.

## securesystemslib v0.10.5
@vladimir-v-diaz vladimir-v-diaz released this on Jun 14 · 130 commits to master since this release

* Bump cryptography dependency to v1.9.0

* Fix backwards-incompatible change introduced by v1.9.0 of cryptography
(dependency)

## securesystemslib v0.10.4
@vladimir-v-diaz vladimir-v-diaz released this on Jan 23 · 146 commits to master since this release

* Add PUBLIC_KEY_SCHEMA and PUBLIC_KEYVAL_SCHEMA

* Remove ssl_crypto/ssl_commons relics in docstrings

## securesystemslib v0.10.3
@vladimir-v-diaz vladimir-v-diaz released this on Jan 19 · 152 commits to master since this release

* Initial pre-release
