Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename pouf::Json to Pouf1 #394

Merged
merged 1 commit into from
Sep 28, 2022
Merged

Conversation

erickt
Copy link
Collaborator

@erickt erickt commented Sep 28, 2022

After a discussion with the TUF community, we decided it made more sense to name our implementation of POUF-1 as Pouf1, not Json, because it has additional restrictions on top of JSON. Furthermore, it doesn't make sense to call this CJSON since TUF doesn't allow for raw bytes in strings.

This also moves JsonPretty into the interop-tests, since this is only used to make the interop tests easier to review. I've filed 161 with the TUF spec to consider allowing whitespace in POUF-1. If this is accepted we can move this back into the tuf::pouf submodule.

After a discussion with the TUF community, we decided it made more sense
to name our implementation of [POUF-1] as `Pouf1`, not `Json`, because it
has additional restrictions on top of JSON. Furthermore, it doesn't make
sense to call this [CJSON] since TUF doesn't allow for raw bytes in
strings.

This also moves `JsonPretty` into the interop-tests, since this is only
used to make the interop tests easier to review. I've filed [161] with
the TUF spec to consider allowing whitespace in POUF-1. If this is accepted
we can move this back into the tuf::pouf submodule.

[POUF-1]: https://github.com/theupdateframework/taps/blob/master/POUFs/reference-POUF/pouf1.md
[161]: theupdateframework/taps#161
[CJSON]: https://wiki.laptop.org/go/Canonical_JSON
@erickt erickt merged commit 4e56ff1 into theupdateframework:develop Sep 28, 2022
@erickt erickt deleted the pouf branch September 28, 2022 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants