-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Backport of Add missing parameter signature_bits to the generate root PKI API docs into release/1.18.x #29526
Merged
stevendpclark
merged 1 commit into
release/1.18.x
from
backport/docs/stevendpclark/add-sigbits-to-pki-gen-root/gently-fitting-swan
Feb 11, 2025
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
285fa68
to
ce81795
Compare
stevendpclark
approved these changes
Feb 7, 2025
CI Results: |
Build Results: |
schavis
requested changes
Feb 11, 2025
Comment on lines
+2179
to
+2183
- `signature_bits` `(int: 0)` - Specifies the number of bits to use in | ||
the signature algorithm; accepts 256 for SHA-2-256, 384 for SHA-2-384, | ||
and 512 for SHA-2-512. Defaults to 0 to automatically detect based | ||
on issuer's key length (SHA-2-256 for RSA keys, and matching the curve size | ||
for NIST P-Curves). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
- `signature_bits` `(int: 0)` - Specifies the number of bits to use in | |
the signature algorithm; accepts 256 for SHA-2-256, 384 for SHA-2-384, | |
and 512 for SHA-2-512. Defaults to 0 to automatically detect based | |
on issuer's key length (SHA-2-256 for RSA keys, and matching the curve size | |
for NIST P-Curves). | |
- `signature_bits` `(int: 0)` - The number of bits used in the signature | |
algorithm. Must be one of the following: | |
- `256` to use SHA-2-256 | |
- `384` to use SHA-2-384, | |
- `512` to use SHA-2-512 | |
- `0` to use automatic detection based on the issuer key length. For example, | |
SHA-2-256 for RSA keys, and matching the curve size for NIST P-Curves. |
Style correction: make key values easy to scan for, avoid possessives
schavis
approved these changes
Feb 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
backport
docs
hashicorp-contributed-pr
If the PR is HashiCorp (i.e. not-community) contributed
pr/no-changelog
pr/no-milestone
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.
Backport
This PR is auto-generated from #29522 to be assessed for backporting due to the inclusion of the label backport/1.18.x.
The below text is copied from the body of the original PR.
Description
Add a missing parameter
signature_bits
to the Generate Root PKI API documentation.TODO only if you're a HashiCorp employee
backport/
label that matches the desired release branch. Note that in the CE repo, the latest release branch will look likebackport/x.x.x
, but older release branches will bebackport/ent/x.x.x+ent
.of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.
Overview of commits