Willy Tarreau | 0da5b3b | 2017-09-21 09:30:46 +0200 | [diff] [blame] | 1 | /* |
| 2 | * include/types/h1.h |
| 3 | * This file contains HTTP/1 protocol definitions. |
| 4 | * |
| 5 | * Copyright (C) 2000-2017 Willy Tarreau - w@1wt.eu |
| 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
| 21 | |
| 22 | #ifndef _TYPES_H1_H |
| 23 | #define _TYPES_H1_H |
| 24 | |
| 25 | /* Possible states while parsing HTTP/1 messages (request|response) */ |
| 26 | enum h1_state { |
| 27 | HTTP_MSG_RQBEFORE = 0, // request: leading LF, before start line |
| 28 | HTTP_MSG_RQBEFORE_CR = 1, // request: leading CRLF, before start line |
| 29 | /* these ones define a request start line */ |
| 30 | HTTP_MSG_RQMETH = 2, // parsing the Method |
| 31 | HTTP_MSG_RQMETH_SP = 3, // space(s) after the Method |
| 32 | HTTP_MSG_RQURI = 4, // parsing the Request URI |
| 33 | HTTP_MSG_RQURI_SP = 5, // space(s) after the Request URI |
| 34 | HTTP_MSG_RQVER = 6, // parsing the Request Version |
| 35 | HTTP_MSG_RQLINE_END = 7, // end of request line (CR or LF) |
| 36 | |
| 37 | HTTP_MSG_RPBEFORE = 8, // response: leading LF, before start line |
| 38 | HTTP_MSG_RPBEFORE_CR = 9, // response: leading CRLF, before start line |
| 39 | |
| 40 | /* these ones define a response start line */ |
| 41 | HTTP_MSG_RPVER = 10, // parsing the Response Version |
| 42 | HTTP_MSG_RPVER_SP = 11, // space(s) after the Response Version |
| 43 | HTTP_MSG_RPCODE = 12, // response code |
| 44 | HTTP_MSG_RPCODE_SP = 13, // space(s) after the response code |
| 45 | HTTP_MSG_RPREASON = 14, // response reason |
| 46 | HTTP_MSG_RPLINE_END = 15, // end of response line (CR or LF) |
| 47 | |
| 48 | /* common header processing */ |
| 49 | HTTP_MSG_HDR_FIRST = 16, // waiting for first header or last CRLF (no LWS possible) |
| 50 | HTTP_MSG_HDR_NAME = 17, // parsing header name |
| 51 | HTTP_MSG_HDR_COL = 18, // parsing header colon |
| 52 | HTTP_MSG_HDR_L1_SP = 19, // parsing header LWS (SP|HT) before value |
| 53 | HTTP_MSG_HDR_L1_LF = 20, // parsing header LWS (LF) before value |
| 54 | HTTP_MSG_HDR_L1_LWS = 21, // checking whether it's a new header or an LWS |
| 55 | HTTP_MSG_HDR_VAL = 22, // parsing header value |
| 56 | HTTP_MSG_HDR_L2_LF = 23, // parsing header LWS (LF) inside/after value |
| 57 | HTTP_MSG_HDR_L2_LWS = 24, // checking whether it's a new header or an LWS |
| 58 | |
| 59 | HTTP_MSG_LAST_LF = 25, // parsing last LF |
| 60 | |
| 61 | /* error state : must be before HTTP_MSG_BODY so that (>=BODY) always indicates |
| 62 | * that data are being processed. |
| 63 | */ |
| 64 | HTTP_MSG_ERROR = 26, // an error occurred |
| 65 | /* Body processing. |
| 66 | * The state HTTP_MSG_BODY is a delimiter to know if we're waiting for headers |
| 67 | * or body. All the sub-states below also indicate we're processing the body, |
| 68 | * with some additional information. |
| 69 | */ |
| 70 | HTTP_MSG_BODY = 27, // parsing body at end of headers |
| 71 | HTTP_MSG_100_SENT = 28, // parsing body after a 100-Continue was sent |
| 72 | HTTP_MSG_CHUNK_SIZE = 29, // parsing the chunk size (RFC7230 #4.1) |
| 73 | HTTP_MSG_DATA = 30, // skipping data chunk / content-length data |
| 74 | HTTP_MSG_CHUNK_CRLF = 31, // skipping CRLF after data chunk |
| 75 | HTTP_MSG_TRAILERS = 32, // trailers (post-data entity headers) |
| 76 | /* we enter this state when we've received the end of the current message */ |
| 77 | HTTP_MSG_ENDING = 33, // message end received, wait that the filters end too |
| 78 | HTTP_MSG_DONE = 34, // message end received, waiting for resync or close |
| 79 | HTTP_MSG_CLOSING = 35, // shutdown_w done, not all bytes sent yet |
| 80 | HTTP_MSG_CLOSED = 36, // shutdown_w done, all bytes sent |
| 81 | HTTP_MSG_TUNNEL = 37, // tunneled data after DONE |
| 82 | } __attribute__((packed)); |
| 83 | |
| 84 | |
Willy Tarreau | 4093a4d | 2017-09-21 11:46:43 +0200 | [diff] [blame] | 85 | /* HTTP/1 message flags (32 bit), for use in h1m->flags only */ |
| 86 | #define H1_MF_NONE 0x00000000 |
| 87 | #define H1_MF_CLEN 0x00000001 // content-length present |
| 88 | #define H1_MF_CHNK 0x00000002 // chunk present, exclusive with c-l |
| 89 | |
| 90 | |
| 91 | /* basic HTTP/1 message state for use in parsers */ |
| 92 | struct h1m { |
| 93 | enum h1_state state; // H1 message state (HTTP_MSG_*) |
Willy Tarreau | d22e83a | 2017-10-31 08:02:24 +0100 | [diff] [blame] | 94 | /* 8 bits available here */ |
| 95 | uint16_t status; // HTTP status code |
Willy Tarreau | 4093a4d | 2017-09-21 11:46:43 +0200 | [diff] [blame] | 96 | uint32_t flags; // H1 message flags (H1_MF_*) |
| 97 | uint64_t curr_len; // content-length or last chunk length |
| 98 | uint64_t body_len; // total known size of the body length |
| 99 | int err_pos; // position in the byte stream of the first error (H1 or H2) |
| 100 | int err_state; // state where the first error was met (H1 or H2) |
| 101 | }; |
| 102 | |
Willy Tarreau | 0da5b3b | 2017-09-21 09:30:46 +0200 | [diff] [blame] | 103 | #endif /* _TYPES_H1_H */ |