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: add scrypt to armor (to enable the removal of bcrypt later) #15155

Closed
wants to merge 7 commits into from

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented Feb 24, 2023

Description

TBD: how to do the migration from bcrypt to scrypt. Dev mentioned here that we should be able to save using the new KDF when a user decrypts (#3129 (comment)).

Closes: #3129 (I think it might close this)

Note: geth's keystore uses scrypt: https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts

In the original issue there is a mention of using the same format as Ethereum, do we still want that? (eth's format https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition)


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

crypto/keyring/keyring.go Fixed Show fixed Hide fixed
Comment on lines -174 to -187
if header["kdf"] != "bcrypt" {
return privKey, "", fmt.Errorf("unrecognized KDF type: %v", header["kdf"])
}

if header["salt"] == "" {
return privKey, "", fmt.Errorf("missing salt bytes")
}

saltBytes, err := hex.DecodeString(header["salt"])
if err != nil {
return privKey, "", fmt.Errorf("error decoding salt: %v", err.Error())
}

privKey, err = decryptPrivKey(saltBytes, encBytes, passphrase)
Copy link
Member Author

Choose a reason for hiding this comment

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

we can remove these as we are checking for these in other places

@facundomedica facundomedica marked this pull request as ready for review February 24, 2023 20:14
@facundomedica facundomedica requested a review from a team as a code owner February 24, 2023 20:14
@@ -46,7 +46,7 @@
passKeyringPrefix = "keyring-%s"

// temporary pass phrase for exporting a key during a key rename
passPhrase = "temp"
tempPassphrase = "temp"

Check failure

Code scanning / CodeQL

Hard-coded credentials

Hard-coded [password](1).
@tac0turtle tac0turtle closed this Mar 6, 2023
@tac0turtle tac0turtle deleted the facu/add-scrypt-armor branch March 6, 2023 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improper use of bcrypt API
2 participants