Enum gosling::context::ContextEvent

source · 
pub enum ContextEvent {

Show 21 variants    TorBootstrapStatusReceived {
        progress: u32,
        tag: String,
        summary: String,
    },
    TorBootstrapCompleted,
    TorLogReceived {
        line: String,
    },
    IdentityClientChallengeReceived {
        handle: HandshakeHandle,
        endpoint_challenge: Document,
    },
    IdentityClientHandshakeCompleted {
        handle: HandshakeHandle,
        identity_service_id: V3OnionServiceId,
        endpoint_service_id: V3OnionServiceId,
        endpoint_name: String,
        client_auth_private_key: X25519PrivateKey,
    },
    IdentityClientHandshakeFailed {
        handle: HandshakeHandle,
        reason: Error,
    },
    IdentityServerPublished,
    IdentityServerHandshakeStarted {
        handle: HandshakeHandle,
    },
    IdentityServerEndpointRequestReceived {
        handle: HandshakeHandle,
        client_service_id: V3OnionServiceId,
        requested_endpoint: String,
    },
    IdentityServerChallengeResponseReceived {
        handle: HandshakeHandle,
        challenge_response: Document,
    },
    IdentityServerHandshakeCompleted {
        handle: HandshakeHandle,
        endpoint_private_key: Ed25519PrivateKey,
        endpoint_name: String,
        client_service_id: V3OnionServiceId,
        client_auth_public_key: X25519PublicKey,
    },
    IdentityServerHandshakeRejected {
        handle: HandshakeHandle,
        client_allowed: bool,
        client_requested_endpoint_valid: bool,
        client_proof_signature_valid: bool,
        client_auth_signature_valid: bool,
        challenge_response_valid: bool,
    },
    IdentityServerHandshakeFailed {
        handle: HandshakeHandle,
        reason: Error,
    },
    EndpointClientHandshakeCompleted {
        handle: HandshakeHandle,
        endpoint_service_id: V3OnionServiceId,
        channel_name: String,
        stream: TcpStream,
    },
    EndpointClientHandshakeFailed {
        handle: HandshakeHandle,
        reason: Error,
    },
    EndpointServerPublished {
        endpoint_service_id: V3OnionServiceId,
        endpoint_name: String,
    },
    EndpointServerHandshakeStarted {
        handle: HandshakeHandle,
    },
    EndpointServerChannelRequestReceived {
        handle: HandshakeHandle,
        client_service_id: V3OnionServiceId,
        requested_channel: String,
    },
    EndpointServerHandshakeCompleted {
        handle: HandshakeHandle,
        endpoint_service_id: V3OnionServiceId,
        client_service_id: V3OnionServiceId,
        channel_name: String,
        stream: TcpStream,
    },
    EndpointServerHandshakeRejected {
        handle: HandshakeHandle,
        client_allowed: bool,
        client_requested_channel_valid: bool,
        client_proof_signature_valid: bool,
    },
    EndpointServerHandshakeFailed {
        handle: HandshakeHandle,
        reason: Error,
    },

}
Expand description

Events to signal completion of asynchronous Context operations

Variants§

§

TorBootstrapStatusReceived

Tor bootstrap progress

Fields

§progress: u32

Bootstrap percent compeletion

§tag: String

A short string indicating the completed bootstrap step

§summary: String

A longer human-readable summary of the bootstrap progress

§

TorBootstrapCompleted

Tor bootstrap completed

§

TorLogReceived

Human-readable logs from the Context’s TorProvider

Fields

§line: String

Human-readable debug log

§

IdentityClientChallengeReceived

An identity client has received a challenge request from an identy server

To continue the handshake, the client must call Context::identity_client_handle_challenge_received()

Fields

§handle: HandshakeHandle

The handle of the in-progress handshake

§endpoint_challenge: Document

An application specific challenge object used by the identity client to create a challenge response object

§

IdentityClientHandshakeCompleted

An identity client has successfully completed an identity handshake and may now access the requested endpoint server.

Fields

§handle: HandshakeHandle

The handle of the completed handshake

§identity_service_id: V3OnionServiceId

The onion-service service-id of the identity server the client has completed an identity handshake with

§endpoint_service_id: V3OnionServiceId

The onion-service service-id of the requested endpoint server

§endpoint_name: String

The ASCII-encoded name of the requested endpoint server

§client_auth_private_key: X25519PrivateKey

The private x25519 client-auth key required to access the requested endpoint server

§

IdentityClientHandshakeFailed

An incoming identit handshake has failed

Fields

§handle: HandshakeHandle

The handle of the failed handshake

§reason: Error

The failure reason

§

IdentityServerPublished

The identity server’s onion-service has been published and may be reachable by identity clients

§

IdentityServerHandshakeStarted

An identity server has received an incoming connection and the handshake is ready to begin

Fields

§handle: HandshakeHandle

The handle of the new handshake

§

IdentityServerEndpointRequestReceived

An identity server has received a request for an endpoint from an identity client.

To continue the handshake, the server must call Context::identity_server_handle_endpoint_request_received()

