Giters

repository-service-tuf / repository-service-tuf

Umbrella Repository Service for TUF

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feature: Add support to unrecognized_fields

kairoaraujo opened this issue · comments

commented

What is the feature about?

Add support during the Ceremony and Metadata Update to add unrecognized_fields to the Root metadata.

These fields can help distribute information from the Root Metadata.

Services it relates to

repository-service-for-tuf-cli, repository-service-for-tuf-api

Related tasks

  • Add support to the Ceremony and Metadata Update
  • Allow the API to recognize the the unrecognized_fields

References

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
commented

For context: we use an unrecognized_fields attribute in most (all?) TUF Metadata API model classes, to store fields that aren't recognised during deserialization.

E.g. the json metadata file:

{"signed": <SIGNED>, "signatures": <SIGNATURES>, "foo": <BAR>}

deserialises into the Metadata object:

Metadata(signed=<SIGNED>, signatures=<SIGNATURES>, unrecognized_fields={"foo":<BAR>}

It also works the other way around.

commented

@lukpueh
Do we want to use some standard format for this?

For example: x-{application|organization|identifier}-{name}?

x-example-artifacts-url="https://www.example.com/downloads/"