theupdateframework / theupdateframework/tuf-conformance

tests: Test optional features

Open
#33 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
9
Forks
7
Avg merge
2d 16h
Merged PRs (30d)
13

Description

Specification has a few optional features. This list is from memory so possibly not complete:

hashes & length in METAFILEs

The single-item dictionary in timestamp and the dictionary in snapshot may or may not contain hashes and/or length. We should check that at least both reasonable options are supported (neither hashes nor length included; and both hashes and length included)

Consistent snapshot

According to spec the "consistent snapshot" feature is SHOULD only. I don't think we're very interested in the "non-consistent" version: I think we should only possibly test it with security in mind -- but have no practical examples at the moment

EDIT: I believe all tests currently implemented require consistent snapshot. I think this is fine, in this aspect we'll be more opinionated than the spec itself: consistent_snapshot really makes much more sense. We should still accept an optional test for non-consistent snapshot... but it's not a priority

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing conformance tests and the specification sections for hashes and length in METAFILEs. Add coverage for cases with neither fields and with both fields, and consider non-consistent snapshots only if a practical security case is identified; done means the optional-feature behavior is exercised and the tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.