Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 1 | /* |
Christopher Faulet | fc9cfe4 | 2019-07-16 14:54:53 +0200 | [diff] [blame] | 2 | * include/types/http_ana.h |
Willy Tarreau | 3667d5d | 2009-10-18 19:50:43 +0200 | [diff] [blame] | 3 | * This file contains HTTP protocol definitions. |
| 4 | * |
Willy Tarreau | ff011f2 | 2011-01-06 17:51:27 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 3667d5d | 2009-10-18 19:50:43 +0200 | [diff] [blame] | 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 | */ |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 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 | 35b51c6 | 2018-09-10 15:38:55 +0200 | [diff] [blame] | 26 | #include <common/http.h> |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 27 | |
Willy Tarreau | db4893d | 2017-09-21 08:40:02 +0200 | [diff] [blame] | 28 | #include <types/channel.h> |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 29 | |
Willy Tarreau | fcffa69 | 2010-01-10 14:21:19 +0100 | [diff] [blame] | 30 | /* These are the flags that are found in txn->flags */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 31 | |
| 32 | /* action flags */ |
| 33 | #define TX_CLDENY 0x00000001 /* a client header matches a deny regex */ |
| 34 | #define TX_CLALLOW 0x00000002 /* a client header matches an allow regex */ |
| 35 | #define TX_SVDENY 0x00000004 /* a server header matches a deny regex */ |
| 36 | #define TX_SVALLOW 0x00000008 /* a server header matches an allow regex */ |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 37 | #define TX_CLTARPIT 0x00000010 /* the transaction is tarpitted (anti-dos) */ |
Willy Tarreau | b608feb | 2010-01-02 22:47:18 +0100 | [diff] [blame] | 38 | |
Willy Tarreau | 92954fd | 2010-10-06 19:38:55 +0200 | [diff] [blame] | 39 | /* transaction flags dedicated to cookies : bits values 0x20 to 0x80 (0-7 shift 5) */ |
Willy Tarreau | 87b0966 | 2015-04-03 00:22:06 +0200 | [diff] [blame] | 40 | #define TX_CK_NONE 0x00000000 /* this transaction had no cookie */ |
| 41 | #define TX_CK_INVALID 0x00000020 /* this transaction had a cookie which matches no server */ |
| 42 | #define TX_CK_DOWN 0x00000040 /* this transaction had cookie matching a down server */ |
| 43 | #define TX_CK_VALID 0x00000060 /* this transaction had cookie matching a valid server */ |
| 44 | #define TX_CK_EXPIRED 0x00000080 /* this transaction had an expired cookie (idle for too long) */ |
| 45 | #define TX_CK_OLD 0x000000A0 /* this transaction had too old a cookie (offered too long ago) */ |
| 46 | #define TX_CK_UNUSED 0x000000C0 /* this transaction had a cookie but it was not used (eg: use-server was preferred) */ |
| 47 | #define TX_CK_MASK 0x000000E0 /* mask to get this transaction's cookie flags */ |
Willy Tarreau | 92954fd | 2010-10-06 19:38:55 +0200 | [diff] [blame] | 48 | #define TX_CK_SHIFT 5 /* bit shift */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 49 | |
Willy Tarreau | f134831 | 2010-10-07 15:54:11 +0200 | [diff] [blame] | 50 | /* response cookie information, bits values 0x100 to 0x700 (0-7 shift 8) */ |
| 51 | #define TX_SCK_NONE 0x00000000 /* no cookie found in the response */ |
| 52 | #define TX_SCK_FOUND 0x00000100 /* a persistence cookie was found and forwarded */ |
| 53 | #define TX_SCK_DELETED 0x00000200 /* an existing persistence cookie was deleted */ |
| 54 | #define TX_SCK_INSERTED 0x00000300 /* a persistence cookie was inserted */ |
| 55 | #define TX_SCK_REPLACED 0x00000400 /* a persistence cookie was present and rewritten */ |
| 56 | #define TX_SCK_UPDATED 0x00000500 /* an expirable persistence cookie was updated */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 57 | #define TX_SCK_MASK 0x00000700 /* mask to get the set-cookie field */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 58 | #define TX_SCK_SHIFT 8 /* bit shift */ |
Willy Tarreau | f134831 | 2010-10-07 15:54:11 +0200 | [diff] [blame] | 59 | |
| 60 | #define TX_SCK_PRESENT 0x00000800 /* a cookie was found in the server's response */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 61 | |
| 62 | /* cacheability management, bits values 0x1000 to 0x3000 (0-3 shift 12) */ |
| 63 | #define TX_CACHEABLE 0x00001000 /* at least part of the response is cacheable */ |
| 64 | #define TX_CACHE_COOK 0x00002000 /* a cookie in the response is cacheable */ |
Willy Tarreau | 0ad8e0d | 2017-12-22 15:03:36 +0100 | [diff] [blame] | 65 | #define TX_CACHE_IGNORE 0x00004000 /* do not retrieve object from cache */ |
Willy Tarreau | 3d30059 | 2007-03-18 18:34:41 +0100 | [diff] [blame] | 66 | #define TX_CACHE_SHIFT 12 /* bit shift */ |
| 67 | |
Christopher Faulet | 3716ebc | 2019-07-17 11:22:37 +0200 | [diff] [blame] | 68 | #define TX_CON_WANT_TUN 0x00008000 /* Will be a tunnel (CONNECT or 101-Switching-Protocol) */ |
Christopher Faulet | e600624 | 2017-03-10 11:52:44 +0100 | [diff] [blame] | 69 | |
Christopher Faulet | 3716ebc | 2019-07-17 11:22:37 +0200 | [diff] [blame] | 70 | #define TX_WAIT_NEXT_RQ 0x00010000 /* waiting for the second request to start, use keep-alive timeout */ |
Christopher Faulet | e600624 | 2017-03-10 11:52:44 +0100 | [diff] [blame] | 71 | |
Christopher Faulet | 3716ebc | 2019-07-17 11:22:37 +0200 | [diff] [blame] | 72 | #define TX_USE_PX_CONN 0x00020000 /* Use "Proxy-Connection" instead of "Connection" */ |
Willy Tarreau | bbf0b37 | 2010-01-18 16:54:40 +0100 | [diff] [blame] | 73 | |
Willy Tarreau | 92954fd | 2010-10-06 19:38:55 +0200 | [diff] [blame] | 74 | /* used only for keep-alive purposes, to indicate we're on a second transaction */ |
Christopher Faulet | 3716ebc | 2019-07-17 11:22:37 +0200 | [diff] [blame] | 75 | #define TX_NOT_FIRST 0x00040000 /* the transaction is not the first one */ |
Willy Tarreau | bbf0b37 | 2010-01-18 16:54:40 +0100 | [diff] [blame] | 76 | |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 77 | /* |
| 78 | * HTTP message status flags (msg->flags) |
| 79 | */ |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 80 | #define HTTP_MSGF_CNT_LEN 0x00000001 /* content-length was found in the message */ |
| 81 | #define HTTP_MSGF_TE_CHNK 0x00000002 /* transfer-encoding: chunked was found */ |
| 82 | |
| 83 | /* if this flags is not set in either direction, we may be forced to complete a |
| 84 | * connection as a half-way tunnel (eg if no content-length appears in a 1.1 |
| 85 | * response, but the request is correctly sized) |
| 86 | */ |
| 87 | #define HTTP_MSGF_XFER_LEN 0x00000004 /* message xfer size can be determined */ |
| 88 | #define HTTP_MSGF_VER_11 0x00000008 /* the message is HTTP/1.1 or above */ |
| 89 | |
Christopher Faulet | a00071e | 2019-12-12 16:41:00 +0100 | [diff] [blame] | 90 | #define HTTP_MSGF_SOFT_RW 0x00000010 /* soft header rewrites, no error triggered */ |
Christopher Faulet | cc76d5b | 2019-07-17 11:21:36 +0200 | [diff] [blame] | 91 | |
Christopher Faulet | d7c9196 | 2015-04-30 11:48:27 +0200 | [diff] [blame] | 92 | #define HTTP_MSGF_COMPRESSING 0x00000020 /* data compression is in progress */ |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 93 | |
Christopher Faulet | b2db4fa | 2018-11-27 16:51:09 +0100 | [diff] [blame] | 94 | #define HTTP_MSGF_BODYLESS 0x00000040 /* The message has no body (content-length = 0) */ |
| 95 | |
Willy Tarreau | a36fc4d | 2012-02-17 17:39:37 +0100 | [diff] [blame] | 96 | |
Willy Tarreau | 79da469 | 2008-11-19 20:03:04 +0100 | [diff] [blame] | 97 | /* Redirect flags */ |
| 98 | enum { |
| 99 | REDIRECT_FLAG_NONE = 0, |
| 100 | REDIRECT_FLAG_DROP_QS = 1, /* drop query string */ |
Willy Tarreau | 81e3b4f | 2010-01-10 00:42:19 +0100 | [diff] [blame] | 101 | REDIRECT_FLAG_APPEND_SLASH = 2, /* append a slash if missing at the end */ |
Christopher Faulet | c87e468 | 2020-01-28 09:13:41 +0100 | [diff] [blame^] | 102 | REDIRECT_FLAG_FROM_REQ = 3, /* redirect rule on the request path */ |
Willy Tarreau | 79da469 | 2008-11-19 20:03:04 +0100 | [diff] [blame] | 103 | }; |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 104 | |
| 105 | /* Redirect types (location, prefix, extended ) */ |
| 106 | enum { |
| 107 | REDIRECT_TYPE_NONE = 0, /* no redirection */ |
| 108 | REDIRECT_TYPE_LOCATION, /* location redirect */ |
| 109 | REDIRECT_TYPE_PREFIX, /* prefix redirect */ |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 110 | REDIRECT_TYPE_SCHEME, /* scheme redirect (eg: switch from http to https) */ |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 111 | }; |
| 112 | |
Cyril Bonté | 47fdd8e | 2010-04-25 00:00:51 +0200 | [diff] [blame] | 113 | /* Perist types (force-persist, ignore-persist) */ |
| 114 | enum { |
| 115 | PERSIST_TYPE_NONE = 0, /* no persistence */ |
| 116 | PERSIST_TYPE_FORCE, /* force-persist */ |
| 117 | PERSIST_TYPE_IGNORE, /* ignore-persist */ |
| 118 | }; |
| 119 | |
Willy Tarreau | 0b74833 | 2014-04-29 00:13:29 +0200 | [diff] [blame] | 120 | /* final results for http-request rules */ |
| 121 | enum rule_result { |
| 122 | HTTP_RULE_RES_CONT = 0, /* nothing special, continue rules evaluation */ |
Thierry FOURNIER | bc4c1ac | 2015-02-25 13:36:14 +0100 | [diff] [blame] | 123 | HTTP_RULE_RES_YIELD, /* call me later because some data is missing. */ |
Willy Tarreau | 0b74833 | 2014-04-29 00:13:29 +0200 | [diff] [blame] | 124 | HTTP_RULE_RES_STOP, /* stopped processing on an accept */ |
| 125 | HTTP_RULE_RES_DENY, /* deny (or tarpit if TX_CLTARPIT) */ |
| 126 | HTTP_RULE_RES_ABRT, /* abort request, msg already sent (eg: auth) */ |
| 127 | HTTP_RULE_RES_DONE, /* processing done, stop processing (eg: redirect) */ |
| 128 | HTTP_RULE_RES_BADREQ, /* bad request */ |
Christopher Faulet | 4d90db5 | 2019-12-16 12:22:05 +0100 | [diff] [blame] | 129 | HTTP_RULE_RES_ERROR, /* Internal error */ |
Willy Tarreau | 0b74833 | 2014-04-29 00:13:29 +0200 | [diff] [blame] | 130 | }; |
| 131 | |
Willy Tarreau | 326e27e | 2018-12-11 11:04:56 +0100 | [diff] [blame] | 132 | /* Legacy version of the HTTP/1 message state, used by the channels, should |
| 133 | * ultimately be removed. |
| 134 | */ |
| 135 | enum h1_state { |
| 136 | HTTP_MSG_RQBEFORE = 0, // request: leading LF, before start line |
Christopher Faulet | 711ed6a | 2019-07-16 14:16:10 +0200 | [diff] [blame] | 137 | HTTP_MSG_RPBEFORE = 1, // response: leading LF, before start line |
Willy Tarreau | 326e27e | 2018-12-11 11:04:56 +0100 | [diff] [blame] | 138 | |
| 139 | /* error state : must be before HTTP_MSG_BODY so that (>=BODY) always indicates |
| 140 | * that data are being processed. |
| 141 | */ |
Christopher Faulet | 711ed6a | 2019-07-16 14:16:10 +0200 | [diff] [blame] | 142 | HTTP_MSG_ERROR = 2, // an error occurred |
Willy Tarreau | 326e27e | 2018-12-11 11:04:56 +0100 | [diff] [blame] | 143 | /* Body processing. |
| 144 | * The state HTTP_MSG_BODY is a delimiter to know if we're waiting for headers |
| 145 | * or body. All the sub-states below also indicate we're processing the body, |
| 146 | * with some additional information. |
| 147 | */ |
Christopher Faulet | 711ed6a | 2019-07-16 14:16:10 +0200 | [diff] [blame] | 148 | HTTP_MSG_BODY = 3, // parsing body at end of headers |
| 149 | HTTP_MSG_DATA = 4, // skipping data chunk / content-length data |
Willy Tarreau | 326e27e | 2018-12-11 11:04:56 +0100 | [diff] [blame] | 150 | /* we enter this state when we've received the end of the current message */ |
Christopher Faulet | 711ed6a | 2019-07-16 14:16:10 +0200 | [diff] [blame] | 151 | HTTP_MSG_ENDING = 5, // message end received, wait that the filters end too |
| 152 | HTTP_MSG_DONE = 6, // message end received, waiting for resync or close |
| 153 | HTTP_MSG_CLOSING = 7, // shutdown_w done, not all bytes sent yet |
| 154 | HTTP_MSG_CLOSED = 8, // shutdown_w done, all bytes sent |
| 155 | HTTP_MSG_TUNNEL = 9, // tunneled data after DONE |
Willy Tarreau | 326e27e | 2018-12-11 11:04:56 +0100 | [diff] [blame] | 156 | } __attribute__((packed)); |
| 157 | |
| 158 | |
Christopher Faulet | 711ed6a | 2019-07-16 14:16:10 +0200 | [diff] [blame] | 159 | /* This is the state of an HTTP seen from the analyzers point of view. It can be |
| 160 | * either a request message or a response message. |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 161 | */ |
| 162 | struct http_msg { |
Willy Tarreau | 0da5b3b | 2017-09-21 09:30:46 +0200 | [diff] [blame] | 163 | enum h1_state msg_state; /* where we are in the current message parsing */ |
Willy Tarreau | 3770f23 | 2013-12-07 00:01:53 +0100 | [diff] [blame] | 164 | unsigned char flags; /* flags describing the message (HTTP version, ...) */ |
Willy Tarreau | 10e61cb | 2017-01-04 14:51:22 +0100 | [diff] [blame] | 165 | /* 5 bytes unused here */ |
Willy Tarreau | 394db37 | 2012-10-12 22:40:39 +0200 | [diff] [blame] | 166 | struct channel *chn; /* pointer to the channel transporting the message */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 167 | }; |
| 168 | |
| 169 | /* This is an HTTP transaction. It contains both a request message and a |
| 170 | * response message (which can be empty). |
| 171 | */ |
| 172 | struct http_txn { |
Willy Tarreau | 520bbb2 | 2010-01-10 11:31:22 +0100 | [diff] [blame] | 173 | struct http_msg rsp; /* HTTP response message */ |
Willy Tarreau | c8987b3 | 2013-12-06 23:43:17 +0100 | [diff] [blame] | 174 | struct http_msg req; /* HTTP request message */ |
| 175 | unsigned int flags; /* transaction flags */ |
| 176 | enum http_meth_t meth; /* HTTP method */ |
| 177 | /* 1 unused byte here */ |
| 178 | short status; /* HTTP status from the server, negative if from proxy */ |
Christopher Faulet | 473e880 | 2020-01-14 11:12:37 +0100 | [diff] [blame] | 179 | struct buffer *errmsg; /* custom HTTP error message to use as reply */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 180 | |
William Lallemand | f528fff | 2017-11-23 19:43:17 +0100 | [diff] [blame] | 181 | char cache_hash[20]; /* Store the cache hash */ |
Willy Tarreau | 520bbb2 | 2010-01-10 11:31:22 +0100 | [diff] [blame] | 182 | char *uri; /* first line if log needed, NULL otherwise */ |
| 183 | char *cli_cookie; /* cookie presented by the client, in capture mode */ |
| 184 | char *srv_cookie; /* cookie presented by the server, in capture mode */ |
Willy Tarreau | f64d141 | 2010-10-07 20:06:11 +0200 | [diff] [blame] | 185 | int cookie_first_date; /* if non-zero, first date the expirable cookie was set/seen */ |
| 186 | int cookie_last_date; /* if non-zero, last date the expirable cookie was set/seen */ |
Willy Tarreau | 520bbb2 | 2010-01-10 11:31:22 +0100 | [diff] [blame] | 187 | |
Krzysztof Piotr Oledzki | f9423ae | 2010-01-29 19:26:18 +0100 | [diff] [blame] | 188 | struct http_auth_data auth; /* HTTP auth data */ |
Willy Tarreau | 3bac9ff | 2007-03-18 17:31:28 +0100 | [diff] [blame] | 189 | }; |
| 190 | |
Willy Tarreau | bafbe01 | 2017-11-24 17:34:44 +0100 | [diff] [blame] | 191 | extern struct pool_head *pool_head_http_txn; |
Willy Tarreau | eee5b51 | 2015-04-03 23:46:31 +0200 | [diff] [blame] | 192 | |
Willy Tarreau | baaee00 | 2006-06-26 02:48:02 +0200 | [diff] [blame] | 193 | #endif /* _TYPES_PROTO_HTTP_H */ |
| 194 | |
| 195 | /* |
| 196 | * Local variables: |
| 197 | * c-indent-level: 8 |
| 198 | * c-basic-offset: 8 |
| 199 | * End: |
| 200 | */ |