blob: a95abe5d4f763c76254e0b6e456966d5192bb947 [file] [log] [blame]
William Lallemand41db4602017-10-30 11:15:51 +01001/*
2 * Cache management
3 *
4 * Copyright 2017 HAProxy Technologies
5 * William Lallemand <wlallemand@haproxy.com>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 */
12
Willy Tarreaub2551052020-06-09 09:07:15 +020013#include <import/eb32tree.h>
14#include <import/sha1.h>
15
Willy Tarreau122eba92020-06-04 10:15:32 +020016#include <haproxy/action-t.h>
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020017#include <haproxy/api.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020018#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020019#include <haproxy/channel.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020020#include <haproxy/cli.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020021#include <haproxy/errors.h>
Willy Tarreauc7babd82020-06-04 21:29:29 +020022#include <haproxy/filters.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020023#include <haproxy/hash.h>
Remi Tricot-Le Bretondbb65b52020-10-22 10:40:04 +020024#include <haproxy/http.h>
Willy Tarreauc2b1ff02020-06-04 21:21:03 +020025#include <haproxy/http_ana.h>
Willy Tarreau87735332020-06-04 09:08:41 +020026#include <haproxy/http_htx.h>
Willy Tarreauc761f842020-06-04 11:40:28 +020027#include <haproxy/http_rules.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020028#include <haproxy/htx.h>
29#include <haproxy/net_helper.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020030#include <haproxy/proxy.h>
Remi Tricot-Le Bretonbf971212020-10-27 11:55:57 +010031#include <haproxy/sample.h>
Willy Tarreau334099c2020-06-03 18:38:48 +020032#include <haproxy/shctx.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020033#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020034#include <haproxy/stream_interface.h>
William Lallemand41db4602017-10-30 11:15:51 +010035
Christopher Faulet27d93c32018-12-15 22:32:02 +010036#define CACHE_FLT_F_IMPLICIT_DECL 0x00000001 /* The cache filtre was implicitly declared (ie without
Christopher Faulet99a17a22018-12-11 09:18:27 +010037 * the filter keyword) */
Tim Duesterhusd7c6e6a2020-09-14 18:01:33 +020038#define CACHE_FLT_INIT 0x00000002 /* Whether the cache name was freed. */
Christopher Fauletafd819c2018-12-11 08:57:45 +010039
Christopher Fauletf4a4ef72018-12-07 17:39:53 +010040const char *cache_store_flt_id = "cache store filter";
William Lallemand41db4602017-10-30 11:15:51 +010041
Willy Tarreau2231b632019-03-29 18:26:52 +010042extern struct applet http_cache_applet;
William Lallemand41db4602017-10-30 11:15:51 +010043
44struct flt_ops cache_ops;
45
46struct cache {
Willy Tarreaufd5efb52017-11-26 08:54:31 +010047 struct list list; /* cache linked list */
William Lallemand41db4602017-10-30 11:15:51 +010048 struct eb_root entries; /* head of cache entries based on keys */
Willy Tarreaufd5efb52017-11-26 08:54:31 +010049 unsigned int maxage; /* max-age */
50 unsigned int maxblocks;
Frédéric Lécaille4eba5442018-10-25 20:29:31 +020051 unsigned int maxobjsz; /* max-object-size (in bytes) */
Remi Tricot-Le Breton5853c0c2020-12-10 17:58:43 +010052 unsigned int max_secondary_entries; /* maximum number of secondary entries with the same primary hash */
Remi Tricot-Le Breton754b2422020-11-16 15:56:10 +010053 uint8_t vary_processing_enabled; /* boolean : manage Vary header (disabled by default) */
Willy Tarreaufd5efb52017-11-26 08:54:31 +010054 char id[33]; /* cache name */
William Lallemand41db4602017-10-30 11:15:51 +010055};
56
Christopher Faulet95220e22018-12-07 17:34:39 +010057/* cache config for filters */
58struct cache_flt_conf {
59 union {
60 struct cache *cache; /* cache used by the filter */
61 char *name; /* cache name used during conf parsing */
62 } c;
63 unsigned int flags; /* CACHE_FLT_F_* */
64};
65
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +010066
67/*
68 * Vary-related structures and functions
69 */
70enum vary_header_bit {
71 VARY_ACCEPT_ENCODING = (1 << 0),
72 VARY_REFERER = (1 << 1),
73 VARY_LAST /* should always be last */
74};
75
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +010076/*
77 * Encoding list extracted from
78 * https://www.iana.org/assignments/http-parameters/http-parameters.xhtml
79 * and RFC7231#5.3.4.
80 */
81enum vary_encoding {
82 VARY_ENCODING_GZIP = (1 << 0),
83 VARY_ENCODING_DEFLATE = (1 << 1),
84 VARY_ENCODING_BR = (1 << 2),
85 VARY_ENCODING_COMPRESS = (1 << 3),
86 VARY_ENCODING_AES128GCM = (1 << 4),
87 VARY_ENCODING_EXI = (1 << 5),
88 VARY_ENCODING_PACK200_GZIP = (1 << 6),
89 VARY_ENCODING_ZSTD = (1 << 7),
90 VARY_ENCODING_IDENTITY = (1 << 8),
91 VARY_ENCODING_STAR = (1 << 9),
92 VARY_ENCODING_OTHER = (1 << 10)
93};
94
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +010095struct vary_hashing_information {
96 struct ist hdr_name; /* Header name */
Ilya Shipitsinf38a0182020-12-21 01:16:17 +050097 enum vary_header_bit value; /* Bit representing the header in a vary signature */
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +010098 unsigned int hash_length; /* Size of the sub hash for this header's value */
Remi Tricot-Le Breton6a34b2b2020-12-23 18:13:47 +010099 int(*norm_fn)(struct htx*,struct ist hdr_name,char* buf,unsigned int* buf_len); /* Normalization function */
Tim Duesterhused84d842021-01-18 13:41:17 +0100100 int(*cmp_fn)(const void *ref, const void *new, unsigned int len); /* Comparison function, should return 0 if the hashes are alike */
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100101};
102
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100103static int http_request_prebuild_full_secondary_key(struct stream *s);
104static int http_request_build_secondary_key(struct stream *s, int vary_signature);
105static int http_request_reduce_secondary_key(unsigned int vary_signature,
106 char prebuilt_key[HTTP_CACHE_SEC_KEY_LEN]);
107
108static int parse_encoding_value(struct ist value, unsigned int *encoding_value,
109 unsigned int *has_null_weight);
110
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +0100111static int accept_encoding_normalizer(struct htx *htx, struct ist hdr_name,
112 char *buf, unsigned int *buf_len);
113static int default_normalizer(struct htx *htx, struct ist hdr_name,
114 char *buf, unsigned int *buf_len);
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100115
Tim Duesterhused84d842021-01-18 13:41:17 +0100116static int accept_encoding_bitmap_cmp(const void *ref, const void *new, unsigned int len);
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100117
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100118/* Warning : do not forget to update HTTP_CACHE_SEC_KEY_LEN when new items are
119 * added to this array. */
120const struct vary_hashing_information vary_information[] = {
Tim Duesterhused84d842021-01-18 13:41:17 +0100121 { IST("accept-encoding"), VARY_ACCEPT_ENCODING, sizeof(uint32_t), &accept_encoding_normalizer, &accept_encoding_bitmap_cmp },
Remi Tricot-Le Breton6a34b2b2020-12-23 18:13:47 +0100122 { IST("referer"), VARY_REFERER, sizeof(int), &default_normalizer, NULL },
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100123};
124
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100125
William Lallemand41db4602017-10-30 11:15:51 +0100126/*
127 * cache ctx for filters
128 */
129struct cache_st {
William Lallemand41db4602017-10-30 11:15:51 +0100130 struct shared_block *first_block;
131};
132
Remi Tricot-Le Breton5853c0c2020-12-10 17:58:43 +0100133#define DEFAULT_MAX_SECONDARY_ENTRY 10
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100134
William Lallemand41db4602017-10-30 11:15:51 +0100135struct cache_entry {
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +0100136 unsigned int complete; /* An entry won't be valid until complete is not null. */
William Lallemand41db4602017-10-30 11:15:51 +0100137 unsigned int latest_validation; /* latest validation date */
138 unsigned int expire; /* expiration date */
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200139 unsigned int age; /* Origin server "Age" header value */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100140
William Lallemand41db4602017-10-30 11:15:51 +0100141 struct eb32_node eb; /* ebtree node used to hold the cache object */
William Lallemandf528fff2017-11-23 19:43:17 +0100142 char hash[20];
Remi Tricot-Le Bretondbb65b52020-10-22 10:40:04 +0200143
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +0100144 char secondary_key[HTTP_CACHE_SEC_KEY_LEN]; /* Optional secondary key. */
145 unsigned int secondary_key_signature; /* Bitfield of the HTTP headers that should be used
146 * to build secondary keys for this cache entry. */
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100147 unsigned int secondary_entries_count; /* Should only be filled in the last entry of a list of dup entries */
Remi Tricot-Le Breton73be7962020-12-10 17:58:42 +0100148 unsigned int last_clear_ts; /* Timestamp of the last call to clear_expired_duplicates. */
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +0100149
Remi Tricot-Le Bretondbb65b52020-10-22 10:40:04 +0200150 unsigned int etag_length; /* Length of the ETag value (if one was found in the response). */
151 unsigned int etag_offset; /* Offset of the ETag value in the data buffer. */
152
Remi Tricot Le Breton27091b42020-10-23 10:51:27 +0200153 time_t last_modified; /* Origin server "Last-Modified" header value converted in
154 * seconds since epoch. If no "Last-Modified"
155 * header is found, use "Date" header value,
156 * otherwise use reception time. This field will
157 * be used in case of an "If-Modified-Since"-based
158 * conditional request. */
159
William Lallemand41db4602017-10-30 11:15:51 +0100160 unsigned char data[0];
161};
162
163#define CACHE_BLOCKSIZE 1024
Willy Tarreau96062a12018-11-11 14:00:28 +0100164#define CACHE_ENTRY_MAX_AGE 2147483648U
William Lallemand41db4602017-10-30 11:15:51 +0100165
166static struct list caches = LIST_HEAD_INIT(caches);
William Lallemandd1d1e222019-08-28 15:22:49 +0200167static struct list caches_config = LIST_HEAD_INIT(caches_config); /* cache config to init */
William Lallemand41db4602017-10-30 11:15:51 +0100168static struct cache *tmp_cache_config = NULL;
169
Willy Tarreau8ceae722018-11-26 11:58:30 +0100170DECLARE_STATIC_POOL(pool_head_cache_st, "cache_st", sizeof(struct cache_st));
171
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100172static struct eb32_node *insert_entry(struct cache *cache, struct cache_entry *new_entry);
173static void delete_entry(struct cache_entry *del_entry);
174
William Lallemandf528fff2017-11-23 19:43:17 +0100175struct cache_entry *entry_exist(struct cache *cache, char *hash)
William Lallemand4da3f8a2017-10-31 14:33:34 +0100176{
177 struct eb32_node *node;
178 struct cache_entry *entry;
179
Willy Tarreau8b507582020-02-25 09:35:07 +0100180 node = eb32_lookup(&cache->entries, read_u32(hash));
William Lallemand4da3f8a2017-10-31 14:33:34 +0100181 if (!node)
182 return NULL;
183
184 entry = eb32_entry(node, struct cache_entry, eb);
William Lallemandf528fff2017-11-23 19:43:17 +0100185
186 /* if that's not the right node */
187 if (memcmp(entry->hash, hash, sizeof(entry->hash)))
188 return NULL;
189
William Lallemand08727662017-11-21 20:01:27 +0100190 if (entry->expire > now.tv_sec) {
William Lallemand4da3f8a2017-10-31 14:33:34 +0100191 return entry;
William Lallemand08727662017-11-21 20:01:27 +0100192 } else {
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100193 delete_entry(entry);
William Lallemand08727662017-11-21 20:01:27 +0100194 entry->eb.key = 0;
195 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100196 return NULL;
197
198}
199
Remi Tricot-Le Breton6a34b2b2020-12-23 18:13:47 +0100200
201/*
202 * Compare a newly built secondary key to the one found in a cache_entry.
203 * Every sub-part of the key is compared to the reference through the dedicated
204 * comparison function of the sub-part (that might do more than a simple
205 * memcmp).
206 * Returns 0 if the keys are alike.
207 */
208static int secondary_key_cmp(const char *ref_key, const char *new_key)
209{
210 int retval = 0;
Tim Duesterhus5897cfe2021-01-18 13:41:18 +0100211 size_t idx = 0;
212 unsigned int offset = 0;
Remi Tricot-Le Breton6a34b2b2020-12-23 18:13:47 +0100213 const struct vary_hashing_information *info;
214
215 for (idx = 0; idx < sizeof(vary_information)/sizeof(*vary_information) && !retval; ++idx) {
216 info = &vary_information[idx];
217
218 if (info->cmp_fn)
219 retval = info->cmp_fn(&ref_key[offset], &new_key[offset], info->hash_length);
220 else
221 retval = memcmp(&ref_key[offset], &new_key[offset], info->hash_length);
222
223 offset += info->hash_length;
224 }
225
226 return retval;
227}
228
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +0100229/*
230 * There can be multiple entries with the same primary key in the ebtree so in
231 * order to get the proper one out of the list, we use a secondary_key.
232 * This function simply iterates over all the entries with the same primary_key
233 * until it finds the right one.
234 * Returns the cache_entry in case of success, NULL otherwise.
235 */
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100236struct cache_entry *secondary_entry_exist(struct cache *cache, struct cache_entry *entry,
Remi Tricot-Le Breton6a34b2b2020-12-23 18:13:47 +0100237 const char *secondary_key)
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100238{
239 struct eb32_node *node = &entry->eb;
240
241 if (!entry->secondary_key_signature)
242 return NULL;
243
Remi Tricot-Le Breton6a34b2b2020-12-23 18:13:47 +0100244 while (entry && secondary_key_cmp(entry->secondary_key, secondary_key) != 0) {
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100245 node = eb32_next_dup(node);
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100246
247 /* Make the best use of this iteration and clear expired entries
248 * when we find them. Calling delete_entry would be too costly
249 * so we simply call eb32_delete. The secondary_entry count will
250 * be updated when we try to insert a new entry to this list. */
251 if (entry->expire <= now.tv_sec) {
252 eb32_delete(&entry->eb);
253 entry->eb.key = 0;
254 }
255
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100256 entry = node ? eb32_entry(node, struct cache_entry, eb) : NULL;
257 }
258
259 /* Expired entry */
260 if (entry && entry->expire <= now.tv_sec) {
261 eb32_delete(&entry->eb);
262 entry->eb.key = 0;
263 entry = NULL;
264 }
265
266 return entry;
267}
268
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100269
Remi Tricot-Le Breton73be7962020-12-10 17:58:42 +0100270/*
271 * Remove all expired entries from a list of duplicates.
272 * Return the number of alive entries in the list and sets dup_tail to the
273 * current last item of the list.
274 */
275static unsigned int clear_expired_duplicates(struct eb32_node **dup_tail)
276{
277 unsigned int entry_count = 0;
278 struct cache_entry *entry = NULL;
279 struct eb32_node *prev = *dup_tail;
280 struct eb32_node *tail = NULL;
281
282 while (prev) {
283 entry = container_of(prev, struct cache_entry, eb);
284 prev = eb32_prev_dup(prev);
285 if (entry->expire <= now.tv_sec) {
286 eb32_delete(&entry->eb);
287 entry->eb.key = 0;
288 }
289 else {
290 if (!tail)
291 tail = &entry->eb;
292 ++entry_count;
293 }
294 }
295
296 *dup_tail = tail;
297
298 return entry_count;
299}
300
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100301
302/*
303 * This function inserts a cache_entry in the cache's ebtree. In case of
304 * duplicate entries (vary), it then checks that the number of entries did not
305 * reach the max number of secondary entries. If this entry should not have been
306 * created, remove it.
307 * In the regular case (unique entries), this function does not do more than a
308 * simple insert. In case of secondary entries, it will at most cost an
309 * insertion+max_sec_entries time checks and entry deletion.
310 * Returns the newly inserted node in case of success, NULL otherwise.
311 */
312static struct eb32_node *insert_entry(struct cache *cache, struct cache_entry *new_entry)
313{
314 struct eb32_node *prev = NULL;
315 struct cache_entry *entry = NULL;
316 unsigned int entry_count = 0;
Remi Tricot-Le Breton73be7962020-12-10 17:58:42 +0100317 unsigned int last_clear_ts = now.tv_sec;
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100318
319 struct eb32_node *node = eb32_insert(&cache->entries, &new_entry->eb);
320
321 /* We should not have multiple entries with the same primary key unless
322 * the entry has a non null vary signature. */
323 if (!new_entry->secondary_key_signature)
324 return node;
325
326 prev = eb32_prev_dup(node);
327 if (prev != NULL) {
328 /* The last entry of a duplicate list should contain the current
329 * number of entries in the list. */
330 entry = container_of(prev, struct cache_entry, eb);
331 entry_count = entry->secondary_entries_count;
Remi Tricot-Le Breton73be7962020-12-10 17:58:42 +0100332 last_clear_ts = entry->last_clear_ts;
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100333
Remi Tricot-Le Breton5853c0c2020-12-10 17:58:43 +0100334 if (entry_count >= cache->max_secondary_entries) {
Remi Tricot-Le Breton73be7962020-12-10 17:58:42 +0100335 /* Some entries of the duplicate list might be expired so
336 * we will iterate over all the items in order to free some
337 * space. In order to avoid going over the same list too
338 * often, we first check the timestamp of the last check
339 * performed. */
340 if (last_clear_ts == now.tv_sec) {
341 /* Too many entries for this primary key, clear the
342 * one that was inserted. */
343 eb32_delete(node);
344 node->key = 0;
345 return NULL;
346 }
347
348 entry_count = clear_expired_duplicates(&prev);
Remi Tricot-Le Breton5853c0c2020-12-10 17:58:43 +0100349 if (entry_count >= cache->max_secondary_entries) {
Remi Tricot-Le Breton73be7962020-12-10 17:58:42 +0100350 /* Still too many entries for this primary key, delete
351 * the newly inserted one. */
352 entry = container_of(prev, struct cache_entry, eb);
353 entry->last_clear_ts = now.tv_sec;
354 eb32_delete(node);
355 node->key = 0;
356 return NULL;
357 }
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100358 }
359 }
360
361 new_entry->secondary_entries_count = entry_count + 1;
Remi Tricot-Le Breton73be7962020-12-10 17:58:42 +0100362 new_entry->last_clear_ts = last_clear_ts;
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100363
364 return node;
365}
366
367
368/*
369 * This function removes an entry from the ebtree. If the entry was a duplicate
370 * (in case of Vary), it updates the secondary entry counter in another
371 * duplicate entry (the last entry of the dup list).
372 */
373static void delete_entry(struct cache_entry *del_entry)
374{
375 struct eb32_node *prev = NULL, *next = NULL;
376 struct cache_entry *entry = NULL;
377 struct eb32_node *last = NULL;
378
379 if (del_entry->secondary_key_signature) {
380 next = &del_entry->eb;
381
382 /* Look for last entry of the duplicates list. */
383 while ((next = eb32_next_dup(next))) {
384 last = next;
385 }
386
387 if (last) {
388 entry = container_of(last, struct cache_entry, eb);
389 --entry->secondary_entries_count;
390 }
391 else {
392 /* The current entry is the last one, look for the
393 * previous one to update its counter. */
394 prev = eb32_prev_dup(&del_entry->eb);
395 if (prev) {
396 entry = container_of(prev, struct cache_entry, eb);
397 entry->secondary_entries_count = del_entry->secondary_entries_count - 1;
398 }
399 }
400 }
401 eb32_delete(&del_entry->eb);
402 del_entry->eb.key = 0;
403}
404
405
William Lallemand4da3f8a2017-10-31 14:33:34 +0100406static inline struct shared_context *shctx_ptr(struct cache *cache)
407{
408 return (struct shared_context *)((unsigned char *)cache - ((struct shared_context *)NULL)->data);
409}
410
William Lallemand77c11972017-10-31 20:43:01 +0100411static inline struct shared_block *block_ptr(struct cache_entry *entry)
412{
413 return (struct shared_block *)((unsigned char *)entry - ((struct shared_block *)NULL)->data);
414}
415
416
417
William Lallemand41db4602017-10-30 11:15:51 +0100418static int
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100419cache_store_init(struct proxy *px, struct flt_conf *fconf)
William Lallemand41db4602017-10-30 11:15:51 +0100420{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100421 fconf->flags |= FLT_CFG_FL_HTX;
William Lallemand41db4602017-10-30 11:15:51 +0100422 return 0;
423}
424
Christopher Faulet95220e22018-12-07 17:34:39 +0100425static void
426cache_store_deinit(struct proxy *px, struct flt_conf *fconf)
427{
428 struct cache_flt_conf *cconf = fconf->conf;
429
Tim Duesterhusd7c6e6a2020-09-14 18:01:33 +0200430 if (!(cconf->flags & CACHE_FLT_INIT))
431 free(cconf->c.name);
Christopher Faulet95220e22018-12-07 17:34:39 +0100432 free(cconf);
433}
434
William Lallemand4da3f8a2017-10-31 14:33:34 +0100435static int
Christopher Faulet95220e22018-12-07 17:34:39 +0100436cache_store_check(struct proxy *px, struct flt_conf *fconf)
437{
438 struct cache_flt_conf *cconf = fconf->conf;
Christopher Fauletafd819c2018-12-11 08:57:45 +0100439 struct flt_conf *f;
Christopher Faulet95220e22018-12-07 17:34:39 +0100440 struct cache *cache;
Christopher Faulet27d93c32018-12-15 22:32:02 +0100441 int comp = 0;
Christopher Faulet95220e22018-12-07 17:34:39 +0100442
William Lallemandd1d1e222019-08-28 15:22:49 +0200443 /* Find the cache corresponding to the name in the filter config. The
444 * cache will not be referenced now in the filter config because it is
445 * not fully allocated. This step will be performed during the cache
446 * post_check.
447 */
448 list_for_each_entry(cache, &caches_config, list) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100449 if (strcmp(cache->id, cconf->c.name) == 0)
Christopher Faulet95220e22018-12-07 17:34:39 +0100450 goto found;
Christopher Faulet95220e22018-12-07 17:34:39 +0100451 }
452
453 ha_alert("config: %s '%s': unable to find the cache '%s' referenced by the filter 'cache'.\n",
454 proxy_type_str(px), px->id, (char *)cconf->c.name);
455 return 1;
456
457 found:
Christopher Fauletafd819c2018-12-11 08:57:45 +0100458 /* Here <cache> points on the cache the filter must use and <cconf>
459 * points on the cache filter configuration. */
460
461 /* Check all filters for proxy <px> to know if the compression is
Christopher Faulet27d93c32018-12-15 22:32:02 +0100462 * enabled and if it is after the cache. When the compression is before
463 * the cache, an error is returned. Also check if the cache filter must
464 * be explicitly declaired or not. */
Christopher Fauletafd819c2018-12-11 08:57:45 +0100465 list_for_each_entry(f, &px->filter_configs, list) {
466 if (f == fconf) {
Christopher Faulet27d93c32018-12-15 22:32:02 +0100467 /* The compression filter must be evaluated after the cache. */
468 if (comp) {
469 ha_alert("config: %s '%s': unable to enable the compression filter before "
470 "the cache '%s'.\n", proxy_type_str(px), px->id, cache->id);
471 return 1;
472 }
Christopher Faulet99a17a22018-12-11 09:18:27 +0100473 }
Christopher Faulet8f7fe1c2019-07-15 15:08:25 +0200474 else if (f->id == http_comp_flt_id)
Christopher Faulet27d93c32018-12-15 22:32:02 +0100475 comp = 1;
Christopher Faulet78fbb9f2019-08-11 23:11:03 +0200476 else if (f->id == fcgi_flt_id)
477 continue;
Christopher Faulet27d93c32018-12-15 22:32:02 +0100478 else if ((f->id != fconf->id) && (cconf->flags & CACHE_FLT_F_IMPLICIT_DECL)) {
479 /* Implicit declaration is only allowed with the
Christopher Faulet78fbb9f2019-08-11 23:11:03 +0200480 * compression and fcgi. For other filters, an implicit
Christopher Faulet27d93c32018-12-15 22:32:02 +0100481 * declaration is required. */
482 ha_alert("config: %s '%s': require an explicit filter declaration "
483 "to use the cache '%s'.\n", proxy_type_str(px), px->id, cache->id);
484 return 1;
485 }
486
Christopher Fauletafd819c2018-12-11 08:57:45 +0100487 }
Christopher Faulet95220e22018-12-07 17:34:39 +0100488 return 0;
489}
490
491static int
Christopher Faulet65554e12020-03-06 14:52:06 +0100492cache_store_strm_init(struct stream *s, struct filter *filter)
William Lallemand4da3f8a2017-10-31 14:33:34 +0100493{
Christopher Faulet65554e12020-03-06 14:52:06 +0100494 struct cache_st *st;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100495
Willy Tarreauacc5b012021-03-22 15:00:49 +0100496 st = pool_alloc(pool_head_cache_st);
Christopher Faulet65554e12020-03-06 14:52:06 +0100497 if (st == NULL)
498 return -1;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100499
Christopher Faulet65554e12020-03-06 14:52:06 +0100500 st->first_block = NULL;
501 filter->ctx = st;
Christopher Faulet839791a2019-01-07 16:12:07 +0100502
Christopher Faulet65554e12020-03-06 14:52:06 +0100503 /* Register post-analyzer on AN_RES_WAIT_HTTP */
504 filter->post_analyzers |= AN_RES_WAIT_HTTP;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100505 return 1;
506}
507
Christopher Faulet65554e12020-03-06 14:52:06 +0100508static void
509cache_store_strm_deinit(struct stream *s, struct filter *filter)
William Lallemand49dc0482017-11-24 14:33:54 +0100510{
511 struct cache_st *st = filter->ctx;
Christopher Faulet95220e22018-12-07 17:34:39 +0100512 struct cache_flt_conf *cconf = FLT_CONF(filter);
513 struct cache *cache = cconf->c.cache;
William Lallemand49dc0482017-11-24 14:33:54 +0100514 struct shared_context *shctx = shctx_ptr(cache);
515
William Lallemand49dc0482017-11-24 14:33:54 +0100516 /* Everything should be released in the http_end filter, but we need to do it
517 * there too, in case of errors */
William Lallemand49dc0482017-11-24 14:33:54 +0100518 if (st && st->first_block) {
William Lallemand49dc0482017-11-24 14:33:54 +0100519 shctx_lock(shctx);
520 shctx_row_dec_hot(shctx, st->first_block);
521 shctx_unlock(shctx);
William Lallemand49dc0482017-11-24 14:33:54 +0100522 }
523 if (st) {
Willy Tarreaubafbe012017-11-24 17:34:44 +0100524 pool_free(pool_head_cache_st, st);
William Lallemand49dc0482017-11-24 14:33:54 +0100525 filter->ctx = NULL;
526 }
William Lallemand49dc0482017-11-24 14:33:54 +0100527}
528
Christopher Faulet839791a2019-01-07 16:12:07 +0100529static int
530cache_store_post_analyze(struct stream *s, struct filter *filter, struct channel *chn,
531 unsigned an_bit)
532{
533 struct http_txn *txn = s->txn;
534 struct http_msg *msg = &txn->rsp;
535 struct cache_st *st = filter->ctx;
536
537 if (an_bit != AN_RES_WAIT_HTTP)
538 goto end;
539
540 /* Here we need to check if any compression filter precedes the cache
541 * filter. This is only possible when the compression is configured in
542 * the frontend while the cache filter is configured on the
543 * backend. This case cannot be detected during HAProxy startup. So in
544 * such cases, the cache is disabled.
545 */
546 if (st && (msg->flags & HTTP_MSGF_COMPRESSING)) {
547 pool_free(pool_head_cache_st, st);
548 filter->ctx = NULL;
549 }
550
551 end:
552 return 1;
553}
William Lallemand49dc0482017-11-24 14:33:54 +0100554
555static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100556cache_store_http_headers(struct stream *s, struct filter *filter, struct http_msg *msg)
557{
558 struct cache_st *st = filter->ctx;
559
William Lallemand4da3f8a2017-10-31 14:33:34 +0100560 if (!(msg->chn->flags & CF_ISRESP) || !st)
561 return 1;
562
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200563 if (st->first_block)
Christopher Faulet67658c92018-12-06 21:59:39 +0100564 register_data_filter(s, msg->chn, filter);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100565 return 1;
566}
567
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200568static inline void disable_cache_entry(struct cache_st *st,
569 struct filter *filter, struct shared_context *shctx)
570{
571 struct cache_entry *object;
572
573 object = (struct cache_entry *)st->first_block->data;
574 filter->ctx = NULL; /* disable cache */
575 shctx_lock(shctx);
576 shctx_row_dec_hot(shctx, st->first_block);
Remi Tricot-Le Breton964caaf2020-12-15 14:30:12 +0100577 eb32_delete(&object->eb);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200578 object->eb.key = 0;
579 shctx_unlock(shctx);
580 pool_free(pool_head_cache_st, st);
581}
582
William Lallemand4da3f8a2017-10-31 14:33:34 +0100583static int
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100584cache_store_http_payload(struct stream *s, struct filter *filter, struct http_msg *msg,
585 unsigned int offset, unsigned int len)
586{
Christopher Faulet95220e22018-12-07 17:34:39 +0100587 struct cache_flt_conf *cconf = FLT_CONF(filter);
588 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100589 struct cache_st *st = filter->ctx;
590 struct htx *htx = htxbuf(&msg->chn->buf);
591 struct htx_blk *blk;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200592 struct shared_block *fb;
Christopher Faulet497c7592020-03-02 16:19:50 +0100593 struct htx_ret htxret;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200594 unsigned int orig_len, to_forward;
595 int ret;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100596
597 if (!len)
598 return len;
599
600 if (!st->first_block) {
601 unregister_data_filter(s, msg->chn, filter);
602 return len;
603 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100604
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200605 chunk_reset(&trash);
606 orig_len = len;
607 to_forward = 0;
Christopher Faulet497c7592020-03-02 16:19:50 +0100608
609 htxret = htx_find_offset(htx, offset);
610 blk = htxret.blk;
611 offset = htxret.ret;
612 for (; blk && len; blk = htx_get_next_blk(htx, blk)) {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100613 enum htx_blk_type type = htx_get_blk_type(blk);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200614 uint32_t info, sz = htx_get_blksz(blk);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100615 struct ist v;
616
617 switch (type) {
618 case HTX_BLK_UNUSED:
619 break;
620
621 case HTX_BLK_DATA:
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100622 v = htx_get_blk_value(htx, blk);
Tim Duesterhus154374c2021-03-02 18:57:27 +0100623 v = istadv(v, offset);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100624 if (v.len > len)
625 v.len = len;
626
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200627 info = (type << 28) + v.len;
628 chunk_memcat(&trash, (char *)&info, sizeof(info));
629 chunk_memcat(&trash, v.ptr, v.len);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100630 to_forward += v.len;
631 len -= v.len;
632 break;
633
634 default:
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200635 /* Here offset must always be 0 because only
636 * DATA blocks can be partially transferred. */
637 if (offset)
638 goto no_cache;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100639 if (sz > len)
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200640 goto end;
641
642 chunk_memcat(&trash, (char *)&blk->info, sizeof(blk->info));
643 chunk_memcat(&trash, htx_get_blk_ptr(htx, blk), sz);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100644 to_forward += sz;
645 len -= sz;
646 break;
647 }
648
649 offset = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100650 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200651
652 end:
653 shctx_lock(shctx);
654 fb = shctx_row_reserve_hot(shctx, st->first_block, trash.data);
655 if (!fb) {
656 shctx_unlock(shctx);
657 goto no_cache;
658 }
659 shctx_unlock(shctx);
660
661 ret = shctx_row_data_append(shctx, st->first_block, st->first_block->last_append,
662 (unsigned char *)b_head(&trash), b_data(&trash));
663 if (ret < 0)
664 goto no_cache;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100665
666 return to_forward;
667
668 no_cache:
669 disable_cache_entry(st, filter, shctx);
670 unregister_data_filter(s, msg->chn, filter);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200671 return orig_len;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100672}
673
674static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100675cache_store_http_end(struct stream *s, struct filter *filter,
676 struct http_msg *msg)
677{
678 struct cache_st *st = filter->ctx;
Christopher Faulet95220e22018-12-07 17:34:39 +0100679 struct cache_flt_conf *cconf = FLT_CONF(filter);
680 struct cache *cache = cconf->c.cache;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100681 struct shared_context *shctx = shctx_ptr(cache);
682 struct cache_entry *object;
683
684 if (!(msg->chn->flags & CF_ISRESP))
685 return 1;
686
687 if (st && st->first_block) {
688
689 object = (struct cache_entry *)st->first_block->data;
690
William Lallemand4da3f8a2017-10-31 14:33:34 +0100691 shctx_lock(shctx);
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +0100692 /* The whole payload was cached, the entry can now be used. */
693 object->complete = 1;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100694 /* remove from the hotlist */
William Lallemand4da3f8a2017-10-31 14:33:34 +0100695 shctx_row_dec_hot(shctx, st->first_block);
696 shctx_unlock(shctx);
697
698 }
699 if (st) {
Willy Tarreaubafbe012017-11-24 17:34:44 +0100700 pool_free(pool_head_cache_st, st);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100701 filter->ctx = NULL;
702 }
703
704 return 1;
705}
706
707 /*
708 * This intends to be used when checking HTTP headers for some
709 * word=value directive. Return a pointer to the first character of value, if
Willy Tarreau94a01e12021-01-06 17:35:12 +0100710 * the word was not found or if there wasn't any value assigned to it return NULL
William Lallemand4da3f8a2017-10-31 14:33:34 +0100711 */
712char *directive_value(const char *sample, int slen, const char *word, int wlen)
713{
714 int st = 0;
715
716 if (slen < wlen)
717 return 0;
718
719 while (wlen) {
720 char c = *sample ^ *word;
721 if (c && c != ('A' ^ 'a'))
722 return NULL;
723 sample++;
724 word++;
725 slen--;
726 wlen--;
727 }
728
729 while (slen) {
730 if (st == 0) {
731 if (*sample != '=')
732 return NULL;
733 sample++;
734 slen--;
735 st = 1;
736 continue;
737 } else {
738 return (char *)sample;
739 }
740 }
741
742 return NULL;
743}
744
745/*
746 * Return the maxage in seconds of an HTTP response.
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100747 * The returned value will always take the cache's configuration into account
748 * (cache->maxage) but the actual max age of the response will be set in the
749 * true_maxage parameter. It will be used to determine if a response is already
750 * stale or not.
William Lallemand4da3f8a2017-10-31 14:33:34 +0100751 * Compute the maxage using either:
752 * - the assigned max-age of the cache
753 * - the s-maxage directive
754 * - the max-age directive
755 * - (Expires - Data) headers
756 * - the default-max-age of the cache
757 *
758 */
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100759int http_calc_maxage(struct stream *s, struct cache *cache, int *true_maxage)
William Lallemand4da3f8a2017-10-31 14:33:34 +0100760{
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200761 struct htx *htx = htxbuf(&s->res.buf);
762 struct http_hdr_ctx ctx = { .blk = NULL };
Remi Tricot-Le Bretonfcea3742020-12-03 18:19:30 +0100763 long smaxage = -1;
764 long maxage = -1;
Remi Tricot-Le Bretona6476112020-10-28 17:52:53 +0100765 int expires = -1;
766 struct tm tm = {};
767 time_t expires_val = 0;
Remi Tricot-Le Bretonfcea3742020-12-03 18:19:30 +0100768 char *endptr = NULL;
769 int offset = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100770
Remi Tricot-Le Bretonfcea3742020-12-03 18:19:30 +0100771 /* The Cache-Control max-age and s-maxage directives should be followed by
772 * a positive numerical value (see RFC 7234#5.2.1.1). According to the
773 * specs, a sender "should not" generate a quoted-string value but we will
774 * still accept this format since it isn't strictly forbidden. */
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200775 while (http_find_header(htx, ist("cache-control"), &ctx, 0)) {
776 char *value;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100777
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200778 value = directive_value(ctx.value.ptr, ctx.value.len, "s-maxage", 8);
779 if (value) {
780 struct buffer *chk = get_trash_chunk();
William Lallemand4da3f8a2017-10-31 14:33:34 +0100781
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200782 chunk_strncat(chk, value, ctx.value.len - 8 + 1);
783 chunk_strncat(chk, "", 1);
Remi Tricot-Le Bretonfcea3742020-12-03 18:19:30 +0100784 offset = (*chk->area == '"') ? 1 : 0;
785 smaxage = strtol(chk->area + offset, &endptr, 10);
786 if (unlikely(smaxage < 0 || endptr == chk->area))
787 return -1;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100788 }
789
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200790 value = directive_value(ctx.value.ptr, ctx.value.len, "max-age", 7);
791 if (value) {
792 struct buffer *chk = get_trash_chunk();
Christopher Faulet5f2c49f2019-07-15 20:49:46 +0200793
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200794 chunk_strncat(chk, value, ctx.value.len - 7 + 1);
795 chunk_strncat(chk, "", 1);
Remi Tricot-Le Bretonfcea3742020-12-03 18:19:30 +0100796 offset = (*chk->area == '"') ? 1 : 0;
797 maxage = strtol(chk->area + offset, &endptr, 10);
798 if (unlikely(maxage < 0 || endptr == chk->area))
799 return -1;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100800 }
801 }
802
Remi Tricot-Le Bretona6476112020-10-28 17:52:53 +0100803 /* Look for Expires header if no s-maxage or max-age Cache-Control data
804 * was found. */
805 if (maxage == -1 && smaxage == -1) {
806 ctx.blk = NULL;
807 if (http_find_header(htx, ist("expires"), &ctx, 1)) {
808 if (parse_http_date(istptr(ctx.value), istlen(ctx.value), &tm)) {
809 expires_val = my_timegm(&tm);
810 /* A request having an expiring date earlier
811 * than the current date should be considered as
812 * stale. */
813 expires = (expires_val >= now.tv_sec) ?
814 (expires_val - now.tv_sec) : 0;
815 }
816 else {
817 /* Following RFC 7234#5.3, an invalid date
818 * format must be treated as a date in the past
819 * so the cache entry must be seen as already
820 * expired. */
821 expires = 0;
822 }
823 }
824 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100825
826
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100827 if (smaxage > 0) {
828 if (true_maxage)
829 *true_maxage = smaxage;
William Lallemand49b44532017-11-24 18:53:43 +0100830 return MIN(smaxage, cache->maxage);
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100831 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100832
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100833 if (maxage > 0) {
834 if (true_maxage)
835 *true_maxage = maxage;
William Lallemand49b44532017-11-24 18:53:43 +0100836 return MIN(maxage, cache->maxage);
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100837 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100838
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100839 if (expires >= 0) {
840 if (true_maxage)
841 *true_maxage = expires;
Remi Tricot-Le Bretona6476112020-10-28 17:52:53 +0100842 return MIN(expires, cache->maxage);
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100843 }
Remi Tricot-Le Bretona6476112020-10-28 17:52:53 +0100844
William Lallemand49b44532017-11-24 18:53:43 +0100845 return cache->maxage;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100846
847}
848
849
William Lallemanda400a3a2017-11-20 19:13:12 +0100850static void cache_free_blocks(struct shared_block *first, struct shared_block *block)
851{
Willy Tarreau5bd37fa2018-04-04 20:17:03 +0200852 struct cache_entry *object = (struct cache_entry *)block->data;
853
854 if (first == block && object->eb.key)
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +0100855 delete_entry(object);
Willy Tarreau5bd37fa2018-04-04 20:17:03 +0200856 object->eb.key = 0;
William Lallemanda400a3a2017-11-20 19:13:12 +0100857}
858
Remi Tricot Le Breton27091b42020-10-23 10:51:27 +0200859
860/* As per RFC 7234#4.3.2, in case of "If-Modified-Since" conditional request, the
861 * date value should be compared to a date determined by in a previous response (for
862 * the same entity). This date could either be the "Last-Modified" value, or the "Date"
863 * value of the response's reception time (by decreasing order of priority). */
864static time_t get_last_modified_time(struct htx *htx)
865{
866 time_t last_modified = 0;
867 struct http_hdr_ctx ctx = { .blk = NULL };
868 struct tm tm = {};
869
870 if (http_find_header(htx, ist("last-modified"), &ctx, 1)) {
871 if (parse_http_date(istptr(ctx.value), istlen(ctx.value), &tm)) {
872 last_modified = my_timegm(&tm);
873 }
874 }
875
876 if (!last_modified) {
877 ctx.blk = NULL;
878 if (http_find_header(htx, ist("date"), &ctx, 1)) {
879 if (parse_http_date(istptr(ctx.value), istlen(ctx.value), &tm)) {
880 last_modified = my_timegm(&tm);
881 }
882 }
883 }
884
885 /* Fallback on the current time if no "Last-Modified" or "Date" header
886 * was found. */
887 if (!last_modified)
888 last_modified = now.tv_sec;
889
890 return last_modified;
891}
892
William Lallemand41db4602017-10-30 11:15:51 +0100893/*
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100894 * Checks the vary header's value. The headers on which vary should be applied
Ilya Shipitsinf38a0182020-12-21 01:16:17 +0500895 * must be explicitly supported in the vary_information array (see cache.c). If
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100896 * any other header is mentioned, we won't store the response.
897 * Returns 1 if Vary-based storage can work, 0 otherwise.
898 */
899static int http_check_vary_header(struct htx *htx, unsigned int *vary_signature)
900{
901 unsigned int vary_idx;
902 unsigned int vary_info_count;
903 const struct vary_hashing_information *vary_info;
904 struct http_hdr_ctx ctx = { .blk = NULL };
905
906 int retval = 1;
907
908 *vary_signature = 0;
909
910 vary_info_count = sizeof(vary_information)/sizeof(*vary_information);
911 while (retval && http_find_header(htx, ist("Vary"), &ctx, 0)) {
912 for (vary_idx = 0; vary_idx < vary_info_count; ++vary_idx) {
913 vary_info = &vary_information[vary_idx];
914 if (isteqi(ctx.value, vary_info->hdr_name)) {
915 *vary_signature |= vary_info->value;
916 break;
917 }
918 }
919 retval = (vary_idx < vary_info_count);
920 }
921
922 return retval;
923}
924
925
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100926/*
927 * Look for the accept-encoding part of the secondary_key and replace the
928 * encoding bitmap part of the hash with the actual encoding of the response,
929 * extracted from the content-encoding header value.
Remi Tricot-Le Breton6ca89162021-01-07 14:50:51 +0100930 * Responses that have an unknown encoding will not be cached if they also
931 * "vary" on the accept-encoding value.
932 * Returns 0 if we found a known encoding in the response, -1 otherwise.
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100933 */
Remi Tricot-Le Breton6ca89162021-01-07 14:50:51 +0100934static int set_secondary_key_encoding(struct htx *htx, char *secondary_key)
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100935{
936 unsigned int resp_encoding_bitmap = 0;
937 const struct vary_hashing_information *info = vary_information;
938 unsigned int offset = 0;
939 unsigned int count = 0;
940 unsigned int hash_info_count = sizeof(vary_information)/sizeof(*vary_information);
941 unsigned int encoding_value;
942 struct http_hdr_ctx ctx = { .blk = NULL };
943
944 /* Look for the accept-encoding part of the secondary_key. */
945 while (count < hash_info_count && info->value != VARY_ACCEPT_ENCODING) {
946 offset += info->hash_length;
947 ++info;
948 ++count;
949 }
950
951 if (count == hash_info_count)
Remi Tricot-Le Breton6ca89162021-01-07 14:50:51 +0100952 return -1;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100953
954 while (http_find_header(htx, ist("content-encoding"), &ctx, 0)) {
Remi Tricot-Le Breton6ca89162021-01-07 14:50:51 +0100955 if (parse_encoding_value(ctx.value, &encoding_value, NULL))
956 return -1; /* Do not store responses with an unknown encoding */
957 resp_encoding_bitmap |= encoding_value;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100958 }
959
960 if (!resp_encoding_bitmap)
961 resp_encoding_bitmap |= VARY_ENCODING_IDENTITY;
962
963 /* Rewrite the bitmap part of the hash with the new bitmap that only
Ilya Shipitsinb8888ab2021-01-06 21:20:16 +0500964 * corresponds the the response's encoding. */
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100965 write_u32(secondary_key + offset, resp_encoding_bitmap);
Remi Tricot-Le Breton6ca89162021-01-07 14:50:51 +0100966
967 return 0;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +0100968}
969
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +0100970
971/*
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +0500972 * This function will store the headers of the response in a buffer and then
William Lallemand41db4602017-10-30 11:15:51 +0100973 * register a filter to store the data
974 */
975enum act_return http_action_store_cache(struct act_rule *rule, struct proxy *px,
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200976 struct session *sess, struct stream *s, int flags)
William Lallemand41db4602017-10-30 11:15:51 +0100977{
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +0100978 int effective_maxage = 0;
979 int true_maxage = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100980 struct http_txn *txn = s->txn;
981 struct http_msg *msg = &txn->rsp;
982 struct filter *filter;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100983 struct shared_block *first = NULL;
Christopher Faulet95220e22018-12-07 17:34:39 +0100984 struct cache_flt_conf *cconf = rule->arg.act.p[0];
Remi Tricot-Le Breton754b2422020-11-16 15:56:10 +0100985 struct cache *cache = cconf->c.cache;
986 struct shared_context *shctx = shctx_ptr(cache);
Christopher Faulet839791a2019-01-07 16:12:07 +0100987 struct cache_st *cache_ctx = NULL;
988 struct cache_entry *object, *old;
Willy Tarreau8b507582020-02-25 09:35:07 +0100989 unsigned int key = read_u32(txn->cache_hash);
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200990 struct htx *htx;
991 struct http_hdr_ctx ctx;
Christopher Fauletb0667472019-09-03 22:22:12 +0200992 size_t hdrs_len = 0;
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200993 int32_t pos;
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +0100994 unsigned int vary_signature = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100995
William Lallemand4da3f8a2017-10-31 14:33:34 +0100996 /* Don't cache if the response came from a cache */
997 if ((obj_type(s->target) == OBJ_TYPE_APPLET) &&
998 s->target == &http_cache_applet.obj_type) {
999 goto out;
1000 }
1001
1002 /* cache only HTTP/1.1 */
1003 if (!(txn->req.flags & HTTP_MSGF_VER_11))
1004 goto out;
1005
Willy Tarreau6905d182019-10-01 17:59:17 +02001006 /* cache only GET method */
Remi Tricot-Le Breton72cffaf2020-12-03 18:19:31 +01001007 if (txn->meth != HTTP_METH_GET) {
1008 /* In case of successful unsafe method on a stored resource, the
1009 * cached entry must be invalidated (see RFC7234#4.4).
1010 * A "non-error response" is one with a 2xx (Successful) or 3xx
1011 * (Redirection) status code. */
1012 if (txn->status >= 200 && txn->status < 400) {
1013 switch (txn->meth) {
1014 case HTTP_METH_OPTIONS:
1015 case HTTP_METH_GET:
1016 case HTTP_METH_HEAD:
1017 case HTTP_METH_TRACE:
1018 break;
1019
1020 default: /* Any unsafe method */
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05001021 /* Discard any corresponding entry in case of successful
Remi Tricot-Le Breton72cffaf2020-12-03 18:19:31 +01001022 * unsafe request (such as PUT, POST or DELETE). */
1023 shctx_lock(shctx);
1024
1025 old = entry_exist(cconf->c.cache, txn->cache_hash);
1026 if (old) {
1027 eb32_delete(&old->eb);
1028 old->eb.key = 0;
1029 }
1030 shctx_unlock(shctx);
1031 }
1032 }
William Lallemand4da3f8a2017-10-31 14:33:34 +01001033 goto out;
Remi Tricot-Le Breton72cffaf2020-12-03 18:19:31 +01001034 }
William Lallemand4da3f8a2017-10-31 14:33:34 +01001035
Willy Tarreauc9036c02019-01-11 19:38:25 +01001036 /* cache key was not computed */
1037 if (!key)
1038 goto out;
1039
William Lallemand4da3f8a2017-10-31 14:33:34 +01001040 /* cache only 200 status code */
1041 if (txn->status != 200)
1042 goto out;
1043
Christopher Faulet839791a2019-01-07 16:12:07 +01001044 /* Find the corresponding filter instance for the current stream */
1045 list_for_each_entry(filter, &s->strm_flt.filters, list) {
1046 if (FLT_ID(filter) == cache_store_flt_id && FLT_CONF(filter) == cconf) {
1047 /* No filter ctx, don't cache anything */
1048 if (!filter->ctx)
1049 goto out;
1050 cache_ctx = filter->ctx;
1051 break;
1052 }
1053 }
1054
1055 /* from there, cache_ctx is always defined */
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001056 htx = htxbuf(&s->res.buf);
William Lallemand4da3f8a2017-10-31 14:33:34 +01001057
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001058 /* Do not cache too big objects. */
1059 if ((msg->flags & HTTP_MSGF_CNT_LEN) && shctx->max_obj_size > 0 &&
1060 htx->data + htx->extra > shctx->max_obj_size)
1061 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001062
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001063 /* Only a subset of headers are supported in our Vary implementation. If
1064 * any other header is present in the Vary header value, we won't be
Remi Tricot-Le Breton754b2422020-11-16 15:56:10 +01001065 * able to use the cache. Likewise, if Vary header support is disabled,
1066 * avoid caching responses that contain such a header. */
1067 ctx.blk = NULL;
1068 if (cache->vary_processing_enabled) {
1069 if (!http_check_vary_header(htx, &vary_signature))
1070 goto out;
Remi Tricot-Le Breton2b5c5cb2020-12-23 18:13:45 +01001071 if (vary_signature) {
1072 /* If something went wrong during the secondary key
1073 * building, do not store the response. */
1074 if (!(txn->flags & TX_CACHE_HAS_SEC_KEY))
1075 goto out;
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001076 http_request_reduce_secondary_key(vary_signature, txn->cache_secondary_hash);
Remi Tricot-Le Breton2b5c5cb2020-12-23 18:13:45 +01001077 }
Remi Tricot-Le Breton754b2422020-11-16 15:56:10 +01001078 }
1079 else if (http_find_header(htx, ist("Vary"), &ctx, 0)) {
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001080 goto out;
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001081 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001082
Christopher Fauletfc9cfe42019-07-16 14:54:53 +02001083 http_check_response_for_cacheability(s, &s->res);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001084
Remi Tricot-Le Bretoncc9bf2e2020-11-12 11:14:41 +01001085 if (!(txn->flags & TX_CACHEABLE) || !(txn->flags & TX_CACHE_COOK) || (txn->flags & TX_CACHE_IGNORE))
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001086 goto out;
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001087
1088 shctx_lock(shctx);
1089 old = entry_exist(cache, txn->cache_hash);
1090 if (old) {
1091 if (vary_signature)
1092 old = secondary_entry_exist(cconf->c.cache, old,
1093 txn->cache_secondary_hash);
1094 if (old) {
1095 if (!old->complete) {
1096 /* An entry with the same primary key is already being
1097 * created, we should not try to store the current
1098 * response because it will waste space in the cache. */
1099 shctx_unlock(shctx);
1100 goto out;
1101 }
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +01001102 delete_entry(old);
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001103 old->eb.key = 0;
1104 }
1105 }
1106 first = shctx_row_reserve_hot(shctx, NULL, sizeof(struct cache_entry));
1107 if (!first) {
1108 shctx_unlock(shctx);
1109 goto out;
1110 }
1111 /* the received memory is not initialized, we need at least to mark
1112 * the object as not indexed yet.
1113 */
1114 object = (struct cache_entry *)first->data;
1115 memset(object, 0, sizeof(*object));
1116 object->eb.key = key;
1117 object->secondary_key_signature = vary_signature;
1118 /* We need to temporarily set a valid expiring time until the actual one
1119 * is set by the end of this function (in case of concurrent accesses to
1120 * the same resource). This way the second access will find an existing
1121 * but not yet usable entry in the tree and will avoid storing its data. */
1122 object->expire = now.tv_sec + 2;
1123
1124 memcpy(object->hash, txn->cache_hash, sizeof(object->hash));
1125 if (vary_signature)
1126 memcpy(object->secondary_key, txn->cache_secondary_hash, HTTP_CACHE_SEC_KEY_LEN);
1127
1128 /* Insert the entry in the tree even if the payload is not cached yet. */
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +01001129 if (insert_entry(cache, object) != &object->eb) {
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001130 object->eb.key = 0;
1131 shctx_unlock(shctx);
1132 goto out;
1133 }
1134 shctx_unlock(shctx);
1135
1136 /* reserve space for the cache_entry structure */
1137 first->len = sizeof(struct cache_entry);
1138 first->last_append = NULL;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001139
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +01001140 /* Determine the entry's maximum age (taking into account the cache's
1141 * configuration) as well as the response's explicit max age (extracted
1142 * from cache-control directives or the expires header). */
1143 effective_maxage = http_calc_maxage(s, cconf->c.cache, &true_maxage);
1144
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001145 ctx.blk = NULL;
1146 if (http_find_header(htx, ist("Age"), &ctx, 0)) {
Tim Duesterhusc2942842021-01-02 22:47:17 +01001147 long long hdr_age;
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001148 if (!strl2llrc(ctx.value.ptr, ctx.value.len, &hdr_age) && hdr_age > 0) {
1149 if (unlikely(hdr_age > CACHE_ENTRY_MAX_AGE))
1150 hdr_age = CACHE_ENTRY_MAX_AGE;
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +01001151 /* A response with an Age value greater than its
1152 * announced max age is stale and should not be stored. */
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001153 object->age = hdr_age;
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +01001154 if (unlikely(object->age > true_maxage))
1155 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001156 }
Remi Tricot-Le Breton51058d62020-12-03 18:19:32 +01001157 else
1158 goto out;
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001159 http_remove_header(htx, &ctx);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001160 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001161
Remi Tricot Le Breton27091b42020-10-23 10:51:27 +02001162 /* Build a last-modified time that will be stored in the cache_entry and
1163 * compared to a future If-Modified-Since client header. */
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001164 object->last_modified = get_last_modified_time(htx);
Remi Tricot Le Breton27091b42020-10-23 10:51:27 +02001165
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001166 chunk_reset(&trash);
1167 for (pos = htx_get_first(htx); pos != -1; pos = htx_get_next(htx, pos)) {
1168 struct htx_blk *blk = htx_get_blk(htx, pos);
1169 enum htx_blk_type type = htx_get_blk_type(blk);
1170 uint32_t sz = htx_get_blksz(blk);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001171
Christopher Fauletb0667472019-09-03 22:22:12 +02001172 hdrs_len += sizeof(*blk) + sz;
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001173 chunk_memcat(&trash, (char *)&blk->info, sizeof(blk->info));
1174 chunk_memcat(&trash, htx_get_blk_ptr(htx, blk), sz);
Remi Tricot-Le Bretondbb65b52020-10-22 10:40:04 +02001175
1176 /* Look for optional ETag header.
1177 * We need to store the offset of the ETag value in order for
1178 * future conditional requests to be able to perform ETag
1179 * comparisons. */
1180 if (type == HTX_BLK_HDR) {
Tim Duesterhuse2fff102021-01-02 22:47:16 +01001181 struct ist header_name = htx_get_blk_name(htx, blk);
Remi Tricot-Le Bretondbb65b52020-10-22 10:40:04 +02001182 if (isteq(header_name, ist("etag"))) {
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001183 object->etag_length = sz - istlen(header_name);
1184 object->etag_offset = sizeof(struct cache_entry) + b_data(&trash) - sz + istlen(header_name);
Remi Tricot-Le Bretondbb65b52020-10-22 10:40:04 +02001185 }
1186 }
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001187 if (type == HTX_BLK_EOH)
1188 break;
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +02001189 }
1190
Christopher Fauletb0667472019-09-03 22:22:12 +02001191 /* Do not cache objects if the headers are too big. */
1192 if (hdrs_len > htx->size - global.tune.maxrewrite)
1193 goto out;
1194
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01001195 /* If the response has a secondary_key, fill its key part related to
1196 * encodings with the actual encoding of the response. This way any
1197 * subsequent request having the same primary key will have its accepted
Remi Tricot-Le Breton6ca89162021-01-07 14:50:51 +01001198 * encodings tested upon the cached response's one.
1199 * We will not cache a response that has an unknown encoding (not
Ilya Shipitsin7704b0e2021-01-23 02:11:59 +05001200 * explicitly supported in parse_encoding_value function). */
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01001201 if (cache->vary_processing_enabled && vary_signature)
Remi Tricot-Le Breton6ca89162021-01-07 14:50:51 +01001202 if (set_secondary_key_encoding(htx, object->secondary_key))
1203 goto out;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01001204
William Lallemand4da3f8a2017-10-31 14:33:34 +01001205 shctx_lock(shctx);
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001206 if (!shctx_row_reserve_hot(shctx, first, trash.data)) {
William Lallemand4da3f8a2017-10-31 14:33:34 +01001207 shctx_unlock(shctx);
1208 goto out;
1209 }
1210 shctx_unlock(shctx);
1211
William Lallemand4da3f8a2017-10-31 14:33:34 +01001212 /* cache the headers in a http action because it allows to chose what
1213 * to cache, for example you might want to cache a response before
1214 * modifying some HTTP headers, or on the contrary after modifying
1215 * those headers.
1216 */
William Lallemand4da3f8a2017-10-31 14:33:34 +01001217 /* does not need to be locked because it's in the "hot" list,
1218 * copy the headers */
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001219 if (shctx_row_data_append(shctx, first, NULL, (unsigned char *)trash.area, trash.data) < 0)
1220 goto out;
William Lallemand4da3f8a2017-10-31 14:33:34 +01001221
1222 /* register the buffer in the filter ctx for filling it with data*/
Christopher Faulet839791a2019-01-07 16:12:07 +01001223 if (cache_ctx) {
1224 cache_ctx->first_block = first;
Christopher Faulet839791a2019-01-07 16:12:07 +01001225 /* store latest value and expiration time */
1226 object->latest_validation = now.tv_sec;
Remi Tricot-Le Breton795e1412020-12-03 18:19:29 +01001227 object->expire = now.tv_sec + effective_maxage;
Christopher Faulet839791a2019-01-07 16:12:07 +01001228 return ACT_RET_CONT;
William Lallemand4da3f8a2017-10-31 14:33:34 +01001229 }
1230
1231out:
1232 /* if does not cache */
1233 if (first) {
1234 shctx_lock(shctx);
William Lallemand08727662017-11-21 20:01:27 +01001235 first->len = 0;
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001236 if (object->eb.key)
Remi Tricot-Le Breton65904e42020-12-10 17:58:41 +01001237 delete_entry(object);
William Lallemand08727662017-11-21 20:01:27 +01001238 object->eb.key = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +01001239 shctx_row_dec_hot(shctx, first);
1240 shctx_unlock(shctx);
1241 }
1242
William Lallemand41db4602017-10-30 11:15:51 +01001243 return ACT_RET_CONT;
1244}
1245
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001246#define HTX_CACHE_INIT 0 /* Initial state. */
1247#define HTX_CACHE_HEADER 1 /* Cache entry headers forwarding */
1248#define HTX_CACHE_DATA 2 /* Cache entry data forwarding */
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001249#define HTX_CACHE_EOM 3 /* Cache entry completely forwarded. Finish the HTX message */
1250#define HTX_CACHE_END 4 /* Cache entry treatment terminated */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001251
William Lallemandecb73b12017-11-24 14:33:55 +01001252static void http_cache_applet_release(struct appctx *appctx)
1253{
Christopher Faulet95220e22018-12-07 17:34:39 +01001254 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
William Lallemandecb73b12017-11-24 14:33:55 +01001255 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
Christopher Faulet95220e22018-12-07 17:34:39 +01001256 struct cache *cache = cconf->c.cache;
William Lallemandecb73b12017-11-24 14:33:55 +01001257 struct shared_block *first = block_ptr(cache_ptr);
1258
1259 shctx_lock(shctx_ptr(cache));
1260 shctx_row_dec_hot(shctx_ptr(cache), first);
1261 shctx_unlock(shctx_ptr(cache));
1262}
1263
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001264
1265static unsigned int htx_cache_dump_blk(struct appctx *appctx, struct htx *htx, enum htx_blk_type type,
1266 uint32_t info, struct shared_block *shblk, unsigned int offset)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001267{
Christopher Faulet95220e22018-12-07 17:34:39 +01001268 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
1269 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001270 struct htx_blk *blk;
Christopher Faulet15a4ce82019-09-03 22:11:52 +02001271 char *ptr;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001272 unsigned int max, total;
1273 uint32_t blksz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001274
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001275 max = htx_get_max_blksz(htx, channel_htx_recv_max(si_ic(appctx->owner), htx));
1276 if (!max)
1277 return 0;
Christopher Faulet2d7c5392019-06-03 10:41:26 +02001278 blksz = ((type == HTX_BLK_HDR || type == HTX_BLK_TLR)
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001279 ? (info & 0xff) + ((info >> 8) & 0xfffff)
1280 : info & 0xfffffff);
1281 if (blksz > max)
1282 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001283
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001284 blk = htx_add_blk(htx, type, blksz);
1285 if (!blk)
1286 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001287
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001288 blk->info = info;
1289 total = 4;
Christopher Faulet15a4ce82019-09-03 22:11:52 +02001290 ptr = htx_get_blk_ptr(htx, blk);
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001291 while (blksz) {
1292 max = MIN(blksz, shctx->block_size - offset);
Christopher Faulet15a4ce82019-09-03 22:11:52 +02001293 memcpy(ptr, (const char *)shblk->data + offset, max);
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001294 offset += max;
1295 blksz -= max;
1296 total += max;
Christopher Faulet15a4ce82019-09-03 22:11:52 +02001297 ptr += max;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001298 if (blksz || offset == shctx->block_size) {
1299 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
1300 offset = 0;
1301 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001302 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001303 appctx->ctx.cache.offset = offset;
1304 appctx->ctx.cache.next = shblk;
1305 appctx->ctx.cache.sent += total;
1306 return total;
1307}
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001308
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001309static unsigned int htx_cache_dump_data_blk(struct appctx *appctx, struct htx *htx,
1310 uint32_t info, struct shared_block *shblk, unsigned int offset)
1311{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001312
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001313 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
1314 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
1315 unsigned int max, total, rem_data;
1316 uint32_t blksz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001317
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001318 max = htx_get_max_blksz(htx, channel_htx_recv_max(si_ic(appctx->owner), htx));
1319 if (!max)
1320 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001321
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001322 rem_data = 0;
Christopher Fauletbda83972019-06-11 09:58:09 +02001323 if (appctx->ctx.cache.rem_data) {
1324 blksz = appctx->ctx.cache.rem_data;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001325 total = 0;
Christopher Fauletbda83972019-06-11 09:58:09 +02001326 }
1327 else {
1328 blksz = (info & 0xfffffff);
1329 total = 4;
1330 }
1331 if (blksz > max) {
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001332 rem_data = blksz - max;
1333 blksz = max;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001334 }
1335
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001336 while (blksz) {
1337 size_t sz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001338
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001339 max = MIN(blksz, shctx->block_size - offset);
1340 sz = htx_add_data(htx, ist2(shblk->data + offset, max));
1341 offset += sz;
1342 blksz -= sz;
1343 total += sz;
1344 if (sz < max)
1345 break;
1346 if (blksz || offset == shctx->block_size) {
1347 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
1348 offset = 0;
1349 }
1350 }
1351
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001352 appctx->ctx.cache.offset = offset;
1353 appctx->ctx.cache.next = shblk;
1354 appctx->ctx.cache.sent += total;
1355 appctx->ctx.cache.rem_data = rem_data + blksz;
1356 return total;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001357}
1358
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001359static size_t htx_cache_dump_msg(struct appctx *appctx, struct htx *htx, unsigned int len,
1360 enum htx_blk_type mark)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001361{
Christopher Faulet95220e22018-12-07 17:34:39 +01001362 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
1363 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001364 struct shared_block *shblk;
1365 unsigned int offset, sz;
1366 unsigned int ret, total = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001367
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001368 while (len) {
1369 enum htx_blk_type type;
1370 uint32_t info;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001371
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001372 shblk = appctx->ctx.cache.next;
1373 offset = appctx->ctx.cache.offset;
1374 if (appctx->ctx.cache.rem_data) {
1375 type = HTX_BLK_DATA;
1376 info = 0;
1377 goto add_data_blk;
1378 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001379
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +05001380 /* Get info of the next HTX block. May be split on 2 shblk */
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001381 sz = MIN(4, shctx->block_size - offset);
1382 memcpy((char *)&info, (const char *)shblk->data + offset, sz);
1383 offset += sz;
1384 if (sz < 4) {
1385 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
1386 memcpy(((char *)&info)+sz, (const char *)shblk->data, 4 - sz);
1387 offset = (4 - sz);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001388 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001389
1390 /* Get payload of the next HTX block and insert it. */
1391 type = (info >> 28);
1392 if (type != HTX_BLK_DATA)
1393 ret = htx_cache_dump_blk(appctx, htx, type, info, shblk, offset);
1394 else {
1395 add_data_blk:
1396 ret = htx_cache_dump_data_blk(appctx, htx, info, shblk, offset);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001397 }
1398
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001399 if (!ret)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001400 break;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001401 total += ret;
1402 len -= ret;
1403
1404 if (appctx->ctx.cache.rem_data || type == mark)
1405 break;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001406 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001407
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001408 return total;
1409}
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001410
1411static int htx_cache_add_age_hdr(struct appctx *appctx, struct htx *htx)
1412{
1413 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
1414 unsigned int age;
1415 char *end;
1416
1417 chunk_reset(&trash);
1418 age = MAX(0, (int)(now.tv_sec - cache_ptr->latest_validation)) + cache_ptr->age;
1419 if (unlikely(age > CACHE_ENTRY_MAX_AGE))
1420 age = CACHE_ENTRY_MAX_AGE;
1421 end = ultoa_o(age, b_head(&trash), b_size(&trash));
1422 b_set_data(&trash, end - b_head(&trash));
1423 if (!http_add_header(htx, ist("Age"), ist2(b_head(&trash), b_data(&trash))))
1424 return 0;
1425 return 1;
1426}
1427
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001428static void http_cache_io_handler(struct appctx *appctx)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001429{
1430 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
1431 struct shared_block *first = block_ptr(cache_ptr);
1432 struct stream_interface *si = appctx->owner;
1433 struct channel *req = si_oc(si);
1434 struct channel *res = si_ic(si);
1435 struct htx *req_htx, *res_htx;
1436 struct buffer *errmsg;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001437 unsigned int len;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001438 size_t ret, total = 0;
1439
1440 res_htx = htxbuf(&res->buf);
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001441 total = res_htx->data;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001442
1443 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1444 goto out;
1445
Ilya Shipitsin6fb0f212020-04-02 15:25:26 +05001446 /* Check if the input buffer is available. */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001447 if (!b_size(&res->buf)) {
1448 si_rx_room_blk(si);
1449 goto out;
1450 }
1451
Willy Tarreauefef3232018-12-16 00:37:45 +01001452 if (res->flags & (CF_SHUTW|CF_SHUTR|CF_SHUTW_NOW))
Willy Tarreau273e9642018-12-16 00:35:15 +01001453 appctx->st0 = HTX_CACHE_END;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001454
1455 if (appctx->st0 == HTX_CACHE_INIT) {
1456 appctx->ctx.cache.next = block_ptr(cache_ptr);
1457 appctx->ctx.cache.offset = sizeof(*cache_ptr);
1458 appctx->ctx.cache.sent = 0;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001459 appctx->ctx.cache.rem_data = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001460 appctx->st0 = HTX_CACHE_HEADER;
1461 }
1462
1463 if (appctx->st0 == HTX_CACHE_HEADER) {
1464 /* Headers must be dump at once. Otherwise it is an error */
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001465 len = first->len - sizeof(*cache_ptr) - appctx->ctx.cache.sent;
1466 ret = htx_cache_dump_msg(appctx, res_htx, len, HTX_BLK_EOH);
1467 if (!ret || (htx_get_tail_type(res_htx) != HTX_BLK_EOH) ||
1468 !htx_cache_add_age_hdr(appctx, res_htx))
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001469 goto error;
1470
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001471 /* In case of a conditional request, we might want to send a
1472 * "304 Not Modified" response instead of the stored data. */
Tim Duesterhuse0142342020-10-22 21:15:06 +02001473 if (appctx->ctx.cache.send_notmodified) {
1474 if (!http_replace_res_status(res_htx, ist("304"), ist("Not Modified"))) {
1475 /* If replacing the status code fails we need to send the full response. */
1476 appctx->ctx.cache.send_notmodified = 0;
1477 }
1478 }
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001479
1480 /* Skip response body for HEAD requests or in case of "304 Not
1481 * Modified" response. */
1482 if (si_strm(si)->txn->meth == HTTP_METH_HEAD || appctx->ctx.cache.send_notmodified)
Christopher Fauletf0dd0372019-02-25 11:08:34 +01001483 appctx->st0 = HTX_CACHE_EOM;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001484 else
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001485 appctx->st0 = HTX_CACHE_DATA;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001486 }
1487
1488 if (appctx->st0 == HTX_CACHE_DATA) {
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001489 len = first->len - sizeof(*cache_ptr) - appctx->ctx.cache.sent;
1490 if (len) {
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001491 ret = htx_cache_dump_msg(appctx, res_htx, len, HTX_BLK_UNUSED);
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001492 if (ret < len) {
1493 si_rx_room_blk(si);
1494 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001495 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001496 }
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001497 appctx->st0 = HTX_CACHE_EOM;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001498 }
1499
1500 if (appctx->st0 == HTX_CACHE_EOM) {
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001501 /* no more data are expected. */
1502 res_htx->flags |= HTX_FL_EOM;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001503 appctx->st0 = HTX_CACHE_END;
1504 }
1505
1506 end:
Christopher Fauletadb36312019-02-25 11:40:49 +01001507 if (!(res->flags & CF_SHUTR) && appctx->st0 == HTX_CACHE_END) {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001508 res->flags |= CF_READ_NULL;
1509 si_shutr(si);
1510 }
1511
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001512 out:
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001513 total = res_htx->data - total;
Christopher Faulet61123912019-01-02 14:10:01 +01001514 if (total)
1515 channel_add_input(res, total);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001516 htx_to_buf(res_htx, &res->buf);
Christopher Fauletadb36312019-02-25 11:40:49 +01001517
1518 /* eat the whole request */
1519 if (co_data(req)) {
1520 req_htx = htx_from_buf(&req->buf);
1521 co_htx_skip(req, req_htx, co_data(req));
1522 htx_to_buf(req_htx, &req->buf);
1523 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001524 return;
1525
1526 error:
1527 /* Sent and HTTP error 500 */
1528 b_reset(&res->buf);
Christopher Fauletf7346382019-07-17 22:02:08 +02001529 errmsg = &http_err_chunks[HTTP_ERR_500];
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001530 res->buf.data = b_data(errmsg);
1531 memcpy(res->buf.area, b_head(errmsg), b_data(errmsg));
1532 res_htx = htx_from_buf(&res->buf);
1533
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001534 total = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001535 appctx->st0 = HTX_CACHE_END;
1536 goto end;
1537}
1538
1539
Christopher Faulet95220e22018-12-07 17:34:39 +01001540static int parse_cache_rule(struct proxy *proxy, const char *name, struct act_rule *rule, char **err)
William Lallemand41db4602017-10-30 11:15:51 +01001541{
1542 struct flt_conf *fconf;
Christopher Faulet95220e22018-12-07 17:34:39 +01001543 struct cache_flt_conf *cconf = NULL;
William Lallemand41db4602017-10-30 11:15:51 +01001544
Christopher Faulet95220e22018-12-07 17:34:39 +01001545 if (!*name || strcmp(name, "if") == 0 || strcmp(name, "unless") == 0) {
William Lallemand41db4602017-10-30 11:15:51 +01001546 memprintf(err, "expects a cache name");
Christopher Faulet95220e22018-12-07 17:34:39 +01001547 goto err;
William Lallemand41db4602017-10-30 11:15:51 +01001548 }
1549
1550 /* check if a cache filter was already registered with this cache
1551 * name, if that's the case, must use it. */
1552 list_for_each_entry(fconf, &proxy->filter_configs, list) {
Christopher Faulet95220e22018-12-07 17:34:39 +01001553 if (fconf->id == cache_store_flt_id) {
1554 cconf = fconf->conf;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001555 if (cconf && strcmp((char *)cconf->c.name, name) == 0) {
Christopher Faulet95220e22018-12-07 17:34:39 +01001556 rule->arg.act.p[0] = cconf;
1557 return 1;
1558 }
William Lallemand41db4602017-10-30 11:15:51 +01001559 }
1560 }
1561
Christopher Faulet95220e22018-12-07 17:34:39 +01001562 /* Create the filter cache config */
1563 cconf = calloc(1, sizeof(*cconf));
1564 if (!cconf) {
1565 memprintf(err, "out of memory\n");
1566 goto err;
1567 }
Christopher Faulet99a17a22018-12-11 09:18:27 +01001568 cconf->flags = CACHE_FLT_F_IMPLICIT_DECL;
Christopher Faulet95220e22018-12-07 17:34:39 +01001569 cconf->c.name = strdup(name);
1570 if (!cconf->c.name) {
1571 memprintf(err, "out of memory\n");
William Lallemand41db4602017-10-30 11:15:51 +01001572 goto err;
1573 }
Christopher Faulet95220e22018-12-07 17:34:39 +01001574
William Lallemand41db4602017-10-30 11:15:51 +01001575 /* register a filter to fill the cache buffer */
1576 fconf = calloc(1, sizeof(*fconf));
1577 if (!fconf) {
Christopher Faulet95220e22018-12-07 17:34:39 +01001578 memprintf(err, "out of memory\n");
William Lallemand41db4602017-10-30 11:15:51 +01001579 goto err;
1580 }
Christopher Faulet95220e22018-12-07 17:34:39 +01001581 fconf->id = cache_store_flt_id;
1582 fconf->conf = cconf;
William Lallemand41db4602017-10-30 11:15:51 +01001583 fconf->ops = &cache_ops;
Willy Tarreau2b718102021-04-21 07:32:39 +02001584 LIST_APPEND(&proxy->filter_configs, &fconf->list);
William Lallemand41db4602017-10-30 11:15:51 +01001585
Christopher Faulet95220e22018-12-07 17:34:39 +01001586 rule->arg.act.p[0] = cconf;
1587 return 1;
William Lallemand41db4602017-10-30 11:15:51 +01001588
Christopher Faulet95220e22018-12-07 17:34:39 +01001589 err:
1590 free(cconf);
1591 return 0;
1592}
1593
1594enum act_parse_ret parse_cache_store(const char **args, int *orig_arg, struct proxy *proxy,
1595 struct act_rule *rule, char **err)
1596{
1597 rule->action = ACT_CUSTOM;
1598 rule->action_ptr = http_action_store_cache;
1599
1600 if (!parse_cache_rule(proxy, args[*orig_arg], rule, err))
1601 return ACT_RET_PRS_ERR;
William Lallemand41db4602017-10-30 11:15:51 +01001602
Christopher Faulet95220e22018-12-07 17:34:39 +01001603 (*orig_arg)++;
1604 return ACT_RET_PRS_OK;
William Lallemand41db4602017-10-30 11:15:51 +01001605}
1606
Baptiste Assmanndb92a832019-08-05 16:55:32 +02001607/* This produces a sha1 hash of the concatenation of the HTTP method,
1608 * the first occurrence of the Host header followed by the path component
1609 * if it begins with a slash ('/'). */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001610int sha1_hosturi(struct stream *s)
William Lallemandf528fff2017-11-23 19:43:17 +01001611{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001612 struct http_txn *txn = s->txn;
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001613 struct htx *htx = htxbuf(&s->req.buf);
1614 struct htx_sl *sl;
1615 struct http_hdr_ctx ctx;
Willy Tarreauccc61d82019-10-17 09:28:28 +02001616 struct ist uri;
William Lallemandf528fff2017-11-23 19:43:17 +01001617 blk_SHA_CTX sha1_ctx;
Willy Tarreau83061a82018-07-13 11:56:34 +02001618 struct buffer *trash;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001619
William Lallemandf528fff2017-11-23 19:43:17 +01001620 trash = get_trash_chunk();
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001621 ctx.blk = NULL;
Baptiste Assmanndb92a832019-08-05 16:55:32 +02001622
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001623 sl = http_get_stline(htx);
Willy Tarreauccc61d82019-10-17 09:28:28 +02001624 uri = htx_sl_req_uri(sl); // whole uri
1625 if (!uri.len)
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001626 return 0;
Willy Tarreauccc61d82019-10-17 09:28:28 +02001627
1628 /* In HTTP/1, most URIs are seen in origin form ('/path/to/resource'),
1629 * unless haproxy is deployed in front of an outbound cache. In HTTP/2,
1630 * URIs are almost always sent in absolute form with their scheme. In
1631 * this case, the scheme is almost always "https". In order to support
1632 * sharing of cache objects between H1 and H2, we'll hash the absolute
1633 * URI whenever known, or prepend "https://" + the Host header for
1634 * relative URIs. The difference will only appear on absolute HTTP/1
1635 * requests sent to an origin server, which practically is never met in
1636 * the real world so we don't care about the ability to share the same
1637 * key here.URIs are normalized from the absolute URI to an origin form as
1638 * well.
1639 */
1640 if (!(sl->flags & HTX_SL_F_HAS_AUTHORITY)) {
Willy Tarreau20020ae2019-10-29 13:02:15 +01001641 chunk_istcat(trash, ist("https://"));
Willy Tarreauccc61d82019-10-17 09:28:28 +02001642 if (!http_find_header(htx, ist("Host"), &ctx, 0))
1643 return 0;
Willy Tarreau20020ae2019-10-29 13:02:15 +01001644 chunk_istcat(trash, ctx.value);
Willy Tarreauccc61d82019-10-17 09:28:28 +02001645 }
1646
1647 chunk_memcat(trash, uri.ptr, uri.len);
William Lallemandf528fff2017-11-23 19:43:17 +01001648
1649 /* hash everything */
1650 blk_SHA1_Init(&sha1_ctx);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001651 blk_SHA1_Update(&sha1_ctx, trash->area, trash->data);
William Lallemandf528fff2017-11-23 19:43:17 +01001652 blk_SHA1_Final((unsigned char *)txn->cache_hash, &sha1_ctx);
1653
1654 return 1;
1655}
1656
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001657/* Looks for "If-None-Match" headers in the request and compares their value
1658 * with the one that might have been stored in the cache_entry. If any of them
1659 * matches, a "304 Not Modified" response should be sent instead of the cached
1660 * data.
1661 * Although unlikely in a GET/HEAD request, the "If-None-Match: *" syntax is
Remi Tricot-Le Breton53161d82020-10-23 10:51:28 +02001662 * valid and should receive a "304 Not Modified" response (RFC 7234#4.3.2).
1663 *
1664 * If no "If-None-Match" header was found, look for an "If-Modified-Since"
1665 * header and compare its value (date) to the one stored in the cache_entry.
1666 * If the request's date is later than the cached one, we also send a
1667 * "304 Not Modified" response (see RFCs 7232#3.3 and 7234#4.3.2).
1668 *
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001669 * Returns 1 if "304 Not Modified" should be sent, 0 otherwise.
1670 */
1671static int should_send_notmodified_response(struct cache *cache, struct htx *htx,
1672 struct cache_entry *entry)
1673{
1674 int retval = 0;
1675
1676 struct http_hdr_ctx ctx = { .blk = NULL };
1677 struct ist cache_entry_etag = IST_NULL;
1678 struct buffer *etag_buffer = NULL;
Remi Tricot-Le Breton53161d82020-10-23 10:51:28 +02001679 int if_none_match_found = 0;
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001680
Remi Tricot-Le Breton53161d82020-10-23 10:51:28 +02001681 struct tm tm = {};
1682 time_t if_modified_since = 0;
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001683
1684 /* If we find a "If-None-Match" header in the request, rebuild the
Remi Tricot-Le Breton53161d82020-10-23 10:51:28 +02001685 * cache_entry's ETag in order to perform comparisons.
1686 * There could be multiple "if-none-match" header lines. */
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001687 while (http_find_header(htx, ist("if-none-match"), &ctx, 0)) {
Remi Tricot-Le Breton53161d82020-10-23 10:51:28 +02001688 if_none_match_found = 1;
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001689
1690 /* A '*' matches everything. */
1691 if (isteq(ctx.value, ist("*")) != 0) {
1692 retval = 1;
1693 break;
1694 }
1695
Remi Tricot-Le Breton53161d82020-10-23 10:51:28 +02001696 /* No need to rebuild an etag if none was stored in the cache. */
1697 if (entry->etag_length == 0)
1698 break;
1699
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001700 /* Rebuild the stored ETag. */
1701 if (etag_buffer == NULL) {
1702 etag_buffer = get_trash_chunk();
1703
1704 if (shctx_row_data_get(shctx_ptr(cache), block_ptr(entry),
1705 (unsigned char*)b_orig(etag_buffer),
1706 entry->etag_offset, entry->etag_length) == 0) {
1707 cache_entry_etag = ist2(b_orig(etag_buffer), entry->etag_length);
1708 } else {
1709 /* We could not rebuild the ETag in one go, we
1710 * won't send a "304 Not Modified" response. */
1711 break;
1712 }
1713 }
1714
1715 if (http_compare_etags(cache_entry_etag, ctx.value) == 1) {
1716 retval = 1;
1717 break;
1718 }
1719 }
1720
Remi Tricot-Le Breton53161d82020-10-23 10:51:28 +02001721 /* If the request did not contain an "If-None-Match" header, we look for
1722 * an "If-Modified-Since" header (see RFC 7232#3.3). */
1723 if (retval == 0 && if_none_match_found == 0) {
1724 ctx.blk = NULL;
1725 if (http_find_header(htx, ist("if-modified-since"), &ctx, 1)) {
1726 if (parse_http_date(istptr(ctx.value), istlen(ctx.value), &tm)) {
1727 if_modified_since = my_timegm(&tm);
1728
1729 /* We send a "304 Not Modified" response if the
1730 * entry's last modified date is earlier than
1731 * the one found in the "If-Modified-Since"
1732 * header. */
1733 retval = (entry->last_modified <= if_modified_since);
1734 }
1735 }
1736 }
1737
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001738 return retval;
1739}
1740
William Lallemand41db4602017-10-30 11:15:51 +01001741enum act_return http_action_req_cache_use(struct act_rule *rule, struct proxy *px,
1742 struct session *sess, struct stream *s, int flags)
1743{
William Lallemand77c11972017-10-31 20:43:01 +01001744
Christopher Fauletb3d4bca2019-02-25 10:59:33 +01001745 struct http_txn *txn = s->txn;
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001746 struct cache_entry *res, *sec_entry = NULL;
Christopher Faulet95220e22018-12-07 17:34:39 +01001747 struct cache_flt_conf *cconf = rule->arg.act.p[0];
1748 struct cache *cache = cconf->c.cache;
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001749 struct shared_block *entry_block;
1750
William Lallemand77c11972017-10-31 20:43:01 +01001751
Willy Tarreau6905d182019-10-01 17:59:17 +02001752 /* Ignore cache for HTTP/1.0 requests and for requests other than GET
1753 * and HEAD */
Christopher Fauletb3d4bca2019-02-25 10:59:33 +01001754 if (!(txn->req.flags & HTTP_MSGF_VER_11) ||
Willy Tarreau6905d182019-10-01 17:59:17 +02001755 (txn->meth != HTTP_METH_GET && txn->meth != HTTP_METH_HEAD))
Christopher Fauletb3d4bca2019-02-25 10:59:33 +01001756 txn->flags |= TX_CACHE_IGNORE;
1757
Christopher Fauletfc9cfe42019-07-16 14:54:53 +02001758 http_check_request_for_cacheability(s, &s->req);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001759
Remi Tricot-Le Breton72cffaf2020-12-03 18:19:31 +01001760 /* The request's hash has to be calculated for all requests, even POSTs
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05001761 * or PUTs for instance because RFC7234 specifies that a successful
Remi Tricot-Le Breton72cffaf2020-12-03 18:19:31 +01001762 * "unsafe" method on a stored resource must invalidate it
1763 * (see RFC7234#4.4). */
1764 if (!sha1_hosturi(s))
Willy Tarreau504455c2017-12-22 17:47:35 +01001765 return ACT_RET_CONT;
1766
Willy Tarreau504455c2017-12-22 17:47:35 +01001767 if (s->txn->flags & TX_CACHE_IGNORE)
1768 return ACT_RET_CONT;
1769
Willy Tarreaua1214a52018-12-14 14:00:25 +01001770 if (px == strm_fe(s))
Willy Tarreau4781b152021-04-06 13:53:36 +02001771 _HA_ATOMIC_INC(&px->fe_counters.p.http.cache_lookups);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001772 else
Willy Tarreau4781b152021-04-06 13:53:36 +02001773 _HA_ATOMIC_INC(&px->be_counters.p.http.cache_lookups);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001774
William Lallemanda400a3a2017-11-20 19:13:12 +01001775 shctx_lock(shctx_ptr(cache));
William Lallemandf528fff2017-11-23 19:43:17 +01001776 res = entry_exist(cache, s->txn->cache_hash);
Remi Tricot-Le Breton32434472020-11-25 10:09:43 +01001777 /* We must not use an entry that is not complete. */
1778 if (res && res->complete) {
William Lallemand77c11972017-10-31 20:43:01 +01001779 struct appctx *appctx;
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001780 entry_block = block_ptr(res);
1781 shctx_row_inc_hot(shctx_ptr(cache), entry_block);
William Lallemanda400a3a2017-11-20 19:13:12 +01001782 shctx_unlock(shctx_ptr(cache));
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001783
1784 /* In case of Vary, we could have multiple entries with the same
Remi Tricot-Le Breton2b5c5cb2020-12-23 18:13:45 +01001785 * primary hash. We need to calculate the secondary hash in order
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001786 * to find the actual entry we want (if it exists). */
1787 if (res->secondary_key_signature) {
1788 if (!http_request_build_secondary_key(s, res->secondary_key_signature)) {
1789 shctx_lock(shctx_ptr(cache));
1790 sec_entry = secondary_entry_exist(cache, res,
1791 s->txn->cache_secondary_hash);
1792 if (sec_entry && sec_entry != res) {
1793 /* The wrong row was added to the hot list. */
1794 shctx_row_dec_hot(shctx_ptr(cache), entry_block);
1795 entry_block = block_ptr(sec_entry);
1796 shctx_row_inc_hot(shctx_ptr(cache), entry_block);
1797 }
1798 res = sec_entry;
1799 shctx_unlock(shctx_ptr(cache));
1800 }
1801 else
1802 res = NULL;
1803 }
1804
1805 /* We looked for a valid secondary entry and could not find one,
1806 * the request must be forwarded to the server. */
1807 if (!res) {
1808 shctx_lock(shctx_ptr(cache));
1809 shctx_row_dec_hot(shctx_ptr(cache), entry_block);
1810 shctx_unlock(shctx_ptr(cache));
1811 return ACT_RET_CONT;
1812 }
1813
William Lallemand77c11972017-10-31 20:43:01 +01001814 s->target = &http_cache_applet.obj_type;
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001815 if ((appctx = si_register_handler(&s->si[1], objt_applet(s->target)))) {
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001816 appctx->st0 = HTX_CACHE_INIT;
William Lallemand77c11972017-10-31 20:43:01 +01001817 appctx->rule = rule;
1818 appctx->ctx.cache.entry = res;
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001819 appctx->ctx.cache.next = NULL;
1820 appctx->ctx.cache.sent = 0;
Remi Tricot-Le Breton6cb10382020-10-22 10:40:05 +02001821 appctx->ctx.cache.send_notmodified =
1822 should_send_notmodified_response(cache, htxbuf(&s->req.buf), res);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001823
1824 if (px == strm_fe(s))
Willy Tarreau4781b152021-04-06 13:53:36 +02001825 _HA_ATOMIC_INC(&px->fe_counters.p.http.cache_hits);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001826 else
Willy Tarreau4781b152021-04-06 13:53:36 +02001827 _HA_ATOMIC_INC(&px->be_counters.p.http.cache_hits);
Olivier Houchardfccf8402017-11-01 14:04:02 +01001828 return ACT_RET_CONT;
William Lallemand77c11972017-10-31 20:43:01 +01001829 } else {
William Lallemand55e76742017-11-21 20:01:28 +01001830 shctx_lock(shctx_ptr(cache));
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001831 shctx_row_dec_hot(shctx_ptr(cache), entry_block);
William Lallemand55e76742017-11-21 20:01:28 +01001832 shctx_unlock(shctx_ptr(cache));
Olivier Houchardfccf8402017-11-01 14:04:02 +01001833 return ACT_RET_YIELD;
William Lallemand77c11972017-10-31 20:43:01 +01001834 }
1835 }
William Lallemanda400a3a2017-11-20 19:13:12 +01001836 shctx_unlock(shctx_ptr(cache));
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001837
1838 /* Shared context does not need to be locked while we calculate the
1839 * secondary hash. */
Remi Tricot-Le Breton754b2422020-11-16 15:56:10 +01001840 if (!res && cache->vary_processing_enabled) {
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01001841 /* Build a complete secondary hash until the server response
1842 * tells us which fields should be kept (if any). */
1843 http_request_prebuild_full_secondary_key(s);
1844 }
Olivier Houchardfccf8402017-11-01 14:04:02 +01001845 return ACT_RET_CONT;
William Lallemand41db4602017-10-30 11:15:51 +01001846}
1847
1848
1849enum act_parse_ret parse_cache_use(const char **args, int *orig_arg, struct proxy *proxy,
1850 struct act_rule *rule, char **err)
1851{
William Lallemand41db4602017-10-30 11:15:51 +01001852 rule->action = ACT_CUSTOM;
1853 rule->action_ptr = http_action_req_cache_use;
1854
Christopher Faulet95220e22018-12-07 17:34:39 +01001855 if (!parse_cache_rule(proxy, args[*orig_arg], rule, err))
William Lallemand41db4602017-10-30 11:15:51 +01001856 return ACT_RET_PRS_ERR;
William Lallemand41db4602017-10-30 11:15:51 +01001857
1858 (*orig_arg)++;
1859 return ACT_RET_PRS_OK;
William Lallemand41db4602017-10-30 11:15:51 +01001860}
1861
1862int cfg_parse_cache(const char *file, int linenum, char **args, int kwm)
1863{
1864 int err_code = 0;
1865
1866 if (strcmp(args[0], "cache") == 0) { /* new cache section */
1867
1868 if (!*args[1]) {
Tim Duesterhusff4d86b2020-08-18 22:20:27 +02001869 ha_alert("parsing [%s:%d] : '%s' expects a <name> argument\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001870 file, linenum, args[0]);
William Lallemand41db4602017-10-30 11:15:51 +01001871 err_code |= ERR_ALERT | ERR_ABORT;
1872 goto out;
1873 }
1874
1875 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1876 err_code |= ERR_ABORT;
1877 goto out;
1878 }
1879
1880 if (tmp_cache_config == NULL) {
Tim Duesterhusff4d86b2020-08-18 22:20:27 +02001881 struct cache *cache_config;
1882
William Lallemand41db4602017-10-30 11:15:51 +01001883 tmp_cache_config = calloc(1, sizeof(*tmp_cache_config));
1884 if (!tmp_cache_config) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001885 ha_alert("parsing [%s:%d]: out of memory.\n", file, linenum);
William Lallemand41db4602017-10-30 11:15:51 +01001886 err_code |= ERR_ALERT | ERR_ABORT;
1887 goto out;
1888 }
1889
1890 strlcpy2(tmp_cache_config->id, args[1], 33);
1891 if (strlen(args[1]) > 32) {
Tim Duesterhusff4d86b2020-08-18 22:20:27 +02001892 ha_warning("parsing [%s:%d]: cache name is limited to 32 characters, truncate to '%s'.\n",
Christopher Faulet767a84b2017-11-24 16:50:31 +01001893 file, linenum, tmp_cache_config->id);
William Lallemand41db4602017-10-30 11:15:51 +01001894 err_code |= ERR_WARN;
1895 }
Tim Duesterhusff4d86b2020-08-18 22:20:27 +02001896
1897 list_for_each_entry(cache_config, &caches_config, list) {
1898 if (strcmp(tmp_cache_config->id, cache_config->id) == 0) {
1899 ha_alert("parsing [%s:%d]: Duplicate cache name '%s'.\n",
1900 file, linenum, tmp_cache_config->id);
1901 err_code |= ERR_ALERT | ERR_ABORT;
1902 goto out;
1903 }
1904 }
1905
William Lallemand49b44532017-11-24 18:53:43 +01001906 tmp_cache_config->maxage = 60;
William Lallemand41db4602017-10-30 11:15:51 +01001907 tmp_cache_config->maxblocks = 0;
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001908 tmp_cache_config->maxobjsz = 0;
Remi Tricot-Le Breton5853c0c2020-12-10 17:58:43 +01001909 tmp_cache_config->max_secondary_entries = DEFAULT_MAX_SECONDARY_ENTRY;
William Lallemand41db4602017-10-30 11:15:51 +01001910 }
1911 } else if (strcmp(args[0], "total-max-size") == 0) {
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001912 unsigned long int maxsize;
1913 char *err;
William Lallemand41db4602017-10-30 11:15:51 +01001914
1915 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1916 err_code |= ERR_ABORT;
1917 goto out;
1918 }
1919
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001920 maxsize = strtoul(args[1], &err, 10);
1921 if (err == args[1] || *err != '\0') {
1922 ha_warning("parsing [%s:%d]: total-max-size wrong value '%s'\n",
1923 file, linenum, args[1]);
1924 err_code |= ERR_ABORT;
1925 goto out;
1926 }
1927
1928 if (maxsize > (UINT_MAX >> 20)) {
1929 ha_warning("parsing [%s:%d]: \"total-max-size\" (%s) must not be greater than %u\n",
1930 file, linenum, args[1], UINT_MAX >> 20);
1931 err_code |= ERR_ABORT;
1932 goto out;
1933 }
1934
William Lallemand41db4602017-10-30 11:15:51 +01001935 /* size in megabytes */
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001936 maxsize *= 1024 * 1024 / CACHE_BLOCKSIZE;
William Lallemand41db4602017-10-30 11:15:51 +01001937 tmp_cache_config->maxblocks = maxsize;
William Lallemand49b44532017-11-24 18:53:43 +01001938 } else if (strcmp(args[0], "max-age") == 0) {
1939 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1940 err_code |= ERR_ABORT;
1941 goto out;
1942 }
1943
1944 if (!*args[1]) {
1945 ha_warning("parsing [%s:%d]: '%s' expects an age parameter in seconds.\n",
1946 file, linenum, args[0]);
1947 err_code |= ERR_WARN;
1948 }
1949
1950 tmp_cache_config->maxage = atoi(args[1]);
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001951 } else if (strcmp(args[0], "max-object-size") == 0) {
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001952 unsigned int maxobjsz;
1953 char *err;
1954
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001955 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1956 err_code |= ERR_ABORT;
1957 goto out;
1958 }
1959
1960 if (!*args[1]) {
1961 ha_warning("parsing [%s:%d]: '%s' expects a maximum file size parameter in bytes.\n",
1962 file, linenum, args[0]);
1963 err_code |= ERR_WARN;
1964 }
1965
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001966 maxobjsz = strtoul(args[1], &err, 10);
1967 if (err == args[1] || *err != '\0') {
1968 ha_warning("parsing [%s:%d]: max-object-size wrong value '%s'\n",
1969 file, linenum, args[1]);
1970 err_code |= ERR_ABORT;
1971 goto out;
1972 }
1973 tmp_cache_config->maxobjsz = maxobjsz;
Remi Tricot-Le Breton754b2422020-11-16 15:56:10 +01001974 } else if (strcmp(args[0], "process-vary") == 0) {
1975 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1976 err_code |= ERR_ABORT;
1977 goto out;
1978 }
1979
1980 if (!*args[1]) {
Remi Tricot-Le Bretone6cc5b52020-12-23 18:13:53 +01001981 ha_warning("parsing [%s:%d]: '%s' expects \"on\" or \"off\" (enable or disable vary processing).\n",
Remi Tricot-Le Breton754b2422020-11-16 15:56:10 +01001982 file, linenum, args[0]);
1983 err_code |= ERR_WARN;
1984 }
Remi Tricot-Le Bretone6cc5b52020-12-23 18:13:53 +01001985 if (strcmp(args[1], "on") == 0)
1986 tmp_cache_config->vary_processing_enabled = 1;
1987 else if (strcmp(args[1], "off") == 0)
1988 tmp_cache_config->vary_processing_enabled = 0;
1989 else {
1990 ha_warning("parsing [%s:%d]: '%s' expects \"on\" or \"off\" (enable or disable vary processing).\n",
1991 file, linenum, args[0]);
1992 err_code |= ERR_WARN;
1993 }
Remi Tricot-Le Breton5853c0c2020-12-10 17:58:43 +01001994 } else if (strcmp(args[0], "max-secondary-entries") == 0) {
1995 unsigned int max_sec_entries;
1996 char *err;
1997
1998 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1999 err_code |= ERR_ABORT;
2000 goto out;
2001 }
2002
2003 if (!*args[1]) {
2004 ha_warning("parsing [%s:%d]: '%s' expects a strictly positive number.\n",
2005 file, linenum, args[0]);
2006 err_code |= ERR_WARN;
2007 }
2008
2009 max_sec_entries = strtoul(args[1], &err, 10);
2010 if (err == args[1] || *err != '\0' || max_sec_entries == 0) {
2011 ha_warning("parsing [%s:%d]: max-secondary-entries wrong value '%s'\n",
2012 file, linenum, args[1]);
2013 err_code |= ERR_ABORT;
2014 goto out;
2015 }
2016 tmp_cache_config->max_secondary_entries = max_sec_entries;
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02002017 }
2018 else if (*args[0] != 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002019 ha_alert("parsing [%s:%d] : unknown keyword '%s' in 'cache' section\n", file, linenum, args[0]);
William Lallemand41db4602017-10-30 11:15:51 +01002020 err_code |= ERR_ALERT | ERR_FATAL;
2021 goto out;
2022 }
2023out:
2024 return err_code;
2025}
2026
2027/* once the cache section is parsed */
2028
2029int cfg_post_parse_section_cache()
2030{
William Lallemand41db4602017-10-30 11:15:51 +01002031 int err_code = 0;
William Lallemand41db4602017-10-30 11:15:51 +01002032
2033 if (tmp_cache_config) {
William Lallemand41db4602017-10-30 11:15:51 +01002034
2035 if (tmp_cache_config->maxblocks <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002036 ha_alert("Size not specified for cache '%s'\n", tmp_cache_config->id);
William Lallemand41db4602017-10-30 11:15:51 +01002037 err_code |= ERR_FATAL | ERR_ALERT;
2038 goto out;
2039 }
2040
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02002041 if (!tmp_cache_config->maxobjsz) {
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02002042 /* Default max. file size is a 256th of the cache size. */
2043 tmp_cache_config->maxobjsz =
2044 (tmp_cache_config->maxblocks * CACHE_BLOCKSIZE) >> 8;
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02002045 }
2046 else if (tmp_cache_config->maxobjsz > tmp_cache_config->maxblocks * CACHE_BLOCKSIZE / 2) {
2047 ha_alert("\"max-object-size\" is limited to an half of \"total-max-size\" => %u\n", tmp_cache_config->maxblocks * CACHE_BLOCKSIZE / 2);
2048 err_code |= ERR_FATAL | ERR_ALERT;
2049 goto out;
2050 }
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02002051
William Lallemandd1d1e222019-08-28 15:22:49 +02002052 /* add to the list of cache to init and reinit tmp_cache_config
2053 * for next cache section, if any.
2054 */
Willy Tarreau2b718102021-04-21 07:32:39 +02002055 LIST_APPEND(&caches_config, &tmp_cache_config->list);
William Lallemandd1d1e222019-08-28 15:22:49 +02002056 tmp_cache_config = NULL;
2057 return err_code;
2058 }
2059out:
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002060 ha_free(&tmp_cache_config);
William Lallemandd1d1e222019-08-28 15:22:49 +02002061 return err_code;
2062
2063}
2064
2065int post_check_cache()
2066{
2067 struct proxy *px;
2068 struct cache *back, *cache_config, *cache;
2069 struct shared_context *shctx;
2070 int ret_shctx;
Christopher Fauletfc633b62020-11-06 15:24:23 +01002071 int err_code = ERR_NONE;
William Lallemandd1d1e222019-08-28 15:22:49 +02002072
2073 list_for_each_entry_safe(cache_config, back, &caches_config, list) {
2074
2075 ret_shctx = shctx_init(&shctx, cache_config->maxblocks, CACHE_BLOCKSIZE,
2076 cache_config->maxobjsz, sizeof(struct cache), 1);
William Lallemand4da3f8a2017-10-31 14:33:34 +01002077
Frédéric Lécaillebc584492018-10-25 20:18:59 +02002078 if (ret_shctx <= 0) {
William Lallemand41db4602017-10-30 11:15:51 +01002079 if (ret_shctx == SHCTX_E_INIT_LOCK)
Christopher Faulet767a84b2017-11-24 16:50:31 +01002080 ha_alert("Unable to initialize the lock for the cache.\n");
William Lallemand41db4602017-10-30 11:15:51 +01002081 else
Christopher Faulet767a84b2017-11-24 16:50:31 +01002082 ha_alert("Unable to allocate cache.\n");
William Lallemand41db4602017-10-30 11:15:51 +01002083
2084 err_code |= ERR_FATAL | ERR_ALERT;
2085 goto out;
2086 }
William Lallemanda400a3a2017-11-20 19:13:12 +01002087 shctx->free_block = cache_free_blocks;
William Lallemandd1d1e222019-08-28 15:22:49 +02002088 /* the cache structure is stored in the shctx and added to the
2089 * caches list, we can remove the entry from the caches_config
2090 * list */
2091 memcpy(shctx->data, cache_config, sizeof(struct cache));
William Lallemand41db4602017-10-30 11:15:51 +01002092 cache = (struct cache *)shctx->data;
Remi Tricot-Le Breton1785f3d2020-11-16 15:56:09 +01002093 cache->entries = EB_ROOT;
Willy Tarreau2b718102021-04-21 07:32:39 +02002094 LIST_APPEND(&caches, &cache->list);
2095 LIST_DELETE(&cache_config->list);
William Lallemandd1d1e222019-08-28 15:22:49 +02002096 free(cache_config);
2097
2098 /* Find all references for this cache in the existing filters
2099 * (over all proxies) and reference it in matching filters.
2100 */
2101 for (px = proxies_list; px; px = px->next) {
2102 struct flt_conf *fconf;
2103 struct cache_flt_conf *cconf;
2104
2105 list_for_each_entry(fconf, &px->filter_configs, list) {
2106 if (fconf->id != cache_store_flt_id)
2107 continue;
2108
2109 cconf = fconf->conf;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002110 if (strcmp(cache->id, cconf->c.name) == 0) {
William Lallemandd1d1e222019-08-28 15:22:49 +02002111 free(cconf->c.name);
Tim Duesterhusd7c6e6a2020-09-14 18:01:33 +02002112 cconf->flags |= CACHE_FLT_INIT;
William Lallemandd1d1e222019-08-28 15:22:49 +02002113 cconf->c.cache = cache;
2114 break;
2115 }
2116 }
2117 }
William Lallemand41db4602017-10-30 11:15:51 +01002118 }
William Lallemandd1d1e222019-08-28 15:22:49 +02002119
William Lallemand41db4602017-10-30 11:15:51 +01002120out:
William Lallemand41db4602017-10-30 11:15:51 +01002121 return err_code;
2122
William Lallemand41db4602017-10-30 11:15:51 +01002123}
2124
William Lallemand41db4602017-10-30 11:15:51 +01002125struct flt_ops cache_ops = {
2126 .init = cache_store_init,
Christopher Faulet95220e22018-12-07 17:34:39 +01002127 .check = cache_store_check,
2128 .deinit = cache_store_deinit,
William Lallemand41db4602017-10-30 11:15:51 +01002129
Christopher Faulet65554e12020-03-06 14:52:06 +01002130 /* Handle stream init/deinit */
2131 .attach = cache_store_strm_init,
2132 .detach = cache_store_strm_deinit,
2133
William Lallemand4da3f8a2017-10-31 14:33:34 +01002134 /* Handle channels activity */
Christopher Faulet839791a2019-01-07 16:12:07 +01002135 .channel_post_analyze = cache_store_post_analyze,
William Lallemand4da3f8a2017-10-31 14:33:34 +01002136
2137 /* Filter HTTP requests and responses */
2138 .http_headers = cache_store_http_headers,
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01002139 .http_payload = cache_store_http_payload,
William Lallemand4da3f8a2017-10-31 14:33:34 +01002140 .http_end = cache_store_http_end,
William Lallemand41db4602017-10-30 11:15:51 +01002141};
2142
Christopher Faulet99a17a22018-12-11 09:18:27 +01002143
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002144#define CHECK_ENCODING(str, encoding_name, encoding_value) \
2145 ({ \
2146 int retval = 0; \
2147 if (istmatch(str, (struct ist){ .ptr = encoding_name+1, .len = sizeof(encoding_name) - 2 })) { \
2148 retval = encoding_value; \
2149 encoding = istadv(encoding, sizeof(encoding_name) - 2); \
2150 } \
2151 (retval); \
2152 })
2153
2154/*
2155 * Parse the encoding <encoding> and try to match the encoding part upon an
2156 * encoding list of explicitly supported encodings (which all have a specific
2157 * bit in an encoding bitmap). If a weight is included in the value, find out if
2158 * it is null or not. The bit value will be set in the <encoding_value>
2159 * parameter and the <has_null_weight> will be set to 1 if the weight is strictly
2160 * 0, 1 otherwise.
2161 * The encodings list is extracted from
2162 * https://www.iana.org/assignments/http-parameters/http-parameters.xhtml.
2163 * Returns 0 in case of success and -1 in case of error.
2164 */
2165static int parse_encoding_value(struct ist encoding, unsigned int *encoding_value,
2166 unsigned int *has_null_weight)
2167{
2168 int retval = 0;
2169
2170 if (!encoding_value)
2171 return -1;
2172
2173 if (!istlen(encoding))
2174 return -1; /* Invalid encoding */
2175
2176 *encoding_value = 0;
2177 if (has_null_weight)
2178 *has_null_weight = 0;
2179
2180 switch (*encoding.ptr) {
2181 case 'a':
2182 encoding = istadv(encoding, 1);
2183 *encoding_value = CHECK_ENCODING(encoding, "aes128gcm", VARY_ENCODING_AES128GCM);
2184 break;
2185 case 'b':
2186 encoding = istadv(encoding, 1);
2187 *encoding_value = CHECK_ENCODING(encoding, "br", VARY_ENCODING_BR);
2188 break;
2189 case 'c':
2190 encoding = istadv(encoding, 1);
2191 *encoding_value = CHECK_ENCODING(encoding, "compress", VARY_ENCODING_COMPRESS);
2192 break;
2193 case 'd':
2194 encoding = istadv(encoding, 1);
2195 *encoding_value = CHECK_ENCODING(encoding, "deflate", VARY_ENCODING_DEFLATE);
2196 break;
2197 case 'e':
2198 encoding = istadv(encoding, 1);
2199 *encoding_value = CHECK_ENCODING(encoding, "exi", VARY_ENCODING_EXI);
2200 break;
2201 case 'g':
2202 encoding = istadv(encoding, 1);
2203 *encoding_value = CHECK_ENCODING(encoding, "gzip", VARY_ENCODING_GZIP);
2204 break;
2205 case 'i':
2206 encoding = istadv(encoding, 1);
2207 *encoding_value = CHECK_ENCODING(encoding, "identity", VARY_ENCODING_IDENTITY);
2208 break;
2209 case 'p':
2210 encoding = istadv(encoding, 1);
2211 *encoding_value = CHECK_ENCODING(encoding, "pack200-gzip", VARY_ENCODING_PACK200_GZIP);
2212 break;
2213 case 'x':
2214 encoding = istadv(encoding, 1);
2215 *encoding_value = CHECK_ENCODING(encoding, "x-gzip", VARY_ENCODING_GZIP);
2216 if (!*encoding_value)
2217 *encoding_value = CHECK_ENCODING(encoding, "x-compress", VARY_ENCODING_COMPRESS);
2218 break;
2219 case 'z':
2220 encoding = istadv(encoding, 1);
2221 *encoding_value = CHECK_ENCODING(encoding, "zstd", VARY_ENCODING_ZSTD);
2222 break;
2223 case '*':
2224 encoding = istadv(encoding, 1);
2225 *encoding_value = VARY_ENCODING_STAR;
2226 break;
2227 default:
2228 retval = -1; /* Unmanaged encoding */
2229 break;
2230 }
2231
2232 /* Process the optional weight part of the encoding. */
2233 if (*encoding_value) {
2234 encoding = http_trim_leading_spht(encoding);
2235 if (istlen(encoding)) {
2236 if (*encoding.ptr != ';')
2237 return -1;
2238
2239 if (has_null_weight) {
2240 encoding = istadv(encoding, 1);
2241
2242 encoding = http_trim_leading_spht(encoding);
2243
2244 *has_null_weight = isteq(encoding, ist("q=0"));
2245 }
2246 }
2247 }
2248
2249 return retval;
2250}
2251
Tim Duesterhus23b29452020-11-24 22:22:56 +01002252#define ACCEPT_ENCODING_MAX_ENTRIES 16
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002253/*
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002254 * Build a bitmap of the accept-encoding header.
2255 *
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002256 * The bitmap is built by matching every sub-part of the accept-encoding value
2257 * with a subset of explicitly supported encodings, which all have their own bit
2258 * in the bitmap. This bitmap will be used to determine if a response can be
2259 * served to a client (that is if it has an encoding that is accepted by the
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002260 * client). Any unknown encodings will be indicated by the VARY_ENCODING_OTHER
2261 * bit.
2262 *
2263 * Returns 0 in case of success and -1 in case of error.
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002264 */
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002265static int accept_encoding_normalizer(struct htx *htx, struct ist hdr_name,
2266 char *buf, unsigned int *buf_len)
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002267{
Tim Duesterhus23b29452020-11-24 22:22:56 +01002268 size_t count = 0;
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002269 uint32_t encoding_bitmap = 0;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002270 unsigned int encoding_bmp_bl = -1;
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002271 struct http_hdr_ctx ctx = { .blk = NULL };
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002272 unsigned int encoding_value;
2273 unsigned int rejected_encoding;
2274
Ilya Shipitsinb8888ab2021-01-06 21:20:16 +05002275 /* A user agent always accepts an unencoded value unless it explicitly
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002276 * refuses it through an "identity;q=0" accept-encoding value. */
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002277 encoding_bitmap |= VARY_ENCODING_IDENTITY;
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002278
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002279 /* Iterate over all the ACCEPT_ENCODING_MAX_ENTRIES first accept-encoding
2280 * values that might span acrosse multiple accept-encoding headers. */
2281 while (http_find_header(htx, hdr_name, &ctx, 0) && count < ACCEPT_ENCODING_MAX_ENTRIES) {
2282 /* Turn accept-encoding value to lower case */
2283 ist2bin_lc(istptr(ctx.value), ctx.value);
Tim Duesterhus23b29452020-11-24 22:22:56 +01002284
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002285 /* Try to identify a known encoding and to manage null weights. */
2286 if (!parse_encoding_value(ctx.value, &encoding_value, &rejected_encoding)) {
2287 if (rejected_encoding)
2288 encoding_bmp_bl &= ~encoding_value;
2289 else
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002290 encoding_bitmap |= encoding_value;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002291 }
2292 else {
2293 /* Unknown encoding */
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002294 encoding_bitmap |= VARY_ENCODING_OTHER;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002295 }
2296
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002297 count++;
Remi Tricot-Le Breton8bb72aa2020-11-30 17:06:03 +01002298 }
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002299
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002300 /* If a "*" was found in the accepted encodings (without a null weight),
Ilya Shipitsinb8888ab2021-01-06 21:20:16 +05002301 * all the encoding are accepted except the ones explicitly rejected. */
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002302 if (encoding_bitmap & VARY_ENCODING_STAR) {
2303 encoding_bitmap = ~0;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002304 }
2305
Ilya Shipitsinb8888ab2021-01-06 21:20:16 +05002306 /* Clear explicitly rejected encodings from the bitmap */
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002307 encoding_bitmap &= encoding_bmp_bl;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002308
2309 /* As per RFC7231#5.3.4, "If no Accept-Encoding field is in the request,
2310 * any content-coding is considered acceptable by the user agent". */
2311 if (count == 0)
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002312 encoding_bitmap = ~0;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002313
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002314 /* A request with more than ACCEPT_ENCODING_MAX_ENTRIES accepted
2315 * encodings might be illegitimate so we will not use it. */
2316 if (count == ACCEPT_ENCODING_MAX_ENTRIES)
2317 return -1;
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002318
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002319 write_u32(buf, encoding_bitmap);
2320 *buf_len = sizeof(encoding_bitmap);
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002321
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002322 /* This function fills the hash buffer correctly even if no header was
2323 * found, hence the 0 return value (success). */
Tim Duesterhus23b29452020-11-24 22:22:56 +01002324 return 0;
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002325}
Tim Duesterhus23b29452020-11-24 22:22:56 +01002326#undef ACCEPT_ENCODING_MAX_ENTRIES
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002327
2328/*
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002329 * Normalizer used by default for the Referer header. It only
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002330 * calculates a simple crc of the whole value.
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002331 * Only the first occurrence of the header will be taken into account in the
2332 * hash.
2333 * Returns 0 in case of success, 1 if the hash buffer should be filled with 0s
2334 * and -1 in case of error.
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002335 */
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002336static int default_normalizer(struct htx *htx, struct ist hdr_name,
2337 char *buf, unsigned int *buf_len)
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002338{
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002339 int retval = 1;
2340 struct http_hdr_ctx ctx = { .blk = NULL };
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002341
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002342 if (http_find_header(htx, hdr_name, &ctx, 1)) {
2343 retval = 0;
2344 write_u32(buf, hash_crc32(istptr(ctx.value), istlen(ctx.value)));
2345 *buf_len = sizeof(int);
2346 }
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002347
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002348 return retval;
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002349}
2350
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002351/*
Tim Duesterhused84d842021-01-18 13:41:17 +01002352 * Accept-Encoding bitmap comparison function.
2353 * Returns 0 if the bitmaps are compatible.
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002354 */
Tim Duesterhused84d842021-01-18 13:41:17 +01002355static int accept_encoding_bitmap_cmp(const void *ref, const void *new, unsigned int len)
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002356{
Tim Duesterhused84d842021-01-18 13:41:17 +01002357 uint32_t ref_bitmap = read_u32(ref);
2358 uint32_t new_bitmap = read_u32(new);
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002359
Tim Duesterhused84d842021-01-18 13:41:17 +01002360 if (!(ref_bitmap & VARY_ENCODING_OTHER)) {
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002361 /* All the bits set in the reference bitmap correspond to the
2362 * stored response' encoding and should all be set in the new
2363 * encoding bitmap in order for the client to be able to manage
Tim Duesterhusdc38bc42020-12-29 12:43:53 +01002364 * the response.
2365 *
2366 * If this is the case the cached response has encodings that
2367 * are accepted by the client. It can be served directly by
2368 * the cache (as far as the accept-encoding part is concerned).
2369 */
2370
Tim Duesterhused84d842021-01-18 13:41:17 +01002371 return (ref_bitmap & new_bitmap) != ref_bitmap;
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002372 }
Tim Duesterhusdc38bc42020-12-29 12:43:53 +01002373 else {
Tim Duesterhus1d66e392021-01-18 13:41:16 +01002374 return 1;
Tim Duesterhusdc38bc42020-12-29 12:43:53 +01002375 }
Remi Tricot-Le Bretonce9e7b22020-12-23 18:13:49 +01002376}
2377
2378
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002379/*
2380 * Pre-calculate the hashes of all the supported headers (in our Vary
2381 * implementation) of a given request. We have to calculate all the hashes
2382 * in advance because the actual Vary signature won't be known until the first
2383 * response.
2384 * Only the first occurrence of every header will be taken into account in the
2385 * hash.
2386 * If the header is not present, the hash portion of the given header will be
2387 * filled with zeros.
2388 * Returns 0 in case of success.
2389 */
2390static int http_request_prebuild_full_secondary_key(struct stream *s)
2391{
Remi Tricot-Le Bretonbba29122020-12-23 18:13:44 +01002392 /* The fake signature (second parameter) will ensure that every part of the
2393 * secondary key is calculated. */
2394 return http_request_build_secondary_key(s, ~0);
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002395}
2396
2397
2398/*
2399 * Calculate the secondary key for a request for which we already have a known
2400 * vary signature. The key is made by aggregating hashes calculated for every
2401 * header mentioned in the vary signature.
2402 * Only the first occurrence of every header will be taken into account in the
2403 * hash.
2404 * If the header is not present, the hash portion of the given header will be
2405 * filled with zeros.
2406 * Returns 0 in case of success.
2407 */
2408static int http_request_build_secondary_key(struct stream *s, int vary_signature)
2409{
2410 struct http_txn *txn = s->txn;
2411 struct htx *htx = htxbuf(&s->req.buf);
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002412
2413 unsigned int idx;
2414 const struct vary_hashing_information *info = NULL;
2415 unsigned int hash_length = 0;
2416 int retval = 0;
2417 int offset = 0;
2418
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002419 for (idx = 0; idx < sizeof(vary_information)/sizeof(*vary_information) && retval >= 0; ++idx) {
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002420 info = &vary_information[idx];
2421
Remi Tricot-Le Bretone4421de2020-12-23 18:13:46 +01002422 /* The normalizing functions will be in charge of getting the
2423 * header values from the htx. This way they can manage multiple
2424 * occurrences of their processed header. */
2425 if ((vary_signature & info->value) && info->norm_fn != NULL &&
2426 !(retval = info->norm_fn(htx, info->hdr_name, &txn->cache_secondary_hash[offset], &hash_length))) {
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002427 offset += hash_length;
2428 }
2429 else {
2430 /* Fill hash with 0s. */
2431 hash_length = info->hash_length;
2432 memset(&txn->cache_secondary_hash[offset], 0, hash_length);
2433 offset += hash_length;
2434 }
2435 }
2436
Remi Tricot-Le Breton2b5c5cb2020-12-23 18:13:45 +01002437 if (retval >= 0)
2438 txn->flags |= TX_CACHE_HAS_SEC_KEY;
2439
2440 return (retval < 0);
Remi Tricot-Le Breton3d082362020-11-16 15:56:08 +01002441}
2442
2443/*
2444 * Build the actual secondary key of a given request out of the prebuilt key and
2445 * the actual vary signature (extracted from the response).
2446 * Returns 0 in case of success.
2447 */
2448static int http_request_reduce_secondary_key(unsigned int vary_signature,
2449 char prebuilt_key[HTTP_CACHE_SEC_KEY_LEN])
2450{
2451 int offset = 0;
2452 int global_offset = 0;
2453 int vary_info_count = 0;
2454 int keep = 0;
2455 unsigned int vary_idx;
2456 const struct vary_hashing_information *vary_info;
2457
2458 vary_info_count = sizeof(vary_information)/sizeof(*vary_information);
2459 for (vary_idx = 0; vary_idx < vary_info_count; ++vary_idx) {
2460 vary_info = &vary_information[vary_idx];
2461 keep = (vary_signature & vary_info->value) ? 0xff : 0;
2462
2463 for (offset = 0; offset < vary_info->hash_length; ++offset,++global_offset) {
2464 prebuilt_key[global_offset] &= keep;
2465 }
2466 }
2467
2468 return 0;
2469}
2470
2471
Christopher Faulet99a17a22018-12-11 09:18:27 +01002472
2473static int
2474parse_cache_flt(char **args, int *cur_arg, struct proxy *px,
2475 struct flt_conf *fconf, char **err, void *private)
2476{
2477 struct flt_conf *f, *back;
Willy Tarreaua73da1e2018-12-14 10:19:28 +01002478 struct cache_flt_conf *cconf = NULL;
Christopher Faulet99a17a22018-12-11 09:18:27 +01002479 char *name = NULL;
2480 int pos = *cur_arg;
2481
Christopher Faulet2a37cdb2020-05-18 11:58:16 +02002482 /* Get the cache filter name. <pos> point on "cache" keyword */
2483 if (!*args[pos + 1]) {
Tim Duesterhusea969f62020-08-18 22:06:51 +02002484 memprintf(err, "%s : expects a <name> argument", args[pos]);
Christopher Faulet2a37cdb2020-05-18 11:58:16 +02002485 goto error;
2486 }
2487 name = strdup(args[pos + 1]);
2488 if (!name) {
2489 memprintf(err, "%s '%s' : out of memory", args[pos], args[pos + 1]);
2490 goto error;
Christopher Faulet99a17a22018-12-11 09:18:27 +01002491 }
Christopher Faulet2a37cdb2020-05-18 11:58:16 +02002492 pos += 2;
Christopher Faulet99a17a22018-12-11 09:18:27 +01002493
2494 /* Check if an implicit filter with the same name already exists. If so,
2495 * we remove the implicit filter to use the explicit one. */
2496 list_for_each_entry_safe(f, back, &px->filter_configs, list) {
2497 if (f->id != cache_store_flt_id)
2498 continue;
2499
2500 cconf = f->conf;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002501 if (strcmp(name, cconf->c.name) != 0) {
Christopher Faulet99a17a22018-12-11 09:18:27 +01002502 cconf = NULL;
2503 continue;
2504 }
2505
2506 if (!(cconf->flags & CACHE_FLT_F_IMPLICIT_DECL)) {
2507 cconf = NULL;
2508 memprintf(err, "%s: multiple explicit declarations of the cache filter '%s'",
2509 px->id, name);
Tim Duesterhusd34b1ce2020-01-18 01:46:18 +01002510 goto error;
Christopher Faulet99a17a22018-12-11 09:18:27 +01002511 }
2512
2513 /* Remove the implicit filter. <cconf> is kept for the explicit one */
Willy Tarreau2b718102021-04-21 07:32:39 +02002514 LIST_DELETE(&f->list);
Christopher Faulet99a17a22018-12-11 09:18:27 +01002515 free(f);
2516 free(name);
2517 break;
2518 }
2519
2520 /* No implicit cache filter found, create configuration for the explicit one */
2521 if (!cconf) {
2522 cconf = calloc(1, sizeof(*cconf));
2523 if (!cconf) {
2524 memprintf(err, "%s: out of memory", args[*cur_arg]);
2525 goto error;
2526 }
2527 cconf->c.name = name;
2528 }
2529
2530 cconf->flags = 0;
2531 fconf->id = cache_store_flt_id;
2532 fconf->conf = cconf;
2533 fconf->ops = &cache_ops;
2534
2535 *cur_arg = pos;
2536 return 0;
2537
2538 error:
2539 free(name);
2540 free(cconf);
2541 return -1;
2542}
2543
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002544static int cli_parse_show_cache(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemand1f49a362017-11-21 20:01:26 +01002545{
2546 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
2547 return 1;
2548
2549 return 0;
2550}
2551
2552static int cli_io_handler_show_cache(struct appctx *appctx)
2553{
2554 struct cache* cache = appctx->ctx.cli.p0;
2555 struct stream_interface *si = appctx->owner;
2556
William Lallemand1f49a362017-11-21 20:01:26 +01002557 if (cache == NULL) {
2558 cache = LIST_ELEM((caches).n, typeof(struct cache *), list);
2559 }
2560
2561 list_for_each_entry_from(cache, &caches, list) {
2562 struct eb32_node *node = NULL;
2563 unsigned int next_key;
2564 struct cache_entry *entry;
Remi Tricot-Le Bretone3e1e5f2020-11-27 15:48:40 +01002565 unsigned int i;
William Lallemand1f49a362017-11-21 20:01:26 +01002566
William Lallemand1f49a362017-11-21 20:01:26 +01002567 next_key = appctx->ctx.cli.i0;
Willy Tarreauafe1de52018-04-04 11:56:43 +02002568 if (!next_key) {
2569 chunk_printf(&trash, "%p: %s (shctx:%p, available blocks:%d)\n", cache, cache->id, shctx_ptr(cache), shctx_ptr(cache)->nbav);
2570 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01002571 si_rx_room_blk(si);
Willy Tarreauafe1de52018-04-04 11:56:43 +02002572 return 0;
2573 }
2574 }
William Lallemand1f49a362017-11-21 20:01:26 +01002575
2576 appctx->ctx.cli.p0 = cache;
2577
2578 while (1) {
2579
2580 shctx_lock(shctx_ptr(cache));
Remi Tricot-Le Bretone3e1e5f2020-11-27 15:48:40 +01002581 if (!node || (node = eb32_next_dup(node)) == NULL)
2582 node = eb32_lookup_ge(&cache->entries, next_key);
William Lallemand1f49a362017-11-21 20:01:26 +01002583 if (!node) {
2584 shctx_unlock(shctx_ptr(cache));
Willy Tarreauafe1de52018-04-04 11:56:43 +02002585 appctx->ctx.cli.i0 = 0;
William Lallemand1f49a362017-11-21 20:01:26 +01002586 break;
2587 }
2588
2589 entry = container_of(node, struct cache_entry, eb);
Remi Tricot-Le Bretone3e1e5f2020-11-27 15:48:40 +01002590 chunk_printf(&trash, "%p hash:%u vary:0x", entry, read_u32(entry->hash));
2591 for (i = 0; i < HTTP_CACHE_SEC_KEY_LEN; ++i)
2592 chunk_appendf(&trash, "%02x", (unsigned char)entry->secondary_key[i]);
2593 chunk_appendf(&trash, " size:%u (%u blocks), refcount:%u, expire:%d\n", block_ptr(entry)->len, block_ptr(entry)->block_count, block_ptr(entry)->refcount, entry->expire - (int)now.tv_sec);
William Lallemand1f49a362017-11-21 20:01:26 +01002594
2595 next_key = node->key + 1;
2596 appctx->ctx.cli.i0 = next_key;
2597
2598 shctx_unlock(shctx_ptr(cache));
2599
2600 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01002601 si_rx_room_blk(si);
William Lallemand1f49a362017-11-21 20:01:26 +01002602 return 0;
2603 }
2604 }
2605
2606 }
2607
2608 return 1;
2609
2610}
2611
Remi Tricot-Le Bretonbf971212020-10-27 11:55:57 +01002612
2613/*
2614 * boolean, returns true if response was built out of a cache entry.
2615 */
2616static int
2617smp_fetch_res_cache_hit(const struct arg *args, struct sample *smp,
2618 const char *kw, void *private)
2619{
2620 smp->data.type = SMP_T_BOOL;
2621 smp->data.u.sint = (smp->strm ? (smp->strm->target == &http_cache_applet.obj_type) : 0);
2622
2623 return 1;
2624}
2625
2626/*
2627 * string, returns cache name (if response came from a cache).
2628 */
2629static int
2630smp_fetch_res_cache_name(const struct arg *args, struct sample *smp,
2631 const char *kw, void *private)
2632{
2633 struct appctx *appctx = NULL;
2634
2635 struct cache_flt_conf *cconf = NULL;
2636 struct cache *cache = NULL;
2637
2638 if (!smp->strm || smp->strm->target != &http_cache_applet.obj_type)
2639 return 0;
2640
2641 /* Get appctx from the stream_interface. */
2642 appctx = si_appctx(&smp->strm->si[1]);
2643 if (appctx && appctx->rule) {
2644 cconf = appctx->rule->arg.act.p[0];
2645 if (cconf) {
2646 cache = cconf->c.cache;
2647
2648 smp->data.type = SMP_T_STR;
2649 smp->flags = SMP_F_CONST;
2650 smp->data.u.str.area = cache->id;
2651 smp->data.u.str.data = strlen(cache->id);
2652 return 1;
2653 }
2654 }
2655
2656 return 0;
2657}
2658
Christopher Faulet99a17a22018-12-11 09:18:27 +01002659/* Declare the filter parser for "cache" keyword */
2660static struct flt_kw_list filter_kws = { "CACHE", { }, {
2661 { "cache", parse_cache_flt, NULL },
2662 { NULL, NULL, NULL },
2663 }
2664};
2665
2666INITCALL1(STG_REGISTER, flt_register_keywords, &filter_kws);
2667
William Lallemand1f49a362017-11-21 20:01:26 +01002668static struct cli_kw_list cli_kws = {{},{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02002669 { { "show", "cache", NULL }, "show cache : show cache status", cli_parse_show_cache, cli_io_handler_show_cache, NULL, NULL },
William Lallemande899af82017-11-22 16:41:26 +01002670 {{},}
William Lallemand1f49a362017-11-21 20:01:26 +01002671}};
2672
Willy Tarreau0108d902018-11-25 19:14:37 +01002673INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
William Lallemand1f49a362017-11-21 20:01:26 +01002674
William Lallemand41db4602017-10-30 11:15:51 +01002675static struct action_kw_list http_res_actions = {
2676 .kw = {
2677 { "cache-store", parse_cache_store },
2678 { NULL, NULL }
2679 }
2680};
2681
Willy Tarreau0108d902018-11-25 19:14:37 +01002682INITCALL1(STG_REGISTER, http_res_keywords_register, &http_res_actions);
2683
William Lallemand41db4602017-10-30 11:15:51 +01002684static struct action_kw_list http_req_actions = {
2685 .kw = {
2686 { "cache-use", parse_cache_use },
2687 { NULL, NULL }
2688 }
2689};
2690
Willy Tarreau0108d902018-11-25 19:14:37 +01002691INITCALL1(STG_REGISTER, http_req_keywords_register, &http_req_actions);
2692
Willy Tarreau2231b632019-03-29 18:26:52 +01002693struct applet http_cache_applet = {
William Lallemand41db4602017-10-30 11:15:51 +01002694 .obj_type = OBJ_TYPE_APPLET,
2695 .name = "<CACHE>", /* used for logging */
William Lallemand77c11972017-10-31 20:43:01 +01002696 .fct = http_cache_io_handler,
William Lallemandecb73b12017-11-24 14:33:55 +01002697 .release = http_cache_applet_release,
William Lallemand41db4602017-10-30 11:15:51 +01002698};
2699
Willy Tarreaue6552512018-11-26 11:33:13 +01002700/* config parsers for this section */
2701REGISTER_CONFIG_SECTION("cache", cfg_parse_cache, cfg_post_parse_section_cache);
William Lallemandd1d1e222019-08-28 15:22:49 +02002702REGISTER_POST_CHECK(post_check_cache);
Remi Tricot-Le Bretonbf971212020-10-27 11:55:57 +01002703
2704
2705/* Note: must not be declared <const> as its list will be overwritten */
2706static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, {
2707 { "res.cache_hit", smp_fetch_res_cache_hit, 0, NULL, SMP_T_BOOL, SMP_USE_HRSHP, SMP_VAL_RESPONSE },
2708 { "res.cache_name", smp_fetch_res_cache_name, 0, NULL, SMP_T_STR, SMP_USE_HRSHP, SMP_VAL_RESPONSE },
2709 { /* END */ },
2710 }
2711};
2712
2713INITCALL1(STG_REGISTER, sample_register_fetches, &sample_fetch_keywords);