      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
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218

    use http::header::{self, HeaderName};
    use server::Request;

    const X_FORWARDED_FOR: &[u8] = b"x-forwarded-for";
    const X_FORWARDED_HOST: &[u8] = b"x-forwarded-host";
    const X_FORWARDED_PROTO: &[u8] = b"x-forwarded-proto";

    /// `HttpRequest` connection information
    #[derive(Clone, Default)]
    pub struct ConnectionInfo {
        scheme: String,
        host: String,
        remote: Option<String>,
        peer: Option<String>,
    }

    impl ConnectionInfo {
        /// Create *ConnectionInfo* instance for a request.
        #[cfg_attr(feature = "cargo-clippy", allow(cyclomatic_complexity))]
        pub fn update(&mut self, req: &Request) {
            let mut host = None;
            let mut scheme = None;
            let mut remote = None;
            let mut peer = None;

            // load forwarded header
            for hdr in req.headers().get_all(header::FORWARDED) {
                if let Ok(val) = hdr.to_str() {
                    for pair in val.split(';') {
                        for el in pair.split(',') {
                            let mut items = el.trim().splitn(2, '=');
                            if let Some(name) = items.next() {
                                if let Some(val) = items.next() {
                                    match &name.to_lowercase() as &str {
                                        "for" => if remote.is_none() {
                                            remote = Some(val.trim());
                                        },
                                        "proto" => if scheme.is_none() {
                                            scheme = Some(val.trim());
                                        },
                                        "host" => if host.is_none() {
                                            host = Some(val.trim());
                                        },
                                        _ => (),
                                    }
                                }
                            }
                        }
                    }
                }
            }

            // scheme
            if scheme.is_none() {
                if let Some(h) = req
                    .headers()
                    .get(HeaderName::from_lowercase(X_FORWARDED_PROTO).unwrap())
                {
                    if let Ok(h) = h.to_str() {
                        scheme = h.split(',').next().map(|v| v.trim());
                    }
                }
                if scheme.is_none() {
                    scheme = req.uri().scheme_part().map(|a| a.as_str());
                    if scheme.is_none() && req.server_settings().secure() {
                        scheme = Some("https")
                    }
                }
            }

            // host
            if host.is_none() {
                if let Some(h) = req
                    .headers()
                    .get(HeaderName::from_lowercase(X_FORWARDED_HOST).unwrap())
                {
                    if let Ok(h) = h.to_str() {
                        host = h.split(',').next().map(|v| v.trim());
                    }
                }
                if host.is_none() {
                    if let Some(h) = req.headers().get(header::HOST) {
                        host = h.to_str().ok();
                    }
                    if host.is_none() {
                        host = req.uri().authority_part().map(|a| a.as_str());
                        if host.is_none() {
                            host = Some(req.server_settings().host());
                        }
                    }
                }
            }

            // remote addr
            if remote.is_none() {
                if let Some(h) = req
                    .headers()
                    .get(HeaderName::from_lowercase(X_FORWARDED_FOR).unwrap())
                {
                    if let Ok(h) = h.to_str() {
                        remote = h.split(',').next().map(|v| v.trim());
                    }
                }
                if remote.is_none() {
                    // get peeraddr from socketaddr
                    peer = req.peer_addr().map(|addr| format!("{}", addr));
                }
            }

            self.scheme = scheme.unwrap_or("http").to_owned();
            self.host = host.unwrap_or("localhost").to_owned();
            self.remote = remote.map(|s| s.to_owned());
            self.peer = peer;
        }

        /// Scheme of the request.
        ///
        /// Scheme is resolved through the following headers, in this order:
        ///
        /// - Forwarded
        /// - X-Forwarded-Proto
        /// - Uri
        #[inline]
        pub fn scheme(&self) -> &str {
            &self.scheme
        }

        /// Hostname of the request.
        ///
        /// Hostname is resolved through the following headers, in this order:
        ///
        /// - Forwarded
        /// - X-Forwarded-Host
        /// - Host
        /// - Uri
        /// - Server hostname
        pub fn host(&self) -> &str {
            &self.host
        }

        /// Remote IP of client initiated HTTP request.
        ///
        /// The IP is resolved through the following headers, in this order:
        ///
        /// - Forwarded
        /// - X-Forwarded-For
        /// - peer name of opened socket
        #[inline]
        pub fn remote(&self) -> Option<&str> {
            if let Some(ref r) = self.remote {
                Some(r)
            } else if let Some(ref peer) = self.peer {
                Some(peer)
            } else {
                None
            }
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;
        use test::TestRequest;

        #[test]
        fn test_forwarded() {
            let req = TestRequest::default().request();
            let mut info = ConnectionInfo::default();
            info.update(&req);
            assert_eq!(info.scheme(), "http");
            assert_eq!(info.host(), "localhost:8080");

            let req = TestRequest::default()
                .header(
                    header::FORWARDED,
                    "for=192.0.2.60; proto=https; by=203.0.113.43; host=rust-lang.org",
                )
                .request();

            let mut info = ConnectionInfo::default();
            info.update(&req);
            assert_eq!(info.scheme(), "https");
            assert_eq!(info.host(), "rust-lang.org");
            assert_eq!(info.remote(), Some("192.0.2.60"));

            let req = TestRequest::default()
                .header(header::HOST, "rust-lang.org")
                .request();

            let mut info = ConnectionInfo::default();
            info.update(&req);
            assert_eq!(info.scheme(), "http");
            assert_eq!(info.host(), "rust-lang.org");
            assert_eq!(info.remote(), None);

            let req = TestRequest::default()
                .header(X_FORWARDED_FOR, "192.0.2.60")
                .request();
            let mut info = ConnectionInfo::default();
            info.update(&req);
            assert_eq!(info.remote(), Some("192.0.2.60"));

            let req = TestRequest::default()
                .header(X_FORWARDED_HOST, "192.0.2.60")
                .request();
            let mut info = ConnectionInfo::default();
            info.update(&req);
            assert_eq!(info.host(), "192.0.2.60");
            assert_eq!(info.remote(), None);

            let req = TestRequest::default()
                .header(X_FORWARDED_PROTO, "https")
                .request();
            let mut info = ConnectionInfo::default();
            info.update(&req);
            assert_eq!(info.scheme(), "https");
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)