Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Stream filters related variables and functions. |
| 3 | * |
| 4 | * Copyright (C) 2015 Qualys Inc., Christopher Faulet <cfaulet@qualys.com> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU General Public License |
| 8 | * as published by the Free Software Foundation; either version |
| 9 | * 2 of the License, or (at your option) any later version. |
| 10 | * |
| 11 | */ |
| 12 | |
Willy Tarreau | 4c7e4b7 | 2020-05-27 12:58:42 +0200 | [diff] [blame] | 13 | #include <haproxy/api.h> |
Willy Tarreau | 6be7849 | 2020-06-05 00:00:29 +0200 | [diff] [blame] | 14 | #include <haproxy/cfgparse.h> |
Willy Tarreau | 0a3bd39 | 2020-06-04 08:52:38 +0200 | [diff] [blame] | 15 | #include <haproxy/compression.h> |
Willy Tarreau | 2741c8c | 2020-06-02 11:28:02 +0200 | [diff] [blame] | 16 | #include <haproxy/dynbuf.h> |
Willy Tarreau | c7babd8 | 2020-06-04 21:29:29 +0200 | [diff] [blame] | 17 | #include <haproxy/filters.h> |
Willy Tarreau | cd72d8c | 2020-06-02 19:11:26 +0200 | [diff] [blame] | 18 | #include <haproxy/http.h> |
Willy Tarreau | c2b1ff0 | 2020-06-04 21:21:03 +0200 | [diff] [blame] | 19 | #include <haproxy/http_ana-t.h> |
Willy Tarreau | 8773533 | 2020-06-04 09:08:41 +0200 | [diff] [blame] | 20 | #include <haproxy/http_htx.h> |
Willy Tarreau | 16f958c | 2020-06-03 08:44:35 +0200 | [diff] [blame] | 21 | #include <haproxy/htx.h> |
Willy Tarreau | 853b297 | 2020-05-27 18:01:47 +0200 | [diff] [blame] | 22 | #include <haproxy/list.h> |
Willy Tarreau | 202f93d | 2021-05-08 20:34:16 +0200 | [diff] [blame] | 23 | #include <haproxy/proxy.h> |
Willy Tarreau | e6ce10b | 2020-06-04 15:33:47 +0200 | [diff] [blame] | 24 | #include <haproxy/sample.h> |
Willy Tarreau | dfd3de8 | 2020-06-04 23:46:14 +0200 | [diff] [blame] | 25 | #include <haproxy/stream.h> |
Willy Tarreau | 48fbcae | 2020-06-03 18:09:46 +0200 | [diff] [blame] | 26 | #include <haproxy/tools.h> |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 27 | |
Christopher Faulet | 12554d0 | 2021-06-09 17:12:44 +0200 | [diff] [blame] | 28 | #define COMP_STATE_PROCESSING 0x01 |
| 29 | |
Christopher Faulet | f4a4ef7 | 2018-12-07 17:39:53 +0100 | [diff] [blame] | 30 | const char *http_comp_flt_id = "compression filter"; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 31 | |
| 32 | struct flt_ops comp_ops; |
| 33 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 34 | struct comp_state { |
| 35 | struct comp_ctx *comp_ctx; /* compression context */ |
| 36 | struct comp_algo *comp_algo; /* compression algorithm if not NULL */ |
Christopher Faulet | 12554d0 | 2021-06-09 17:12:44 +0200 | [diff] [blame] | 37 | unsigned int flags; /* COMP_STATE_* */ |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 38 | }; |
| 39 | |
Willy Tarreau | 8ceae72 | 2018-11-26 11:58:30 +0100 | [diff] [blame] | 40 | /* Pools used to allocate comp_state structs */ |
| 41 | DECLARE_STATIC_POOL(pool_head_comp_state, "comp_state", sizeof(struct comp_state)); |
| 42 | |
| 43 | static THREAD_LOCAL struct buffer tmpbuf; |
| 44 | static THREAD_LOCAL struct buffer zbuf; |
Willy Tarreau | 8ceae72 | 2018-11-26 11:58:30 +0100 | [diff] [blame] | 45 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 46 | static int select_compression_request_header(struct comp_state *st, |
| 47 | struct stream *s, |
| 48 | struct http_msg *msg); |
| 49 | static int select_compression_response_header(struct comp_state *st, |
| 50 | struct stream *s, |
| 51 | struct http_msg *msg); |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 52 | static int set_compression_response_header(struct comp_state *st, |
| 53 | struct stream *s, |
| 54 | struct http_msg *msg); |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 55 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 56 | static int htx_compression_buffer_init(struct htx *htx, struct buffer *out); |
| 57 | static int htx_compression_buffer_add_data(struct comp_state *st, const char *data, size_t len, |
| 58 | struct buffer *out); |
| 59 | static int htx_compression_buffer_end(struct comp_state *st, struct buffer *out, int end); |
| 60 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 61 | /***********************************************************************/ |
| 62 | static int |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 63 | comp_flt_init(struct proxy *px, struct flt_conf *fconf) |
| 64 | { |
Christopher Faulet | 6e54095 | 2018-12-03 22:43:41 +0100 | [diff] [blame] | 65 | fconf->flags |= FLT_CFG_FL_HTX; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 66 | return 0; |
| 67 | } |
| 68 | |
| 69 | static int |
Christopher Faulet | 8ca3b4b | 2017-07-25 11:07:15 +0200 | [diff] [blame] | 70 | comp_flt_init_per_thread(struct proxy *px, struct flt_conf *fconf) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 71 | { |
Willy Tarreau | 862ad82 | 2021-03-22 16:16:22 +0100 | [diff] [blame] | 72 | if (b_alloc(&tmpbuf) == NULL) |
Christopher Faulet | b77c5c2 | 2015-12-07 16:48:42 +0100 | [diff] [blame] | 73 | return -1; |
Willy Tarreau | 862ad82 | 2021-03-22 16:16:22 +0100 | [diff] [blame] | 74 | if (b_alloc(&zbuf) == NULL) |
Christopher Faulet | b77c5c2 | 2015-12-07 16:48:42 +0100 | [diff] [blame] | 75 | return -1; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 76 | return 0; |
| 77 | } |
| 78 | |
| 79 | static void |
Christopher Faulet | 8ca3b4b | 2017-07-25 11:07:15 +0200 | [diff] [blame] | 80 | comp_flt_deinit_per_thread(struct proxy *px, struct flt_conf *fconf) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 81 | { |
Willy Tarreau | c9fa048 | 2018-07-10 17:43:27 +0200 | [diff] [blame] | 82 | if (tmpbuf.size) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 83 | b_free(&tmpbuf); |
Willy Tarreau | c9fa048 | 2018-07-10 17:43:27 +0200 | [diff] [blame] | 84 | if (zbuf.size) |
Christopher Faulet | b77c5c2 | 2015-12-07 16:48:42 +0100 | [diff] [blame] | 85 | b_free(&zbuf); |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | static int |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 89 | comp_strm_init(struct stream *s, struct filter *filter) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 90 | { |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 91 | struct comp_state *st; |
Christopher Faulet | 8ca3b4b | 2017-07-25 11:07:15 +0200 | [diff] [blame] | 92 | |
Willy Tarreau | 5bfeb21 | 2021-03-22 15:08:17 +0100 | [diff] [blame] | 93 | st = pool_alloc(pool_head_comp_state); |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 94 | if (st == NULL) |
| 95 | return -1; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 96 | |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 97 | st->comp_algo = NULL; |
| 98 | st->comp_ctx = NULL; |
Christopher Faulet | 12554d0 | 2021-06-09 17:12:44 +0200 | [diff] [blame] | 99 | st->flags = 0; |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 100 | filter->ctx = st; |
Christopher Faulet | 3dc860d | 2017-09-15 11:39:36 +0200 | [diff] [blame] | 101 | |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 102 | /* Register post-analyzer on AN_RES_WAIT_HTTP because we need to |
| 103 | * analyze response headers before http-response rules execution |
| 104 | * to be sure we can use res.comp and res.comp_algo sample |
| 105 | * fetches */ |
| 106 | filter->post_analyzers |= AN_RES_WAIT_HTTP; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 107 | return 1; |
| 108 | } |
| 109 | |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 110 | static void |
| 111 | comp_strm_deinit(struct stream *s, struct filter *filter) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 112 | { |
| 113 | struct comp_state *st = filter->ctx; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 114 | |
Christopher Faulet | d60b3cf | 2017-06-26 11:47:13 +0200 | [diff] [blame] | 115 | if (!st) |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 116 | return; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 117 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 118 | /* release any possible compression context */ |
Christopher Faulet | d60b3cf | 2017-06-26 11:47:13 +0200 | [diff] [blame] | 119 | if (st->comp_algo) |
| 120 | st->comp_algo->end(&st->comp_ctx); |
Willy Tarreau | bafbe01 | 2017-11-24 17:34:44 +0100 | [diff] [blame] | 121 | pool_free(pool_head_comp_state, st); |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 122 | filter->ctx = NULL; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 123 | } |
| 124 | |
| 125 | static int |
Christopher Faulet | 1339d74 | 2016-05-11 16:48:33 +0200 | [diff] [blame] | 126 | comp_http_headers(struct stream *s, struct filter *filter, struct http_msg *msg) |
| 127 | { |
| 128 | struct comp_state *st = filter->ctx; |
| 129 | |
| 130 | if (!strm_fe(s)->comp && !s->be->comp) |
| 131 | goto end; |
| 132 | |
| 133 | if (!(msg->chn->flags & CF_ISRESP)) |
| 134 | select_compression_request_header(st, s, msg); |
| 135 | else { |
Christopher Faulet | 3dc860d | 2017-09-15 11:39:36 +0200 | [diff] [blame] | 136 | /* Response headers have already been checked in |
| 137 | * comp_http_post_analyze callback. */ |
Christopher Faulet | 1339d74 | 2016-05-11 16:48:33 +0200 | [diff] [blame] | 138 | if (st->comp_algo) { |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 139 | if (!set_compression_response_header(st, s, msg)) |
| 140 | goto end; |
Christopher Faulet | 1339d74 | 2016-05-11 16:48:33 +0200 | [diff] [blame] | 141 | register_data_filter(s, msg->chn, filter); |
Christopher Faulet | 12554d0 | 2021-06-09 17:12:44 +0200 | [diff] [blame] | 142 | st->flags |= COMP_STATE_PROCESSING; |
Christopher Faulet | 1339d74 | 2016-05-11 16:48:33 +0200 | [diff] [blame] | 143 | } |
| 144 | } |
| 145 | |
| 146 | end: |
| 147 | return 1; |
| 148 | } |
| 149 | |
| 150 | static int |
Christopher Faulet | 3dc860d | 2017-09-15 11:39:36 +0200 | [diff] [blame] | 151 | comp_http_post_analyze(struct stream *s, struct filter *filter, |
| 152 | struct channel *chn, unsigned an_bit) |
| 153 | { |
| 154 | struct http_txn *txn = s->txn; |
| 155 | struct http_msg *msg = &txn->rsp; |
| 156 | struct comp_state *st = filter->ctx; |
| 157 | |
| 158 | if (an_bit != AN_RES_WAIT_HTTP) |
| 159 | goto end; |
| 160 | |
| 161 | if (!strm_fe(s)->comp && !s->be->comp) |
| 162 | goto end; |
| 163 | |
| 164 | select_compression_response_header(st, s, msg); |
| 165 | |
| 166 | end: |
| 167 | return 1; |
| 168 | } |
| 169 | |
| 170 | static int |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 171 | comp_http_payload(struct stream *s, struct filter *filter, struct http_msg *msg, |
| 172 | unsigned int offset, unsigned int len) |
| 173 | { |
| 174 | struct comp_state *st = filter->ctx; |
Christopher Faulet | 27ba2dc | 2018-12-05 11:53:24 +0100 | [diff] [blame] | 175 | struct htx *htx = htxbuf(&msg->chn->buf); |
Christopher Faulet | e6a62bf | 2020-03-02 16:20:05 +0100 | [diff] [blame] | 176 | struct htx_ret htxret = htx_find_offset(htx, offset); |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 177 | struct htx_blk *blk, *next; |
| 178 | int ret, consumed = 0, to_forward = 0, last = 0; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 179 | |
Christopher Faulet | e6a62bf | 2020-03-02 16:20:05 +0100 | [diff] [blame] | 180 | blk = htxret.blk; |
| 181 | offset = htxret.ret; |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 182 | for (next = NULL; blk && len; blk = next) { |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 183 | enum htx_blk_type type = htx_get_blk_type(blk); |
| 184 | uint32_t sz = htx_get_blksz(blk); |
| 185 | struct ist v; |
| 186 | |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 187 | next = htx_get_next_blk(htx, blk); |
| 188 | while (next && htx_get_blk_type(next) == HTX_BLK_UNUSED) |
Christopher Faulet | 86ca0e5 | 2021-06-09 16:59:02 +0200 | [diff] [blame] | 189 | next = htx_get_next_blk(htx, next); |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 190 | |
Christopher Faulet | 12554d0 | 2021-06-09 17:12:44 +0200 | [diff] [blame] | 191 | if (!(st->flags & COMP_STATE_PROCESSING)) |
| 192 | goto consume; |
| 193 | |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 194 | if (htx_compression_buffer_init(htx, &trash) < 0) { |
| 195 | msg->chn->flags |= CF_WAKE_WRITE; |
| 196 | goto end; |
| 197 | } |
| 198 | |
| 199 | switch (type) { |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 200 | case HTX_BLK_DATA: |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 201 | /* it is the last data block */ |
| 202 | last = ((!next && (htx->flags & HTX_FL_EOM)) || (next && htx_get_blk_type(next) != HTX_BLK_DATA)); |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 203 | v = htx_get_blk_value(htx, blk); |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 204 | v = istadv(v, offset); |
| 205 | if (v.len > len) { |
| 206 | last = 0; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 207 | v.len = len; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 208 | } |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 209 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 210 | ret = htx_compression_buffer_add_data(st, v.ptr, v.len, &trash); |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 211 | if (ret < 0 || htx_compression_buffer_end(st, &trash, last) < 0) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 212 | goto error; |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 213 | BUG_ON(v.len != ret); |
| 214 | |
| 215 | if (ret == sz && !b_data(&trash)) |
| 216 | next = htx_remove_blk(htx, blk); |
Christopher Faulet | 402740c | 2021-06-09 17:04:37 +0200 | [diff] [blame] | 217 | else { |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 218 | blk = htx_replace_blk_value(htx, blk, v, ist2(b_head(&trash), b_data(&trash))); |
Christopher Faulet | 402740c | 2021-06-09 17:04:37 +0200 | [diff] [blame] | 219 | next = htx_get_next_blk(htx, blk); |
| 220 | } |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 221 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 222 | len -= ret; |
| 223 | consumed += ret; |
| 224 | to_forward += b_data(&trash); |
Christopher Faulet | 12554d0 | 2021-06-09 17:12:44 +0200 | [diff] [blame] | 225 | if (last) |
| 226 | st->flags &= ~COMP_STATE_PROCESSING; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 227 | break; |
| 228 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 229 | case HTX_BLK_TLR: |
Christopher Faulet | 2d7c539 | 2019-06-03 10:41:26 +0200 | [diff] [blame] | 230 | case HTX_BLK_EOT: |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 231 | if (htx_compression_buffer_end(st, &trash, 1) < 0) |
| 232 | goto error; |
| 233 | if (b_data(&trash)) { |
| 234 | struct htx_blk *last = htx_add_last_data(htx, ist2(b_head(&trash), b_data(&trash))); |
| 235 | if (!last) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 236 | goto error; |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 237 | blk = htx_get_next_blk(htx, last); |
| 238 | if (!blk) |
| 239 | goto error; |
Christopher Faulet | 402740c | 2021-06-09 17:04:37 +0200 | [diff] [blame] | 240 | next = htx_get_next_blk(htx, blk); |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 241 | to_forward += b_data(&trash); |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 242 | } |
Christopher Faulet | 12554d0 | 2021-06-09 17:12:44 +0200 | [diff] [blame] | 243 | st->flags &= ~COMP_STATE_PROCESSING; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 244 | /* fall through */ |
| 245 | |
| 246 | default: |
Christopher Faulet | d1ac2b9 | 2020-12-02 19:12:22 +0100 | [diff] [blame] | 247 | consume: |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 248 | sz -= offset; |
| 249 | if (sz > len) |
| 250 | sz = len; |
| 251 | consumed += sz; |
| 252 | to_forward += sz; |
| 253 | len -= sz; |
| 254 | break; |
| 255 | } |
| 256 | |
| 257 | offset = 0; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 258 | } |
| 259 | |
| 260 | end: |
| 261 | if (to_forward != consumed) |
| 262 | flt_update_offsets(filter, msg->chn, to_forward - consumed); |
| 263 | |
| 264 | if (st->comp_ctx && st->comp_ctx->cur_lvl > 0) { |
Willy Tarreau | ef6fd85 | 2019-02-04 11:48:03 +0100 | [diff] [blame] | 265 | update_freq_ctr(&global.comp_bps_in, consumed); |
Olivier Houchard | 43da343 | 2019-03-08 18:50:27 +0100 | [diff] [blame] | 266 | _HA_ATOMIC_ADD(&strm_fe(s)->fe_counters.comp_in, consumed); |
| 267 | _HA_ATOMIC_ADD(&s->be->be_counters.comp_in, consumed); |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 268 | update_freq_ctr(&global.comp_bps_out, to_forward); |
Olivier Houchard | 43da343 | 2019-03-08 18:50:27 +0100 | [diff] [blame] | 269 | _HA_ATOMIC_ADD(&strm_fe(s)->fe_counters.comp_out, to_forward); |
| 270 | _HA_ATOMIC_ADD(&s->be->be_counters.comp_out, to_forward); |
Willy Tarreau | ef6fd85 | 2019-02-04 11:48:03 +0100 | [diff] [blame] | 271 | } else { |
Olivier Houchard | 43da343 | 2019-03-08 18:50:27 +0100 | [diff] [blame] | 272 | _HA_ATOMIC_ADD(&strm_fe(s)->fe_counters.comp_byp, consumed); |
| 273 | _HA_ATOMIC_ADD(&s->be->be_counters.comp_byp, consumed); |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 274 | } |
| 275 | return to_forward; |
| 276 | |
| 277 | error: |
| 278 | return -1; |
| 279 | } |
| 280 | |
Christopher Faulet | 2fb2880 | 2015-12-01 10:40:57 +0100 | [diff] [blame] | 281 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 282 | static int |
Christopher Faulet | d60b3cf | 2017-06-26 11:47:13 +0200 | [diff] [blame] | 283 | comp_http_end(struct stream *s, struct filter *filter, |
| 284 | struct http_msg *msg) |
| 285 | { |
| 286 | struct comp_state *st = filter->ctx; |
| 287 | |
| 288 | if (!(msg->chn->flags & CF_ISRESP) || !st || !st->comp_algo) |
| 289 | goto end; |
| 290 | |
| 291 | if (strm_fe(s)->mode == PR_MODE_HTTP) |
Willy Tarreau | 4781b15 | 2021-04-06 13:53:36 +0200 | [diff] [blame] | 292 | _HA_ATOMIC_INC(&strm_fe(s)->fe_counters.p.http.comp_rsp); |
Christopher Faulet | d60b3cf | 2017-06-26 11:47:13 +0200 | [diff] [blame] | 293 | if ((s->flags & SF_BE_ASSIGNED) && (s->be->mode == PR_MODE_HTTP)) |
Willy Tarreau | 4781b15 | 2021-04-06 13:53:36 +0200 | [diff] [blame] | 294 | _HA_ATOMIC_INC(&s->be->be_counters.p.http.comp_rsp); |
Christopher Faulet | d60b3cf | 2017-06-26 11:47:13 +0200 | [diff] [blame] | 295 | end: |
| 296 | return 1; |
| 297 | } |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 298 | |
Christopher Faulet | 89f2b16 | 2019-07-15 21:16:04 +0200 | [diff] [blame] | 299 | /***********************************************************************/ |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 300 | static int |
Christopher Faulet | 89f2b16 | 2019-07-15 21:16:04 +0200 | [diff] [blame] | 301 | set_compression_response_header(struct comp_state *st, struct stream *s, struct http_msg *msg) |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 302 | { |
| 303 | struct htx *htx = htxbuf(&msg->chn->buf); |
Tim Duesterhus | b229f01 | 2019-01-29 16:38:56 +0100 | [diff] [blame] | 304 | struct http_hdr_ctx ctx; |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 305 | |
| 306 | /* |
| 307 | * Add Content-Encoding header when it's not identity encoding. |
| 308 | * RFC 2616 : Identity encoding: This content-coding is used only in the |
| 309 | * Accept-Encoding header, and SHOULD NOT be used in the Content-Encoding |
| 310 | * header. |
| 311 | */ |
| 312 | if (st->comp_algo->cfg_name_len != 8 || memcmp(st->comp_algo->cfg_name, "identity", 8) != 0) { |
| 313 | struct ist v = ist2(st->comp_algo->ua_name, st->comp_algo->ua_name_len); |
| 314 | |
| 315 | if (!http_add_header(htx, ist("Content-Encoding"), v)) |
| 316 | goto error; |
| 317 | } |
| 318 | |
| 319 | /* remove Content-Length header */ |
| 320 | if (msg->flags & HTTP_MSGF_CNT_LEN) { |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 321 | ctx.blk = NULL; |
| 322 | while (http_find_header(htx, ist("Content-Length"), &ctx, 1)) |
| 323 | http_remove_header(htx, &ctx); |
| 324 | } |
| 325 | |
| 326 | /* add "Transfer-Encoding: chunked" header */ |
| 327 | if (!(msg->flags & HTTP_MSGF_TE_CHNK)) { |
| 328 | if (!http_add_header(htx, ist("Transfer-Encoding"), ist("chunked"))) |
| 329 | goto error; |
| 330 | } |
| 331 | |
Tim Duesterhus | b229f01 | 2019-01-29 16:38:56 +0100 | [diff] [blame] | 332 | /* convert "ETag" header to a weak ETag */ |
| 333 | ctx.blk = NULL; |
| 334 | if (http_find_header(htx, ist("ETag"), &ctx, 1)) { |
| 335 | if (ctx.value.ptr[0] == '"') { |
| 336 | /* This a strong ETag. Convert it to a weak one. */ |
| 337 | struct ist v = ist2(trash.area, 0); |
| 338 | if (istcat(&v, ist("W/"), trash.size) == -1 || istcat(&v, ctx.value, trash.size) == -1) |
| 339 | goto error; |
| 340 | |
| 341 | if (!http_replace_header_value(htx, &ctx, v)) |
| 342 | goto error; |
| 343 | } |
| 344 | } |
| 345 | |
Tim Duesterhus | 721d686 | 2019-06-17 16:10:07 +0200 | [diff] [blame] | 346 | if (!http_add_header(htx, ist("Vary"), ist("Accept-Encoding"))) |
| 347 | goto error; |
| 348 | |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 349 | return 1; |
| 350 | |
| 351 | error: |
| 352 | st->comp_algo->end(&st->comp_ctx); |
| 353 | st->comp_algo = NULL; |
| 354 | return 0; |
| 355 | } |
| 356 | |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 357 | /* |
| 358 | * Selects a compression algorithm depending on the client request. |
| 359 | */ |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 360 | static int |
Christopher Faulet | 89f2b16 | 2019-07-15 21:16:04 +0200 | [diff] [blame] | 361 | select_compression_request_header(struct comp_state *st, struct stream *s, struct http_msg *msg) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 362 | { |
Christopher Faulet | 27ba2dc | 2018-12-05 11:53:24 +0100 | [diff] [blame] | 363 | struct htx *htx = htxbuf(&msg->chn->buf); |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 364 | struct http_hdr_ctx ctx; |
| 365 | struct comp_algo *comp_algo = NULL; |
| 366 | struct comp_algo *comp_algo_back = NULL; |
| 367 | |
| 368 | /* Disable compression for older user agents announcing themselves as "Mozilla/4" |
| 369 | * unless they are known good (MSIE 6 with XP SP2, or MSIE 7 and later). |
| 370 | * See http://zoompf.com/2012/02/lose-the-wait-http-compression for more details. |
| 371 | */ |
| 372 | ctx.blk = NULL; |
| 373 | if (http_find_header(htx, ist("User-Agent"), &ctx, 1) && |
| 374 | ctx.value.len >= 9 && |
| 375 | memcmp(ctx.value.ptr, "Mozilla/4", 9) == 0 && |
| 376 | (ctx.value.len < 31 || |
| 377 | memcmp(ctx.value.ptr + 25, "MSIE ", 5) != 0 || |
| 378 | *(ctx.value.ptr + 30) < '6' || |
| 379 | (*(ctx.value.ptr + 30) == '6' && |
| 380 | (ctx.value.len < 54 || memcmp(ctx.value.ptr + 51, "SV1", 3) != 0)))) { |
| 381 | st->comp_algo = NULL; |
| 382 | return 0; |
| 383 | } |
| 384 | |
| 385 | /* search for the algo in the backend in priority or the frontend */ |
| 386 | if ((s->be->comp && (comp_algo_back = s->be->comp->algos)) || |
| 387 | (strm_fe(s)->comp && (comp_algo_back = strm_fe(s)->comp->algos))) { |
| 388 | int best_q = 0; |
| 389 | |
| 390 | ctx.blk = NULL; |
| 391 | while (http_find_header(htx, ist("Accept-Encoding"), &ctx, 0)) { |
| 392 | const char *qval; |
| 393 | int q; |
| 394 | int toklen; |
| 395 | |
| 396 | /* try to isolate the token from the optional q-value */ |
| 397 | toklen = 0; |
| 398 | while (toklen < ctx.value.len && HTTP_IS_TOKEN(*(ctx.value.ptr + toklen))) |
| 399 | toklen++; |
| 400 | |
| 401 | qval = ctx.value.ptr + toklen; |
| 402 | while (1) { |
Tim Duesterhus | 7750850 | 2022-03-15 13:11:06 +0100 | [diff] [blame] | 403 | while (qval < istend(ctx.value) && HTTP_IS_LWS(*qval)) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 404 | qval++; |
| 405 | |
Tim Duesterhus | 7750850 | 2022-03-15 13:11:06 +0100 | [diff] [blame] | 406 | if (qval >= istend(ctx.value) || *qval != ';') { |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 407 | qval = NULL; |
| 408 | break; |
| 409 | } |
| 410 | qval++; |
| 411 | |
Tim Duesterhus | 7750850 | 2022-03-15 13:11:06 +0100 | [diff] [blame] | 412 | while (qval < istend(ctx.value) && HTTP_IS_LWS(*qval)) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 413 | qval++; |
| 414 | |
Tim Duesterhus | 7750850 | 2022-03-15 13:11:06 +0100 | [diff] [blame] | 415 | if (qval >= istend(ctx.value)) { |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 416 | qval = NULL; |
| 417 | break; |
| 418 | } |
Tim Duesterhus | 7750850 | 2022-03-15 13:11:06 +0100 | [diff] [blame] | 419 | if (strncmp(qval, "q=", MIN(istend(ctx.value) - qval, 2)) == 0) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 420 | break; |
| 421 | |
Tim Duesterhus | 7750850 | 2022-03-15 13:11:06 +0100 | [diff] [blame] | 422 | while (qval < istend(ctx.value) && *qval != ';') |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 423 | qval++; |
| 424 | } |
| 425 | |
| 426 | /* here we have qval pointing to the first "q=" attribute or NULL if not found */ |
| 427 | q = qval ? http_parse_qvalue(qval + 2, NULL) : 1000; |
| 428 | |
| 429 | if (q <= best_q) |
| 430 | continue; |
| 431 | |
| 432 | for (comp_algo = comp_algo_back; comp_algo; comp_algo = comp_algo->next) { |
| 433 | if (*(ctx.value.ptr) == '*' || |
| 434 | word_match(ctx.value.ptr, toklen, comp_algo->ua_name, comp_algo->ua_name_len)) { |
| 435 | st->comp_algo = comp_algo; |
| 436 | best_q = q; |
| 437 | break; |
| 438 | } |
| 439 | } |
| 440 | } |
| 441 | } |
| 442 | |
| 443 | /* remove all occurrences of the header when "compression offload" is set */ |
| 444 | if (st->comp_algo) { |
| 445 | if ((s->be->comp && s->be->comp->offload) || |
| 446 | (strm_fe(s)->comp && strm_fe(s)->comp->offload)) { |
| 447 | http_remove_header(htx, &ctx); |
| 448 | ctx.blk = NULL; |
| 449 | while (http_find_header(htx, ist("Accept-Encoding"), &ctx, 1)) |
| 450 | http_remove_header(htx, &ctx); |
| 451 | } |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 452 | return 1; |
| 453 | } |
| 454 | |
| 455 | /* identity is implicit does not require headers */ |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 456 | if ((s->be->comp && (comp_algo_back = s->be->comp->algos)) || |
| 457 | (strm_fe(s)->comp && (comp_algo_back = strm_fe(s)->comp->algos))) { |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 458 | for (comp_algo = comp_algo_back; comp_algo; comp_algo = comp_algo->next) { |
| 459 | if (comp_algo->cfg_name_len == 8 && memcmp(comp_algo->cfg_name, "identity", 8) == 0) { |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 460 | st->comp_algo = comp_algo; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 461 | return 1; |
| 462 | } |
| 463 | } |
| 464 | } |
| 465 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 466 | st->comp_algo = NULL; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 467 | return 0; |
| 468 | } |
| 469 | |
| 470 | /* |
Ilya Shipitsin | 46a030c | 2020-07-05 16:36:08 +0500 | [diff] [blame] | 471 | * Selects a compression algorithm depending of the server response. |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 472 | */ |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 473 | static int |
Christopher Faulet | 89f2b16 | 2019-07-15 21:16:04 +0200 | [diff] [blame] | 474 | select_compression_response_header(struct comp_state *st, struct stream *s, struct http_msg *msg) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 475 | { |
Christopher Faulet | 27ba2dc | 2018-12-05 11:53:24 +0100 | [diff] [blame] | 476 | struct htx *htx = htxbuf(&msg->chn->buf); |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 477 | struct http_txn *txn = s->txn; |
| 478 | struct http_hdr_ctx ctx; |
| 479 | struct comp_type *comp_type; |
| 480 | |
| 481 | /* no common compression algorithm was found in request header */ |
| 482 | if (st->comp_algo == NULL) |
| 483 | goto fail; |
| 484 | |
Christopher Faulet | 1d3613a | 2019-01-07 14:41:59 +0100 | [diff] [blame] | 485 | /* compression already in progress */ |
| 486 | if (msg->flags & HTTP_MSGF_COMPRESSING) |
| 487 | goto fail; |
| 488 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 489 | /* HTTP < 1.1 should not be compressed */ |
| 490 | if (!(msg->flags & HTTP_MSGF_VER_11) || !(txn->req.flags & HTTP_MSGF_VER_11)) |
| 491 | goto fail; |
| 492 | |
| 493 | if (txn->meth == HTTP_METH_HEAD) |
| 494 | goto fail; |
| 495 | |
| 496 | /* compress 200,201,202,203 responses only */ |
| 497 | if ((txn->status != 200) && |
| 498 | (txn->status != 201) && |
| 499 | (txn->status != 202) && |
| 500 | (txn->status != 203)) |
| 501 | goto fail; |
| 502 | |
Christopher Faulet | c963eb2 | 2018-12-21 14:53:54 +0100 | [diff] [blame] | 503 | if (!(msg->flags & HTTP_MSGF_XFER_LEN) || msg->flags & HTTP_MSGF_BODYLESS) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 504 | goto fail; |
| 505 | |
| 506 | /* content is already compressed */ |
| 507 | ctx.blk = NULL; |
| 508 | if (http_find_header(htx, ist("Content-Encoding"), &ctx, 1)) |
| 509 | goto fail; |
| 510 | |
| 511 | /* no compression when Cache-Control: no-transform is present in the message */ |
| 512 | ctx.blk = NULL; |
| 513 | while (http_find_header(htx, ist("Cache-Control"), &ctx, 0)) { |
| 514 | if (word_match(ctx.value.ptr, ctx.value.len, "no-transform", 12)) |
| 515 | goto fail; |
| 516 | } |
| 517 | |
Tim Duesterhus | b229f01 | 2019-01-29 16:38:56 +0100 | [diff] [blame] | 518 | /* no compression when ETag is malformed */ |
| 519 | ctx.blk = NULL; |
| 520 | if (http_find_header(htx, ist("ETag"), &ctx, 1)) { |
Tim Duesterhus | 6414cd1 | 2020-09-01 18:32:35 +0200 | [diff] [blame] | 521 | if (http_get_etag_type(ctx.value) == ETAG_INVALID) |
Tim Duesterhus | b229f01 | 2019-01-29 16:38:56 +0100 | [diff] [blame] | 522 | goto fail; |
Tim Duesterhus | b229f01 | 2019-01-29 16:38:56 +0100 | [diff] [blame] | 523 | } |
| 524 | /* no compression when multiple ETags are present |
| 525 | * Note: Do not reset ctx.blk! |
| 526 | */ |
| 527 | if (http_find_header(htx, ist("ETag"), &ctx, 1)) |
| 528 | goto fail; |
| 529 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 530 | comp_type = NULL; |
| 531 | |
| 532 | /* we don't want to compress multipart content-types, nor content-types that are |
| 533 | * not listed in the "compression type" directive if any. If no content-type was |
| 534 | * found but configuration requires one, we don't compress either. Backend has |
| 535 | * the priority. |
| 536 | */ |
| 537 | ctx.blk = NULL; |
| 538 | if (http_find_header(htx, ist("Content-Type"), &ctx, 1)) { |
| 539 | if (ctx.value.len >= 9 && strncasecmp("multipart", ctx.value.ptr, 9) == 0) |
| 540 | goto fail; |
| 541 | |
| 542 | if ((s->be->comp && (comp_type = s->be->comp->types)) || |
| 543 | (strm_fe(s)->comp && (comp_type = strm_fe(s)->comp->types))) { |
| 544 | for (; comp_type; comp_type = comp_type->next) { |
| 545 | if (ctx.value.len >= comp_type->name_len && |
| 546 | strncasecmp(ctx.value.ptr, comp_type->name, comp_type->name_len) == 0) |
| 547 | /* this Content-Type should be compressed */ |
| 548 | break; |
| 549 | } |
| 550 | /* this Content-Type should not be compressed */ |
| 551 | if (comp_type == NULL) |
| 552 | goto fail; |
| 553 | } |
| 554 | } |
| 555 | else { /* no content-type header */ |
| 556 | if ((s->be->comp && s->be->comp->types) || |
| 557 | (strm_fe(s)->comp && strm_fe(s)->comp->types)) |
| 558 | goto fail; /* a content-type was required */ |
| 559 | } |
| 560 | |
| 561 | /* limit compression rate */ |
| 562 | if (global.comp_rate_lim > 0) |
| 563 | if (read_freq_ctr(&global.comp_bps_in) > global.comp_rate_lim) |
| 564 | goto fail; |
| 565 | |
| 566 | /* limit cpu usage */ |
Willy Tarreau | 45c38e2 | 2021-09-30 18:28:49 +0200 | [diff] [blame] | 567 | if (th_ctx->idle_pct < compress_min_idle) |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 568 | goto fail; |
| 569 | |
| 570 | /* initialize compression */ |
| 571 | if (st->comp_algo->init(&st->comp_ctx, global.tune.comp_maxlevel) < 0) |
| 572 | goto fail; |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 573 | msg->flags |= HTTP_MSGF_COMPRESSING; |
| 574 | return 1; |
| 575 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 576 | fail: |
| 577 | st->comp_algo = NULL; |
| 578 | return 0; |
| 579 | } |
| 580 | |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 581 | /***********************************************************************/ |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 582 | static int |
| 583 | htx_compression_buffer_init(struct htx *htx, struct buffer *out) |
| 584 | { |
| 585 | /* output stream requires at least 10 bytes for the gzip header, plus |
| 586 | * at least 8 bytes for the gzip trailer (crc+len), plus a possible |
| 587 | * plus at most 5 bytes per 32kB block and 2 bytes to close the stream. |
| 588 | */ |
| 589 | if (htx_free_space(htx) < 20 + 5 * ((htx->data + 32767) >> 15)) |
| 590 | return -1; |
| 591 | b_reset(out); |
| 592 | return 0; |
| 593 | } |
| 594 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 595 | static int |
| 596 | htx_compression_buffer_add_data(struct comp_state *st, const char *data, size_t len, |
| 597 | struct buffer *out) |
| 598 | { |
| 599 | return st->comp_algo->add_data(st->comp_ctx, data, len, out); |
| 600 | } |
| 601 | |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 602 | static int |
| 603 | htx_compression_buffer_end(struct comp_state *st, struct buffer *out, int end) |
| 604 | { |
| 605 | if (end) |
| 606 | return st->comp_algo->finish(st->comp_ctx, out); |
| 607 | else |
| 608 | return st->comp_algo->flush(st->comp_ctx, out); |
| 609 | } |
| 610 | |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 611 | |
| 612 | /***********************************************************************/ |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 613 | struct flt_ops comp_ops = { |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 614 | .init = comp_flt_init, |
Christopher Faulet | 8ca3b4b | 2017-07-25 11:07:15 +0200 | [diff] [blame] | 615 | .init_per_thread = comp_flt_init_per_thread, |
| 616 | .deinit_per_thread = comp_flt_deinit_per_thread, |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 617 | |
Christopher Faulet | 5e89651 | 2020-03-06 14:59:05 +0100 | [diff] [blame] | 618 | .attach = comp_strm_init, |
| 619 | .detach = comp_strm_deinit, |
| 620 | |
Christopher Faulet | 3dc860d | 2017-09-15 11:39:36 +0200 | [diff] [blame] | 621 | .channel_post_analyze = comp_http_post_analyze, |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 622 | |
Christopher Faulet | 1339d74 | 2016-05-11 16:48:33 +0200 | [diff] [blame] | 623 | .http_headers = comp_http_headers, |
Christopher Faulet | e6902cd | 2018-11-30 22:29:48 +0100 | [diff] [blame] | 624 | .http_payload = comp_http_payload, |
| 625 | .http_end = comp_http_end, |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 626 | }; |
| 627 | |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 628 | static int |
| 629 | parse_compression_options(char **args, int section, struct proxy *proxy, |
Willy Tarreau | 0182516 | 2021-03-09 09:53:46 +0100 | [diff] [blame] | 630 | const struct proxy *defpx, const char *file, int line, |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 631 | char **err) |
| 632 | { |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 633 | struct comp *comp; |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 634 | int ret = 0; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 635 | |
| 636 | if (proxy->comp == NULL) { |
Vincent Bernat | 02779b6 | 2016-04-03 13:48:43 +0200 | [diff] [blame] | 637 | comp = calloc(1, sizeof(*comp)); |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 638 | proxy->comp = comp; |
| 639 | } |
| 640 | else |
| 641 | comp = proxy->comp; |
| 642 | |
Tim Duesterhus | e5ff141 | 2021-01-02 22:31:53 +0100 | [diff] [blame] | 643 | if (strcmp(args[1], "algo") == 0) { |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 644 | struct comp_ctx *ctx; |
| 645 | int cur_arg = 2; |
| 646 | |
| 647 | if (!*args[cur_arg]) { |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 648 | memprintf(err, "parsing [%s:%d] : '%s' expects <algorithm>.", |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 649 | file, line, args[0]); |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 650 | ret = -1; |
| 651 | goto end; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 652 | } |
| 653 | while (*(args[cur_arg])) { |
Remi Tricot-Le Breton | 6443bcc | 2021-05-17 10:35:08 +0200 | [diff] [blame] | 654 | int retval = comp_append_algo(comp, args[cur_arg]); |
| 655 | if (retval) { |
| 656 | if (retval < 0) |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 657 | memprintf(err, "'%s' : '%s' is not a supported algorithm.", |
Remi Tricot-Le Breton | 6443bcc | 2021-05-17 10:35:08 +0200 | [diff] [blame] | 658 | args[0], args[cur_arg]); |
| 659 | else |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 660 | memprintf(err, "'%s' : out of memory while parsing algo '%s'.", |
Remi Tricot-Le Breton | 6443bcc | 2021-05-17 10:35:08 +0200 | [diff] [blame] | 661 | args[0], args[cur_arg]); |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 662 | ret = -1; |
| 663 | goto end; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 664 | } |
Remi Tricot-Le Breton | 6443bcc | 2021-05-17 10:35:08 +0200 | [diff] [blame] | 665 | |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 666 | if (proxy->comp->algos->init(&ctx, 9) == 0) |
| 667 | proxy->comp->algos->end(&ctx); |
| 668 | else { |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 669 | memprintf(err, "'%s' : Can't init '%s' algorithm.", |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 670 | args[0], args[cur_arg]); |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 671 | ret = -1; |
| 672 | goto end; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 673 | } |
| 674 | cur_arg++; |
| 675 | continue; |
| 676 | } |
| 677 | } |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 678 | else if (strcmp(args[1], "offload") == 0) { |
| 679 | if (proxy->cap & PR_CAP_DEF) { |
| 680 | memprintf(err, "'%s' : '%s' ignored in 'defaults' section.", |
| 681 | args[0], args[1]); |
| 682 | ret = 1; |
| 683 | } |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 684 | comp->offload = 1; |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 685 | } |
Tim Duesterhus | e5ff141 | 2021-01-02 22:31:53 +0100 | [diff] [blame] | 686 | else if (strcmp(args[1], "type") == 0) { |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 687 | int cur_arg = 2; |
| 688 | |
| 689 | if (!*args[cur_arg]) { |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 690 | memprintf(err, "'%s' expects <type>.", args[0]); |
| 691 | ret = -1; |
| 692 | goto end; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 693 | } |
| 694 | while (*(args[cur_arg])) { |
Remi Tricot-Le Breton | 6443bcc | 2021-05-17 10:35:08 +0200 | [diff] [blame] | 695 | if (comp_append_type(comp, args[cur_arg])) { |
| 696 | memprintf(err, "'%s': out of memory.", args[0]); |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 697 | ret = -1; |
| 698 | goto end; |
Remi Tricot-Le Breton | 6443bcc | 2021-05-17 10:35:08 +0200 | [diff] [blame] | 699 | } |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 700 | cur_arg++; |
| 701 | continue; |
| 702 | } |
| 703 | } |
| 704 | else { |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 705 | memprintf(err, "'%s' expects 'algo', 'type' or 'offload'", |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 706 | args[0]); |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 707 | ret = -1; |
| 708 | goto end; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 709 | } |
| 710 | |
Christopher Faulet | 44d34bf | 2021-11-05 12:06:14 +0100 | [diff] [blame] | 711 | end: |
| 712 | return ret; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 713 | } |
| 714 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 715 | static int |
| 716 | parse_http_comp_flt(char **args, int *cur_arg, struct proxy *px, |
Thierry Fournier | 3610c39 | 2016-04-13 18:27:51 +0200 | [diff] [blame] | 717 | struct flt_conf *fconf, char **err, void *private) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 718 | { |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 719 | struct flt_conf *fc, *back; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 720 | |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 721 | list_for_each_entry_safe(fc, back, &px->filter_configs, list) { |
| 722 | if (fc->id == http_comp_flt_id) { |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 723 | memprintf(err, "%s: Proxy supports only one compression filter\n", px->id); |
| 724 | return -1; |
| 725 | } |
| 726 | } |
| 727 | |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 728 | fconf->id = http_comp_flt_id; |
| 729 | fconf->conf = NULL; |
| 730 | fconf->ops = &comp_ops; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 731 | (*cur_arg)++; |
| 732 | |
| 733 | return 0; |
| 734 | } |
| 735 | |
| 736 | |
| 737 | int |
Christopher Faulet | c9df7f7 | 2018-12-10 16:14:04 +0100 | [diff] [blame] | 738 | check_implicit_http_comp_flt(struct proxy *proxy) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 739 | { |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 740 | struct flt_conf *fconf; |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 741 | int explicit = 0; |
| 742 | int comp = 0; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 743 | int err = 0; |
| 744 | |
| 745 | if (proxy->comp == NULL) |
| 746 | goto end; |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 747 | if (!LIST_ISEMPTY(&proxy->filter_configs)) { |
| 748 | list_for_each_entry(fconf, &proxy->filter_configs, list) { |
| 749 | if (fconf->id == http_comp_flt_id) |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 750 | comp = 1; |
| 751 | else if (fconf->id == cache_store_flt_id) { |
| 752 | if (comp) { |
| 753 | ha_alert("config: %s '%s': unable to enable the compression filter " |
| 754 | "before any cache filter.\n", |
| 755 | proxy_type_str(proxy), proxy->id); |
| 756 | err++; |
| 757 | goto end; |
| 758 | } |
| 759 | } |
Christopher Faulet | 78fbb9f | 2019-08-11 23:11:03 +0200 | [diff] [blame] | 760 | else if (fconf->id == fcgi_flt_id) |
| 761 | continue; |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 762 | else |
| 763 | explicit = 1; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 764 | } |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 765 | } |
| 766 | if (comp) |
| 767 | goto end; |
| 768 | else if (explicit) { |
| 769 | ha_alert("config: %s '%s': require an explicit filter declaration to use " |
| 770 | "HTTP compression\n", proxy_type_str(proxy), proxy->id); |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 771 | err++; |
| 772 | goto end; |
| 773 | } |
| 774 | |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 775 | /* Implicit declaration of the compression filter is always the last |
| 776 | * one */ |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 777 | fconf = calloc(1, sizeof(*fconf)); |
| 778 | if (!fconf) { |
Christopher Faulet | 767a84b | 2017-11-24 16:50:31 +0100 | [diff] [blame] | 779 | ha_alert("config: %s '%s': out of memory\n", |
| 780 | proxy_type_str(proxy), proxy->id); |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 781 | err++; |
| 782 | goto end; |
| 783 | } |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 784 | fconf->id = http_comp_flt_id; |
| 785 | fconf->conf = NULL; |
| 786 | fconf->ops = &comp_ops; |
Willy Tarreau | 2b71810 | 2021-04-21 07:32:39 +0200 | [diff] [blame] | 787 | LIST_APPEND(&proxy->filter_configs, &fconf->list); |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 788 | end: |
| 789 | return err; |
| 790 | } |
| 791 | |
| 792 | /* |
| 793 | * boolean, returns true if compression is used (either gzip or deflate) in the |
| 794 | * response. |
| 795 | */ |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 796 | static int |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 797 | smp_fetch_res_comp(const struct arg *args, struct sample *smp, const char *kw, |
| 798 | void *private) |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 799 | { |
Willy Tarreau | be508f1 | 2016-03-10 11:47:01 +0100 | [diff] [blame] | 800 | struct http_txn *txn = smp->strm ? smp->strm->txn : NULL; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 801 | |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 802 | smp->data.type = SMP_T_BOOL; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 803 | smp->data.u.sint = (txn && (txn->rsp.flags & HTTP_MSGF_COMPRESSING)); |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 804 | return 1; |
| 805 | } |
| 806 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 807 | /* |
| 808 | * string, returns algo |
| 809 | */ |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 810 | static int |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 811 | smp_fetch_res_comp_algo(const struct arg *args, struct sample *smp, |
| 812 | const char *kw, void *private) |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 813 | { |
Willy Tarreau | be508f1 | 2016-03-10 11:47:01 +0100 | [diff] [blame] | 814 | struct http_txn *txn = smp->strm ? smp->strm->txn : NULL; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 815 | struct filter *filter; |
| 816 | struct comp_state *st; |
| 817 | |
Christopher Faulet | 03d8553 | 2017-09-15 10:14:43 +0200 | [diff] [blame] | 818 | if (!txn || !(txn->rsp.flags & HTTP_MSGF_COMPRESSING)) |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 819 | return 0; |
| 820 | |
Christopher Faulet | fcf035c | 2015-12-03 11:48:03 +0100 | [diff] [blame] | 821 | list_for_each_entry(filter, &strm_flt(smp->strm)->filters, list) { |
Christopher Faulet | 443ea1a | 2016-02-04 13:40:26 +0100 | [diff] [blame] | 822 | if (FLT_ID(filter) != http_comp_flt_id) |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 823 | continue; |
| 824 | |
| 825 | if (!(st = filter->ctx)) |
| 826 | break; |
| 827 | |
| 828 | smp->data.type = SMP_T_STR; |
| 829 | smp->flags = SMP_F_CONST; |
Willy Tarreau | 843b7cb | 2018-07-13 10:54:26 +0200 | [diff] [blame] | 830 | smp->data.u.str.area = st->comp_algo->cfg_name; |
| 831 | smp->data.u.str.data = st->comp_algo->cfg_name_len; |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 832 | return 1; |
| 833 | } |
| 834 | return 0; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 835 | } |
| 836 | |
| 837 | /* Declare the config parser for "compression" keyword */ |
| 838 | static struct cfg_kw_list cfg_kws = {ILH, { |
| 839 | { CFG_LISTEN, "compression", parse_compression_options }, |
| 840 | { 0, NULL, NULL }, |
| 841 | } |
| 842 | }; |
| 843 | |
Willy Tarreau | 0108d90 | 2018-11-25 19:14:37 +0100 | [diff] [blame] | 844 | INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws); |
| 845 | |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 846 | /* Declare the filter parser for "compression" keyword */ |
| 847 | static struct flt_kw_list filter_kws = { "COMP", { }, { |
Thierry Fournier | 3610c39 | 2016-04-13 18:27:51 +0200 | [diff] [blame] | 848 | { "compression", parse_http_comp_flt, NULL }, |
| 849 | { NULL, NULL, NULL }, |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 850 | } |
| 851 | }; |
| 852 | |
Willy Tarreau | 0108d90 | 2018-11-25 19:14:37 +0100 | [diff] [blame] | 853 | INITCALL1(STG_REGISTER, flt_register_keywords, &filter_kws); |
| 854 | |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 855 | /* Note: must not be declared <const> as its list will be overwritten */ |
| 856 | static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, { |
Christopher Faulet | 92d3638 | 2015-11-05 13:35:03 +0100 | [diff] [blame] | 857 | { "res.comp", smp_fetch_res_comp, 0, NULL, SMP_T_BOOL, SMP_USE_HRSHP }, |
| 858 | { "res.comp_algo", smp_fetch_res_comp_algo, 0, NULL, SMP_T_STR, SMP_USE_HRSHP }, |
| 859 | { /* END */ }, |
| 860 | } |
| 861 | }; |
Christopher Faulet | 3d97c90 | 2015-12-09 14:59:38 +0100 | [diff] [blame] | 862 | |
Willy Tarreau | 0108d90 | 2018-11-25 19:14:37 +0100 | [diff] [blame] | 863 | INITCALL1(STG_REGISTER, sample_register_fetches, &sample_fetch_keywords); |