proxyapi 0.4.4

Core library for the Proxelar MITM proxy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

//! `proxyapi` — core library for the Proxelar MITM proxy.
//!
//! Provides HTTP/HTTPS forward and reverse proxy functionality with
//! request/response interception via the [`HttpHandler`] trait.

#![forbid(unsafe_code)]

pub mod body;
pub mod ca;
pub mod error;
pub mod event;
pub(crate) mod handler;
pub mod intercept;
pub mod proxy;
mod rewind;
#[cfg(feature = "scripting")]
pub mod scripting;

use body::ProxyBody;
use hyper::{Request, Response};
use std::net::SocketAddr;

pub use error::Error;
pub use event::ProxyEvent;
pub use handler::{CapturingHandler, DEFAULT_BODY_CAPTURE_LIMIT};
pub use intercept::{InterceptConfig, InterceptDecision};
pub use proxy::{Proxy, ProxyConfig, ProxyMode};

/// Returned by [`HttpHandler::handle_request`] to either forward or short-circuit.
pub enum RequestOrResponse {
    Request(Request<ProxyBody>),
    Response(Response<ProxyBody>),
}

/// Metadata about the incoming connection.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct HttpContext {
    pub remote_addr: SocketAddr,
}

/// Trait for intercepting and modifying proxied HTTP traffic.
///
/// Implementations must be `Clone` because the proxy clones the handler
/// for each connection/request pair.
#[async_trait::async_trait]
pub trait HttpHandler: Clone + Send + Sync + 'static {
    async fn handle_request(
        &mut self,
        ctx: &HttpContext,
        req: Request<hyper::body::Incoming>,
    ) -> RequestOrResponse;

    async fn handle_response(
        &mut self,
        ctx: &HttpContext,
        res: Response<hyper::body::Incoming>,
    ) -> Response<ProxyBody>;
}