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

Backport of Add missing parameter signature_bits to the generate root PKI API docs into release/1.18.x #29526

Conversation

hc-github-team-secure-vault-core
Copy link
Collaborator

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 Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    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.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

Overview of commits

@stevendpclark stevendpclark enabled auto-merge (squash) February 7, 2025 14:29
Copy link

github-actions bot commented Feb 7, 2025

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Feb 7, 2025

Build Results:
All builds succeeded! ✅

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).
Copy link
Contributor

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

@stevendpclark stevendpclark merged commit 3463730 into release/1.18.x Feb 11, 2025
39 of 40 checks passed
@stevendpclark stevendpclark deleted the backport/docs/stevendpclark/add-sigbits-to-pki-gen-root/gently-fitting-swan branch February 11, 2025 21:02
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants