Skip to content

Commit

Permalink
docs: add TRUST.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xynydev committed Apr 17, 2024
1 parent c60ad9b commit 741fd99
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
13 changes: 13 additions & 0 deletions TRUST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Trusting BlueBuild Workshop

## GitHub login

It is unfortunate that the GitHub API does not allow for enough granular control over the permissions for a tool like this to not require the `repo` permission, giving it read/write access to all your repositories. However, the Workshop is designed to not make changes to repositories that are not _initiated by the user_, and technically works like any GitHub client. The OAuth log in system follows GitHub recommendations and best practices. You can audit the code of the whole project [here](https://github.com/blue-build/workshop).

## Cosign keys

Sigstore's Cosign is used to sign all custom images built with BlueBuild. It is an important step, as it allows for end users to verify the authenticity of a custom image. It is also required for things such as secure boot on atomic Fedora systems.

The Workshop provides a way to automatically generate cosign keys in the repository setup wizard. The keys are first generated inside your own web browser with WASM using [this project](https://github.com/blue-build/wasm-cosign-keygen), then sent through HTTPS to our serverless backend (run on Cloudflare Pages), which makes the final API requests to GitHub. **There is technically nothing insecure about this process**, it is very similar to you yourself sending the keys to GitHub through their web UI or CLI. The only difference is the added trust in BlueBuild.

If you do not wish to trust BlueBuild's Workshop with this duty, you should do it manually, [which we also provide a guide for](https://blue-build.org/how-to/cosign/).
6 changes: 5 additions & 1 deletion src/routes/new/+page.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,11 @@
important not to expose the cosign keys to third parties. BlueBuild can set
these up automatically for you. The keys will be generated in your browser and
transmitted over HTTPS to GitHub. If you do not trust BlueBuild to do this, you
can skip it for now and do it manually instead.
can skip it for now and do it manually instead. <a
href="https://github.com/blue-build/workshop/blob/main/TRUST.md"
>
Read more about trust...
</a>
</p>

<div class="mt-6 flex w-full flex-row flex-wrap justify-between">
Expand Down

0 comments on commit 741fd99

Please sign in to comment.