theupdateframework / theupdateframework/specification

Delineating between security property requirements and internal consistency requirements in detailed client workflow

Open
#185 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
405
Forks
59
Avg merge
3d 4h
Merged PRs (30d)
1

Description

There are parts of the specification which implementers SHOULD adhere to in order to gain the security properties of TUF.
There are parts of the specification which implementers need not strictly adhere to, so long as they are internally consistent across the detailed client workflow.

For example, it is not strictly necessary to persist metadata files in the recommended fixed form. However, it is necessary to store the data in a consistent and consistently identifiable fashion in order to be able to implement the workflow.

It could be helpful if the specification explicitly delineated between these two types of requirement so that implementers can more easily make informed decisions. In many cases the delineation is implicit (through use of RFC 2119 keywords on pieces of the detailed client workflow related to TUF security properties), but more explicit notation/annotations would make it easier for integrators to adopt TUF safely.

This may be easier to do after #121

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

Review the specification's detailed client workflow and its use of RFC 2119 keywords, then compare the context from issue #121. Define how security-property requirements should be distinguished from internal-consistency requirements, with annotations that let implementers identify which choices are flexible; done when the distinction is explicit throughout the relevant workflow.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.