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

Rename private key structures #362

Merged
merged 3 commits into from
Feb 4, 2019
Merged

Conversation

ilammy
Copy link
Collaborator

@ilammy ilammy commented Feb 3, 2019

Let‘s use consistent naming for our key data structures in Rust code. As outlined by @vixentael in this pull request comment, wording “secret key” usually refers to symmetric keys and it is confusing in the context of asymmetric cryptography. We should use the traditional “private and public keys” terminology instead. All other language wrappers and the core library do so.

Update the structure and variable names, command-line arguments and documentation to consistently use “private keys” everywhere. Avoid jokes about private parts. This is a breaking change due to structure renaming.

Let's use consistent naming for our key data structure. As outlined
in this pull request comment [1], wording 'secret key' usually refers
to symmetric keys and it is confusing in the context of asymmetric
cryptography. We should use the traditional "private and public keys"
terminology instead.

Update the structure and variable names, command-line arguments and
documentation to consistently use "private keys" everywhere. This is
a breaking change due to structure renaming.

[1]: cossacklabs#358 (comment)
@ilammy ilammy added the W-RustThemis 🦀 Wrapper: Rust-Themis, Rust API, Cargo crates label Feb 3, 2019
Mass-renaming revealed a sleeper bug in memory allocation in unsafe
code. Reserve correct amount of memory for RSA and ECDSA public keys.

Co-Authored-by: ilammy <[email protected]>
@vixentael vixentael merged commit 6f2a6ef into cossacklabs:master Feb 4, 2019
@ilammy ilammy deleted the rename-private branch February 9, 2019 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
W-RustThemis 🦀 Wrapper: Rust-Themis, Rust API, Cargo crates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants