Skip to content

x448: apply clippy #[must_use] #1961

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.

Sign up for GitHub

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

Open
dishmaker wants to merge 1 commit into
base: master
Choose a base branch
from
Open

x448: apply clippy #[must_use] #1961

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions x448/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ impl PublicKey {
/// Returns None if:
/// - The length of the slice is not 56
/// - The point is a low order point
#[must_use]
pub fn from_bytes(bytes: &[u8]) -> Option<PublicKey> {
let public_key = PublicKey::from_bytes_unchecked(bytes)?;
if public_key.0.is_low_order() {
Expand All @@ -50,6 +51,7 @@ impl PublicKey {
/// Converts a bytes slice into a Public key
/// Returns None if:
/// - The length of the slice is not 56
#[must_use]
pub fn from_bytes_unchecked(bytes: &[u8]) -> Option<PublicKey> {
// First check if we have 56 bytes
if bytes.len() != 56 {
Expand All @@ -64,6 +66,7 @@ impl PublicKey {
}

/// Converts a public key into a byte slice
#[must_use]
pub fn as_bytes(&self) -> &[u8; 56] {
self.0.as_bytes()
}
Expand All @@ -77,6 +80,7 @@ pub struct SharedSecret(MontgomeryPoint);

impl SharedSecret {
/// Converts a shared secret into a byte slice
#[must_use]
pub fn as_bytes(&self) -> &[u8; 56] {
self.0.as_bytes()
}
Expand Down Expand Up @@ -106,6 +110,7 @@ impl EphemeralSecret {
}

/// Performs a Diffie-hellman key exchange between the secret key and an external public key
#[must_use]
pub fn diffie_hellman(&self, public_key: &PublicKey) -> SharedSecret {
// NOTE(security): it is assumed PublicKey is not a low_order. It should be checked when
// created.
Expand All @@ -114,6 +119,7 @@ impl EphemeralSecret {
}

/// Converts a secret into a byte array
#[must_use]
pub fn as_bytes(&self) -> &[u8; 56] {
self.0.as_ref()
}
Expand Down Expand Up @@ -149,13 +155,15 @@ fn slice_to_array(bytes: &[u8]) -> [u8; 56] {
/// we do not return a low order point.
///
/// [1]: https://github.com/rust-lang/nomicon/issues/59
#[must_use]
pub fn x448(scalar_bytes: [u8; 56], point_bytes: [u8; 56]) -> Option<[u8; 56]> {
let point = PublicKey::from_bytes(&point_bytes)?;
let scalar = EphemeralSecret::clamp(scalar_bytes.into()).as_scalar();
Some((&point.0 * &scalar).0)
}
/// An unchecked version of the x448 function defined in RFC448
/// No checks are made on the points.
#[must_use]
pub fn x448_unchecked(scalar_bytes: [u8; 56], point_bytes: [u8; 56]) -> [u8; 56] {
let point = MontgomeryPoint(point_bytes);
let scalar = EphemeralSecret::clamp(scalar_bytes.into()).as_scalar();
Expand Down Expand Up @@ -212,6 +220,7 @@ impl StaticSecret {

/// Perform a Diffie-Hellman key agreement between `self` and
/// `their_public` key to produce a `SharedSecret`.
#[must_use]
pub fn diffie_hellman(&self, their_public: &PublicKey) -> SharedSecret {
// NOTE(security): it is assumed PublicKey is not a low_order. It should be checked when
// created.
Expand All @@ -221,6 +230,7 @@ impl StaticSecret {

/// View this key as a byte array.
#[inline]
#[must_use]
pub fn as_bytes(&self) -> &[u8; 56] {
self.0.as_ref()
}
Expand Down
Loading