Skip to content

Use go-secure-stdlib's RSA key generator backed by a DRBG #29020

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

Merged
merged 34 commits into from
Dec 5, 2024
Merged

Conversation

sgmiller
Copy link
Collaborator

@sgmiller sgmiller commented Nov 25, 2024

If the random source is not crypto/rand.Reader, use a secure deterministic
random bit generator seeded by the random source to generate RSA keys,
rather than the source directly. This massively improves performance for
RSA key generation if the source is a slow RNG, as can be found in many
HSMs.

This fixes customer issues resulting in timeouts as key generation can take several minutes on some HSMs, needing to pull thousands of candidate numbers for primes. In particular:
https://hashicorp.atlassian.net/browse/VAULT-21911 and https://hashicorp.atlassian.net/browse/VAULT-31473

This feature is on by default but can be overridden by setting VAULT_DISABLE_RSA_DRBG
to true.

https://hashicorp.atlassian.net/browse/VAULT-32705

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.

@sgmiller sgmiller requested review from a team as code owners November 25, 2024 19:07
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Nov 25, 2024
Copy link

github-actions bot commented Nov 25, 2024

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Nov 25, 2024

Build Results:
All builds succeeded! ✅

@sgmiller sgmiller marked this pull request as draft November 25, 2024 19:29
@sgmiller sgmiller marked this pull request as ready for review November 25, 2024 19:31
@sgmiller sgmiller added this to the 1.19.0-rc milestone Nov 26, 2024
Copy link
Contributor

@stevendpclark stevendpclark left a comment

Choose a reason for hiding this comment

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

There's a reference to rsa.GenerateKey within sdk/helper/certutil/helpers.go line 371 that was missed.

Beyond that and the go.mod conflict 👍

stevendpclark
stevendpclark previously approved these changes Nov 28, 2024
fairclothjm
fairclothjm previously approved these changes Dec 5, 2024
Copy link
Contributor

@fairclothjm fairclothjm left a comment

Choose a reason for hiding this comment

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

LGTM

fairclothjm
fairclothjm previously approved these changes Dec 5, 2024
@sgmiller sgmiller merged commit 86ba0db into main Dec 5, 2024
92 checks passed
@sgmiller sgmiller deleted the sgm/prng-rsa branch December 5, 2024 21:39
Monkeychip pushed a commit that referenced this pull request Dec 18, 2024
* Use DRBG based RSA key generation everywhere

* switch to the conditional generator

* Use DRBG based RSA key generation everywhere

* switch to the conditional generator

* Add an ENV var to disable the DRBG in a pinch

* update go.mod

* Use DRBG based RSA key generation everywhere

* switch to the conditional generator

* Add an ENV var to disable the DRBG in a pinch

* Use DRBG based RSA key generation everywhere

* update go.mod

* fix import

* Remove rsa2 alias, remove test code

* move cryptoutil/rsa.go to sdk

* move imports too

* remove makefile change

* rsa2->rsa

* more rsa2->rsa, remove test code

* fix some overzelous search/replace

* Update to a real tag

* changelog

* copyright

* work around copyright check

* work around copyright check pt2

* bunch of dupe imports

* missing import

* wrong license

* fix go.mod conflict

* missed a spot

* dupe import
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants