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

Add document and diagram for artifact movement #31

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/Notary-v2_movement.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/movement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# How to move an artifact signed by tuf-notary

<img src="images/Notary-v2_movement.jpg">

The following is the process for moving an artifact that has been signed with TUF.
We assume that both the source and destination registries have existing TUF metadata.

1. Copy the artifact and any delegated targets metadata to the target repository on the destination registry.
1. Update the top-level targets metadata on the destination repository to indicate that the original uploader's signature should be trusted
1. (Optional) Add a signature to the artifact from the verifier or other entity and update the top-level targets metadata accordingly
1. (Automated) Update the snapshot and timestamp metadata on the destination registry.


All of these steps can be combined into a single CLI/API call with flags for adding signatures and indicating which keys should be trusted.