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

refactor: bcrypt key derivation to aead (#509) #15817

Merged
merged 18 commits into from
Apr 27, 2023
Merged

Conversation

bizk
Copy link
Contributor

@bizk bizk commented Apr 12, 2023

  • Added Aead encryption and Argon2 key derivation to armor## Description

Closes: #3129

  • Replaced bcrypt key derivation for argon2id, this approach is secure and resolves most of bcrypt common issues. Algorithm implementation uses these parameters
const (
	argon2Time    = 1 // Recommended by library authors: Uses max memory available
	argon2Memory  = 64 * 1024 // Memory usage 
	argon2Threads = 4
	argon2KeyLen  = 32 // Key bytes
)
  • Replaced xsalsa20 symmetric encryption with AEAD ChaCha20Poly
  • Added backward compatibility for old keys.
  • Added respective tests
  • Fixed suggestions and comments by @facundomedica
  • fix different lint errors
  • Fixed comments, and added error handling messages
  • added error default value for kdf switch case and error handling
  • added missing error message for unarmor when having a bad passphrase

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)

🔗 zboto Link

* Added Aead encryption and Argon2 key derivation to armor

* Added Argon2 key derivation to keyring

* Fixed potential bug in variable not being propertly assigned

* Switched aead library to x/crypto

* fix different lint errors

* fix lint issues

* Modified decrtyption logic and fixed typo

* Fixed comments, and added error handling messages

* fixed comments

* added changelog

* Added improvements over crypto/armor.go

* added error default value for kdf switch case and error handling

* failing test fix

* checkout keyring changes since it was out of scope and generated bugs

* rollback changes on keyring_test

* reducing scope of the PR 

* added missing error message for unarmor when having a bad passphrase
@bizk bizk requested a review from a team as a code owner April 12, 2023 13:15
@facundomedica
Copy link
Member

LGTM, would love a quick review from @FiloSottile 🙏

Copy link

@FiloSottile FiloSottile left a comment

Choose a reason for hiding this comment

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

LGTM

crypto/armor.go Outdated Show resolved Hide resolved
crypto/armor.go Outdated Show resolved Hide resolved
crypto/armor.go Outdated Show resolved Hide resolved
crypto/armor.go Outdated
}

key = crypto.Sha256(key) // get 32 bytes
privKeyBytes := legacy.Cdc.MustMarshal(privKey)
nonce := make([]byte, aead.NonceSize(), aead.NonceSize()+len(privKeyBytes)+aead.Overhead())

Choose a reason for hiding this comment

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

Probably worth a comment explaining that it's ok to use a fixed (all zeroes) nonce because the key is generated fresh at every encryption using a fresh random salt every time. If nothing else because it's very important that the code is not changed later to reuse the same salt and passphrase with different private keys.

(By the way, the salt is 128 bits, which gives a 2^-32 chance of collision after 2^50 encryptions. Is that a particularly realistic concern? No. Is it worth making the salt 24 bytes if it's just a matter of changing a constant? Probably.)

crypto/armor.go Outdated Show resolved Hide resolved
@facundomedica
Copy link
Member

@bizk let's address Filippo's comments and merge it 👌

@bizk
Copy link
Contributor Author

bizk commented Apr 21, 2023

Hi solved the comments @FiloSottile also thanks @facundomedica for following up :)

auto-merge was automatically disabled April 24, 2023 20:26

Head branch was pushed to by a user without write access

bizk and others added 2 commits April 25, 2023 12:06
* solved lint issues

* feat(x/tx): API improvements (cosmos#15871)

* refactor(baseapp): set vote info to latest votes (cosmos#15930)

* refactor(staking, slashing, signing, misc): remove aliases from types/math.go (cosmos#15902)

* fix(autocli): fix simapp enhancing (cosmos#15906)

* fix lint on armor.go

* ran make lint-fix

---------

Co-authored-by: Matt Kocubinski <mkocubinski@gmail.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
auto-merge was automatically disabled April 25, 2023 15:10

Head branch was pushed to by a user without write access

@tac0turtle
Copy link
Member

@bizk could you fix the linting issue then the bot will merge the pr

* solved lint issues

* fix lint on armor.go

* ran make lint-fix

* fixed nolint comment
auto-merge was automatically disabled April 26, 2023 21:19

Head branch was pushed to by a user without write access

@facundomedica facundomedica added this pull request to the merge queue Apr 27, 2023
Merged via the queue into cosmos:main with commit 26faee9 Apr 27, 2023
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
5 participants