MitmProxy

Struct MitmProxy 

Source
pub struct MitmProxy<T, U>
where T: Layer<ThirdWheel, Service = U> + Sync + Send + 'static + Clone, U: Service<Request<Body>, Response = <ThirdWheel as Service<Request<Body>>>::Response> + Sync + Send + Clone + 'static, <U as Service<Request<Body>>>::Future: Send, <U as Service<Request<Body>>>::Error: Error + Send + Sync + 'static,
{ /* private fields */ }
Expand description

The main struct of the crate. Start here.

This struct is the workhorse and main interface for third-wheel. By passing in a Mitm layer this can be customized to perform any required behavior on HTTP requests and responses. Use the mitm_layer function to easily construct services to pass in to this struct.

Implementations§

Source§

impl<T, U> MitmProxy<T, U>
where T: Layer<ThirdWheel, Service = U> + Sync + Send + 'static + Clone, U: Service<Request<Body>, Response = <ThirdWheel as Service<Request<Body>>>::Response> + Sync + Send + Clone + 'static, <U as Service<Request<Body>>>::Future: Send, <U as Service<Request<Body>>>::Error: Error + Send + Sync + 'static,

Source

pub fn builder( mitm_layer: T, ca: CertificateAuthority, ) -> MitmProxyBuilder<T, U>

Source

pub fn bind( self, addr: SocketAddr, ) -> (SocketAddr, impl Future<Output = Result<(), Error>>)

Bind to a socket address. Returns the address actually bound to, and the future to be executed that will run the server.

Source

pub fn bind_with_graceful_shutdown<F>( self, addr: SocketAddr, signal: F, ) -> (SocketAddr, impl Future<Output = Result<(), Error>>)
where F: Future<Output = ()>,

The same as bind except in the event that signal completes the proxy will gracefully terminate itself.

let trivial_mitm = MitmProxy::builder(
    mitm_layer(|req: Request<Body>, mut third_wheel: ThirdWheel| third_wheel.call(req)),
    third_wheel_ca,
).build();
let (third_wheel_killer, receiver) = tokio::sync::oneshot::channel();
let (third_wheel_address, mitm_fut) = trivial_mitm
    .bind_with_graceful_shutdown("127.0.0.1:0".parse().unwrap(), async {
        receiver.await.ok().unwrap()
    });
tokio::spawn(mitm_fut);
// Wait for some stuff to happen
third_wheel_killer.send(()).unwrap();
// This kills the proxy

Auto Trait Implementations§

§

impl<T, U> Freeze for MitmProxy<T, U>
where T: Freeze,

§

impl<T, U> RefUnwindSafe for MitmProxy<T, U>
where T: RefUnwindSafe,

§

impl<T, U> Send for MitmProxy<T, U>

§

impl<T, U> Sync for MitmProxy<T, U>

§

impl<T, U> Unpin for MitmProxy<T, U>
where T: Unpin,

§

impl<T, U> UnwindSafe for MitmProxy<T, U>
where T: UnwindSafe,

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
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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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, 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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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