Struct PrivateKey

pub struct PrivateKey { /* private fields */ }

Available on crate feature dep_orion only.

A type to represent the PrivateKey that X25519 uses.

This type holds a scalar and is used internally as such. The scalar held is decoded (a.k.a “clamped”) as mandated in the RFC.

Errors:

An error will be returned if:

• slice is not 32 bytes.

Panics:

A panic will occur if:

• Failure to generate random bytes securely.

Security:

• Avoid using unprotected_as_bytes() whenever possible, as it breaks all protections that the type implements.

• The trait PartialEq<&'_ [u8]> is implemented for this type so that users are not tempted to call unprotected_as_bytes to compare this sensitive value to a byte slice. The trait is implemented in such a way that the comparison happens in constant time. Thus, users should prefer SecretType == &[u8] over SecretType.unprotected_as_bytes() == &[u8].

Examples are shown below. The examples apply to any type that implements PartialEq<&'_ [u8]>.

use orion::hazardous::ecc::x25519::PrivateKey;

// Initialize a secret key with random bytes.
let secret_key = PrivateKey::generate();

// Secure, constant-time comparison with a byte slice
assert_ne!(secret_key, &[0; 32][..]);

// Secure, constant-time comparison with another SecretKey
assert_ne!(secret_key, PrivateKey::generate());

Implementations

impl PrivateKey

pub fn from_slice(slice: &[u8]) -> Result<PrivateKey, UnknownCryptoError>

Construct from a given byte slice.

pub fn len(&self) -> usize

Return the length of the object.

pub fn is_empty(&self) -> bool

Return true if this object does not hold any data, false otherwise.

NOTE: This method should always return false, since there shouldn’t be a way to create an empty instance of this object.

pub fn unprotected_as_bytes(&self) -> &[u8]

Return the object as byte slice. Warning: Should not be used unless strictly needed. This breaks protections that the type implements.

pub fn generate() -> PrivateKey

Randomly generate using a CSPRNG. Not available in no_std context.

Trait Implementations

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl From<[u8; 32]> for PrivateKey

fn from(bytes: [u8; 32]) -> PrivateKey

Converts to this type from the input type.

impl PartialEq<&[u8]> for PrivateKey

fn eq(&self, other: &&[u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for PrivateKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&PrivateKey> for PublicKey

type Error = UnknownCryptoError

The type returned in the event of a conversion error.

fn try_from( private_key: &PrivateKey, ) -> Result<PublicKey, <PublicKey as TryFrom<&PrivateKey>>::Error>

Performs the conversion.

impl StructuralPartialEq for PrivateKey