Struct MPI

pub struct MPI { /* private fields */ }

A Multiprecision Integer.

Implementations

impl MPI

pub fn new(value: &[u8]) -> Self

Creates a new MPI.

This function takes care of removing leading zeros.

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 an 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 an 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 zero() -> Self

Creates a new MPI representing zero.

pub fn is_zero(&self) -> bool

Tests whether the MPI represents zero.

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 value_padded(&self, to: usize) -> Result<Cow<'_, [u8]>>

Returns the value of this MPI zero-padded to the given length.

MPI-encoding strips leading zero-bytes. This function adds them back, if necessary. If the size exceeds to, an error is returned.

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, Error::InvalidOperation if the given curve is operating on native octet strings.

Trait Implementations

impl Clone for MPI

fn clone(&self) -> MPI

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MPI

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

Formats the value using the given formatter.

impl From<Box<[u8]>> for MPI

fn from(v: Box<[u8]>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for MPI

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

Converts to this type from the input type.

impl Hash for MPI

fn hash(&self, hash: &mut Context) -> Result<()>

Updates the given hash with this object.

impl Hash for MPI

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Marshal for MPI

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 MPI

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 MPI

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> Parse<'a, MPI> for MPI

fn from_buffered_reader<R>(reader: R) -> Result<Self>

where R: BufferedReader<Cookie> + 'a,

Reads from the given buffered reader.

fn from_reader<R: 'a + Read + Send + Sync>(reader: R) -> Result<T>

Reads from the given reader.

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>

Reads from the given file.

fn from_bytes<D: AsRef<[u8]> + ?Sized + Send + Sync>(data: &'a D) -> Result<T>

Reads from the given slice.

impl PartialEq for MPI

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

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

const 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 PartialOrd for MPI

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for MPI