Add bundle to x509 needs-renewal command. #873
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fixes unexpected behavior of implicitly applying needs-renewal to every cert in the bundle
github-actions
bot
added
the
needs triage
maraino
reviewed
Mar 9, 2023
command/certificate/needsRenewal.go
Outdated
| cli.BoolFlag{ | ||
| Name: `bundle`, | ||
| Usage: `Check all certificates in the order in which they appear in the bundle. | ||
| By default (without this flag) this command will only check the leaf certificate.`, |
There was a problem hiding this comment.
I think the default option can be clarified in the description.
There was a problem hiding this comment.
It is documented just below in the exit codes section.
maraino
reviewed
Mar 9, 2023
command/certificate/needsRenewal.go
Outdated
| @@ -22,13 +23,16 @@ func needsRenewalCommand() cli.Command { | |||
| Action: cli.ActionFunc(needsRenewalAction), | |||
| Usage: `Check if a certificate needs to be renewed`, | |||
| UsageText: `**step certificate needs-renewal** <cert-file or hostname> | |||
| [**--expires-in**=<percent|duration>] [**--roots**=<root-bundle>] [**--servername**=<servername>]`, | |||
| [**--expires-in**=<percent|duration>] [**--bundle] [**--verbose] | |||
maraino
requested changes
Mar 9, 2023
command/certificate/needsRenewal.go
Outdated
| @@ -48,11 +52,22 @@ Check if certificate.crt has passed 66 percent of its validity period: | |||
| $ step certificate needs-renewal ./certificate.crt | |||
| ''' | |||
|
|
|||
| Check if any certificate in the bundle has passed 66 percent of it's validity period: | |||
There was a problem hiding this comment.
Clarify in the first example that is the leaf certificate. Check if the leaf certificate.crt ...
command/certificate/needsRenewal.go
Outdated
Comment on lines
228
to
233
| if isVerbose { | ||
| fmt.Println(needsRenewal) | ||
| } | ||
| if needsRenewal { | ||
| return nil | ||
| } |
There was a problem hiding this comment.
I didn't know that when the certificate doesn't need renewal shows the following:
$ step certificate needs-renewal acme.crt
certificate does not need renewal
So perhaps the verbose option is not necessary.
command/ssh/needsRenewal.go
Outdated
Comment on lines
155
to
161
| func isVerboseExit(needsRenewal, isVerbose bool) error { | ||
| if isVerbose { | ||
| fmt.Println(needsRenewal) | ||
| } | ||
| if needsRenewal { | ||
| return nil | ||
| } |
There was a problem hiding this comment.
Same comment as before. Perhaps show something only if needs renewal is false?
maraino
requested changes
Mar 9, 2023
command/certificate/needsRenewal.go
Outdated
| }, | ||
| cli.BoolFlag{ | ||
| Name: "verbose, v", | ||
| Usage: `Return "true" or "false" in the terminal.`, |
There was a problem hiding this comment.
The verbose usage is not right. We don't show true or false.
command/ssh/needsRenewal.go
Outdated
| @@ -66,6 +68,10 @@ character. If using <duration>, the input must be a sequence of decimal numbers, | |||
| each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". | |||
| Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".`, | |||
| }, | |||
| cli.BoolFlag{ | |||
| Name: "verbose, v", | |||
| Usage: `Return "true" or "false" in the terminal.`, | |||
maraino
approved these changes
Mar 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #870