theupdateframework / theupdateframework/taps

Should POUF-1 allow whitespace for prettified output?

Open
#161 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
37
Forks
23
PR merge metrics
No merged PRs in 30d

Description

In this conversation on #tuf, I'm in the process of renaming rust-tuf's interchange types to pouf, since that's more aligned with the tuf project. One complication though is that rust-tuf supports a prettified version of pouf-1 with JsonPretty. We use this to generate golden files to make sure code changes don't unintentionally change pregenerated metadata. It's much easier to read pretty json than minified json. However, according to pouf-1, this format uses OLPC's canonical json format, which disallows whitespace.

rust-tuf, and I'm guessing all the other implementations of POUF-1, can work with prettified metadata without issue. Should this be something that's formally supported? Or should implementations like this be treated as a non-standard POUF? If the latter, how should we refer to things like this? Should we avoid using the term POUF with things like this?

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 reading the POUF-1 reference specification and OLPC's Canonical JSON definition linked in the issue, then review the rust-tuf JsonPretty implementation for the contrasting behavior. Done means deciding whether whitespace-prettified POUF-1 is formally supported and documenting how implementations should classify or refer to it.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.