Struct elliptic_curve::secret_key::SecretKey

source · [−]

pub struct SecretKey<C: Curve + SecretValue> { /* private fields */ }

Expand description

Elliptic curve secret keys.

This type wraps a secret scalar value, helping to prevent accidental exposure and securely erasing the value from memory when dropped (when the zeroize feature of this crate is enabled).

Parsing PKCS#8 Keys

PKCS#8 is a commonly used format for encoding secret keys (especially ones generated by OpenSSL).

Keys in PKCS#8 format are either binary (ASN.1 BER/DER), or PEM encoded (ASCII) and begin with the following:

-----BEGIN PRIVATE KEY-----

To decode an elliptic curve private key from PKCS#8, enable the pkcs8 feature of this crate (or the pkcs8 feature of a specific RustCrypto elliptic curve crate) and use the [elliptic_curve::pkcs8::FromPrivateKey][FromPrivateKey] trait to parse it.

When the pem feature of this crate (or a specific RustCrypto elliptic curve crate) is enabled, a [FromStr] impl is also available.

Struct elliptic_curve::secret_key::SecretKey

Parsing PKCS#8 Keys

Implementations

impl<C> SecretKey<C> where C: Curve + SecretValue, C::Secret: Clone + Zeroize, FieldBytes<C>: From<C::Secret>,

pub fn random(rng: impl CryptoRng + RngCore) -> Self where C: ProjectiveArithmetic + SecretValue<Secret = NonZeroScalar<C>>, FieldBytes<C>: From<Scalar<C>> + for<'a> From<&'a Scalar<C>>, Scalar<C>: PrimeField<Repr = FieldBytes<C>> + Zeroize,

pub fn new(secret_value: C::Secret) -> Self

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self, Error>

pub fn to_bytes(&self) -> FieldBytes<C>

pub fn secret_scalar(&self) -> &NonZeroScalar<C> where C: ProjectiveArithmetic + SecretValue<Secret = NonZeroScalar<C>>, FieldBytes<C>: From<Scalar<C>> + for<'a> From<&'a Scalar<C>>, Scalar<C>: PrimeField<Repr = FieldBytes<C>> + Zeroize,

Warning

Trait Implementations

impl<C: Clone + Curve + SecretValue> Clone for SecretKey<C> where C::Secret: Clone,

fn clone(&self) -> SecretKey<C>

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

impl<C> Debug for SecretKey<C> where C: Curve + SecretValue,

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

impl<C> Drop for SecretKey<C> where C: Curve + SecretValue,

fn drop(&mut self)

impl<C> TryFrom<&'_ [u8]> for SecretKey<C> where C: Curve + SecretValue, C::Secret: Clone + Zeroize, FieldBytes<C>: From<C::Secret>,

type Error = Error

fn try_from(slice: &[u8]) -> Result<Self, Error>

Auto Trait Implementations

impl<C> RefUnwindSafe for SecretKey<C> where <C as SecretValue>::Secret: RefUnwindSafe,

impl<C> Send for SecretKey<C> where <C as SecretValue>::Secret: Send,

impl<C> Sync for SecretKey<C> where <C as SecretValue>::Secret: Sync,

impl<C> Unpin for SecretKey<C> where <C as SecretValue>::Secret: Unpin,

impl<C> UnwindSafe for SecretKey<C> where <C as SecretValue>::Secret: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where Self: UpperHex,

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pipe for T

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

impl<T> PipeAsRef for T

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where Self: AsRef<T>, T: 'a, R: 'a,

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where Self: AsMut<T>, T: 'a, R: 'a,

impl<T> PipeBorrow for T

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where Self: Borrow<T>, T: 'a, R: 'a,

fn pipe_borrow_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where Self: BorrowMut<T>, T: 'a, R: 'a,

impl<T> PipeDeref for T

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where Self: Deref, R: 'a,

