Skip to content

feat: adds cert-utility templates and documentation.#889

Merged
Hayden-IO merged 20 commits into
sigstore:mainfrom
ianhundere:feat/adds-cert-maker
Feb 3, 2025
Merged

feat: adds cert-utility templates and documentation.#889
Hayden-IO merged 20 commits into
sigstore:mainfrom
ianhundere:feat/adds-cert-maker

Conversation

@ianhundere

@ianhundere ianhundere commented Nov 21, 2024

Copy link
Copy Markdown
Contributor

closes #886, closes sigstore/fulcio#1930

Summary

currently, there is no standard method for creating cert chains for fulcio or tsa. the community has used an assortment of open source scripts/tools, but i thought it would be nice to have a small cloud agnostic go app to create/sign (via awskms, gcpkms, or azurekms) certificates. the smallstep crypto library is fairly comprehensive in its kms/cert capabilities.

@haydentherapper / @bobcallaway gave the go ahead in proceeding w/ this work.

Release Note

  • Adds certificate utility to create and sign certificates via AWS KMS, Google Cloud KMS, or Azure Key Vault.

Documentation

added docs to ./docs folder and updated README.md to point to docs.

@ianhundere ianhundere changed the title feat: adds cert templates. feat: adds cert-utility. Nov 22, 2024
@ianhundere ianhundere marked this pull request as ready for review November 25, 2024 20:14
@ianhundere ianhundere requested a review from a team as a code owner November 25, 2024 20:14
@ianhundere

ianhundere commented Dec 1, 2024

Copy link
Copy Markdown
Contributor Author

i think this is ready for 👀 now. just a couple of notes.

  1. the following use-cases are now covered:
  • root ca -> leaf
  • root ca -> intermediate ca -> leaf
  1. the following kms providers are working:
  • awskms
  • azurekms
  • gcpkms
  1. hashivault was added, but has not been tested.

i think that about covers it, i have some basic readme/documentation above as well.

cc @haydentherapper

@codecov

codecov Bot commented Dec 4, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.73%. Comparing base (6fd19b0) to head (a96f1ed).
Report is 282 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #889      +/-   ##
==========================================
- Coverage   52.85%   44.73%   -8.12%     
==========================================
  Files          20       55      +35     
  Lines        1209     3657    +2448     
==========================================
+ Hits          639     1636     +997     
- Misses        509     1881    +1372     
- Partials       61      140      +79     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ianhundere

Copy link
Copy Markdown
Contributor Author

nudge for 👀 / thanks y'all

cc @haydentherapper / @bobcallaway

@Hayden-IO Hayden-IO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related to the comment I just left on the other PR, I wonder if we can reduce duplication between these two. The only difference between the two is 1) the templates, and 2) that the TSA needs a leaf certificate and Fulcio doesn't.

In the Fulcio codebase, could we have certificate_maker have leaf be optional? Then in this repo, just have a readme pointing to the fulcio codebase and the templates for the TSA?

@ianhundere

ianhundere commented Jan 24, 2025

Copy link
Copy Markdown
Contributor Author

reduce duplication between these two.

yeah, that's what i was thinking / i think that totally works.

so just to reiterate / instead of allowing intermediate keys be optional, we just allow leafs to be optional, correct ?

heh, it's the end of the day here and i didn't connect the dots.

@Hayden-IO

Copy link
Copy Markdown
Contributor

Roots are always required, intermediates are optional, and leafs are optional (for a CA vs TSA).

@ianhundere

Copy link
Copy Markdown
Contributor Author

Roots are always required, intermediates are optional, and leafs are optional (for a CA vs TSA).

perfect / should i create a new issue in fulcio for this work or ?

@Hayden-IO

Copy link
Copy Markdown
Contributor

Feel free to just create a PR in Fulcio making the leaf optional, then update this PR to be just the templates plus README. Thanks!

@ianhundere ianhundere changed the title feat: adds cert-utility. feat: adds cert-utility templates and documentation. Jan 25, 2025
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
…escriptive.

Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
… consistent w/ flags.

Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
…e flag to gcp-credentials-file.

Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
…son error.

Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
…per, and other PR fb.

Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
…vements.

Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
@ianhundere

Copy link
Copy Markdown
Contributor Author

this is ready for 👀

cc @haydentherapper

@Hayden-IO Hayden-IO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, just a few minor comments!

Comment thread go.mod
Comment thread .gitignore Outdated
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
Signed-off-by: ianhundere <138915+ianhundere@users.noreply.github.com>
@ianhundere

Copy link
Copy Markdown
Contributor Author

Thanks, just a few minor comments!

done and done / thanks for the 👀.

@Hayden-IO Hayden-IO enabled auto-merge (squash) February 3, 2025 20:50
@Hayden-IO Hayden-IO merged commit 40f1f8f into sigstore:main Feb 3, 2025
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.

make leaf optional in certificate-maker light tool to create/sign (via kms) certs (ca, leaf etc)

2 participants