Struct relay_auth::SecretKey

pub struct SecretKey { /* private fields */ }

Represents the secret key of an Relay.

Secret keys are based on ed25519 but this should be considered an implementation detail for now. We only ever represent public keys on the wire as opaque ascii encoded strings of arbitrary format or length.

Implementations

impl SecretKey

pub fn sign(&self, data: &[u8]) -> String

Signs some data with the secret key and returns the signature.

This is will sign with the default header.

pub fn sign_with_header(&self, data: &[u8], header: &SignatureHeader) -> String

Signs some data with the secret key and a specific header and then returns the signature.

The default behavior is to attach the timestamp in the header to the signature so that old signatures on verification can be rejected.

pub fn pack<S: Serialize>(&self, data: S) -> (Vec<u8>, String)

Packs some serializable data into JSON and signs it with the default header.

pub fn pack_with_header<S: Serialize>( &self, data: S, header: &SignatureHeader, ) -> (Vec<u8>, String)

Packs some serializable data into JSON and signs it with the specified header.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretKey

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

Formats the value using the given formatter.

impl FromStr for SecretKey

type Err = KeyParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SecretKey, KeyParseError>

Parses a string s to return a value of this type.

impl PartialEq for SecretKey

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SecretKey