Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 1 | /* |
| 2 | include/types/proto_http.h |
| 3 | This file contains HTTP protocol definitions. |
| 4 | |
| 5 | Copyright (C) 2000-2006 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_PROTO_HTTP_H |
| 23 | #define _TYPES_PROTO_HTTP_H |
| 24 | |
Willy Tarreau | e3ba5f0 | 2006-06-29 18:54:54 +0200 | [diff] [blame] | 25 | #include <common/config.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 26 | |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 27 | #include <types/buffers.h> |
| 28 | #include <types/hdr_idx.h> |
| 29 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 30 | /* |
| 31 | * FIXME: break this into HTTP state and TCP socket state. |
| 32 | * See server.h for the other end. |
| 33 | */ |
| 34 | |
| 35 | /* different possible states for the client side */ |
| 36 | #define CL_STHEADERS 0 |
| 37 | #define CL_STDATA 1 |
| 38 | #define CL_STSHUTR 2 |
| 39 | #define CL_STSHUTW 3 |
| 40 | #define CL_STCLOSE 4 |
| 41 | |
| 42 | /* |
| 43 | * FIXME: break this into HTTP state and TCP socket state. |
| 44 | * See client.h for the other end. |
| 45 | */ |
| 46 | |
| 47 | /* different possible states for the server side */ |
| 48 | #define SV_STIDLE 0 |
| 49 | #define SV_STCONN 1 |
| 50 | #define SV_STHEADERS 2 |
| 51 | #define SV_STDATA 3 |
| 52 | #define SV_STSHUTR 4 |
| 53 | #define SV_STSHUTW 5 |
| 54 | #define SV_STCLOSE 6 |
| 55 | |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 56 | /* |
| 57 | * Transaction flags moved from session |
| 58 | */ |
| 59 | |
| 60 | |
| 61 | /* action flags */ |
| 62 | #define TX_CLDENY 0x00000001 /* a client header matches a deny regex */ |
| 63 | #define TX_CLALLOW 0x00000002 /* a client header matches an allow regex */ |
| 64 | #define TX_SVDENY 0x00000004 /* a server header matches a deny regex */ |
| 65 | #define TX_SVALLOW 0x00000008 /* a server header matches an allow regex */ |
| 66 | #define TX_CLTARPIT 0x00000010 /* the session is tarpitted (anti-dos) */ |
| 67 | /* unused: 0x00000020 */ |
| 68 | |
| 69 | /* transaction flags dedicated to cookies : bits values 0x40, 0x80 (0-3 shift 6) */ |
| 70 | #define TX_CK_NONE 0x00000000 /* this session had no cookie */ |
| 71 | #define TX_CK_INVALID 0x00000040 /* this session had a cookie which matches no server */ |
| 72 | #define TX_CK_DOWN 0x00000080 /* this session had cookie matching a down server */ |
| 73 | #define TX_CK_VALID 0x000000C0 /* this session had cookie matching a valid server */ |
| 74 | #define TX_CK_MASK 0x000000C0 /* mask to get this session's cookie flags */ |
| 75 | #define TX_CK_SHIFT 6 /* bit shift */ |
| 76 | |
| 77 | /* cookie information, bits values 0x100 to 0x800 (0-8 shift 8) */ |
| 78 | #define TX_SCK_NONE 0x00000000 /* no set-cookie seen for the server cookie */ |
| 79 | #define TX_SCK_DELETED 0x00000100 /* existing set-cookie deleted or changed */ |
| 80 | #define TX_SCK_INSERTED 0x00000200 /* new set-cookie inserted or changed existing one */ |
| 81 | #define TX_SCK_SEEN 0x00000400 /* set-cookie seen for the server cookie */ |
| 82 | #define TX_SCK_MASK 0x00000700 /* mask to get the set-cookie field */ |
| 83 | #define TX_SCK_ANY 0x00000800 /* at least one set-cookie seen (not to be counted) */ |
| 84 | #define TX_SCK_SHIFT 8 /* bit shift */ |
| 85 | |
| 86 | /* cacheability management, bits values 0x1000 to 0x3000 (0-3 shift 12) */ |
| 87 | #define TX_CACHEABLE 0x00001000 /* at least part of the response is cacheable */ |
| 88 | #define TX_CACHE_COOK 0x00002000 /* a cookie in the response is cacheable */ |
| 89 | #define TX_CACHE_SHIFT 12 /* bit shift */ |
| 90 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 91 | |
Willy Tarreau | 8d5d7f2 | 2007-01-21 19:16:41 +0100 | [diff] [blame] | 92 | /* The HTTP parser is more complex than it looks like, because we have to |
| 93 | * support multi-line headers and any number of spaces between the colon and |
| 94 | * the value. |
| 95 | * |
| 96 | * All those examples must work : |
| 97 | |
| 98 | Hdr1:val1\r\n |
| 99 | Hdr1: val1\r\n |
| 100 | Hdr1:\t val1\r\n |
| 101 | Hdr1: \r\n |
| 102 | val1\r\n |
| 103 | Hdr1:\r\n |
| 104 | val1\n |
| 105 | \tval2\r\n |
| 106 | val3\n |
| 107 | |
| 108 | * |
| 109 | */ |
| 110 | |
Willy Tarreau | 58f10d7 | 2006-12-04 02:26:12 +0100 | [diff] [blame] | 111 | /* Possible states while parsing HTTP messages (request|response) */ |
Willy Tarreau | 8d5d7f2 | 2007-01-21 19:16:41 +0100 | [diff] [blame] | 112 | #define HTTP_MSG_RQBEFORE 0 // request: leading LF, before start line |
| 113 | #define HTTP_MSG_RQBEFORE_CR 1 // request: leading CRLF, before start line |
| 114 | |
| 115 | /* these ones define a request start line */ |
| 116 | #define HTTP_MSG_RQMETH 2 // parsing the Method |
| 117 | #define HTTP_MSG_RQMETH_SP 3 // space(s) after the ethod |
| 118 | #define HTTP_MSG_RQURI 4 // parsing the Request URI |
| 119 | #define HTTP_MSG_RQURI_SP 5 // space(s) after the Request URI |
| 120 | #define HTTP_MSG_RQVER 6 // parsing the Request Version |
| 121 | #define HTTP_MSG_RQLINE_END 7 // end of request line (CR or LF) |
| 122 | |
| 123 | #define HTTP_MSG_RPBEFORE 8 // response: leading LF, before start line |
| 124 | #define HTTP_MSG_RPBEFORE_CR 9 // response: leading CRLF, before start line |
| 125 | |
| 126 | /* these ones define a response start line */ |
| 127 | #define HTTP_MSG_RPVER 10 // parsing the Response Version |
| 128 | #define HTTP_MSG_RPVER_SP 11 // space(s) after the Response Version |
| 129 | #define HTTP_MSG_RPCODE 12 // response code |
| 130 | #define HTTP_MSG_RPCODE_SP 13 // space(s) after the response code |
| 131 | #define HTTP_MSG_RPREASON 14 // response reason |
| 132 | #define HTTP_MSG_RPLINE_END 15 // end of response line (CR or LF) |
| 133 | |
| 134 | /* common header processing */ |
| 135 | |
| 136 | #define HTTP_MSG_HDR_FIRST 16 // waiting for first header or last CRLF (no LWS possible) |
| 137 | #define HTTP_MSG_HDR_NAME 17 // parsing header name |
| 138 | #define HTTP_MSG_HDR_COL 18 // parsing header colon |
| 139 | #define HTTP_MSG_HDR_L1_SP 19 // parsing header LWS (SP|HT) before value |
| 140 | #define HTTP_MSG_HDR_L1_LF 20 // parsing header LWS (LF) before value |
| 141 | #define HTTP_MSG_HDR_L1_LWS 21 // checking whether it's a new header or an LWS |
| 142 | #define HTTP_MSG_HDR_VAL 22 // parsing header value |
| 143 | #define HTTP_MSG_HDR_L2_LF 23 // parsing header LWS (LF) inside/after value |
| 144 | #define HTTP_MSG_HDR_L2_LWS 24 // checking whether it's a new header or an LWS |
| 145 | |
| 146 | #define HTTP_MSG_LAST_LF 25 // parsing last LF |
| 147 | #define HTTP_MSG_BODY 26 // parsing body at end of headers |
| 148 | #define HTTP_MSG_ERROR 27 // an error occurred |
| 149 | |
Willy Tarreau | 58f10d7 | 2006-12-04 02:26:12 +0100 | [diff] [blame] | 150 | |
Willy Tarreau | c0dde7a | 2007-01-01 21:38:07 +0100 | [diff] [blame] | 151 | /* various data sources for the responses */ |
| 152 | #define DATA_SRC_NONE 0 |
| 153 | #define DATA_SRC_STATS 1 |
| 154 | |
| 155 | /* data transmission states for the stats responses */ |
| 156 | enum { |
| 157 | DATA_ST_INIT = 0, |
| 158 | DATA_ST_HEAD, |
| 159 | DATA_ST_INFO, |
| 160 | DATA_ST_LIST, |
| 161 | DATA_ST_END, |
| 162 | DATA_ST_FIN, |
| 163 | }; |
| 164 | |
| 165 | /* data transmission states for the stats responses inside a proxy */ |
| 166 | enum { |
| 167 | DATA_ST_PX_INIT = 0, |
| 168 | DATA_ST_PX_TH, |
| 169 | DATA_ST_PX_FE, |
| 170 | DATA_ST_PX_SV, |
| 171 | DATA_ST_PX_BE, |
| 172 | DATA_ST_PX_END, |
| 173 | DATA_ST_PX_FIN, |
| 174 | }; |
| 175 | |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 176 | /* Known HTTP methods */ |
| 177 | typedef enum { |
| 178 | HTTP_METH_NONE = 0, |
| 179 | HTTP_METH_OPTIONS, |
| 180 | HTTP_METH_GET, |
| 181 | HTTP_METH_HEAD, |
| 182 | HTTP_METH_POST, |
| 183 | HTTP_METH_PUT, |
| 184 | HTTP_METH_DELETE, |
| 185 | HTTP_METH_TRACE, |
| 186 | HTTP_METH_CONNECT, |
| 187 | HTTP_METH_OTHER, |
| 188 | } http_meth_t; |
| 189 | |
| 190 | /* This is an HTTP message, as described in RFC2616. It can be either a request |
| 191 | * message or a response message. |
| 192 | * |
| 193 | * The values there are a little bit obscure, because their meaning can change |
| 194 | * during the parsing : |
| 195 | * |
| 196 | * - som (Start of Message) : relative offset in the buffer of first byte of |
| 197 | * the request being processed or parsed. Reset to |
| 198 | * zero during accept(). |
| 199 | * - eoh (End of Headers) : relative offset in the buffer of first byte that |
| 200 | * is not part of a completely processed header. |
| 201 | * During parsing, it points to last header seen |
| 202 | * for states after START. |
| 203 | * - eol (End of Line) : relative offset in the buffer of the first byte |
| 204 | * which marks the end of the line (LF or CRLF). |
| 205 | */ |
| 206 | struct http_msg { |
| 207 | int msg_state; /* where we are in the current message parsing */ |
Willy Tarreau | 9cdde23 | 2007-05-02 20:58:19 +0200 | [diff] [blame] | 208 | char *sol; /* start of line, also start of message when fully parsed */ |
| 209 | char *eol; /* end of line */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 210 | int som; /* Start Of Message, relative to buffer */ |
| 211 | int col, sov; /* current header: colon, start of value */ |
| 212 | int eoh; /* End Of Headers, relative to buffer */ |
| 213 | char **cap; /* array of captured headers (may be NULL) */ |
| 214 | union { /* useful start line pointers, relative to buffer */ |
| 215 | struct { |
| 216 | int l; /* request line length (not including CR) */ |
| 217 | int m_l; /* METHOD length (method starts at ->som) */ |
| 218 | int u, u_l; /* URI, length */ |
| 219 | int v, v_l; /* VERSION, length */ |
| 220 | } rq; /* request line : field, length */ |
| 221 | struct { |
| 222 | int l; /* status line length (not including CR) */ |
| 223 | int v_l; /* VERSION length (version starts at ->som) */ |
| 224 | int c, c_l; /* CODE, length */ |
| 225 | int r, r_l; /* REASON, length */ |
| 226 | } st; /* status line : field, length */ |
| 227 | } sl; /* start line */ |
| 228 | }; |
| 229 | |
| 230 | /* This is an HTTP transaction. It contains both a request message and a |
| 231 | * response message (which can be empty). |
| 232 | */ |
| 233 | struct http_txn { |
| 234 | http_meth_t meth; /* HTTP method */ |
| 235 | struct hdr_idx hdr_idx; /* array of header indexes (max: MAX_HTTP_HDR) */ |
| 236 | struct chunk auth_hdr; /* points to 'Authorization:' header */ |
| 237 | struct http_msg req, rsp; /* HTTP request and response messages */ |
| 238 | |
| 239 | char *uri; /* first line if log needed, NULL otherwise */ |
| 240 | char *cli_cookie; /* cookie presented by the client, in capture mode */ |
| 241 | char *srv_cookie; /* cookie presented by the server, in capture mode */ |
| 242 | int status; /* HTTP status from the server, negative if from proxy */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 243 | unsigned int flags; /* transaction flags */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 244 | }; |
| 245 | |
Willy Tarreau | 58f10d7 | 2006-12-04 02:26:12 +0100 | [diff] [blame] | 246 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 247 | #endif /* _TYPES_PROTO_HTTP_H */ |
| 248 | |
| 249 | /* |
| 250 | * Local variables: |
| 251 | * c-indent-level: 8 |
| 252 | * c-basic-offset: 8 |
| 253 | * End: |
| 254 | */ |