Struct EstablishIntro

pub struct EstablishIntro { /* private fields */ }

Available on crate feature hs only.

A hidden services establishes a new introduction point, by sending an EstablishIntro message.

This may represent either an outbound body that we’re sending, or a decoded body that we’re receiving.

Usage

This type is a good choice for handling an incoming EstablishIntro message on a Relay, but not for generating an outgoing EstablishIntro message.

Onion services should not construct this message object; instead, they should construct an EstablishIntroDetails, and then call its sign_and_encode method.

Implementations

impl EstablishIntro

pub fn from_parts_for_test( body: EstablishIntroDetails, mac: CtByteArray<HS_MAC_LEN>, signature: Signature, ) -> Self

Available on crate feature testing only.

Construct a new EstablishIntro message from its constituent parts.

Limitations

This is really only useful for testing; it will construct a version of the object whose signatures will probably never check as valid.

Panics

Panics if the body’s public key is not a valid ed25519 public key

pub fn check_and_unwrap<'a>( self, mac_key: impl Into<HsMacKey<'a>>, ) -> Result<EstablishIntroDetails, EstablishIntroSigError>

Check whether this EstablishIntro message is well-signed (with its included key), and well authenticated with the provided MAC key.

On success, return the EstablishIntroDetails describing how to function as an introduction point for this service. On failure, return an error.

pub fn dangerously_unwrap(self) -> EstablishIntroDetails

Consume this EstablishIntro message and return its body.

This is a “dangerous” function because it does not check correctness for the signature or the MAC.

Trait Implementations

impl Body for EstablishIntro

fn decode_from_reader(r: &mut Reader<'_>) -> Result<Self>

Decode a relay cell body from a provided reader.

fn encode_onto<W: Writer + ?Sized>(self, w: &mut W) -> EncodeResult<()>

Encode the body of this cell into the end of a writer.

impl Clone for EstablishIntro

fn clone(&self) -> EstablishIntro

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EstablishIntro

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

Formats the value using the given formatter.

impl From<EstablishIntro> for AnyRelayMsg

fn from(m: EstablishIntro) -> AnyRelayMsg

Converts to this type from the input type.

impl HasMemoryCostStructural for EstablishIntro

fn indirect_memory_cost(&self, et: EnabledToken) -> usize

Memory cost of data stored out-of-line

impl RelayMsg for EstablishIntro

fn cmd(&self) -> RelayCmd

Return the stream command associated with this message.

fn encode_onto<W: Writer + ?Sized>(self, w: &mut W) -> EncodeResult<()>

Encode the body of this message, not including command or length

fn decode_from_reader(cmd: RelayCmd, r: &mut Reader<'_>) -> Result<Self>

Extract the body of a message with command cmd from reader r.

impl TryFrom<AnyRelayMsg> for EstablishIntro

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: AnyRelayMsg) -> Result<EstablishIntro>

Performs the conversion.