Fields

§handle: HandshakeHandle

The handle of the in-progress handshake

§client_service_id: V3OnionServiceId

The alleged onion-service service-id of the connecting client

§requested_endpoint: String

The ASCII-encoded name of the requested endpoint server

§

IdentityServerChallengeResponseReceived

An identity server has received a challenge response from an identity client.

To continue the handshake, the server must call Context::identity_server_handle_challenge_response_received()

Fields

§handle: HandshakeHandle

The handle of the in-progress handshake

§challenge_response: Document

An application specific challenge response object created by the identity client in response to the identity server’s challenge object

§

IdentityServerHandshakeCompleted

An identity server’s handshake has completed.

Fields

§handle: HandshakeHandle

The handle of the completed handshake

§endpoint_private_key: Ed25519PrivateKey

The ed25519 private key of requested endpoint server

§endpoint_name: String

The ASCII-encoded name of the requested endpoint server

§client_service_id: V3OnionServiceId

The onion-service service-id of the authenticated client

§client_auth_public_key: X25519PublicKey

The public x25519 client-auth key used to encrypt the endpoint server’s onion-service descriptor

§

IdentityServerHandshakeRejected

An identity server has rejected an identity client’s endpoint-request.

There are multiple potential reasons why a handshake may be rejected and this event provides a breakdown on which part(s) failed specifically.

Fields

§handle: HandshakeHandle

The handle of the rejected handshake

§client_allowed: bool

false if the client was rejected based on their onion-service service-id

§client_requested_endpoint_valid: bool

false if the requested endpoint name was not understood by the server

§client_proof_signature_valid: bool

false if the client failed its authentication proof (i.e. potential attempt at identity client impersonation)

§client_auth_signature_valid: bool

false if the client fails its x25519 key-ownership proof (i.e. potential attempt at use an x25519 public key not owned by the client)

§challenge_response_valid: bool

false if the client’s challenge response was not suitable

§

IdentityServerHandshakeFailed

An incoming identity handshake has failed.

Fields

§handle: HandshakeHandle

The handle of the failed handshake

§reason: Error

The failure reason

§

EndpointClientHandshakeCompleted

An endpoint client has successfully completed an endpoint handshake and may now communicate freely with the endpoint server.

Fields

§handle: HandshakeHandle

The handle of the completed handshake

§endpoint_service_id: V3OnionServiceId

The onion-service service-id of the endpoint server the client has connected to

§channel_name: String

The ASCII-encoded name of the requested channel on the endpoint server

§stream: TcpStream

The resulting TCP connection to the endpoint server

§

EndpointClientHandshakeFailed

An outgoing endpoint handshake has failed.

Fields

§handle: HandshakeHandle

The handle of the failed handshake

§reason: Error

The failure reason

§

EndpointServerPublished

The endpoint server’s onion-service has been published and may be reachable by endpoint clients.

Fields

§endpoint_service_id: V3OnionServiceId

The onion-service service-id of the published endpoint server

§endpoint_name: String

The name of the published endpoint server

§

EndpointServerHandshakeStarted

An endpoint server has received an incoming connection and the handshake is ready to begin.

Fields

§handle: HandshakeHandle

The handle of the new handshake

§

EndpointServerChannelRequestReceived

An endpoint server has received a request for a channel from an endpoint client.

To continue the handshake, the server must call Context::endpoint_server_handle_channel_request_received()

Fields

§handle: HandshakeHandle

The handle of the in-progress handshake

§client_service_id: V3OnionServiceId

The alleged onion-service service-id of the connecting client

§requested_channel: String

The ASCII-encoded name of the requested channel

§

EndpointServerHandshakeCompleted

An endpoint server’s handshake has completed

Fields

§handle: HandshakeHandle

The handle of the completed handshake

§endpoint_service_id: V3OnionServiceId

The onion-service service-id of the endpoint server which an endpoint client has connected to

§client_service_id: V3OnionServiceId

The onion-service service-id of the connected client

§channel_name: String

The ASCII-encoded name of the client’s requested channel

§stream: TcpStream

The resulting TCP connection to tohe endpoint clientt

§

EndpointServerHandshakeRejected

An endpoint server has rejected an endpoint client’s channel request.

There are multiple potential reasons why a handshake may be rejected and this event provides a breakdown on which part(s) failed specifically.

Fields

§handle: HandshakeHandle

The handle of the rejected handshake

§client_allowed: bool

false if the client was rejected based on their onion-service service-id

§client_requested_channel_valid: bool

false if the requested channel name was not understood by the server

§client_proof_signature_valid: bool

false if the client failed its authentication proof (i.e. potential attempt at endpoint client impersonation)

§

EndpointServerHandshakeFailed

An incoming endpoint handshake has failed.

Fields

§handle: HandshakeHandle

The handle of the failed handshake

§reason: Error

The failure reason

Trait Implementations§

source§

impl Debug for ContextEvent

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

§

type Error = <Target as OctetsFrom<Source>>::Error

§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T