Struct nisty::SecretKey

pub struct SecretKey(_);

Secret part of a keypair, a scalar. Signs messages.

Implementations

impl SecretKey

pub fn sign_with(secret_bytes: [u8; 32], message: &[u8]) -> Signature

Sign data using provided secret key buffer.

pub fn sign(&self, message: &[u8]) -> Signature

Sign arbitrary data.

Convenience method, calls sign_prehashed on prehash(message).

pub fn sign_prehashed(&self, prehashed_message: &[u8; 32]) -> Signature

Sign data that is prehashed, probably with SHA-256.

impl SecretKey

pub fn agree(&self, public_key: &PublicKey) -> Result<SharedSecret>

Agree on a shared secret with a public key.

Remark: These shared secrets are not random and should never be used as cryptographically strong key material without first being passed through a key derivation function, see e.g. RFC 5869, Section 3.3.

use nisty::{Keypair, SEED_LENGTH};
let seed_0 = [0u8; SEED_LENGTH];
let seed_1 = [1u8; SEED_LENGTH];
let keypair_0 = Keypair::generate_patiently(&seed_0);
let keypair_1 = Keypair::generate_patiently(&seed_1);
assert_ne!(keypair_0.public, keypair_1.public);
let secret_0 = keypair_0.secret.agree(&keypair_1.public).unwrap();
let secret_1 = keypair_1.secret.agree(&keypair_0.public).unwrap();
assert_eq!(secret_0, secret_1);

TODO: Find out when exactly this can fail. Can we remove Result-ing?

TODO: Clarify whether this is the x-coordinate of (ab.G) = secret_key*public_key or what.

impl SecretKey

pub fn try_from_bytes(secret_key_bytes: &[u8; 32]) -> Result<Self>

pub fn to_bytes(self) -> [u8; 32]

pub fn as_bytes(&self) -> &[u8; 32]

Trait Implementations

impl AsArrayRef<[u8; 32]> for SecretKey

fn as_array_ref(&self) -> &[u8; 32]

impl AsArrayRef<[u8; 32]> for &SecretKey

fn as_array_ref(&self) -> &[u8; 32]

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecretKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&'_ SecretKey> for Keypair

fn from(secret_key: &SecretKey) -> Self

Performs the conversion.

impl From<&'_ SecretKey> for PublicKey

fn from(secret_key: &SecretKey) -> Self

Performs the conversion.

impl Into<[u8; 32]> for SecretKey

fn into(self) -> [u8; 32]

Performs the conversion.

impl PartialEq<SecretKey> for SecretKey

fn eq(&self, other: &SecretKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SecretKey) -> bool

This method tests for !=.

impl StructuralPartialEq for SecretKey

impl TryFrom<&'_ [u8; 32]> for SecretKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(secret_key_bytes: &[u8; 32]) -> Result<SecretKey>

Performs the conversion.