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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
//! This crate provides some utilities for reading HTTP JSON requests.

#![feature(try_from)]

extern crate serde;
extern crate serde_json;
extern crate subslice_index;
extern crate uhttp_body_bytes;
extern crate uhttp_chunked_bytes;
extern crate uhttp_content_encoding;
extern crate uhttp_media_type;
extern crate uhttp_method;
extern crate uhttp_request;
extern crate uhttp_request_target;
extern crate uhttp_status;
extern crate uhttp_transfer_encoding;
extern crate uhttp_uri;
extern crate uhttp_version;

#[cfg(test)]
#[macro_use]
extern crate serde_derive;

use std::convert::TryFrom;
use std::io::Read;

use serde::Deserialize;
use subslice_index::subslice_index;
use uhttp_body_bytes::BodyBytes;
use uhttp_chunked_bytes::ChunkedBytes;
use uhttp_content_encoding::{content_encodings, ContentEncoding, StdContentEncoding};
use uhttp_media_type::{MediaType, MediaParams};
use uhttp_method::Method;
use uhttp_request::{RequestLine, Header, Headers};
use uhttp_request_target::RequestTarget;
use uhttp_status::StatusCode;
use uhttp_transfer_encoding::{transfer_encodings, TransferEncoding, StdTransferEncoding};
use uhttp_uri::{HttpUri, HttpResource};
use uhttp_version::HttpVersion;

/// Result with an HTTP status code error.
pub type HttpResult<T> = std::result::Result<T, StatusCode>;

/// Format of a request body [RFC7230§3.3.3].
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
enum RequestBodyFormat {
    /// Body contains the specified number of bytes.
    Sized(usize),
    /// Body is in chunked encoding format.
    Chunked,
    /// Body ends when the connection is closed.
    Closed,
}

/// Handles headers related to determining the request body format.
struct RequestBodyHeaders {
    /// Current transfer encoding of the body.
    tenc: Option<StdTransferEncoding>,
    /// Current explicit length of the body.
    len: Option<usize>,
}

impl Default for RequestBodyHeaders {
    fn default() -> Self {
        RequestBodyHeaders {
            tenc: None,
            len: None,
        }
    }
}

impl RequestBodyHeaders {
    /// Update the current view of the request body using the given header.
    pub fn process_header(&mut self, hdr: &Header) -> HttpResult<()> {
        if hdr.name.eq_ignore_ascii_case("content-encoding") {
            let val = std::str::from_utf8(hdr.val).map_err(|_| StatusCode::BadRequest)?;

            for enc in content_encodings(val) {
                match enc {
                    ContentEncoding::Std(StdContentEncoding::Identity) => {},
                    _ => return Err(StatusCode::NotImplemented),
                }
            }
        } else if hdr.name.eq_ignore_ascii_case("content-length") {
            let next = std::str::from_utf8(hdr.val)
                .map_err(|_| StatusCode::BadRequest)?
                .trim().parse().map_err(|_| StatusCode::BadRequest)?;

            if let Some(len) = self.len {
                // Multiple given lengths must match [RFC7230§3.3.2].
                if len != next {
                    return Err(StatusCode::BadRequest);
                }
            } else {
                self.len = Some(next);
            }
        } else if hdr.name.eq_ignore_ascii_case("transfer-encoding") {
            use self::TransferEncoding::*;
            use self::StdTransferEncoding::*;

            let val = std::str::from_utf8(hdr.val).map_err(|_| StatusCode::BadRequest)?;

            for enc in transfer_encodings(val) {
                // Only support a single encoding layer.
                if self.tenc.is_some() {
                    return Err(StatusCode::NotImplemented);
                }

                if let Std(Chunked) = enc {
                    self.tenc = Some(Chunked);
                } else {
                    return Err(StatusCode::NotImplemented);
                }
            }
        } else if hdr.name.eq_ignore_ascii_case("content-type") {
            let val = std::str::from_utf8(hdr.val).map_err(|_| StatusCode::BadRequest)?;
            let media = MediaType::new(val).map_err(|_| StatusCode::BadRequest)?;

            if !media.mimetype.eq_ignore_ascii_case("application/json") {
                return Err(StatusCode::NotImplemented);
            }

            for param in MediaParams::new(media.params) {
                let (name, val) = param.map_err(|_| StatusCode::BadRequest)?;

                if !name.eq_ignore_ascii_case("charset") ||
                   !val.inner().eq_ignore_ascii_case("utf-8")
                {
                    return Err(StatusCode::NotImplemented);
                }
            }
        }

        Ok(())
    }

    /// Parse a request body format if the current state is valid.
    pub fn into_format(self) -> HttpResult<RequestBodyFormat> {
        match (self.tenc, self.len) {
            (Some(StdTransferEncoding::Chunked), None) =>
                Ok(RequestBodyFormat::Chunked),
            (None, Some(len)) => Ok(RequestBodyFormat::Sized(len)),
            (None, None) => Ok(RequestBodyFormat::Closed),
            // Both present is an error [RFC7230§3.3.3].
            (Some(_), Some(_)) => Err(StatusCode::BadRequest),
            (Some(_), None) => unreachable!(),
        }
    }
}

/// Handles request routing and JSON deserialization.
pub struct HttpRequest<'a, S: Read> {
    /// Underlying stream to read bytes from.
    stream: S,
    /// Buffer to read request header and body into.
    buf: &'a mut [u8],
    /// Number of valid bytes in `buf`.
    len: usize,
    /// Current byte position in `buf`.
    pos: usize,
}

impl<'a, S: Read> HttpRequest<'a, S> {
    /// Create a new `HttpRequest` over the given stream, backed by the given buffer.
    ///
    /// The buffer is [recommended](https://tools.ietf.org/html/rfc7230#section-3.1.1) to
    /// hold at least 8000 bytes.
    pub fn new(mut stream: S, buf: &'a mut [u8]) -> HttpResult<Self> {
        match stream.read(&mut buf[..]) {
            Ok(len) => Ok(HttpRequest {
                stream: stream,
                buf: buf,
                len: len,
                pos: 0,
            }),
            Err(_) => Err(StatusCode::InternalServerError),
        }
    }

    /// Try to extract a version, method, and route.
    pub fn route<'b, R>(&'b mut self) -> HttpResult<(HttpVersion, Method, R)>
        where R: TryFrom<HttpResource<'b>, Error=StatusCode>
    {
        let (reqline, rest) = RequestLine::new(&self.buf[..self.len])
            .map_err(|err| match err {
                uhttp_request::Error::Partial => StatusCode::UriTooLong,
                uhttp_request::Error::Syntax => StatusCode::BadRequest,
            })?;

        self.pos = subslice_index(&self.buf[..], rest);

        let method = reqline.method.parse::<Method>()
            .map_err(|_| StatusCode::BadRequest)?;

        let target = reqline.target.parse::<RequestTarget>()
            .map_err(|_| StatusCode::BadRequest)?;

        let ver = reqline.version.parse::<HttpVersion>()
            .map_err(|_| StatusCode::BadRequest)?;

        let url = match target {
            RequestTarget::AbsPath =>
                HttpResource::new(reqline.target),
            RequestTarget::AbsUri =>
                // TODO: verify authority
                HttpUri::new(reqline.target)
                    .map_err(|_| StatusCode::BadRequest)?.resource,
            _ => return Err(StatusCode::NotImplemented),
        };

        let route = R::try_from(url)?;

        Ok((ver, method, route))
    }

    /// Try to deserialize a JSON payload from the request body.
    pub fn read_json<D: Deserialize>(&mut self) -> HttpResult<D> {
        let fmt = self.process_headers()?;
        let bytes = BodyBytes::new(&mut self.stream, &mut self.buf[..],
                                   self.pos, self.len);

        let msg = match fmt {
            RequestBodyFormat::Closed =>
                serde_json::from_iter(bytes),
            RequestBodyFormat::Sized(b) =>
                serde_json::from_iter(bytes.take(b)),
            RequestBodyFormat::Chunked =>
                serde_json::from_iter(ChunkedBytes::new(bytes)),
        };

        msg.map_err(|_| StatusCode::BadRequest)
    }

    /// Process the request headers.
    fn process_headers(&mut self) -> HttpResult<RequestBodyFormat> {
        let mut headers = Headers::new(&self.buf[self.pos..]);
        let mut body = RequestBodyHeaders::default();

        for hdr in &mut headers {
            let hdr = hdr.map_err(|err| match err {
                uhttp_request::Error::Partial =>
                    StatusCode::RequestHeaderFieldsTooLarge,
                uhttp_request::Error::Syntax =>
                    StatusCode::BadRequest,
            })?;

            try!(body.process_header(&hdr));
        }

        self.pos = subslice_index(&self.buf[..], headers.into_inner());

        body.into_format()
    }

    /// Consume the object and extract the underlying stream.
    pub fn into_stream(self) -> S { self.stream }
}

#[cfg(test)]
mod test {
    use super::*;
    use std::io::Cursor;

    #[test]
    fn test_req_body_headers() {
        let h = RequestBodyHeaders::default();
        assert_eq!(h.into_format(), Ok(RequestBodyFormat::Closed));

        let mut h = RequestBodyHeaders::default();
        h.process_header(&Header { name: "Host", val: b"example.com" }).unwrap();
        assert_eq!(h.into_format(), Ok(RequestBodyFormat::Closed));

        let mut h = RequestBodyHeaders::default();
        assert_eq!(h.process_header(&Header { name: "Content-Encoding", val: b"identity" }),
            Ok(()));
        assert_eq!(h.process_header(&Header { name: "Content-Encoding", val: b"gzip" }),
            Err(StatusCode::NotImplemented));

        let mut h = RequestBodyHeaders::default();
        h.process_header(&Header { name: "transfer-encoding", val: b"chunked" }).unwrap();
        assert_eq!(h.into_format(), Ok(RequestBodyFormat::Chunked));

        let mut h = RequestBodyHeaders::default();
        h.process_header(&Header { name: "Transfer-Encoding", val: b"chunked" }).unwrap();
        h.process_header(&Header { name: "Content-Type", val: b"application/json" }).unwrap();
        assert_eq!(h.into_format(), Ok(RequestBodyFormat::Chunked));

        let mut h = RequestBodyHeaders::default();
        assert_eq!(h.process_header(&Header {
            name: "Content-Type",
            val: b"application/json; charset=UTF-8",
        }), Ok(()));
        assert_eq!(h.process_header(&Header {
            name: "Content-Type",
            val: b"application/json; charset=latin-1",
        }), Err(StatusCode::NotImplemented));

        let mut h = RequestBodyHeaders::default();
        h.process_header(&Header { name: "Transfer-Encoding", val: b"chunked" }).unwrap();
        assert_eq!(h.process_header(&Header { name: "Content-Type", val: b"text/plain" }),
            Err(StatusCode::NotImplemented));

        let mut h = RequestBodyHeaders::default();
        assert_eq!(h.process_header(&Header {
            name: "Transfer-Encoding",
            val: b"chunked, chunked"
        }), Err(StatusCode::NotImplemented));

        let mut h = RequestBodyHeaders::default();
        assert_eq!(h.process_header(&Header { name: "Transfer-Encoding", val: b"chunked" }),
            Ok(()));
        assert_eq!(h.process_header(&Header { name: "Transfer-Encoding", val: b"chunked" }),
            Err(StatusCode::NotImplemented));
        assert_eq!(h.into_format(), Ok(RequestBodyFormat::Chunked));

        let mut h = RequestBodyHeaders::default();
        h.process_header(&Header { name: "Transfer-Encoding", val: b"chunked" }).unwrap();
        h.process_header(&Header { name: "Content-Length", val: b"42" }).unwrap();
        assert_eq!(h.into_format(), Err(StatusCode::BadRequest));

        let mut h = RequestBodyHeaders::default();
        h.process_header(&Header { name: "Transfer-Encoding", val: b"chunked" }).unwrap();
        assert_eq!(h.process_header(&Header { name: "Content-Length", val: b"abc" }),
            Err(StatusCode::BadRequest));

        let mut h = RequestBodyHeaders::default();
        h.process_header(&Header { name: "Content-Length", val: b"1337" }).unwrap();
        assert_eq!(h.into_format(), Ok(RequestBodyFormat::Sized(1337)));
    }

    #[test]
    fn test_http_req() {
        #[derive(Eq, PartialEq, Debug)]
        enum Route {
            First,
            Second,
        }

        #[derive(Eq, PartialEq, Debug, Deserialize)]
        struct Item {
            abc: u32,
        }

        impl<'a> std::convert::TryFrom<HttpResource<'a>> for Route {
            type Err = StatusCode;
            fn try_from(r: HttpResource<'a>) -> HttpResult<Self> {
                match r.path {
                    "/first" => Ok(Route::First),
                    "/sec" => Ok(Route::Second),
                    _ => Err(StatusCode::NotFound),
                }
            }
        }

        let stream = b"GET /first HTTP/1.1\r\n\r\n{\"abc\": 123}";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 32];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        let (ver, method, route) = req.route::<Route>().unwrap();
        assert_eq!(ver, HttpVersion::from_parts(1, 1));
        assert_eq!(method, Method::Get);
        assert_eq!(route, Route::First);
        assert_eq!(req.read_json(), Ok(Item { abc: 123 }));

        let stream = b"GET /first HTTP/1.1\r\n\r\n{\"abc\": 123}";
        let mut buf = [0; 32];
        let mut req = HttpRequest::new(Cursor::new(&stream[..]), &mut buf[..]).unwrap();
        let (ver, method, route) = req.route::<Route>().unwrap();
        assert_eq!(ver, HttpVersion::from_parts(1, 1));
        assert_eq!(method, Method::Get);
        assert_eq!(route, Route::First);
        assert_eq!(req.read_json(), Ok(Item { abc: 123 }));
        req.into_stream();

        let stream = b"GET /first HTTP/1.1\r\n\r\n";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 32];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        let (ver, method, route) = req.route::<Route>().unwrap();
        assert_eq!(ver, HttpVersion::from_parts(1, 1));
        assert_eq!(method, Method::Get);
        assert_eq!(route, Route::First);
        assert_eq!(req.read_json::<Item>(), Err(StatusCode::BadRequest));

        let stream = b"PSHT HTTP/1.1\r\n\r\n";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 32];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        assert_eq!(req.route::<Route>(), Err(StatusCode::BadRequest));

        let stream = b"GET /path HTTP/1.1\r\n\r\n";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 32];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        assert_eq!(req.route::<Route>(), Err(StatusCode::NotFound));

        let stream = b"POST /sec HTTP/1.1\r\nContent-Length: 12\r\n\r\n{\"abc\": 123}";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 8];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        assert_eq!(req.route::<Route>(), Err(StatusCode::UriTooLong));

        let stream = b"POST /sec HTTP/1.1\r\nContent-Length: 12\r\n\r\n{\"abc\": 123}";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 24];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        let (ver, method, route) = req.route::<Route>().unwrap();
        assert_eq!(ver, HttpVersion::from_parts(1, 1));
        assert_eq!(method, Method::Post);
        assert_eq!(route, Route::Second);
        assert_eq!(req.read_json::<Item>(),
            Err(StatusCode::RequestHeaderFieldsTooLarge));

        let stream = b"POST /sec HTTP/1.1\r\nContent-Length: 12\r\n\r\n{\"abc\": 123}";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 256];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        let (ver, method, route) = req.route::<Route>().unwrap();
        assert_eq!(ver, HttpVersion::from_parts(1, 1));
        assert_eq!(method, Method::Post);
        assert_eq!(route, Route::Second);
        assert_eq!(req.read_json(), Ok(Item { abc: 123 }));

        let stream = b"POST /sec HTTP/1.1\r\nTransfer-Encoding:
            chunked\r\n\r\nc\r\n{\"abc\": 123}\r\n";
        let mut cursor = Cursor::new(&stream[..]);
        let mut buf = [0; 256];
        let mut req = HttpRequest::new(&mut cursor, &mut buf[..]).unwrap();
        let (ver, method, route) = req.route::<Route>().unwrap();
        assert_eq!(ver, HttpVersion::from_parts(1, 1));
        assert_eq!(method, Method::Post);
        assert_eq!(route, Route::Second);
        assert_eq!(req.read_json(), Ok(Item { abc: 123 }));
    }
}