Skip to content
v0.20.0
febe6c3
Compare
Choose a tag to compare

NOTE: This will be the final release of python-tuf that includes the legacy implementation code. Please see the 1.0.0 announcement page for more details about the next release and the deprecation of the legacy implementation, including migration instructions.

Added

Changed

  • ngclient: misc API changes (#1604, #1731)
  • ngclient: avoid re-loading verified targets metadata (#1593)
  • ngclient: implicitly call refresh() (#1654)
  • ngclient: return loaded metadata (#1680)
  • ngclient: skip visited nodes on delegation tree traversal (#1683)
  • ngclient: remove URL normalisation (#1686)
  • build: modernise packaging configuration (#1626)
  • build: bump dependencies (#1609, #1611, #1616, #1621)
  • build: limit GitHub Action token visibility and permissions (#1652, #1663)
  • test: misc test changes (#1715, #1670, #1671, #1631, #1695, #1702)

Removed

  • doc: obsolete roadmap (#1698)
@jku jku
v0.19.0
e86a615
Compare
Choose a tag to compare

For users of legacy client (tuf.client module) this is purely a security fix
release with no API or functionality changes. For ngclient (tuf.ngclient) and
Metadata API (tuf.api.metadata), some API changes are included.

All users are advised to upgrade.

Note that python-tuf has required python>=3.5 since release 0.18.0.

Fixed

  • GHSA-wjw6-2cqr-j4qr: Fix client side issue in both legacy client (tuf.client)
    and ngclient (tuf.ngclient) where a malicious repository could trick client
    to overwrite files outside the client metadata store during a metadata
    update. The fix includes percent-encoding the metadata rolename before using
    it as part of a filename
    GHSA-wjw6-2cqr-j4qr
  • ngclient: Do not use urljoin to form metadata URL (included in
    GHSA-wjw6-2cqr-j4qr)
  • ngclient: Persist metadata safely (#1574)
  • ngclient: Handle timeout on session.get() (#1588)

Added

  • build: Dependabot now monitors GitHub Actions (#1572)
  • tests: ngclient test improvements (#1564, #1569, #1587)
  • Metadata API: Add TargetFile.from_file() (#1521)

Changed

  • build: Bump dependency charset-normalizer (#1581, #1586)
  • build: Bump dependency urllib3 (#1589)
  • build: Bump dependency cryptography (#1596)
  • Metadata API: Documentation improvements (#1533, #1590)
  • Metadata API: change Timestamp meta API (#1446)
  • Metadata API: change Delegations roles API (#1537)
  • ngclient: Remove unnecessary sleep() (#1608)
  • ngclient: Fix consistent targets URL resolution (#1591)
  • ngclient: Don't use target path as local path (#1592)
v0.18.1
02d4f42
Compare
Choose a tag to compare

Note: The v0.18.0 release was made with the changes from #1566, resulting in
a release with sources which don't match the git tag. We are rectifying this
with this v0.18.1 release.

v0.18.1

Changed

  • Update setup.cfg to not build universal wheels (#1566)

v0.18.0

0.18 is a big release with 3 main themes:

  • Support only Python 3 and modernize the infrastructure accordingly
  • Metadata API (a low-level API for metadata de/serialization and
    modification) is now feature-complete for the client use cases
  • ngclient (a new high-level client API) was added. ngclient should be
    considered an unstable API and is not yet recommended for production
    use.

Additionally the Github project name changed: project is now "python-tuf"
instead of "tuf". Redirects are in place for the old name but updating links is
advised.

Added

Removed

  • Remove Python 2 support (#1293)
  • Remove direct dependency on six
  • Remove obsolete reference to Thandy in a LICENSE file (#1472)

Changed

  • Bump dependencies:
    • Certifi
    • Cryptography
    • Idna
    • Requests
    • Securesystemslib
    • Six
    • Urllib3
  • Replace indirect dependency chardet with charset-normalizer
  • Move Metadata API serialization to sub-package (#1279)
  • Use SecureSystemslib Signer interface in Metadata API (#1272)
  • Make imports compatible with vendoring (#1261)

Fixed

Please see https://github.com/theupdateframework/python-tuf/releases/tag/v0.18.0

v0.18.0
62195fd
Compare
Choose a tag to compare

0.18 is a big release with 3 main themes:

  • Support only Python 3 and modernize the infrastructure accordingly
  • Metadata API (a low-level API for metadata de/serialization and
    modification) is now feature-complete for the client use cases
  • ngclient (a new high-level client API) was added. ngclient should be
    considered an unstable API and is not yet recommended for production
    use.

Additionally the Github project name changed: project is now "python-tuf"
instead of "tuf". Redirects are in place for the old name but updating links is
advised.

Added

Removed

  • Remove Python 2 support (#1293)
  • Remove direct dependency on six
  • Remove obsolete reference to Thandy in a LICENSE file (#1472)

Changed

  • Bump dependencies:
    • Certifi
    • Cryptography
    • Idna
    • Requests
    • Securesystemslib
    • Six
    • Urllib3
  • Replace indirect dependency chardet with charset-normalizer
  • Move Metadata API serialization to sub-package (#1279)
  • Use SecureSystemslib Signer interface in Metadata API (#1272)
  • Make imports compatible with vendoring (#1261)

Fixed

v0.17.0
60875f9
Compare
Choose a tag to compare

NOTE: this will be the final release of tuf that supports Python 2.7.
This is because Python 2.7 was marked end-of-life in January of 2020, and
since then several of tuf's direct and transient dependencies have stopped
supporting Python 2.7.

Added

  • Added Architectural Decisions Records (ADRs) for:
    • where to develop python-tuf 1.0 (#1220)
    • to justify the extent of OOP in the metadata model (#1229)
    • to decide on a Python code style guide (#1232)

Changed

  • Switch to GitHub Actions for CI (#1242, #1283, #1252)
  • Switch to only running bandit on Python versions greater than 3.5 (#1234)
  • Bump dependencies: requests (#1245), chardet (#1239), urllib3 (#1268),
    cffi (#1280), securesystemslib (#1285), cryptography (#1282, #1286).
    NOTE: the latest version of cryptography is no longer used on
    Python 2, as that is not supported.
  • Moved from dependabot-preview to GitHub native Dependabot (#1258)
  • Configure dependabot to ignore idna, as it breaks Python 2.7 builds (#1259)
  • Install securesystemslib in tox in non-editable mode (#1228)
  • Change the editable venv installation order (#1271)

Fixed

  • Updated expiration check in Updater to better match the specification (#1235)
  • Ensure tempfile's are closed in Updater (#1226)
v0.16.0
2302f0d
Compare
Choose a tag to compare

Added

  • Begin to document architectural and project-wide decisions as Architectural
    Decision Records (ADRs) in docs/adr (#1182, #1203)
  • Add Python 3.9 to the CI test matrix (#1200)
  • Implement a class for Root metadata in the simple TUF role metadata model in
    tuf.api (#1193)

Changed

  • Bump dependencies: cryptography (#1189, #1190), requests (#1210),
    urllib (#1212), cffi (#1222), certifi (#1201), securesystemslib (#1191)
  • Simplify the test runner (aggregate_tests) and stop executing unit test
    modules in a random order (#1187)
  • Speed up indefinite freeze tests by removing sleep() calls (#1194)
  • Adapt to securesystemslib changes in key generation interfaces (#1191)
  • Migrate from travis-ci.org to travis-ci.com (#1208)
  • Make metadata signatures ordered by keyid, to ensure deterministic signature
    ordering in metadata files (#1217)
  • Improve test reliability by using thread-safe Queues, rather than files,
    for process communication (#1198)
  • Avoid reading an entire target file into memory when generating target file
    hashes in tuf.client.updater (#1219)
  • Remove use of an empty list ([]) as the default argument in a test
    function (#1216)
  • Simplified updater logic for downloading and verifying target files (#1202)

Fixed

  • Fix threshold computation in _verify_root_self_signed() such that
    signatures by the same root key count only once towards the threshold (#1218)
v0.15.0
3934152
Compare
Choose a tag to compare

Added

  • Simple TUF role metadata model in the tuf.api package for interacting with
    metadata files directly, per-file without the overheads of reading and
    writing the entire repository at once (#1112, #1177, #1183)
  • Raise MissingLocalRepositoryError in updater when local repository can not
    be found (#1173)
  • Tests for targets metadata generation with existing fileinfo (#1078)
  • Test-verbosity documentation (#1151)

Changed

  • Raise an error in tuf.client.updater when metadata is loaded without a
    signature (#1100)
  • Print a warning in tuf.repository_tool when metadata is written without a
    signature (#1100)
  • Remove iso8661 dependency (#1176)
  • Bump dependencies: cffi (#1146), cryptography (#1149), urllib (#1179),
    securesystemslib (#1183)
  • Overhauled logging to be less verbose and less alarming, by removing logging
    in the library when an exception is raised (including the same information
    that was logged) and using more appropriate log levels (#1145)
  • Make test output more useful by reducing and improving logging (#1145, #1104, #1170)
  • Make the targets_path, metadata_path and confined_target_dirs fields in
    tuf.client.updaters mirror configuration optional (#1153, #1166)
  • Include LICENSE files with source distributions (#1162)
  • Update Python version to be used in release instructions (#1163)
  • Remove direct use of colorama and dependency (#1180)

Fixed

  • Ensure file objects and requests.Responses are closed during tests (#1147)
  • Auto-test against securesystemslib head of development (#1185)
  • Fix parameter name in tuf.repository_lib error message (#1078)
v0.14.0
7cc41c6
Compare
Choose a tag to compare

Added

  • Added a mechanism to the Updater to disable the hash prefix for target files
    even when consistent_snapshot is enabled for a repository (#1102)

Changed

  • Updater now uses keyids provided in the metadata, rather than re-calculating
    keyids using keyid_hash_algorithms (#1014, #1121)
  • When loading an existing repository the keyids provided in the metadata will
    be used, rather than re-calculating keyids using keyid_hash_algorithms (#1014, #1121)
  • Improve reliability and performance of tests by removing sleep calls, instead
    use polling to check whether the simple_server is ready to accept
    connections (#1096)
  • Only calculate lengths and hashes of files listed by timestamp and snapshot
    metadata when those lengths and hashes will be included in the metadata (#1097)
  • Re-raise chained exceptions explicitly per PEP 3134 (#1116)
  • Remove use of securesystemslib.settings.HASH_ALGORITHMS, instead pass
    desired algorithms explicitly to securesystemslib's
    keys.format_metadata_to_key (#1016)

Fixed

  • Better adhere to the detailed client workflow in the specification by
    ensuring that a newly downloaded root metadata file is verified with a
    threshold of its own signatures (#1101)
  • Update a delegating role's metadata when adding a new verification key to a
    delegated role (#1074)
v0.13.0
7a418a2
Compare
Choose a tag to compare

Added

  • Add support for BLAKE hash functions (#993)
  • Don't list root metadata in snapshot metadata, per latest spec (#988)
  • Enable targets metadata to be generated without access to the target files (#1007, #1020)
  • Implement support for abstract files and directories (#1024, #1034)
  • Make lengths and hashes optional for timestamp and snapshot roles (#1031)

Changed

  • Revise requirements files to have layered requirements (#978, #982)
  • Update tutorial instructions (#981, #992) and documentation (#1054, #1001)
  • Replace hard-coded logger names (#989)
  • Fix target file path hashing to ensure paths are hashed as they appear in targets metadata (#1007)
  • Refactor code handling hashed bins (#1007, #1013, #1040, #1058)
  • Improve performance when delegating to a large number of hashed bins (#1012)
  • Improve path handling consistency when adding targets and paths (#1008)
  • Clarify error message and docstring for custom parameter of add_target() (#1027)
  • Ensure each key applies to signature threshold only once (#1091)

Fixed

  • Fix broken CI (#985)
  • Fix tests (#1029, #1064, #1067)
  • Fix loading of delegated targets during repository load (#1049, #1052, #1071)
  • Fix key loading in repo.py (#1066)
  • Remove redundant code in downloader (#1073)
  • Fix alarming logging in updater (#1092)
v0.12.2
15414c6
Compare
Choose a tag to compare
  • Fix incorrect threshold signature computation (#974)
  • Drop support for python 3.4 (#966)
  • Improve documentation (#970, #960, #962, #961, #972)
  • Improve test suite and tutorial scripts (#775)