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

Architecture docs #373

Closed
1 of 5 tasks
nsmith5 opened this issue Feb 1, 2022 · 4 comments
Closed
1 of 5 tasks

Architecture docs #373

nsmith5 opened this issue Feb 1, 2022 · 4 comments
Labels
enhancement New feature or request

Comments

@nsmith5
Copy link
Contributor

nsmith5 commented Feb 1, 2022

Description

It takes a really long time to get started with Fulcio development because of the lack of architecture docs. The reader needs to spin everything up and look the the code to get the gist of how things work. I think we can make this much better with basic architecture docs including

  • Detailed explanation of how a certificate request works from start to finish
  • Flow diagram of OIDC authentication
  • Clear diagrams and explanation of upstream and downstream dependencies
    • Explain how the rest of sigstore relies on Fulcio
    • Explain how Fulcio relies on a certificate transparency log and certificate authority
@nsmith5 nsmith5 added the enhancement New feature or request label Feb 1, 2022
@lukehinds
Copy link
Member

Agree, I would add a nice flow diagram of OIDC as well.

@nsmith5
Copy link
Contributor Author

nsmith5 commented Feb 1, 2022

I've got a very detailed description of the certificate request lifecycle in this doc I can repurpose for the "how a certificate request works" part of this https://docs.google.com/document/d/1PKAou7wEmEob4VOLq6rFlx5maOM5hkJ3XffZizfwdFw/edit

The original doc was to discuss a proposal for #275 but I think the background information in it is probably worth adding in its own right

@endorama
Copy link
Contributor

endorama commented Feb 15, 2022

I've been looking at OICD authentication flow is it correct the one to document is the Basic/Authentication flow?

Am I correct saying that IDP redirects to fulcio, which then uses the ID token as issuer for the sign certificate? Or fulcio is not involved with authentication and just receives an ID token that validates with IDP?

@haydentherapper
Copy link
Contributor

Work is complete

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants