wstt/handshake/
headers.rs

1//! HTTP Request and response header handling.
2
3use http;
4use http::header::{HeaderMap, HeaderName, HeaderValue};
5use httparse;
6use httparse::Status;
7
8use super::machine::TryParse;
9use crate::error::Result;
10
11/// Limit for the number of header lines.
12pub const MAX_HEADERS: usize = 124;
13
14/// Trait to convert raw objects into HTTP parseables.
15pub(crate) trait FromHttparse<T>: Sized {
16    /// Convert raw object into parsed HTTP headers.
17    fn from_httparse(raw: T) -> Result<Self>;
18}
19
20impl<'b: 'h, 'h> FromHttparse<&'b [httparse::Header<'h>]> for HeaderMap {
21    fn from_httparse(raw: &'b [httparse::Header<'h>]) -> Result<Self> {
22        let mut headers = HeaderMap::new();
23        for h in raw {
24            headers.append(
25                HeaderName::from_bytes(h.name.as_bytes())?,
26                HeaderValue::from_bytes(h.value)?,
27            );
28        }
29
30        Ok(headers)
31    }
32}
33impl TryParse for HeaderMap {
34    fn try_parse(buf: &[u8]) -> Result<Option<(usize, Self)>> {
35        let mut hbuffer = [httparse::EMPTY_HEADER; MAX_HEADERS];
36        Ok(match httparse::parse_headers(buf, &mut hbuffer)? {
37            Status::Partial => None,
38            Status::Complete((size, hdr)) => Some((size, HeaderMap::from_httparse(hdr)?)),
39        })
40    }
41}
42
43#[cfg(test)]
44mod tests {
45
46    use super::super::machine::TryParse;
47    use super::HeaderMap;
48
49    #[test]
50    fn headers() {
51        const DATA: &[u8] = b"Host: foo.com\r\n\
52             Connection: Upgrade\r\n\
53             Upgrade: websocket\r\n\
54             \r\n";
55        let (_, hdr) = HeaderMap::try_parse(DATA).unwrap().unwrap();
56        assert_eq!(hdr.get("Host").unwrap(), &b"foo.com"[..]);
57        assert_eq!(hdr.get("Upgrade").unwrap(), &b"websocket"[..]);
58        assert_eq!(hdr.get("Connection").unwrap(), &b"Upgrade"[..]);
59    }
60
61    #[test]
62    fn headers_iter() {
63        const DATA: &[u8] = b"Host: foo.com\r\n\
64              Sec-WebSocket-Extensions: permessage-deflate\r\n\
65              Connection: Upgrade\r\n\
66              Sec-WebSocket-ExtenSIONS: permessage-unknown\r\n\
67              Upgrade: websocket\r\n\
68              \r\n";
69        let (_, hdr) = HeaderMap::try_parse(DATA).unwrap().unwrap();
70        let mut iter = hdr.get_all("Sec-WebSocket-Extensions").iter();
71        assert_eq!(iter.next().unwrap(), &b"permessage-deflate"[..]);
72        assert_eq!(iter.next().unwrap(), &b"permessage-unknown"[..]);
73        assert_eq!(iter.next(), None);
74    }
75
76    #[test]
77    fn headers_incomplete() {
78        const DATA: &[u8] = b"Host: foo.com\r\n\
79              Connection: Upgrade\r\n\
80              Upgrade: websocket\r\n";
81        let hdr = HeaderMap::try_parse(DATA).unwrap();
82        assert!(hdr.is_none());
83    }
84}