Struct SignedEnvelope 

pub struct SignedEnvelope {
    pub d: String,
    pub f: String,
    pub sig: String,
    pub m: SignedEnvelopeMode,
    pub e: Option<u64>,
    pub v: u8,
}

A sealed, HMAC-authenticated envelope.

Carries data, its SHA-256 fingerprint, and an HMAC-SHA256 signature over the fingerprint. Unwrapping requires the same key used to sign.

Example

use entrouter_universal::SignedEnvelope;

let env = SignedEnvelope::wrap("secret", "my-key");
assert_eq!(env.unwrap_verified("my-key").unwrap(), "secret");
assert!(env.unwrap_verified("wrong-key").is_err());

Fields

d: String

Encoded data

f: String

SHA-256 fingerprint of the original raw input

sig: String

HMAC-SHA256 signature (hex) over the fingerprint

m: SignedEnvelopeMode

Encoding mode

e: Option<u64>

Optional expiry as Unix timestamp (seconds)

v: u8

Version

Implementations

impl SignedEnvelope

pub fn wrap(input: &str, key: &str) -> Self

Standard Base64 wrap with HMAC signature.

pub fn wrap_url_safe(input: &str, key: &str) -> Self

URL-safe Base64 wrap with HMAC signature.

pub fn wrap_compressed(input: &str, key: &str) -> Result<Self, UniversalError>

Compressed wrap with HMAC signature.

pub fn wrap_with_ttl(input: &str, key: &str, ttl_secs: u64) -> Self

TTL wrap with HMAC signature.

pub fn unwrap_verified(&self, key: &str) -> Result<String, UniversalError>

Verify HMAC signature, then decode and verify integrity.

pub fn to_json(&self) -> Result<String, UniversalError>

Serialize to JSON.

pub fn from_json(s: &str) -> Result<Self, UniversalError>

Deserialize from JSON.

Trait Implementations

impl Clone for SignedEnvelope

fn clone(&self) -> SignedEnvelope

Returns a duplicate 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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignedEnvelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SignedEnvelope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.