fn pipe_deref_mut<'a, R>( &'a mut self, func: impl FnOnce(&'a mut Self::Target) -> R) -> R where Self: DerefMut, R: 'a,

impl<T> PipeRef for T

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where R: 'a,

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where R: 'a,

impl<T> Same<T> for T

type Output = T

impl<T> Tap for T

fn tap<F, R>(self, func: F) -> Self where F: FnOnce(&Self) -> R,

fn tap_dbg<F, R>(self, func: F) -> Self where F: FnOnce(&Self) -> R,

fn tap_mut<F, R>(self, func: F) -> Self where F: FnOnce(&mut Self) -> R,

fn tap_mut_dbg<F, R>(self, func: F) -> Self where F: FnOnce(&mut Self) -> R,

impl<T, U> TapAsRef<U> for T where U: ?Sized,

fn tap_ref<F, R>(self, func: F) -> Self where Self: AsRef<T>, F: FnOnce(&T) -> R,

fn tap_ref_dbg<F, R>(self, func: F) -> Self where Self: AsRef<T>, F: FnOnce(&T) -> R,

fn tap_ref_mut<F, R>(self, func: F) -> Self where Self: AsMut<T>, F: FnOnce(&mut T) -> R,

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where Self: AsMut<T>, F: FnOnce(&mut T) -> R,

impl<T, U> TapBorrow<U> for T where U: ?Sized,

fn tap_borrow<F, R>(self, func: F) -> Self where Self: Borrow<T>, F: FnOnce(&T) -> R,

fn tap_borrow_dbg<F, R>(self, func: F) -> Self where Self: Borrow<T>, F: FnOnce(&T) -> R,

fn tap_borrow_mut<F, R>(self, func: F) -> Self where Self: BorrowMut<T>, F: FnOnce(&mut T) -> R,

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where Self: BorrowMut<T>, F: FnOnce(&mut T) -> R,

impl<C> SecretKey<C> where
C: Curve + SecretValue,
C::Secret: Clone + Zeroize,
FieldBytes<C>: From<C::Secret>,

pub fn random(rng: impl CryptoRng + RngCore) -> Self where
C: ProjectiveArithmetic + SecretValue<Secret = NonZeroScalar<C>>,
FieldBytes<C>: From<Scalar<C>> + for<'a> From<&'a Scalar<C>>,
Scalar<C>: PrimeField<Repr = FieldBytes<C>> + Zeroize,

pub fn from_bytes(bytes: impl AsRef<[u8 ]>) -> Result<Self, Error>

pub fn secret_scalar(&self) -> &NonZeroScalar<C> where
C: ProjectiveArithmetic + SecretValue<Secret = NonZeroScalar<C>>,
FieldBytes<C>: From<Scalar<C>> + for<'a> From<&'a Scalar<C>>,
Scalar<C>: PrimeField<Repr = FieldBytes<C>> + Zeroize,

impl<C: Clone + Curve + SecretValue> Clone for SecretKey<C> where
C::Secret: Clone,

impl<C> Debug for SecretKey<C> where
C: Curve + SecretValue,

impl<C> Drop for SecretKey<C> where
C: Curve + SecretValue,

impl<C> TryFrom<&'_ [u8 ]> for SecretKey<C> where
C: Curve + SecretValue,
C::Secret: Clone + Zeroize,
FieldBytes<C>: From<C::Secret>,

fn try_from(slice: &[u8 ]) -> Result<Self, Error>

impl<C> RefUnwindSafe for SecretKey<C> where
<C as SecretValue>::Secret: RefUnwindSafe,

impl<C> Send for SecretKey<C> where
<C as SecretValue>::Secret: Send,

impl<C> Sync for SecretKey<C> where
<C as SecretValue>::Secret: Sync,

impl<C> Unpin for SecretKey<C> where
<C as SecretValue>::Secret: Unpin,

impl<C> UnwindSafe for SecretKey<C> where
<C as SecretValue>::Secret: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn conv<T>(self) -> T where
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

impl<T, U> Into<U> for T where
U: From<T>,

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,

fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,

fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

impl<T, U> TapAsRef<U> for T where
U: ?Sized,

fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

impl<T, U> TapBorrow<U> for T where
U: ?Sized,

fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,