http-ip 0.1.8

Utilities to determine HTTP client IP
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! Axum 0.8 extension module
//!
//! Provides [ClientIp](struct.ClientIp.html) to extract client's ip using filters

use core::{fmt, marker};
use core::net::{IpAddr, SocketAddr};

pub use axum08::*;
use axum08::extract::FromRequestParts;

use crate::filter::Filter;
use crate::http::HeaderMapClientIp;

#[repr(transparent)]
#[derive(Copy, Clone)]
///ClientIp extractor
///
///Provided `F` parameter can be used to customize filter selection. Use `nil` type to only extract rightmost IP.
///
///Defaults to `axum::extract::ConnectInfo` if corresponding header cannot provide ip
///
///## Usage
///
///```rust
///use std::net::{IpAddr, Ipv4Addr};
///
///use http_ip::axum08::{
///    routing::get,
///    handler::Handler,
///    Router,
///};
///use http_ip::axum08::ClientIp;
///
///#[derive(Clone)]
///struct MyState {
///    local_ip: IpAddr,
///}
///
/////Alternatively use derive macro
///impl http_ip::axum08::extract::FromRef<MyState> for IpAddr {
///    #[inline(always)]
///    fn from_ref(state: &MyState) -> Self {
///        state.local_ip
///    }
///}
///
///async fn create_user(client_ip: ClientIp<IpAddr>) {
///    // Do whatever you want with client_ip now
///}
///
///let state = MyState {
///    local_ip: IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1))
///};
///let app: Router<MyState> = Router::new().route("/users", get(create_user)).with_state(state);
///```
pub struct ClientIp<F: Filter> {
    ///Underlying IP addr if available
    pub inner: Option<IpAddr>,
    _filter: marker::PhantomData<F>
}

impl<F: Filter> ClientIp<F> {
    #[inline(always)]
    fn new(inner: Option<IpAddr>) -> Self {
        Self {
            inner,
            _filter: marker::PhantomData,
        }
    }

    #[inline(always)]
    ///Access underlying value
    pub fn into_inner(self) -> Option<IpAddr> {
        self.inner
    }
}

impl<F: Filter> fmt::Debug for ClientIp<F> {
    #[inline(always)]
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt::Debug::fmt(&self.inner, fmt)
    }
}

impl<S: Send + Sync, F: Send + Sync + Filter + Clone + extract::FromRef<S>> FromRequestParts<S> for ClientIp<F> {
    type Rejection = core::convert::Infallible;

    async fn from_request_parts(parts: &mut http::request::Parts, state: &S) -> Result<Self, Self::Rejection> {
        let filter: F = extract::FromRef::from_ref(state);
        let ip = if let Some(ip) = parts.headers.extract_filtered_forwarded_ip(&filter) {
            Some(ip)
        } else if let Ok(addr) = extract::ConnectInfo::<SocketAddr>::from_request_parts(parts, state).await {
            Some(addr.ip())
        } else {
            None
        };
        Ok(ClientIp::new(ip))
    }
}