Struct SignedEnvelope

pub struct SignedEnvelope { /* private fields */ }

A signed envelope contains an arbitrary byte string payload, a signature of the payload, and the public key that can be used to verify the signature.

For more details see libp2p RFC0002: https://github.com/libp2p/specs/blob/master/RFC/0002-signed-envelopes.md

Implementations

impl SignedEnvelope

pub fn new( key: &Keypair, domain_separation: String, payload_type: Vec<u8>, payload: Vec<u8>, ) -> Result<SignedEnvelope, SigningError>

Constructs a new SignedEnvelope.

pub fn verify(&self, domain_separation: String) -> bool

Verify this SignedEnvelope against the provided domain-separation string.

pub fn payload_and_signing_key( &self, domain_separation: String, expected_payload_type: &[u8], ) -> Result<(&[u8], &PublicKey), ReadPayloadError>

Extract the payload and signing key of this SignedEnvelope.

You must provide the correct domain-separation string and expected payload type in order to get the payload. This guards against accidental mis-use of the payload where the signature was created for a different purpose or payload type.

It is the caller’s responsibility to check that the signing key is what is expected. For example, checking that the signing key is from a certain peer.

pub fn into_protobuf_encoding(self) -> Vec<u8>

Encode this SignedEnvelope using the protobuf encoding specified in the RFC.

pub fn from_protobuf_encoding( bytes: &[u8], ) -> Result<SignedEnvelope, DecodingError>

Decode a SignedEnvelope using the protobuf encoding specified in the RFC.

Trait Implementations

impl Clone for SignedEnvelope

fn clone(&self) -> SignedEnvelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignedEnvelope

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

Formats the value using the given formatter.

impl PartialEq for SignedEnvelope

fn eq(&self, other: &SignedEnvelope) -> 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 Eq for SignedEnvelope

impl StructuralPartialEq for SignedEnvelope