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

[FEAT] Clarify caCertificate in documentation #452

Closed
nferch opened this issue Apr 27, 2023 · 2 comments · Fixed by #497
Closed

[FEAT] Clarify caCertificate in documentation #452

nferch opened this issue Apr 27, 2023 · 2 comments · Fixed by #497
Labels
enhancement New feature or request

Comments

@nferch
Copy link

nferch commented Apr 27, 2023

The documentation for caCertificate should be expanded to be less ambiguous, especially compared to other systems with a similar parameter. Specifically: when configuring for the first time, I was left wondering:

  • Why does caCertificate need to be Base64 encoded when certificates are already PEM encoded? It is unusual to require Base64 encoding for data that couldn't be binary. The other configuration parameters don't require Base64.
  • Is caCertificate always required? Or is it only required when I have my own CA? If I'm using a standard CA, does the action make use of the standard CA bundle?
@nferch nferch added the enhancement New feature or request label Apr 27, 2023
@WoodyWoodsta
Copy link

@nferch Do you know the answers to these? :) Specifically the second question. I have vault exposed behind a proxy using a letsencrypt certificate. My assumption is that this known CA should already be trusted.

@fairclothjm
Copy link
Contributor

@nferch @WoodyWoodsta Hello! vault-action uses the got library. The vault-action caCertificate field is used to set got's https.certificateAuthority option. This Overrides trusted CA certificates and defaults to CAs provided by Mozilla. So it is not required and the table here documents it as such.

In regards to base64 encoding, I don't have a great answer. It may have been done that way due to limitations of GitHub's core action library. But I don't know for sure.

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

Successfully merging a pull request may close this issue.

3 participants