Struct HsClientDescEncKey

pub struct HsClientDescEncKey(/* private fields */);

Client service discovery key, used for onion descriptor decryption. (KP_hsc_desc_enc)

Any client who knows the secret key corresponding to this key can decrypt the inner layer of the onion service descriptor.

The Display and FromStr representation of keys of this type is descriptor:x25519:<base32-encoded-x25519-public-key>. Note: the base32 encoding of the key is unpadded and case-insensitive, for compatibility with the format accepted by C Tor. See also CLIENT AUTHORIZATION in tor(1).

Example

// A client service discovery key for connecting
// to a service running in restricted discovery mode,
// with an uppercase base32 encoding for the key material.
const CLIENT_KEY1: &str = "descriptor:x25519:ZPRRMIV6DV6SJFL7SFBSVLJ5VUNPGCDFEVZ7M23LTLVTCCXJQBKA";
// An identical key using lowercase base32 encoding for the key material.
const CLIENT_KEY2: &str = "descriptor:x25519:zprrmiv6dv6sjfl7sfbsvlj5vunpgcdfevz7m23ltlvtccxjqbka";

// Both key encodings parse successfully
let key1 = HsClientDescEncKey::from_str(CLIENT_KEY1).unwrap();
let key2 = HsClientDescEncKey::from_str(CLIENT_KEY2).unwrap();
// The keys are identical
assert_eq!(key1, key2);

Methods from Deref<Target = PublicKey>

pub fn as_bytes(&self) -> &[u8; 32]

Return this public key as a reference to an array of bytes.

pub fn to_bytes(&self) -> [u8; 32]

Return this public key as an array of bytes.

Trait Implementations

impl AsRef<PublicKey> for HsClientDescEncKey

fn as_ref(&self) -> &PublicKey

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for HsClientDescEncKey

fn clone(&self) -> HsClientDescEncKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HsClientDescEncKey

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

Formats the value using the given formatter.

impl Deref for HsClientDescEncKey

type Target = PublicKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for HsClientDescEncKey

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

Formats the value using the given formatter.

impl From<&HsClientDescEncKeypair> for HsClientDescEncKey

fn from(ks: &HsClientDescEncKeypair) -> Self

Converts to this type from the input type.

impl From<&HsClientDescEncSecretKey> for HsClientDescEncKey

fn from(ks: &HsClientDescEncSecretKey) -> Self

Converts to this type from the input type.

impl From<HsClientDescEncKey> for PublicKey

fn from(value: HsClientDescEncKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for HsClientDescEncKey

fn from(value: PublicKey) -> Self

Converts to this type from the input type.

impl FromStr for HsClientDescEncKey

type Err = HsClientDescEncKeyParseError

The associated error which can be returned from parsing.

fn from_str(key: &str) -> Result<Self, HsClientDescEncKeyParseError>

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

impl PartialEq for HsClientDescEncKey

fn eq(&self, other: &Self) -> 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 HsClientDescEncKey