Struct sequoia_openpgp::crypto::mpi::ProtectedMPI

pub struct ProtectedMPI { /* fields omitted */ }

Holds a single MPI containing secrets.

The memory will be cleared when the object is dropped. Used by SecretKeyMaterial to protect secret keys.

Implementations

impl ProtectedMPI

pub fn new_point(x: &[u8], y: &[u8], field_bits: usize) -> Self

Creates new MPI encoding an uncompressed EC point.

Encodes the given point on a elliptic curve (see Section 6 of RFC 6637 for details). This is used to encode public keys and ciphertexts for the NIST curves (NistP256, NistP384, and NistP521).

pub fn new_compressed_point(x: &[u8]) -> Self

Creates new MPI encoding a compressed EC point using native encoding.

Encodes the given point on a elliptic curve (see Section 13.2 of RFC4880bis for details). This is used to encode public keys and ciphertexts for the Bernstein curves (currently X25519).

pub fn bits(&self) -> usize

Returns the length of the MPI in bits.

Leading zero-bits are not included in the returned size.

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

Returns the value of this MPI.

Note that due to stripping of zero-bytes, the returned value may be shorter than expected.

pub fn decode_point(&self, curve: &Curve) -> Result<(&[u8], &[u8])>

Decodes an EC point encoded as MPI.

Decodes the MPI into a point on an elliptic curve (see Section 6 of RFC 6637 and Section 13.2 of RFC4880bis for details). If the point is not compressed, the function returns (x, y). If it is compressed, y will be empty.

Errors

Returns Error::UnsupportedEllipticCurve if the curve is not supported, Error::MalformedMPI if the point is formatted incorrectly.

Trait Implementations

impl Clone for ProtectedMPI

fn clone(&self) -> ProtectedMPI

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProtectedMPI

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

Formats the value using the given formatter.

impl Eq for ProtectedMPI

impl From<MPI> for ProtectedMPI

fn from(m: MPI) -> Self

Performs the conversion.

impl From<Protected> for ProtectedMPI

fn from(m: Protected) -> Self

Performs the conversion.

impl From<Vec<u8>> for ProtectedMPI

fn from(m: Vec<u8>) -> Self

Performs the conversion.

impl Hash for ProtectedMPI

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Marshal for ProtectedMPI

fn serialize(&self, w: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl MarshalInto for ProtectedMPI

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

fn to_vec(&self) -> Result<Vec<u8>>

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

fn export_to_vec(&self) -> Result<Vec<u8>>

Exports to a vector.

impl Ord for ProtectedMPI

fn cmp(&self, other: &ProtectedMPI) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ProtectedMPI> for ProtectedMPI

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ProtectedMPI> for ProtectedMPI

fn partial_cmp(&self, other: &ProtectedMPI) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.