Skip to content

Commit

Permalink
Fix variable names in the invariant description (#573)
Browse files Browse the repository at this point in the history
Previously the variable names referred to `public` and `secret` which do
not exist. Update them to `verifying_key` and `secret_key`.
  • Loading branch information
wiktor-k authored Sep 5, 2023
1 parent 5c5a320 commit 135476c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions ed25519-dalek/src/signing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ use crate::{
pub type SecretKey = [u8; SECRET_KEY_LENGTH];

/// ed25519 signing key which can be used to produce signatures.
// Invariant: `public` is always the public key of `secret`. This prevents the signing function
// oracle attack described in https://github.com/MystenLabs/ed25519-unsafe-libs
// Invariant: `verifying_key` is always the public key of
// `secret_key`. This prevents the signing function oracle attack
// described in https://github.com/MystenLabs/ed25519-unsafe-libs
#[derive(Clone, Debug)]
pub struct SigningKey {
/// The secret half of this signing key.
Expand Down

0 comments on commit 135476c

Please sign in to comment.