blob: b773064de6905bec79b5c9d8974fa2a436b389ac [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * General purpose functions.
3 *
Willy Tarreau348238b2010-01-18 15:05:57 +01004 * Copyright 2000-2010 Willy Tarreau <w@1wt.eu>
Willy Tarreaubaaee002006-06-26 02:48:02 +02005 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Baruch Siache1651b22020-07-24 07:52:20 +030013#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +010014#define _GNU_SOURCE
15#include <dlfcn.h>
16#include <link.h>
17#endif
18
devnexen@gmail.comc4e52322021-08-17 12:55:49 +010019#if defined(__FreeBSD__)
20#include <elf.h>
21#include <dlfcn.h>
22extern void *__elf_aux_vector;
23#endif
24
David Carlierbd2cced2021-08-17 08:44:25 +010025#if defined(__NetBSD__)
26#include <sys/exec_elf.h>
27#include <dlfcn.h>
28#endif
29
Willy Tarreau2e74c3f2007-12-02 18:45:09 +010030#include <ctype.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020031#include <errno.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020032#include <netdb.h>
Willy Tarreau9a7bea52012-04-27 11:16:50 +020033#include <stdarg.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020034#include <stdio.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020035#include <stdlib.h>
36#include <string.h>
Thierry Fournier93127942016-01-20 18:49:45 +010037#include <time.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020038#include <unistd.h>
Willy Tarreau127f9662007-12-06 00:53:51 +010039#include <sys/socket.h>
Willy Tarreau37101052019-05-20 16:48:20 +020040#include <sys/stat.h>
41#include <sys/types.h>
Willy Tarreau127f9662007-12-06 00:53:51 +010042#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020043#include <netinet/in.h>
44#include <arpa/inet.h>
45
David Carlier43a56852022-03-04 15:50:48 +000046#if defined(__linux__) && defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
Willy Tarreau30053062020-08-20 16:39:14 +020047#include <sys/auxv.h>
48#endif
49
Willy Tarreau48fbcae2020-06-03 18:09:46 +020050#include <import/eb32sctree.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020051#include <import/eb32tree.h>
Willy Tarreau0dc9e6d2022-08-01 11:55:57 +020052#include <import/ebmbtree.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020053
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020054#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020055#include <haproxy/applet.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020056#include <haproxy/chunk.h>
Willy Tarreau7c18b542020-06-11 09:23:02 +020057#include <haproxy/dgram.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020058#include <haproxy/global.h>
Willy Tarreau86416052020-06-04 09:20:54 +020059#include <haproxy/hlua.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020060#include <haproxy/listener.h>
Willy Tarreau7a00efb2020-06-02 17:02:59 +020061#include <haproxy/namespace.h>
Christopher Faulet9553de72021-02-26 09:12:50 +010062#include <haproxy/net_helper.h>
Willy Tarreau5fc93282020-09-16 18:25:03 +020063#include <haproxy/protocol.h>
Willy Tarreau8f6da642023-03-10 12:04:02 +010064#include <haproxy/quic_sock.h>
Emeric Brunc9437992021-02-12 19:42:55 +010065#include <haproxy/resolvers.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020066#include <haproxy/sc_strm.h>
Willy Tarreau586f71b2020-12-11 15:54:36 +010067#include <haproxy/sock.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020068#include <haproxy/ssl_sock.h>
William Lallemand3aeb3f92021-08-21 23:59:56 +020069#include <haproxy/ssl_utils.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020070#include <haproxy/stconn.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020071#include <haproxy/task.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020072#include <haproxy/tools.h>
Willy Tarreau08093cc2022-11-24 08:09:12 +010073#include <haproxy/xxhash.h>
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +010074
Thierry Fournier93127942016-01-20 18:49:45 +010075/* This macro returns false if the test __x is false. Many
76 * of the following parsing function must be abort the processing
77 * if it returns 0, so this macro is useful for writing light code.
78 */
79#define RET0_UNLESS(__x) do { if (!(__x)) return 0; } while (0)
80
Erwan Le Goas9c766372022-09-14 17:40:24 +020081/* Define the number of line of hash_word */
Erwan Le Goas5eef1582022-09-29 10:25:31 +020082#define NB_L_HASH_WORD 15
Erwan Le Goas9c766372022-09-14 17:40:24 +020083
Willy Tarreau08093cc2022-11-24 08:09:12 +010084/* return the hash of a string and length for a given key. All keys are valid. */
85#define HA_ANON(key, str, len) (XXH32(str, len, key) & 0xFFFFFF)
86
Willy Tarreau56adcf22012-12-23 18:00:29 +010087/* enough to store NB_ITOA_STR integers of :
Willy Tarreau72d759c2007-10-25 12:14:10 +020088 * 2^64-1 = 18446744073709551615 or
89 * -2^63 = -9223372036854775808
Willy Tarreaue7239b52009-03-29 13:41:58 +020090 *
91 * The HTML version needs room for adding the 25 characters
92 * '<span class="rls"></span>' around digits at positions 3N+1 in order
93 * to add spacing at up to 6 positions : 18 446 744 073 709 551 615
Willy Tarreau72d759c2007-10-25 12:14:10 +020094 */
Christopher Faulet99bca652017-11-14 16:47:26 +010095THREAD_LOCAL char itoa_str[NB_ITOA_STR][171];
96THREAD_LOCAL int itoa_idx = 0; /* index of next itoa_str to use */
Willy Tarreaubaaee002006-06-26 02:48:02 +020097
Willy Tarreau588297f2014-06-16 15:16:40 +020098/* sometimes we'll need to quote strings (eg: in stats), and we don't expect
99 * to quote strings larger than a max configuration line.
100 */
Christopher Faulet99bca652017-11-14 16:47:26 +0100101THREAD_LOCAL char quoted_str[NB_QSTR][QSTR_SIZE + 1];
102THREAD_LOCAL int quoted_idx = 0;
Willy Tarreau588297f2014-06-16 15:16:40 +0200103
Willy Tarreau06e69b52021-03-02 14:01:35 +0100104/* thread-local PRNG state. It's modified to start from a different sequence
105 * on all threads upon startup. It must not be used or anything beyond getting
106 * statistical values as it's 100% predictable.
107 */
108THREAD_LOCAL unsigned int statistical_prng_state = 2463534242U;
109
Willy Tarreau5b3cd952022-07-18 13:58:17 +0200110/* set to true if this is a static build */
111int build_is_static = 0;
112
Erwan Le Goas9c766372022-09-14 17:40:24 +0200113/* A global static table to store hashed words */
114static THREAD_LOCAL char hash_word[NB_L_HASH_WORD][20];
115static THREAD_LOCAL int index_hash = 0;
116
Willy Tarreaubaaee002006-06-26 02:48:02 +0200117/*
William Lallemande7340ec2012-01-24 11:15:39 +0100118 * unsigned long long ASCII representation
119 *
120 * return the last char '\0' or NULL if no enough
121 * space in dst
122 */
123char *ulltoa(unsigned long long n, char *dst, size_t size)
124{
125 int i = 0;
126 char *res;
127
128 switch(n) {
129 case 1ULL ... 9ULL:
130 i = 0;
131 break;
132
133 case 10ULL ... 99ULL:
134 i = 1;
135 break;
136
137 case 100ULL ... 999ULL:
138 i = 2;
139 break;
140
141 case 1000ULL ... 9999ULL:
142 i = 3;
143 break;
144
145 case 10000ULL ... 99999ULL:
146 i = 4;
147 break;
148
149 case 100000ULL ... 999999ULL:
150 i = 5;
151 break;
152
153 case 1000000ULL ... 9999999ULL:
154 i = 6;
155 break;
156
157 case 10000000ULL ... 99999999ULL:
158 i = 7;
159 break;
160
161 case 100000000ULL ... 999999999ULL:
162 i = 8;
163 break;
164
165 case 1000000000ULL ... 9999999999ULL:
166 i = 9;
167 break;
168
169 case 10000000000ULL ... 99999999999ULL:
170 i = 10;
171 break;
172
173 case 100000000000ULL ... 999999999999ULL:
174 i = 11;
175 break;
176
177 case 1000000000000ULL ... 9999999999999ULL:
178 i = 12;
179 break;
180
181 case 10000000000000ULL ... 99999999999999ULL:
182 i = 13;
183 break;
184
185 case 100000000000000ULL ... 999999999999999ULL:
186 i = 14;
187 break;
188
189 case 1000000000000000ULL ... 9999999999999999ULL:
190 i = 15;
191 break;
192
193 case 10000000000000000ULL ... 99999999999999999ULL:
194 i = 16;
195 break;
196
197 case 100000000000000000ULL ... 999999999999999999ULL:
198 i = 17;
199 break;
200
201 case 1000000000000000000ULL ... 9999999999999999999ULL:
202 i = 18;
203 break;
204
205 case 10000000000000000000ULL ... ULLONG_MAX:
206 i = 19;
207 break;
208 }
209 if (i + 2 > size) // (i + 1) + '\0'
210 return NULL; // too long
211 res = dst + i + 1;
212 *res = '\0';
213 for (; i >= 0; i--) {
214 dst[i] = n % 10ULL + '0';
215 n /= 10ULL;
216 }
217 return res;
218}
219
220/*
221 * unsigned long ASCII representation
222 *
223 * return the last char '\0' or NULL if no enough
224 * space in dst
225 */
226char *ultoa_o(unsigned long n, char *dst, size_t size)
227{
228 int i = 0;
229 char *res;
230
231 switch (n) {
232 case 0U ... 9UL:
233 i = 0;
234 break;
235
236 case 10U ... 99UL:
237 i = 1;
238 break;
239
240 case 100U ... 999UL:
241 i = 2;
242 break;
243
244 case 1000U ... 9999UL:
245 i = 3;
246 break;
247
248 case 10000U ... 99999UL:
249 i = 4;
250 break;
251
252 case 100000U ... 999999UL:
253 i = 5;
254 break;
255
256 case 1000000U ... 9999999UL:
257 i = 6;
258 break;
259
260 case 10000000U ... 99999999UL:
261 i = 7;
262 break;
263
264 case 100000000U ... 999999999UL:
265 i = 8;
266 break;
267#if __WORDSIZE == 32
268
269 case 1000000000ULL ... ULONG_MAX:
270 i = 9;
271 break;
272
273#elif __WORDSIZE == 64
274
275 case 1000000000ULL ... 9999999999UL:
276 i = 9;
277 break;
278
279 case 10000000000ULL ... 99999999999UL:
280 i = 10;
281 break;
282
283 case 100000000000ULL ... 999999999999UL:
284 i = 11;
285 break;
286
287 case 1000000000000ULL ... 9999999999999UL:
288 i = 12;
289 break;
290
291 case 10000000000000ULL ... 99999999999999UL:
292 i = 13;
293 break;
294
295 case 100000000000000ULL ... 999999999999999UL:
296 i = 14;
297 break;
298
299 case 1000000000000000ULL ... 9999999999999999UL:
300 i = 15;
301 break;
302
303 case 10000000000000000ULL ... 99999999999999999UL:
304 i = 16;
305 break;
306
307 case 100000000000000000ULL ... 999999999999999999UL:
308 i = 17;
309 break;
310
311 case 1000000000000000000ULL ... 9999999999999999999UL:
312 i = 18;
313 break;
314
315 case 10000000000000000000ULL ... ULONG_MAX:
316 i = 19;
317 break;
318
319#endif
320 }
321 if (i + 2 > size) // (i + 1) + '\0'
322 return NULL; // too long
323 res = dst + i + 1;
324 *res = '\0';
325 for (; i >= 0; i--) {
326 dst[i] = n % 10U + '0';
327 n /= 10U;
328 }
329 return res;
330}
331
332/*
333 * signed long ASCII representation
334 *
335 * return the last char '\0' or NULL if no enough
336 * space in dst
337 */
338char *ltoa_o(long int n, char *dst, size_t size)
339{
340 char *pos = dst;
341
342 if (n < 0) {
343 if (size < 3)
344 return NULL; // min size is '-' + digit + '\0' but another test in ultoa
345 *pos = '-';
346 pos++;
347 dst = ultoa_o(-n, pos, size - 1);
348 } else {
349 dst = ultoa_o(n, dst, size);
350 }
351 return dst;
352}
353
354/*
355 * signed long long ASCII representation
356 *
357 * return the last char '\0' or NULL if no enough
358 * space in dst
359 */
360char *lltoa(long long n, char *dst, size_t size)
361{
362 char *pos = dst;
363
364 if (n < 0) {
365 if (size < 3)
366 return NULL; // min size is '-' + digit + '\0' but another test in ulltoa
367 *pos = '-';
368 pos++;
369 dst = ulltoa(-n, pos, size - 1);
370 } else {
371 dst = ulltoa(n, dst, size);
372 }
373 return dst;
374}
375
376/*
377 * write a ascii representation of a unsigned into dst,
378 * return a pointer to the last character
379 * Pad the ascii representation with '0', using size.
380 */
381char *utoa_pad(unsigned int n, char *dst, size_t size)
382{
383 int i = 0;
384 char *ret;
385
386 switch(n) {
387 case 0U ... 9U:
388 i = 0;
389 break;
390
391 case 10U ... 99U:
392 i = 1;
393 break;
394
395 case 100U ... 999U:
396 i = 2;
397 break;
398
399 case 1000U ... 9999U:
400 i = 3;
401 break;
402
403 case 10000U ... 99999U:
404 i = 4;
405 break;
406
407 case 100000U ... 999999U:
408 i = 5;
409 break;
410
411 case 1000000U ... 9999999U:
412 i = 6;
413 break;
414
415 case 10000000U ... 99999999U:
416 i = 7;
417 break;
418
419 case 100000000U ... 999999999U:
420 i = 8;
421 break;
422
423 case 1000000000U ... 4294967295U:
424 i = 9;
425 break;
426 }
427 if (i + 2 > size) // (i + 1) + '\0'
428 return NULL; // too long
Aurelien DARRAGONe3177af2022-11-22 11:42:07 +0100429 i = size - 2; // padding - '\0'
William Lallemande7340ec2012-01-24 11:15:39 +0100430
431 ret = dst + i + 1;
432 *ret = '\0';
433 for (; i >= 0; i--) {
434 dst[i] = n % 10U + '0';
435 n /= 10U;
436 }
437 return ret;
438}
439
440/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200441 * copies at most <size-1> chars from <src> to <dst>. Last char is always
442 * set to 0, unless <size> is 0. The number of chars copied is returned
443 * (excluding the terminating zero).
444 * This code has been optimized for size and speed : on x86, it's 45 bytes
445 * long, uses only registers, and consumes only 4 cycles per char.
446 */
447int strlcpy2(char *dst, const char *src, int size)
448{
449 char *orig = dst;
450 if (size) {
451 while (--size && (*dst = *src)) {
452 src++; dst++;
453 }
454 *dst = 0;
455 }
456 return dst - orig;
457}
458
459/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200460 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200461 * the ascii representation for number 'n' in decimal.
462 */
Emeric Brun3a7fce52010-01-04 14:54:38 +0100463char *ultoa_r(unsigned long n, char *buffer, int size)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200464{
465 char *pos;
466
Willy Tarreau72d759c2007-10-25 12:14:10 +0200467 pos = buffer + size - 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200468 *pos-- = '\0';
469
470 do {
471 *pos-- = '0' + n % 10;
472 n /= 10;
Willy Tarreau72d759c2007-10-25 12:14:10 +0200473 } while (n && pos >= buffer);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200474 return pos + 1;
475}
476
Willy Tarreau91092e52007-10-25 16:58:42 +0200477/*
Willy Tarreaue7239b52009-03-29 13:41:58 +0200478 * This function simply returns a locally allocated string containing
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200479 * the ascii representation for number 'n' in decimal.
480 */
481char *lltoa_r(long long int in, char *buffer, int size)
482{
483 char *pos;
484 int neg = 0;
485 unsigned long long int n;
486
487 pos = buffer + size - 1;
488 *pos-- = '\0';
489
490 if (in < 0) {
491 neg = 1;
492 n = -in;
493 }
494 else
495 n = in;
496
497 do {
498 *pos-- = '0' + n % 10;
499 n /= 10;
500 } while (n && pos >= buffer);
501 if (neg && pos > buffer)
502 *pos-- = '-';
503 return pos + 1;
504}
505
506/*
507 * This function simply returns a locally allocated string containing
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200508 * the ascii representation for signed number 'n' in decimal.
509 */
510char *sltoa_r(long n, char *buffer, int size)
511{
512 char *pos;
513
514 if (n >= 0)
515 return ultoa_r(n, buffer, size);
516
517 pos = ultoa_r(-n, buffer + 1, size - 1) - 1;
518 *pos = '-';
519 return pos;
520}
521
522/*
523 * This function simply returns a locally allocated string containing
Willy Tarreaue7239b52009-03-29 13:41:58 +0200524 * the ascii representation for number 'n' in decimal, formatted for
525 * HTML output with tags to create visual grouping by 3 digits. The
526 * output needs to support at least 171 characters.
527 */
528const char *ulltoh_r(unsigned long long n, char *buffer, int size)
529{
530 char *start;
531 int digit = 0;
532
533 start = buffer + size;
534 *--start = '\0';
535
536 do {
537 if (digit == 3 && start >= buffer + 7)
538 memcpy(start -= 7, "</span>", 7);
539
540 if (start >= buffer + 1) {
541 *--start = '0' + n % 10;
542 n /= 10;
543 }
544
545 if (digit == 3 && start >= buffer + 18)
546 memcpy(start -= 18, "<span class=\"rls\">", 18);
547
548 if (digit++ == 3)
549 digit = 1;
550 } while (n && start > buffer);
551 return start;
552}
553
554/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200555 * This function simply returns a locally allocated string containing the ascii
556 * representation for number 'n' in decimal, unless n is 0 in which case it
557 * returns the alternate string (or an empty string if the alternate string is
558 * NULL). It use is intended for limits reported in reports, where it's
559 * desirable not to display anything if there is no limit. Warning! it shares
560 * the same vector as ultoa_r().
561 */
562const char *limit_r(unsigned long n, char *buffer, int size, const char *alt)
563{
564 return (n) ? ultoa_r(n, buffer, size) : (alt ? alt : "");
565}
566
Willy Tarreau56d1d8d2021-05-08 10:28:53 +0200567/* Trims the first "%f" float in a string to its minimum number of digits after
568 * the decimal point by trimming trailing zeroes, even dropping the decimal
569 * point if not needed. The string is in <buffer> of length <len>, and the
570 * number is expected to start at or after position <num_start> (the first
571 * point appearing there is considered). A NUL character is always placed at
572 * the end if some trimming occurs. The new buffer length is returned.
573 */
574size_t flt_trim(char *buffer, size_t num_start, size_t len)
575{
576 char *end = buffer + len;
577 char *p = buffer + num_start;
578 char *trim;
579
580 do {
581 if (p >= end)
582 return len;
583 trim = p++;
584 } while (*trim != '.');
585
586 /* For now <trim> is on the decimal point. Let's look for any other
587 * meaningful digit after it.
588 */
589 while (p < end) {
590 if (*p++ != '0')
591 trim = p;
592 }
593
594 if (trim < end)
595 *trim = 0;
596
597 return trim - buffer;
598}
599
Willy Tarreauae03d262021-05-08 07:35:00 +0200600/*
601 * This function simply returns a locally allocated string containing
602 * the ascii representation for number 'n' in decimal with useless trailing
603 * zeroes trimmed.
604 */
605char *ftoa_r(double n, char *buffer, int size)
606{
607 flt_trim(buffer, 0, snprintf(buffer, size, "%f", n));
608 return buffer;
609}
610
Willy Tarreau588297f2014-06-16 15:16:40 +0200611/* returns a locally allocated string containing the quoted encoding of the
612 * input string. The output may be truncated to QSTR_SIZE chars, but it is
613 * guaranteed that the string will always be properly terminated. Quotes are
614 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
615 * always be at least 4 chars.
616 */
617const char *qstr(const char *str)
618{
619 char *ret = quoted_str[quoted_idx];
620 char *p, *end;
621
622 if (++quoted_idx >= NB_QSTR)
623 quoted_idx = 0;
624
625 p = ret;
626 end = ret + QSTR_SIZE;
627
628 *p++ = '"';
629
630 /* always keep 3 chars to support passing "" and the ending " */
631 while (*str && p < end - 3) {
632 if (*str == '"') {
633 *p++ = '"';
634 *p++ = '"';
635 }
636 else
637 *p++ = *str;
638 str++;
639 }
640 *p++ = '"';
641 return ret;
642}
643
Robert Tsai81ae1952007-12-05 10:47:29 +0100644/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200645 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
646 *
647 * It looks like this one would be a good candidate for inlining, but this is
648 * not interesting because it around 35 bytes long and often called multiple
649 * times within the same function.
650 */
651int ishex(char s)
652{
653 s -= '0';
654 if ((unsigned char)s <= 9)
655 return 1;
656 s -= 'A' - '0';
657 if ((unsigned char)s <= 5)
658 return 1;
659 s -= 'a' - 'A';
660 if ((unsigned char)s <= 5)
661 return 1;
662 return 0;
663}
664
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100665/* rounds <i> down to the closest value having max 2 digits */
666unsigned int round_2dig(unsigned int i)
667{
668 unsigned int mul = 1;
669
670 while (i >= 100) {
671 i /= 10;
672 mul *= 10;
673 }
674 return i * mul;
675}
676
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100677/*
678 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
679 * invalid character is found, a pointer to it is returned. If everything is
680 * fine, NULL is returned.
681 */
682const char *invalid_char(const char *name)
683{
684 if (!*name)
685 return name;
686
687 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100688 if (!isalnum((unsigned char)*name) && *name != '.' && *name != ':' &&
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100689 *name != '_' && *name != '-')
690 return name;
691 name++;
692 }
693 return NULL;
694}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200695
696/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200697 * Checks <name> for invalid characters. Valid chars are [_.-] and those
698 * accepted by <f> function.
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200699 * If an invalid character is found, a pointer to it is returned.
700 * If everything is fine, NULL is returned.
701 */
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200702static inline const char *__invalid_char(const char *name, int (*f)(int)) {
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200703
704 if (!*name)
705 return name;
706
707 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100708 if (!f((unsigned char)*name) && *name != '.' &&
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200709 *name != '_' && *name != '-')
710 return name;
711
712 name++;
713 }
714
715 return NULL;
716}
717
718/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200719 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
720 * If an invalid character is found, a pointer to it is returned.
721 * If everything is fine, NULL is returned.
722 */
723const char *invalid_domainchar(const char *name) {
724 return __invalid_char(name, isalnum);
725}
726
727/*
728 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
729 * If an invalid character is found, a pointer to it is returned.
730 * If everything is fine, NULL is returned.
731 */
732const char *invalid_prefix_char(const char *name) {
Thierry Fournierf7b7c3e2018-03-26 11:54:39 +0200733 return __invalid_char(name, isalnum);
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200734}
735
736/*
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100737 * converts <str> to a struct sockaddr_storage* provided by the caller. The
Willy Tarreau24709282013-03-10 21:32:12 +0100738 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
739 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
740 * the function tries to guess the address family from the syntax. If the
741 * family is forced and the format doesn't match, an error is returned. The
Willy Tarreaufab5a432011-03-04 15:31:53 +0100742 * string is assumed to contain only an address, no port. The address can be a
743 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
744 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
745 * The return address will only have the address family and the address set,
746 * all other fields remain zero. The string is not supposed to be modified.
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100747 * The IPv6 '::' address is IN6ADDR_ANY. If <resolve> is non-zero, the hostname
748 * is resolved, otherwise only IP addresses are resolved, and anything else
Willy Tarreauecde7df2016-11-02 22:37:03 +0100749 * returns NULL. If the address contains a port, this one is preserved.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200750 */
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100751struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200752{
Willy Tarreaufab5a432011-03-04 15:31:53 +0100753 struct hostent *he;
mildisff5d5102015-10-26 18:50:08 +0100754 /* max IPv6 length, including brackets and terminating NULL */
755 char tmpip[48];
Willy Tarreauecde7df2016-11-02 22:37:03 +0100756 int port = get_host_port(sa);
mildisff5d5102015-10-26 18:50:08 +0100757
758 /* check IPv6 with square brackets */
759 if (str[0] == '[') {
760 size_t iplength = strlen(str);
761
762 if (iplength < 4) {
763 /* minimal size is 4 when using brackets "[::]" */
764 goto fail;
765 }
766 else if (iplength >= sizeof(tmpip)) {
767 /* IPv6 literal can not be larger than tmpip */
768 goto fail;
769 }
770 else {
771 if (str[iplength - 1] != ']') {
772 /* if address started with bracket, it should end with bracket */
773 goto fail;
774 }
775 else {
776 memcpy(tmpip, str + 1, iplength - 2);
777 tmpip[iplength - 2] = '\0';
778 str = tmpip;
779 }
780 }
781 }
Willy Tarreaufab5a432011-03-04 15:31:53 +0100782
Willy Tarreaufab5a432011-03-04 15:31:53 +0100783 /* Any IPv6 address */
784 if (str[0] == ':' && str[1] == ':' && !str[2]) {
Willy Tarreau24709282013-03-10 21:32:12 +0100785 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
786 sa->ss_family = AF_INET6;
787 else if (sa->ss_family != AF_INET6)
788 goto fail;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100789 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100790 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100791 }
792
Willy Tarreau24709282013-03-10 21:32:12 +0100793 /* Any address for the family, defaults to IPv4 */
Willy Tarreaufab5a432011-03-04 15:31:53 +0100794 if (!str[0] || (str[0] == '*' && !str[1])) {
Willy Tarreau24709282013-03-10 21:32:12 +0100795 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
796 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100797 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100798 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100799 }
800
801 /* check for IPv6 first */
Willy Tarreau24709282013-03-10 21:32:12 +0100802 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET6) &&
803 inet_pton(AF_INET6, str, &((struct sockaddr_in6 *)sa)->sin6_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100804 sa->ss_family = AF_INET6;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100805 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100806 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100807 }
808
809 /* then check for IPv4 */
Willy Tarreau24709282013-03-10 21:32:12 +0100810 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET) &&
811 inet_pton(AF_INET, str, &((struct sockaddr_in *)sa)->sin_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100812 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100813 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100814 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100815 }
816
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100817 if (!resolve)
818 return NULL;
819
Emeric Brund30e9a12020-12-23 18:49:16 +0100820 if (!resolv_hostname_validation(str, NULL))
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200821 return NULL;
822
David du Colombierd5f43282011-03-17 10:40:16 +0100823#ifdef USE_GETADDRINFO
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200824 if (global.tune.options & GTUNE_USE_GAI) {
David du Colombierd5f43282011-03-17 10:40:16 +0100825 struct addrinfo hints, *result;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100826 int success = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100827
828 memset(&result, 0, sizeof(result));
829 memset(&hints, 0, sizeof(hints));
Willy Tarreau24709282013-03-10 21:32:12 +0100830 hints.ai_family = sa->ss_family ? sa->ss_family : AF_UNSPEC;
David du Colombierd5f43282011-03-17 10:40:16 +0100831 hints.ai_socktype = SOCK_DGRAM;
Dmitry Sivachenkoeab7f392015-10-02 01:01:58 +0200832 hints.ai_flags = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100833 hints.ai_protocol = 0;
834
835 if (getaddrinfo(str, NULL, &hints, &result) == 0) {
Willy Tarreau24709282013-03-10 21:32:12 +0100836 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
837 sa->ss_family = result->ai_family;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100838 else if (sa->ss_family != result->ai_family) {
839 freeaddrinfo(result);
Willy Tarreau24709282013-03-10 21:32:12 +0100840 goto fail;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100841 }
Willy Tarreau24709282013-03-10 21:32:12 +0100842
David du Colombierd5f43282011-03-17 10:40:16 +0100843 switch (result->ai_family) {
844 case AF_INET:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100845 memcpy((struct sockaddr_in *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100846 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100847 success = 1;
848 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100849 case AF_INET6:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100850 memcpy((struct sockaddr_in6 *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100851 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100852 success = 1;
853 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100854 }
855 }
856
Sean Carey58ea0392013-02-15 23:39:18 +0100857 if (result)
858 freeaddrinfo(result);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100859
860 if (success)
861 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100862 }
David du Colombierd5f43282011-03-17 10:40:16 +0100863#endif
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200864 /* try to resolve an IPv4/IPv6 hostname */
865 he = gethostbyname(str);
866 if (he) {
867 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
868 sa->ss_family = he->h_addrtype;
869 else if (sa->ss_family != he->h_addrtype)
870 goto fail;
871
872 switch (sa->ss_family) {
873 case AF_INET:
874 ((struct sockaddr_in *)sa)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100875 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200876 return sa;
877 case AF_INET6:
878 ((struct sockaddr_in6 *)sa)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100879 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200880 return sa;
881 }
882 }
883
David du Colombierd5f43282011-03-17 10:40:16 +0100884 /* unsupported address family */
Willy Tarreau24709282013-03-10 21:32:12 +0100885 fail:
Willy Tarreaufab5a432011-03-04 15:31:53 +0100886 return NULL;
887}
888
889/*
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100890 * Converts <str> to a locally allocated struct sockaddr_storage *, and a port
891 * range or offset consisting in two integers that the caller will have to
892 * check to find the relevant input format. The following format are supported :
893 *
894 * String format | address | port | low | high
895 * addr | <addr> | 0 | 0 | 0
896 * addr: | <addr> | 0 | 0 | 0
897 * addr:port | <addr> | <port> | <port> | <port>
898 * addr:pl-ph | <addr> | <pl> | <pl> | <ph>
899 * addr:+port | <addr> | <port> | 0 | <port>
900 * addr:-port | <addr> |-<port> | <port> | 0
901 *
902 * The detection of a port range or increment by the caller is made by
903 * comparing <low> and <high>. If both are equal, then port 0 means no port
904 * was specified. The caller may pass NULL for <low> and <high> if it is not
905 * interested in retrieving port ranges.
906 *
907 * Note that <addr> above may also be :
908 * - empty ("") => family will be AF_INET and address will be INADDR_ANY
909 * - "*" => family will be AF_INET and address will be INADDR_ANY
910 * - "::" => family will be AF_INET6 and address will be IN6ADDR_ANY
911 * - a host name => family and address will depend on host name resolving.
912 *
Willy Tarreau24709282013-03-10 21:32:12 +0100913 * A prefix may be passed in before the address above to force the family :
914 * - "ipv4@" => force address to resolve as IPv4 and fail if not possible.
915 * - "ipv6@" => force address to resolve as IPv6 and fail if not possible.
916 * - "unix@" => force address to be a path to a UNIX socket even if the
917 * path does not start with a '/'
Willy Tarreauccfccef2014-05-10 01:49:15 +0200918 * - 'abns@' -> force address to belong to the abstract namespace (Linux
919 * only). These sockets are just like Unix sockets but without
920 * the need for an underlying file system. The address is a
921 * string. Technically it's like a Unix socket with a zero in
922 * the first byte of the address.
Willy Tarreau40aa0702013-03-10 23:51:38 +0100923 * - "fd@" => an integer must follow, and is a file descriptor number.
Willy Tarreau24709282013-03-10 21:32:12 +0100924 *
mildisff5d5102015-10-26 18:50:08 +0100925 * IPv6 addresses can be declared with or without square brackets. When using
926 * square brackets for IPv6 addresses, the port separator (colon) is optional.
927 * If not using square brackets, and in order to avoid any ambiguity with
928 * IPv6 addresses, the last colon ':' is mandatory even when no port is specified.
929 * NULL is returned if the address cannot be parsed. The <low> and <high> ports
930 * are always initialized if non-null, even for non-IP families.
Willy Tarreaud393a622013-03-04 18:22:00 +0100931 *
932 * If <pfx> is non-null, it is used as a string prefix before any path-based
933 * address (typically the path to a unix socket).
Willy Tarreau40aa0702013-03-10 23:51:38 +0100934 *
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200935 * if <fqdn> is non-null, it will be filled with :
936 * - a pointer to the FQDN of the server name to resolve if there's one, and
937 * that the caller will have to free(),
938 * - NULL if there was an explicit address that doesn't require resolution.
939 *
Willy Tarreaucd3a55912020-09-04 15:30:46 +0200940 * Hostnames are only resolved if <opts> has PA_O_RESOLVE. Otherwise <fqdn> is
941 * still honored so it is possible for the caller to know whether a resolution
942 * failed by clearing this flag and checking if <fqdn> was filled, indicating
943 * the need for a resolution.
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200944 *
Willy Tarreau40aa0702013-03-10 23:51:38 +0100945 * When a file descriptor is passed, its value is put into the s_addr part of
Willy Tarreaua5b325f2020-09-04 16:44:20 +0200946 * the address when cast to sockaddr_in and the address family is
947 * AF_CUST_EXISTING_FD.
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200948 *
Willy Tarreau5fc93282020-09-16 18:25:03 +0200949 * The matching protocol will be set into <proto> if non-null.
950 *
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200951 * Any known file descriptor is also assigned to <fd> if non-null, otherwise it
952 * is forced to -1.
Willy Tarreaufab5a432011-03-04 15:31:53 +0100953 */
Willy Tarreau5fc93282020-09-16 18:25:03 +0200954struct sockaddr_storage *str2sa_range(const char *str, int *port, int *low, int *high, int *fd,
955 struct protocol **proto, char **err,
956 const char *pfx, char **fqdn, unsigned int opts)
Willy Tarreaufab5a432011-03-04 15:31:53 +0100957{
Christopher Faulet1bc04c72017-10-29 20:14:08 +0100958 static THREAD_LOCAL struct sockaddr_storage ss;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100959 struct sockaddr_storage *ret = NULL;
Willy Tarreau5fc93282020-09-16 18:25:03 +0200960 struct protocol *new_proto = NULL;
Willy Tarreau24709282013-03-10 21:32:12 +0100961 char *back, *str2;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100962 char *port1, *port2;
963 int portl, porth, porta;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200964 int abstract = 0;
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200965 int new_fd = -1;
Willy Tarreaue3b45182021-10-27 17:28:55 +0200966 enum proto_type proto_type;
967 int ctrl_type;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100968
969 portl = porth = porta = 0;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200970 if (fqdn)
971 *fqdn = NULL;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200972
Willy Tarreaudad36a32013-03-11 01:20:04 +0100973 str2 = back = env_expand(strdup(str));
Willy Tarreaudf350f12013-03-01 20:22:54 +0100974 if (str2 == NULL) {
975 memprintf(err, "out of memory in '%s'\n", __FUNCTION__);
Willy Tarreaud5191e72010-02-09 20:50:45 +0100976 goto out;
Willy Tarreaudf350f12013-03-01 20:22:54 +0100977 }
Willy Tarreaubaaee002006-06-26 02:48:02 +0200978
Willy Tarreau9f69f462015-09-08 16:01:25 +0200979 if (!*str2) {
980 memprintf(err, "'%s' resolves to an empty address (environment variable missing?)\n", str);
981 goto out;
982 }
983
Willy Tarreau24709282013-03-10 21:32:12 +0100984 memset(&ss, 0, sizeof(ss));
985
Willy Tarreaue835bd82020-09-16 11:35:47 +0200986 /* prepare the default socket types */
Willy Tarreauf23b1bc2021-03-23 18:36:37 +0100987 if ((opts & (PA_O_STREAM|PA_O_DGRAM)) == PA_O_DGRAM ||
Willy Tarreaue3b45182021-10-27 17:28:55 +0200988 ((opts & (PA_O_STREAM|PA_O_DGRAM)) == (PA_O_DGRAM|PA_O_STREAM) && (opts & PA_O_DEFAULT_DGRAM))) {
989 proto_type = PROTO_TYPE_DGRAM;
990 ctrl_type = SOCK_DGRAM;
991 } else {
992 proto_type = PROTO_TYPE_STREAM;
993 ctrl_type = SOCK_STREAM;
994 }
Willy Tarreaue835bd82020-09-16 11:35:47 +0200995
996 if (strncmp(str2, "stream+", 7) == 0) {
997 str2 += 7;
Willy Tarreaue3b45182021-10-27 17:28:55 +0200998 proto_type = PROTO_TYPE_STREAM;
999 ctrl_type = SOCK_STREAM;
Willy Tarreaue835bd82020-09-16 11:35:47 +02001000 }
1001 else if (strncmp(str2, "dgram+", 6) == 0) {
1002 str2 += 6;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001003 proto_type = PROTO_TYPE_DGRAM;
1004 ctrl_type = SOCK_DGRAM;
Willy Tarreaue835bd82020-09-16 11:35:47 +02001005 }
Willy Tarreau40725a42023-01-16 13:55:27 +01001006 else if (strncmp(str2, "quic+", 5) == 0) {
1007 str2 += 5;
1008 proto_type = PROTO_TYPE_DGRAM;
1009 ctrl_type = SOCK_STREAM;
1010 }
Willy Tarreaue835bd82020-09-16 11:35:47 +02001011
Willy Tarreau24709282013-03-10 21:32:12 +01001012 if (strncmp(str2, "unix@", 5) == 0) {
1013 str2 += 5;
Willy Tarreauccfccef2014-05-10 01:49:15 +02001014 abstract = 0;
Willy Tarreau24709282013-03-10 21:32:12 +01001015 ss.ss_family = AF_UNIX;
1016 }
Emeric Brunce325c42021-04-02 17:05:09 +02001017 else if (strncmp(str2, "uxdg@", 5) == 0) {
1018 str2 += 5;
1019 abstract = 0;
1020 ss.ss_family = AF_UNIX;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001021 proto_type = PROTO_TYPE_DGRAM;
1022 ctrl_type = SOCK_DGRAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001023 }
1024 else if (strncmp(str2, "uxst@", 5) == 0) {
1025 str2 += 5;
1026 abstract = 0;
1027 ss.ss_family = AF_UNIX;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001028 proto_type = PROTO_TYPE_STREAM;
1029 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001030 }
Willy Tarreauccfccef2014-05-10 01:49:15 +02001031 else if (strncmp(str2, "abns@", 5) == 0) {
1032 str2 += 5;
1033 abstract = 1;
1034 ss.ss_family = AF_UNIX;
1035 }
Emeric Brunce325c42021-04-02 17:05:09 +02001036 else if (strncmp(str2, "ip@", 3) == 0) {
1037 str2 += 3;
1038 ss.ss_family = AF_UNSPEC;
1039 }
Willy Tarreau24709282013-03-10 21:32:12 +01001040 else if (strncmp(str2, "ipv4@", 5) == 0) {
1041 str2 += 5;
1042 ss.ss_family = AF_INET;
1043 }
1044 else if (strncmp(str2, "ipv6@", 5) == 0) {
1045 str2 += 5;
1046 ss.ss_family = AF_INET6;
1047 }
Emeric Brunce325c42021-04-02 17:05:09 +02001048 else if (strncmp(str2, "tcp4@", 5) == 0) {
1049 str2 += 5;
1050 ss.ss_family = AF_INET;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001051 proto_type = PROTO_TYPE_STREAM;
1052 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001053 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001054 else if (strncmp(str2, "udp4@", 5) == 0) {
1055 str2 += 5;
1056 ss.ss_family = AF_INET;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001057 proto_type = PROTO_TYPE_DGRAM;
1058 ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001059 }
Emeric Brunce325c42021-04-02 17:05:09 +02001060 else if (strncmp(str2, "tcp6@", 5) == 0) {
1061 str2 += 5;
1062 ss.ss_family = AF_INET6;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001063 proto_type = PROTO_TYPE_STREAM;
1064 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001065 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001066 else if (strncmp(str2, "udp6@", 5) == 0) {
1067 str2 += 5;
1068 ss.ss_family = AF_INET6;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001069 proto_type = PROTO_TYPE_DGRAM;
1070 ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001071 }
Emeric Brunce325c42021-04-02 17:05:09 +02001072 else if (strncmp(str2, "tcp@", 4) == 0) {
1073 str2 += 4;
1074 ss.ss_family = AF_UNSPEC;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001075 proto_type = PROTO_TYPE_STREAM;
1076 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001077 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001078 else if (strncmp(str2, "udp@", 4) == 0) {
1079 str2 += 4;
1080 ss.ss_family = AF_UNSPEC;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001081 proto_type = PROTO_TYPE_DGRAM;
1082 ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001083 }
Frédéric Lécaille10caf652020-11-23 11:36:57 +01001084 else if (strncmp(str2, "quic4@", 6) == 0) {
1085 str2 += 6;
1086 ss.ss_family = AF_INET;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001087 proto_type = PROTO_TYPE_DGRAM;
Frédéric Lécaille10caf652020-11-23 11:36:57 +01001088 ctrl_type = SOCK_STREAM;
1089 }
1090 else if (strncmp(str2, "quic6@", 6) == 0) {
1091 str2 += 6;
1092 ss.ss_family = AF_INET6;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001093 proto_type = PROTO_TYPE_DGRAM;
Frédéric Lécaille10caf652020-11-23 11:36:57 +01001094 ctrl_type = SOCK_STREAM;
1095 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001096 else if (strncmp(str2, "fd@", 3) == 0) {
1097 str2 += 3;
1098 ss.ss_family = AF_CUST_EXISTING_FD;
1099 }
1100 else if (strncmp(str2, "sockpair@", 9) == 0) {
1101 str2 += 9;
1102 ss.ss_family = AF_CUST_SOCKPAIR;
1103 }
Willy Tarreau24709282013-03-10 21:32:12 +01001104 else if (*str2 == '/') {
1105 ss.ss_family = AF_UNIX;
1106 }
1107 else
1108 ss.ss_family = AF_UNSPEC;
1109
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001110 if (ss.ss_family == AF_CUST_SOCKPAIR) {
Willy Tarreaua215be22020-09-16 10:14:16 +02001111 struct sockaddr_storage ss2;
1112 socklen_t addr_len;
William Lallemand2fe7dd02018-09-11 16:51:29 +02001113 char *endptr;
1114
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001115 new_fd = strtol(str2, &endptr, 10);
1116 if (!*str2 || new_fd < 0 || *endptr) {
William Lallemand2fe7dd02018-09-11 16:51:29 +02001117 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
1118 goto out;
1119 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001120
Willy Tarreaua215be22020-09-16 10:14:16 +02001121 /* just verify that it's a socket */
1122 addr_len = sizeof(ss2);
1123 if (getsockname(new_fd, (struct sockaddr *)&ss2, &addr_len) == -1) {
1124 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1125 goto out;
1126 }
1127
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001128 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1129 ((struct sockaddr_in *)&ss)->sin_port = 0;
William Lallemand2fe7dd02018-09-11 16:51:29 +02001130 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001131 else if (ss.ss_family == AF_CUST_EXISTING_FD) {
Willy Tarreau40aa0702013-03-10 23:51:38 +01001132 char *endptr;
1133
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001134 new_fd = strtol(str2, &endptr, 10);
1135 if (!*str2 || new_fd < 0 || *endptr) {
Willy Tarreaudad36a32013-03-11 01:20:04 +01001136 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
Willy Tarreau40aa0702013-03-10 23:51:38 +01001137 goto out;
1138 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001139
Willy Tarreau6edc7222020-09-15 17:41:56 +02001140 if (opts & PA_O_SOCKET_FD) {
1141 socklen_t addr_len;
1142 int type;
1143
1144 addr_len = sizeof(ss);
1145 if (getsockname(new_fd, (struct sockaddr *)&ss, &addr_len) == -1) {
1146 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1147 goto out;
1148 }
1149
1150 addr_len = sizeof(type);
1151 if (getsockopt(new_fd, SOL_SOCKET, SO_TYPE, &type, &addr_len) != 0 ||
Willy Tarreaue3b45182021-10-27 17:28:55 +02001152 (type == SOCK_STREAM) != (proto_type == PROTO_TYPE_STREAM)) {
Willy Tarreau6edc7222020-09-15 17:41:56 +02001153 memprintf(err, "socket on file descriptor '%d' is of the wrong type.\n", new_fd);
1154 goto out;
1155 }
1156
1157 porta = portl = porth = get_host_port(&ss);
1158 } else if (opts & PA_O_RAW_FD) {
1159 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1160 ((struct sockaddr_in *)&ss)->sin_port = 0;
1161 } else {
1162 memprintf(err, "a file descriptor is not acceptable here in '%s'\n", str);
1163 goto out;
1164 }
Willy Tarreau40aa0702013-03-10 23:51:38 +01001165 }
1166 else if (ss.ss_family == AF_UNIX) {
Willy Tarreau8daa9202019-06-16 18:16:33 +02001167 struct sockaddr_un *un = (struct sockaddr_un *)&ss;
Willy Tarreau15586382013-03-04 19:48:14 +01001168 int prefix_path_len;
1169 int max_path_len;
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001170 int adr_len;
Willy Tarreau15586382013-03-04 19:48:14 +01001171
1172 /* complete unix socket path name during startup or soft-restart is
1173 * <unix_bind_prefix><path>.<pid>.<bak|tmp>
1174 */
Willy Tarreauccfccef2014-05-10 01:49:15 +02001175 prefix_path_len = (pfx && !abstract) ? strlen(pfx) : 0;
Willy Tarreau8daa9202019-06-16 18:16:33 +02001176 max_path_len = (sizeof(un->sun_path) - 1) -
Willy Tarreau327ea5a2020-02-11 06:43:37 +01001177 (abstract ? 0 : prefix_path_len + 1 + 5 + 1 + 3);
Willy Tarreau15586382013-03-04 19:48:14 +01001178
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001179 adr_len = strlen(str2);
1180 if (adr_len > max_path_len) {
Willy Tarreau15586382013-03-04 19:48:14 +01001181 memprintf(err, "socket path '%s' too long (max %d)\n", str, max_path_len);
1182 goto out;
1183 }
1184
Willy Tarreauccfccef2014-05-10 01:49:15 +02001185 /* when abstract==1, we skip the first zero and copy all bytes except the trailing zero */
Willy Tarreau8daa9202019-06-16 18:16:33 +02001186 memset(un->sun_path, 0, sizeof(un->sun_path));
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001187 if (prefix_path_len)
Willy Tarreau8daa9202019-06-16 18:16:33 +02001188 memcpy(un->sun_path, pfx, prefix_path_len);
1189 memcpy(un->sun_path + prefix_path_len + abstract, str2, adr_len + 1 - abstract);
Willy Tarreau15586382013-03-04 19:48:14 +01001190 }
Willy Tarreau24709282013-03-10 21:32:12 +01001191 else { /* IPv4 and IPv6 */
mildisff5d5102015-10-26 18:50:08 +01001192 char *end = str2 + strlen(str2);
1193 char *chr;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001194
mildisff5d5102015-10-26 18:50:08 +01001195 /* search for : or ] whatever comes first */
1196 for (chr = end-1; chr > str2; chr--) {
1197 if (*chr == ']' || *chr == ':')
1198 break;
1199 }
1200
1201 if (*chr == ':') {
1202 /* Found a colon before a closing-bracket, must be a port separator.
1203 * This guarantee backward compatibility.
1204 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001205 if (!(opts & PA_O_PORT_OK)) {
1206 memprintf(err, "port specification not permitted here in '%s'", str);
1207 goto out;
1208 }
mildisff5d5102015-10-26 18:50:08 +01001209 *chr++ = '\0';
1210 port1 = chr;
1211 }
1212 else {
1213 /* Either no colon and no closing-bracket
1214 * or directly ending with a closing-bracket.
1215 * However, no port.
1216 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001217 if (opts & PA_O_PORT_MAND) {
1218 memprintf(err, "missing port specification in '%s'", str);
1219 goto out;
1220 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001221 port1 = "";
mildisff5d5102015-10-26 18:50:08 +01001222 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001223
Willy Tarreau90807112020-02-25 08:16:33 +01001224 if (isdigit((unsigned char)*port1)) { /* single port or range */
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001225 port2 = strchr(port1, '-');
Willy Tarreau7f96a842020-09-15 11:12:44 +02001226 if (port2) {
1227 if (!(opts & PA_O_PORT_RANGE)) {
1228 memprintf(err, "port range not permitted here in '%s'", str);
1229 goto out;
1230 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001231 *port2++ = '\0';
Willy Tarreau7f96a842020-09-15 11:12:44 +02001232 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001233 else
1234 port2 = port1;
1235 portl = atoi(port1);
1236 porth = atoi(port2);
Willy Tarreau7f96a842020-09-15 11:12:44 +02001237
1238 if (portl < !!(opts & PA_O_PORT_MAND) || portl > 65535) {
1239 memprintf(err, "invalid port '%s'", port1);
1240 goto out;
1241 }
1242
1243 if (porth < !!(opts & PA_O_PORT_MAND) || porth > 65535) {
1244 memprintf(err, "invalid port '%s'", port2);
1245 goto out;
1246 }
1247
1248 if (portl > porth) {
1249 memprintf(err, "invalid port range '%d-%d'", portl, porth);
1250 goto out;
1251 }
1252
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001253 porta = portl;
1254 }
1255 else if (*port1 == '-') { /* negative offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001256 if (!(opts & PA_O_PORT_OFS)) {
1257 memprintf(err, "port offset not permitted here in '%s'", str);
1258 goto out;
1259 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001260 portl = atoi(port1 + 1);
1261 porta = -portl;
1262 }
1263 else if (*port1 == '+') { /* positive offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001264 if (!(opts & PA_O_PORT_OFS)) {
1265 memprintf(err, "port offset not permitted here in '%s'", str);
1266 goto out;
1267 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001268 porth = atoi(port1 + 1);
1269 porta = porth;
1270 }
1271 else if (*port1) { /* other any unexpected char */
Willy Tarreaudad36a32013-03-11 01:20:04 +01001272 memprintf(err, "invalid character '%c' in port number '%s' in '%s'\n", *port1, port1, str);
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001273 goto out;
1274 }
Willy Tarreau7f96a842020-09-15 11:12:44 +02001275 else if (opts & PA_O_PORT_MAND) {
1276 memprintf(err, "missing port specification in '%s'", str);
1277 goto out;
1278 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001279
1280 /* first try to parse the IP without resolving. If it fails, it
1281 * tells us we need to keep a copy of the FQDN to resolve later
1282 * and to enable DNS. In this case we can proceed if <fqdn> is
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001283 * set or if PA_O_RESOLVE is set, otherwise it's an error.
Willy Tarreauceccdd72016-11-02 22:27:10 +01001284 */
1285 if (str2ip2(str2, &ss, 0) == NULL) {
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001286 if ((!(opts & PA_O_RESOLVE) && !fqdn) ||
1287 ((opts & PA_O_RESOLVE) && str2ip2(str2, &ss, 1) == NULL)) {
Willy Tarreauceccdd72016-11-02 22:27:10 +01001288 memprintf(err, "invalid address: '%s' in '%s'\n", str2, str);
1289 goto out;
1290 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001291
Willy Tarreauceccdd72016-11-02 22:27:10 +01001292 if (fqdn) {
1293 if (str2 != back)
1294 memmove(back, str2, strlen(str2) + 1);
1295 *fqdn = back;
1296 back = NULL;
1297 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001298 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001299 set_host_port(&ss, porta);
Willy Tarreaue4c58c82013-03-06 15:28:17 +01001300 }
Willy Tarreaufab5a432011-03-04 15:31:53 +01001301
Willy Tarreaue835bd82020-09-16 11:35:47 +02001302 if (ctrl_type == SOCK_STREAM && !(opts & PA_O_STREAM)) {
Willy Tarreau8d31ab02022-05-09 16:18:26 +02001303 memprintf(err, "stream-type address not acceptable in '%s'\n", str);
Willy Tarreaue835bd82020-09-16 11:35:47 +02001304 goto out;
1305 }
1306 else if (ctrl_type == SOCK_DGRAM && !(opts & PA_O_DGRAM)) {
Willy Tarreau8d31ab02022-05-09 16:18:26 +02001307 memprintf(err, "dgram-type address not acceptable in '%s'\n", str);
Willy Tarreaue835bd82020-09-16 11:35:47 +02001308 goto out;
1309 }
1310
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001311 if (proto || (opts & PA_O_CONNECT)) {
Willy Tarreau5fc93282020-09-16 18:25:03 +02001312 /* Note: if the caller asks for a proto, we must find one,
Emeric Brun26754902021-04-07 14:26:44 +02001313 * except if we inherit from a raw FD (family == AF_CUST_EXISTING_FD)
1314 * orif we return with an fqdn that will resolve later,
Willy Tarreau5fc93282020-09-16 18:25:03 +02001315 * in which case the address is not known yet (this is only
1316 * for servers actually).
1317 */
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001318 new_proto = protocol_lookup(ss.ss_family,
Willy Tarreaue3b45182021-10-27 17:28:55 +02001319 proto_type,
Willy Tarreauaf9609b2020-09-16 22:04:46 +02001320 ctrl_type == SOCK_DGRAM);
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001321
Emeric Brun26754902021-04-07 14:26:44 +02001322 if (!new_proto && (!fqdn || !*fqdn) && (ss.ss_family != AF_CUST_EXISTING_FD)) {
Willy Tarreau3d7b4682022-05-20 17:32:35 +02001323 memprintf(err, "unsupported %s protocol for %s family %d address '%s'%s",
Willy Tarreau2b049b82022-05-20 17:28:30 +02001324 (ctrl_type == SOCK_DGRAM) ? "datagram" : "stream",
1325 (proto_type == PROTO_TYPE_DGRAM) ? "datagram" : "stream",
1326 ss.ss_family,
Willy Tarreau3d7b4682022-05-20 17:32:35 +02001327 str,
Willy Tarreau3d7b4682022-05-20 17:32:35 +02001328#ifndef USE_QUIC
Tim Duesterhus147eeb22022-05-22 12:40:58 +02001329 (ctrl_type == SOCK_STREAM && proto_type == PROTO_TYPE_DGRAM)
1330 ? "; QUIC is not compiled in if this is what you were looking for."
1331 : ""
Willy Tarreau3d7b4682022-05-20 17:32:35 +02001332#else
1333 ""
1334#endif
Tim Duesterhus147eeb22022-05-22 12:40:58 +02001335 );
Willy Tarreau5fc93282020-09-16 18:25:03 +02001336 goto out;
1337 }
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001338
1339 if ((opts & PA_O_CONNECT) && new_proto && !new_proto->connect) {
1340 memprintf(err, "connect() not supported for this protocol family %d used by address '%s'", ss.ss_family, str);
1341 goto out;
1342 }
Willy Tarreau5fc93282020-09-16 18:25:03 +02001343 }
1344
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001345 ret = &ss;
Willy Tarreaud5191e72010-02-09 20:50:45 +01001346 out:
Willy Tarreau48ef4c92017-01-06 18:32:38 +01001347 if (port)
1348 *port = porta;
Willy Tarreaud4448bc2013-02-20 15:55:15 +01001349 if (low)
1350 *low = portl;
1351 if (high)
1352 *high = porth;
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001353 if (fd)
1354 *fd = new_fd;
Willy Tarreau5fc93282020-09-16 18:25:03 +02001355 if (proto)
1356 *proto = new_proto;
Willy Tarreau24709282013-03-10 21:32:12 +01001357 free(back);
Willy Tarreaud5191e72010-02-09 20:50:45 +01001358 return ret;
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001359}
1360
Thayne McCombs92149f92020-11-20 01:28:26 -07001361/* converts <addr> and <port> into a string representation of the address and port. This is sort
1362 * of an inverse of str2sa_range, with some restrictions. The supported families are AF_INET,
1363 * AF_INET6, AF_UNIX, and AF_CUST_SOCKPAIR. If the family is unsopported NULL is returned.
1364 * If map_ports is true, then the sign of the port is included in the output, to indicate it is
1365 * relative to the incoming port. AF_INET and AF_INET6 will be in the form "<addr>:<port>".
1366 * AF_UNIX will either be just the path (if using a pathname) or "abns@<path>" if it is abstract.
1367 * AF_CUST_SOCKPAIR will be of the form "sockpair@<fd>".
1368 *
1369 * The returned char* is allocated, and it is the responsibility of the caller to free it.
1370 */
1371char * sa2str(const struct sockaddr_storage *addr, int port, int map_ports)
1372{
1373 char buffer[INET6_ADDRSTRLEN];
1374 char *out = NULL;
1375 const void *ptr;
1376 const char *path;
1377
1378 switch (addr->ss_family) {
1379 case AF_INET:
1380 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1381 break;
1382 case AF_INET6:
1383 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1384 break;
1385 case AF_UNIX:
1386 path = ((struct sockaddr_un *)addr)->sun_path;
1387 if (path[0] == '\0') {
1388 const int max_length = sizeof(struct sockaddr_un) - offsetof(struct sockaddr_un, sun_path) - 1;
1389 return memprintf(&out, "abns@%.*s", max_length, path+1);
1390 } else {
1391 return strdup(path);
1392 }
1393 case AF_CUST_SOCKPAIR:
1394 return memprintf(&out, "sockpair@%d", ((struct sockaddr_in *)addr)->sin_addr.s_addr);
1395 default:
1396 return NULL;
1397 }
Tim Duesterhus22535a52022-05-23 09:30:49 +02001398 if (inet_ntop(addr->ss_family, ptr, buffer, sizeof(buffer)) == NULL) {
1399 BUG_ON(errno == ENOSPC);
1400 return NULL;
1401 }
Thayne McCombs92149f92020-11-20 01:28:26 -07001402 if (map_ports)
1403 return memprintf(&out, "%s:%+d", buffer, port);
1404 else
1405 return memprintf(&out, "%s:%d", buffer, port);
1406}
1407
1408
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001409/* converts <str> to a struct in_addr containing a network mask. It can be
1410 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +03001411 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001412 */
1413int str2mask(const char *str, struct in_addr *mask)
1414{
1415 if (strchr(str, '.') != NULL) { /* dotted notation */
1416 if (!inet_pton(AF_INET, str, mask))
1417 return 0;
1418 }
1419 else { /* mask length */
1420 char *err;
1421 unsigned long len = strtol(str, &err, 10);
1422
1423 if (!*str || (err && *err) || (unsigned)len > 32)
1424 return 0;
Tim Duesterhus8575f722018-01-25 16:24:48 +01001425
1426 len2mask4(len, mask);
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001427 }
1428 return 1;
1429}
1430
Tim Duesterhus47185172018-01-25 16:24:49 +01001431/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +01001432 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +01001433 * if the conversion succeeds otherwise zero.
1434 */
1435int str2mask6(const char *str, struct in6_addr *mask)
1436{
1437 if (strchr(str, ':') != NULL) { /* quadruplet notation */
1438 if (!inet_pton(AF_INET6, str, mask))
1439 return 0;
1440 }
1441 else { /* mask length */
1442 char *err;
1443 unsigned long len = strtol(str, &err, 10);
1444
1445 if (!*str || (err && *err) || (unsigned)len > 128)
1446 return 0;
1447
1448 len2mask6(len, mask);
1449 }
1450 return 1;
1451}
1452
Thierry FOURNIERb0504632013-12-14 15:39:02 +01001453/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
1454 * succeeds otherwise zero.
1455 */
1456int cidr2dotted(int cidr, struct in_addr *mask) {
1457
1458 if (cidr < 0 || cidr > 32)
1459 return 0;
1460
1461 mask->s_addr = cidr ? htonl(~0UL << (32 - cidr)) : 0;
1462 return 1;
1463}
1464
Thierry Fournier70473a52016-02-17 17:12:14 +01001465/* Convert mask from bit length form to in_addr form.
1466 * This function never fails.
1467 */
1468void len2mask4(int len, struct in_addr *addr)
1469{
1470 if (len >= 32) {
1471 addr->s_addr = 0xffffffff;
1472 return;
1473 }
1474 if (len <= 0) {
1475 addr->s_addr = 0x00000000;
1476 return;
1477 }
1478 addr->s_addr = 0xffffffff << (32 - len);
1479 addr->s_addr = htonl(addr->s_addr);
1480}
1481
1482/* Convert mask from bit length form to in6_addr form.
1483 * This function never fails.
1484 */
1485void len2mask6(int len, struct in6_addr *addr)
1486{
1487 len2mask4(len, (struct in_addr *)&addr->s6_addr[0]); /* msb */
1488 len -= 32;
1489 len2mask4(len, (struct in_addr *)&addr->s6_addr[4]);
1490 len -= 32;
1491 len2mask4(len, (struct in_addr *)&addr->s6_addr[8]);
1492 len -= 32;
1493 len2mask4(len, (struct in_addr *)&addr->s6_addr[12]); /* lsb */
1494}
1495
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001496/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +02001497 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001498 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001499 * is optional and either in the dotted or CIDR notation.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001500 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
1501 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001502int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001503{
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001504 __label__ out_free, out_err;
1505 char *c, *s;
1506 int ret_val;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001507
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001508 s = strdup(str);
1509 if (!s)
1510 return 0;
1511
Willy Tarreaubaaee002006-06-26 02:48:02 +02001512 memset(mask, 0, sizeof(*mask));
1513 memset(addr, 0, sizeof(*addr));
Willy Tarreaubaaee002006-06-26 02:48:02 +02001514
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001515 if ((c = strrchr(s, '/')) != NULL) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001516 *c++ = '\0';
1517 /* c points to the mask */
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001518 if (!str2mask(c, mask))
1519 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001520 }
1521 else {
Willy Tarreauebd61602006-12-30 11:54:15 +01001522 mask->s_addr = ~0U;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001523 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001524 if (!inet_pton(AF_INET, s, addr)) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001525 struct hostent *he;
1526
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001527 if (!resolve)
1528 goto out_err;
1529
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001530 if ((he = gethostbyname(s)) == NULL) {
1531 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001532 }
1533 else
1534 *addr = *(struct in_addr *) *(he->h_addr_list);
1535 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001536
1537 ret_val = 1;
1538 out_free:
1539 free(s);
1540 return ret_val;
1541 out_err:
1542 ret_val = 0;
1543 goto out_free;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001544}
1545
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001546
1547/*
Willy Tarreau6d20e282012-04-27 22:49:47 +02001548 * converts <str> to two struct in6_addr* which must be pre-allocated.
1549 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001550 * is an optional number of bits (128 being the default).
Willy Tarreau6d20e282012-04-27 22:49:47 +02001551 * Returns 1 if OK, 0 if error.
1552 */
1553int str62net(const char *str, struct in6_addr *addr, unsigned char *mask)
1554{
1555 char *c, *s;
1556 int ret_val = 0;
1557 char *err;
1558 unsigned long len = 128;
1559
1560 s = strdup(str);
1561 if (!s)
1562 return 0;
1563
1564 memset(mask, 0, sizeof(*mask));
1565 memset(addr, 0, sizeof(*addr));
1566
1567 if ((c = strrchr(s, '/')) != NULL) {
1568 *c++ = '\0'; /* c points to the mask */
1569 if (!*c)
1570 goto out_free;
1571
1572 len = strtoul(c, &err, 10);
1573 if ((err && *err) || (unsigned)len > 128)
1574 goto out_free;
1575 }
1576 *mask = len; /* OK we have a valid mask in <len> */
1577
1578 if (!inet_pton(AF_INET6, s, addr))
1579 goto out_free;
1580
1581 ret_val = 1;
1582 out_free:
1583 free(s);
1584 return ret_val;
1585}
1586
1587
1588/*
Willy Tarreau12e10272021-03-25 11:34:40 +01001589 * Parse IPv4 address found in url. Return the number of bytes parsed. It
1590 * expects exactly 4 numbers between 0 and 255 delimited by dots, and returns
1591 * zero in case of mismatch.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001592 */
David du Colombier6f5ccb12011-03-10 22:26:24 +01001593int url2ipv4(const char *addr, struct in_addr *dst)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001594{
1595 int saw_digit, octets, ch;
1596 u_char tmp[4], *tp;
1597 const char *cp = addr;
1598
1599 saw_digit = 0;
1600 octets = 0;
1601 *(tp = tmp) = 0;
1602
1603 while (*addr) {
Willy Tarreau12e10272021-03-25 11:34:40 +01001604 unsigned char digit = (ch = *addr) - '0';
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001605 if (digit > 9 && ch != '.')
1606 break;
Willy Tarreau12e10272021-03-25 11:34:40 +01001607 addr++;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001608 if (digit <= 9) {
1609 u_int new = *tp * 10 + digit;
1610 if (new > 255)
1611 return 0;
1612 *tp = new;
1613 if (!saw_digit) {
1614 if (++octets > 4)
1615 return 0;
1616 saw_digit = 1;
1617 }
1618 } else if (ch == '.' && saw_digit) {
1619 if (octets == 4)
1620 return 0;
1621 *++tp = 0;
1622 saw_digit = 0;
1623 } else
1624 return 0;
1625 }
1626
1627 if (octets < 4)
1628 return 0;
1629
1630 memcpy(&dst->s_addr, tmp, 4);
Willy Tarreau12e10272021-03-25 11:34:40 +01001631 return addr - cp;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001632}
1633
1634/*
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001635 * Resolve destination server from URL. Convert <str> to a sockaddr_storage.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001636 * <out> contain the code of the detected scheme, the start and length of
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001637 * the hostname. Actually only http and https are supported. <out> can be NULL.
1638 * This function returns the consumed length. It is useful if you parse complete
1639 * url like http://host:port/path, because the consumed length corresponds to
1640 * the first character of the path. If the conversion fails, it returns -1.
1641 *
1642 * This function tries to resolve the DNS name if haproxy is in starting mode.
1643 * So, this function may be used during the configuration parsing.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001644 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001645int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001646{
1647 const char *curr = url, *cp = url;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001648 const char *end;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001649 int ret, url_code = 0;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001650 unsigned long long int http_code = 0;
1651 int default_port;
1652 struct hostent *he;
1653 char *p;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001654
1655 /* Firstly, try to find :// pattern */
1656 while (curr < url+ulen && url_code != 0x3a2f2f) {
1657 url_code = ((url_code & 0xffff) << 8);
1658 url_code += (unsigned char)*curr++;
1659 }
1660
1661 /* Secondly, if :// pattern is found, verify parsed stuff
1662 * before pattern is matching our http pattern.
1663 * If so parse ip address and port in uri.
1664 *
1665 * WARNING: Current code doesn't support dynamic async dns resolver.
1666 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001667 if (url_code != 0x3a2f2f)
1668 return -1;
1669
1670 /* Copy scheme, and utrn to lower case. */
1671 while (cp < curr - 3)
1672 http_code = (http_code << 8) + *cp++;
1673 http_code |= 0x2020202020202020ULL; /* Turn everything to lower case */
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001674
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001675 /* HTTP or HTTPS url matching */
1676 if (http_code == 0x2020202068747470ULL) {
1677 default_port = 80;
1678 if (out)
1679 out->scheme = SCH_HTTP;
1680 }
1681 else if (http_code == 0x2020206874747073ULL) {
1682 default_port = 443;
1683 if (out)
1684 out->scheme = SCH_HTTPS;
1685 }
1686 else
1687 return -1;
1688
1689 /* If the next char is '[', the host address is IPv6. */
1690 if (*curr == '[') {
1691 curr++;
1692
1693 /* Check trash size */
1694 if (trash.size < ulen)
1695 return -1;
1696
1697 /* Look for ']' and copy the address in a trash buffer. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001698 p = trash.area;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001699 for (end = curr;
1700 end < url + ulen && *end != ']';
1701 end++, p++)
1702 *p = *end;
1703 if (*end != ']')
1704 return -1;
1705 *p = '\0';
1706
1707 /* Update out. */
1708 if (out) {
1709 out->host = curr;
1710 out->host_len = end - curr;
1711 }
1712
1713 /* Try IPv6 decoding. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001714 if (!inet_pton(AF_INET6, trash.area, &((struct sockaddr_in6 *)addr)->sin6_addr))
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001715 return -1;
1716 end++;
1717
1718 /* Decode port. */
William Lallemand3d7a9182022-03-25 17:37:51 +01001719 if (end < url + ulen && *end == ':') {
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001720 end++;
1721 default_port = read_uint(&end, url + ulen);
1722 }
1723 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1724 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1725 return end - url;
1726 }
1727 else {
William Lallemand8a913742022-02-18 16:13:12 +01001728 /* we need to copy the string into the trash because url2ipv4
1729 * needs a \0 at the end of the string */
1730 if (trash.size < ulen)
1731 return -1;
1732
1733 memcpy(trash.area, curr, ulen - (curr - url));
1734 trash.area[ulen - (curr - url)] = '\0';
1735
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001736 /* We are looking for IP address. If you want to parse and
1737 * resolve hostname found in url, you can use str2sa_range(), but
1738 * be warned this can slow down global daemon performances
1739 * while handling lagging dns responses.
1740 */
William Lallemand8a913742022-02-18 16:13:12 +01001741 ret = url2ipv4(trash.area, &((struct sockaddr_in *)addr)->sin_addr);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001742 if (ret) {
1743 /* Update out. */
1744 if (out) {
1745 out->host = curr;
1746 out->host_len = ret;
1747 }
1748
William Lallemandb938b772022-03-24 21:59:03 +01001749 curr += ret;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001750
1751 /* Decode port. */
William Lallemand3d7a9182022-03-25 17:37:51 +01001752 if (curr < url + ulen && *curr == ':') {
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001753 curr++;
1754 default_port = read_uint(&curr, url + ulen);
1755 }
1756 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1757
1758 /* Set family. */
1759 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1760 return curr - url;
1761 }
1762 else if (global.mode & MODE_STARTING) {
1763 /* The IPv4 and IPv6 decoding fails, maybe the url contain name. Try to execute
1764 * synchronous DNS request only if HAProxy is in the start state.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001765 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001766
1767 /* look for : or / or end */
1768 for (end = curr;
1769 end < url + ulen && *end != '/' && *end != ':';
1770 end++);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001771 memcpy(trash.area, curr, end - curr);
1772 trash.area[end - curr] = '\0';
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001773
1774 /* try to resolve an IPv4/IPv6 hostname */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001775 he = gethostbyname(trash.area);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001776 if (!he)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001777 return -1;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001778
1779 /* Update out. */
1780 if (out) {
1781 out->host = curr;
1782 out->host_len = end - curr;
1783 }
1784
1785 /* Decode port. */
William Lallemand3d7a9182022-03-25 17:37:51 +01001786 if (end < url + ulen && *end == ':') {
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001787 end++;
1788 default_port = read_uint(&end, url + ulen);
1789 }
1790
1791 /* Copy IP address, set port and family. */
1792 switch (he->h_addrtype) {
1793 case AF_INET:
1794 ((struct sockaddr_in *)addr)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
1795 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1796 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1797 return end - url;
1798
1799 case AF_INET6:
1800 ((struct sockaddr_in6 *)addr)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
1801 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1802 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1803 return end - url;
1804 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001805 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001806 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001807 return -1;
1808}
1809
Willy Tarreau631f01c2011-09-05 00:36:48 +02001810/* Tries to convert a sockaddr_storage address to text form. Upon success, the
1811 * address family is returned so that it's easy for the caller to adapt to the
1812 * output format. Zero is returned if the address family is not supported. -1
1813 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1814 * supported.
1815 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001816int addr_to_str(const struct sockaddr_storage *addr, char *str, int size)
Willy Tarreau631f01c2011-09-05 00:36:48 +02001817{
1818
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001819 const void *ptr;
Willy Tarreau631f01c2011-09-05 00:36:48 +02001820
1821 if (size < 5)
1822 return 0;
1823 *str = '\0';
1824
1825 switch (addr->ss_family) {
1826 case AF_INET:
1827 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1828 break;
1829 case AF_INET6:
1830 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1831 break;
1832 case AF_UNIX:
1833 memcpy(str, "unix", 5);
1834 return addr->ss_family;
1835 default:
1836 return 0;
1837 }
1838
1839 if (inet_ntop(addr->ss_family, ptr, str, size))
1840 return addr->ss_family;
1841
1842 /* failed */
1843 return -1;
1844}
1845
Simon Horman75ab8bd2014-06-16 09:39:41 +09001846/* Tries to convert a sockaddr_storage port to text form. Upon success, the
1847 * address family is returned so that it's easy for the caller to adapt to the
1848 * output format. Zero is returned if the address family is not supported. -1
1849 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1850 * supported.
1851 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001852int port_to_str(const struct sockaddr_storage *addr, char *str, int size)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001853{
1854
1855 uint16_t port;
1856
1857
Willy Tarreaud7dad1b2017-01-06 16:46:22 +01001858 if (size < 6)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001859 return 0;
1860 *str = '\0';
1861
1862 switch (addr->ss_family) {
1863 case AF_INET:
1864 port = ((struct sockaddr_in *)addr)->sin_port;
1865 break;
1866 case AF_INET6:
1867 port = ((struct sockaddr_in6 *)addr)->sin6_port;
1868 break;
1869 case AF_UNIX:
1870 memcpy(str, "unix", 5);
1871 return addr->ss_family;
1872 default:
1873 return 0;
1874 }
1875
1876 snprintf(str, size, "%u", ntohs(port));
1877 return addr->ss_family;
1878}
1879
Willy Tarreau16e01562016-08-09 16:46:18 +02001880/* check if the given address is local to the system or not. It will return
1881 * -1 when it's not possible to know, 0 when the address is not local, 1 when
1882 * it is. We don't want to iterate over all interfaces for this (and it is not
1883 * portable). So instead we try to bind in UDP to this address on a free non
1884 * privileged port and to connect to the same address, port 0 (connect doesn't
1885 * care). If it succeeds, we own the address. Note that non-inet addresses are
1886 * considered local since they're most likely AF_UNIX.
1887 */
1888int addr_is_local(const struct netns_entry *ns,
1889 const struct sockaddr_storage *orig)
1890{
1891 struct sockaddr_storage addr;
1892 int result;
1893 int fd;
1894
1895 if (!is_inet_addr(orig))
1896 return 1;
1897
1898 memcpy(&addr, orig, sizeof(addr));
1899 set_host_port(&addr, 0);
1900
1901 fd = my_socketat(ns, addr.ss_family, SOCK_DGRAM, IPPROTO_UDP);
1902 if (fd < 0)
1903 return -1;
1904
1905 result = -1;
1906 if (bind(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == 0) {
1907 if (connect(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == -1)
1908 result = 0; // fail, non-local address
1909 else
1910 result = 1; // success, local address
1911 }
1912 else {
1913 if (errno == EADDRNOTAVAIL)
1914 result = 0; // definitely not local :-)
1915 }
1916 close(fd);
1917
1918 return result;
1919}
1920
Willy Tarreaubaaee002006-06-26 02:48:02 +02001921/* will try to encode the string <string> replacing all characters tagged in
1922 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
1923 * prefixed by <escape>, and will store the result between <start> (included)
1924 * and <stop> (excluded), and will always terminate the string with a '\0'
1925 * before <stop>. The position of the '\0' is returned if the conversion
1926 * completes. If bytes are missing between <start> and <stop>, then the
1927 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
1928 * cannot even be stored so we return <start> without writing the 0.
1929 * The input string must also be zero-terminated.
1930 */
1931const char hextab[16] = "0123456789ABCDEF";
1932char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001933 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +02001934 const char *string)
1935{
1936 if (start < stop) {
1937 stop--; /* reserve one byte for the final '\0' */
1938 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001939 if (!ha_bit_test((unsigned char)(*string), map))
Willy Tarreaubaaee002006-06-26 02:48:02 +02001940 *start++ = *string;
1941 else {
1942 if (start + 3 >= stop)
1943 break;
1944 *start++ = escape;
1945 *start++ = hextab[(*string >> 4) & 15];
1946 *start++ = hextab[*string & 15];
1947 }
1948 string++;
1949 }
1950 *start = '\0';
1951 }
1952 return start;
1953}
1954
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001955/*
1956 * Same behavior as encode_string() above, except that it encodes chunk
1957 * <chunk> instead of a string.
1958 */
1959char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001960 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001961 const struct buffer *chunk)
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001962{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001963 char *str = chunk->area;
1964 char *end = chunk->area + chunk->data;
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001965
1966 if (start < stop) {
1967 stop--; /* reserve one byte for the final '\0' */
1968 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001969 if (!ha_bit_test((unsigned char)(*str), map))
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001970 *start++ = *str;
1971 else {
1972 if (start + 3 >= stop)
1973 break;
1974 *start++ = escape;
1975 *start++ = hextab[(*str >> 4) & 15];
1976 *start++ = hextab[*str & 15];
1977 }
1978 str++;
1979 }
1980 *start = '\0';
1981 }
1982 return start;
1983}
1984
Dragan Dosen0edd1092016-02-12 13:23:02 +01001985/*
1986 * Tries to prefix characters tagged in the <map> with the <escape>
Aurelien DARRAGONc5bff8e2022-09-20 14:33:18 +02001987 * character. The input <string> is processed until string_stop
1988 * is reached or NULL-byte is encountered. The result will
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001989 * be stored between <start> (included) and <stop> (excluded). This
1990 * function will always try to terminate the resulting string with a '\0'
1991 * before <stop>, and will return its position if the conversion
1992 * completes.
1993 */
1994char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001995 const char escape, const long *map,
Aurelien DARRAGONc5bff8e2022-09-20 14:33:18 +02001996 const char *string, const char *string_stop)
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001997{
1998 if (start < stop) {
1999 stop--; /* reserve one byte for the final '\0' */
Aurelien DARRAGONc5bff8e2022-09-20 14:33:18 +02002000 while (start < stop && string < string_stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002001 if (!ha_bit_test((unsigned char)(*string), map))
Dragan Dosen1a5d0602016-07-22 16:00:31 +02002002 *start++ = *string;
2003 else {
2004 if (start + 2 >= stop)
2005 break;
2006 *start++ = escape;
2007 *start++ = *string;
2008 }
2009 string++;
2010 }
2011 *start = '\0';
2012 }
2013 return start;
2014}
2015
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002016/* Check a string for using it in a CSV output format. If the string contains
2017 * one of the following four char <">, <,>, CR or LF, the string is
2018 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
2019 * <str> is the input string to be escaped. The function assumes that
2020 * the input string is null-terminated.
2021 *
2022 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +01002023 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002024 * format.
2025 *
Willy Tarreau898529b2016-01-06 18:07:04 +01002026 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002027 *
Willy Tarreaub631c292016-01-08 10:04:08 +01002028 * If <quote> is 1, the converter puts the quotes only if any reserved character
2029 * is present. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002030 *
Willy Tarreau83061a82018-07-13 11:56:34 +02002031 * <output> is a struct buffer used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002032 *
Willy Tarreau898529b2016-01-06 18:07:04 +01002033 * The function returns the converted string on its output. If an error
2034 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002035 * for using the function directly as printf() argument.
2036 *
2037 * If the output buffer is too short to contain the input string, the result
2038 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +01002039 *
Willy Tarreaub631c292016-01-08 10:04:08 +01002040 * This function appends the encoding to the existing output chunk, and it
2041 * guarantees that it starts immediately at the first available character of
2042 * the chunk. Please use csv_enc() instead if you want to replace the output
2043 * chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002044 */
Willy Tarreau83061a82018-07-13 11:56:34 +02002045const char *csv_enc_append(const char *str, int quote, struct buffer *output)
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002046{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002047 char *end = output->area + output->size;
2048 char *out = output->area + output->data;
Willy Tarreau898529b2016-01-06 18:07:04 +01002049 char *ptr = out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002050
Willy Tarreaub631c292016-01-08 10:04:08 +01002051 if (quote == 1) {
2052 /* automatic quoting: first verify if we'll have to quote the string */
2053 if (!strpbrk(str, "\n\r,\""))
2054 quote = 0;
2055 }
2056
2057 if (quote)
2058 *ptr++ = '"';
2059
Willy Tarreau898529b2016-01-06 18:07:04 +01002060 while (*str && ptr < end - 2) { /* -2 for reserving space for <"> and \0. */
2061 *ptr = *str;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002062 if (*str == '"') {
Willy Tarreau898529b2016-01-06 18:07:04 +01002063 ptr++;
2064 if (ptr >= end - 2) {
2065 ptr--;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002066 break;
2067 }
Willy Tarreau898529b2016-01-06 18:07:04 +01002068 *ptr = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002069 }
Willy Tarreau898529b2016-01-06 18:07:04 +01002070 ptr++;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002071 str++;
2072 }
2073
Willy Tarreaub631c292016-01-08 10:04:08 +01002074 if (quote)
2075 *ptr++ = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002076
Willy Tarreau898529b2016-01-06 18:07:04 +01002077 *ptr = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002078 output->data = ptr - output->area;
Willy Tarreau898529b2016-01-06 18:07:04 +01002079 return out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002080}
2081
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002082/* Decode an URL-encoded string in-place. The resulting string might
2083 * be shorter. If some forbidden characters are found, the conversion is
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002084 * aborted, the string is truncated before the issue and a negative value is
2085 * returned, otherwise the operation returns the length of the decoded string.
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002086 * If the 'in_form' argument is non-nul the string is assumed to be part of
2087 * an "application/x-www-form-urlencoded" encoded string, and the '+' will be
2088 * turned to a space. If it's zero, this will only be done after a question
2089 * mark ('?').
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002090 */
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002091int url_decode(char *string, int in_form)
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002092{
2093 char *in, *out;
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002094 int ret = -1;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002095
2096 in = string;
2097 out = string;
2098 while (*in) {
2099 switch (*in) {
2100 case '+' :
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002101 *out++ = in_form ? ' ' : *in;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002102 break;
2103 case '%' :
2104 if (!ishex(in[1]) || !ishex(in[2]))
2105 goto end;
2106 *out++ = (hex2i(in[1]) << 4) + hex2i(in[2]);
2107 in += 2;
2108 break;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002109 case '?':
2110 in_form = 1;
Willy Tarreau7de8de02022-11-14 07:20:09 +01002111 __fallthrough;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002112 default:
2113 *out++ = *in;
2114 break;
2115 }
2116 in++;
2117 }
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002118 ret = out - string; /* success */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002119 end:
2120 *out = 0;
2121 return ret;
2122}
Willy Tarreaubaaee002006-06-26 02:48:02 +02002123
Willy Tarreau6911fa42007-03-04 18:06:08 +01002124unsigned int str2ui(const char *s)
2125{
2126 return __str2ui(s);
2127}
2128
2129unsigned int str2uic(const char *s)
2130{
2131 return __str2uic(s);
2132}
2133
2134unsigned int strl2ui(const char *s, int len)
2135{
2136 return __strl2ui(s, len);
2137}
2138
2139unsigned int strl2uic(const char *s, int len)
2140{
2141 return __strl2uic(s, len);
2142}
2143
Willy Tarreau4ec83cd2010-10-15 23:19:55 +02002144unsigned int read_uint(const char **s, const char *end)
2145{
2146 return __read_uint(s, end);
2147}
2148
Thierry FOURNIER763a5d82015-07-06 23:09:52 +02002149/* This function reads an unsigned integer from the string pointed to by <s> and
2150 * returns it. The <s> pointer is adjusted to point to the first unread char. The
2151 * function automatically stops at <end>. If the number overflows, the 2^64-1
2152 * value is returned.
2153 */
2154unsigned long long int read_uint64(const char **s, const char *end)
2155{
2156 const char *ptr = *s;
2157 unsigned long long int i = 0, tmp;
2158 unsigned int j;
2159
2160 while (ptr < end) {
2161
2162 /* read next char */
2163 j = *ptr - '0';
2164 if (j > 9)
2165 goto read_uint64_end;
2166
2167 /* add char to the number and check overflow. */
2168 tmp = i * 10;
2169 if (tmp / 10 != i) {
2170 i = ULLONG_MAX;
2171 goto read_uint64_eat;
2172 }
2173 if (ULLONG_MAX - tmp < j) {
2174 i = ULLONG_MAX;
2175 goto read_uint64_eat;
2176 }
2177 i = tmp + j;
2178 ptr++;
2179 }
2180read_uint64_eat:
2181 /* eat each numeric char */
2182 while (ptr < end) {
2183 if ((unsigned int)(*ptr - '0') > 9)
2184 break;
2185 ptr++;
2186 }
2187read_uint64_end:
2188 *s = ptr;
2189 return i;
2190}
2191
2192/* This function reads an integer from the string pointed to by <s> and returns
2193 * it. The <s> pointer is adjusted to point to the first unread char. The function
2194 * automatically stops at <end>. Il the number is bigger than 2^63-2, the 2^63-1
2195 * value is returned. If the number is lowest than -2^63-1, the -2^63 value is
2196 * returned.
2197 */
2198long long int read_int64(const char **s, const char *end)
2199{
2200 unsigned long long int i = 0;
2201 int neg = 0;
2202
2203 /* Look for minus char. */
2204 if (**s == '-') {
2205 neg = 1;
2206 (*s)++;
2207 }
2208 else if (**s == '+')
2209 (*s)++;
2210
2211 /* convert as positive number. */
2212 i = read_uint64(s, end);
2213
2214 if (neg) {
2215 if (i > 0x8000000000000000ULL)
2216 return LLONG_MIN;
2217 return -i;
2218 }
2219 if (i > 0x7fffffffffffffffULL)
2220 return LLONG_MAX;
2221 return i;
2222}
2223
Willy Tarreau6911fa42007-03-04 18:06:08 +01002224/* This one is 7 times faster than strtol() on athlon with checks.
2225 * It returns the value of the number composed of all valid digits read,
2226 * and can process negative numbers too.
2227 */
2228int strl2ic(const char *s, int len)
2229{
2230 int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002231 int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002232
2233 if (len > 0) {
2234 if (*s != '-') {
2235 /* positive number */
2236 while (len-- > 0) {
2237 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002238 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002239 if (j > 9)
2240 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002241 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002242 }
2243 } else {
2244 /* negative number */
2245 s++;
2246 while (--len > 0) {
2247 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002248 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002249 if (j > 9)
2250 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002251 i = k - j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002252 }
2253 }
2254 }
2255 return i;
2256}
2257
2258
2259/* This function reads exactly <len> chars from <s> and converts them to a
2260 * signed integer which it stores into <ret>. It accurately detects any error
2261 * (truncated string, invalid chars, overflows). It is meant to be used in
2262 * applications designed for hostile environments. It returns zero when the
2263 * number has successfully been converted, non-zero otherwise. When an error
2264 * is returned, the <ret> value is left untouched. It is yet 5 to 40 times
2265 * faster than strtol().
2266 */
2267int strl2irc(const char *s, int len, int *ret)
2268{
2269 int i = 0;
2270 int j;
2271
2272 if (!len)
2273 return 1;
2274
2275 if (*s != '-') {
2276 /* positive number */
2277 while (len-- > 0) {
2278 j = (*s++) - '0';
2279 if (j > 9) return 1; /* invalid char */
2280 if (i > INT_MAX / 10) return 1; /* check for multiply overflow */
2281 i = i * 10;
2282 if (i + j < i) return 1; /* check for addition overflow */
2283 i = i + j;
2284 }
2285 } else {
2286 /* negative number */
2287 s++;
2288 while (--len > 0) {
2289 j = (*s++) - '0';
2290 if (j > 9) return 1; /* invalid char */
2291 if (i < INT_MIN / 10) return 1; /* check for multiply overflow */
2292 i = i * 10;
2293 if (i - j > i) return 1; /* check for subtract overflow */
2294 i = i - j;
2295 }
2296 }
2297 *ret = i;
2298 return 0;
2299}
2300
2301
2302/* This function reads exactly <len> chars from <s> and converts them to a
2303 * signed integer which it stores into <ret>. It accurately detects any error
2304 * (truncated string, invalid chars, overflows). It is meant to be used in
2305 * applications designed for hostile environments. It returns zero when the
2306 * number has successfully been converted, non-zero otherwise. When an error
2307 * is returned, the <ret> value is left untouched. It is about 3 times slower
William Dauchy060ffc82021-02-06 20:47:51 +01002308 * than strl2irc().
Willy Tarreau6911fa42007-03-04 18:06:08 +01002309 */
Willy Tarreau6911fa42007-03-04 18:06:08 +01002310
2311int strl2llrc(const char *s, int len, long long *ret)
2312{
2313 long long i = 0;
2314 int j;
2315
2316 if (!len)
2317 return 1;
2318
2319 if (*s != '-') {
2320 /* positive number */
2321 while (len-- > 0) {
2322 j = (*s++) - '0';
2323 if (j > 9) return 1; /* invalid char */
2324 if (i > LLONG_MAX / 10LL) return 1; /* check for multiply overflow */
2325 i = i * 10LL;
2326 if (i + j < i) return 1; /* check for addition overflow */
2327 i = i + j;
2328 }
2329 } else {
2330 /* negative number */
2331 s++;
2332 while (--len > 0) {
2333 j = (*s++) - '0';
2334 if (j > 9) return 1; /* invalid char */
2335 if (i < LLONG_MIN / 10LL) return 1; /* check for multiply overflow */
2336 i = i * 10LL;
2337 if (i - j > i) return 1; /* check for subtract overflow */
2338 i = i - j;
2339 }
2340 }
2341 *ret = i;
2342 return 0;
2343}
2344
Thierry FOURNIER511e9472014-01-23 17:40:34 +01002345/* This function is used with pat_parse_dotted_ver(). It converts a string
2346 * composed by two number separated by a dot. Each part must contain in 16 bits
2347 * because internally they will be represented as a 32-bit quantity stored in
2348 * a 64-bit integer. It returns zero when the number has successfully been
2349 * converted, non-zero otherwise. When an error is returned, the <ret> value
2350 * is left untouched.
2351 *
2352 * "1.3" -> 0x0000000000010003
2353 * "65535.65535" -> 0x00000000ffffffff
2354 */
2355int strl2llrc_dotted(const char *text, int len, long long *ret)
2356{
2357 const char *end = &text[len];
2358 const char *p;
2359 long long major, minor;
2360
2361 /* Look for dot. */
2362 for (p = text; p < end; p++)
2363 if (*p == '.')
2364 break;
2365
2366 /* Convert major. */
2367 if (strl2llrc(text, p - text, &major) != 0)
2368 return 1;
2369
2370 /* Check major. */
2371 if (major >= 65536)
2372 return 1;
2373
2374 /* Convert minor. */
2375 minor = 0;
2376 if (p < end)
2377 if (strl2llrc(p + 1, end - (p + 1), &minor) != 0)
2378 return 1;
2379
2380 /* Check minor. */
2381 if (minor >= 65536)
2382 return 1;
2383
2384 /* Compose value. */
2385 *ret = (major << 16) | (minor & 0xffff);
2386 return 0;
2387}
2388
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002389/* This function parses a time value optionally followed by a unit suffix among
2390 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
2391 * expected by the caller. The computation does its best to avoid overflows.
2392 * The value is returned in <ret> if everything is fine, and a NULL is returned
2393 * by the function. In case of error, a pointer to the error is returned and
2394 * <ret> is left untouched. Values are automatically rounded up when needed.
Willy Tarreau9faebe32019-06-07 19:00:37 +02002395 * Values resulting in values larger than or equal to 2^31 after conversion are
2396 * reported as an overflow as value PARSE_TIME_OVER. Non-null values resulting
2397 * in an underflow are reported as an underflow as value PARSE_TIME_UNDER.
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002398 */
2399const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags)
2400{
Willy Tarreau9faebe32019-06-07 19:00:37 +02002401 unsigned long long imult, idiv;
2402 unsigned long long omult, odiv;
2403 unsigned long long value, result;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002404 const char *str = text;
2405
2406 if (!isdigit((unsigned char)*text))
2407 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002408
2409 omult = odiv = 1;
2410
2411 switch (unit_flags & TIME_UNIT_MASK) {
2412 case TIME_UNIT_US: omult = 1000000; break;
2413 case TIME_UNIT_MS: omult = 1000; break;
2414 case TIME_UNIT_S: break;
2415 case TIME_UNIT_MIN: odiv = 60; break;
2416 case TIME_UNIT_HOUR: odiv = 3600; break;
2417 case TIME_UNIT_DAY: odiv = 86400; break;
2418 default: break;
2419 }
2420
2421 value = 0;
2422
2423 while (1) {
2424 unsigned int j;
2425
2426 j = *text - '0';
2427 if (j > 9)
2428 break;
2429 text++;
2430 value *= 10;
2431 value += j;
2432 }
2433
2434 imult = idiv = 1;
2435 switch (*text) {
2436 case '\0': /* no unit = default unit */
2437 imult = omult = idiv = odiv = 1;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002438 goto end;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002439 case 's': /* second = unscaled unit */
2440 break;
2441 case 'u': /* microsecond : "us" */
2442 if (text[1] == 's') {
2443 idiv = 1000000;
2444 text++;
Thayne McCombsa6838052021-04-02 14:12:43 -06002445 break;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002446 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002447 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002448 case 'm': /* millisecond : "ms" or minute: "m" */
2449 if (text[1] == 's') {
2450 idiv = 1000;
2451 text++;
2452 } else
2453 imult = 60;
2454 break;
2455 case 'h': /* hour : "h" */
2456 imult = 3600;
2457 break;
2458 case 'd': /* day : "d" */
2459 imult = 86400;
2460 break;
2461 default:
2462 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002463 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002464 if (*(++text) != '\0') {
2465 ha_warning("unexpected character '%c' after the timer value '%s', only "
2466 "(us=microseconds,ms=milliseconds,s=seconds,m=minutes,h=hours,d=days) are supported."
2467 " This will be reported as an error in next versions.\n", *text, str);
2468 }
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002469
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002470 end:
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002471 if (omult % idiv == 0) { omult /= idiv; idiv = 1; }
2472 if (idiv % omult == 0) { idiv /= omult; omult = 1; }
2473 if (imult % odiv == 0) { imult /= odiv; odiv = 1; }
2474 if (odiv % imult == 0) { odiv /= imult; imult = 1; }
2475
Willy Tarreau9faebe32019-06-07 19:00:37 +02002476 result = (value * (imult * omult) + (idiv * odiv - 1)) / (idiv * odiv);
2477 if (result >= 0x80000000)
2478 return PARSE_TIME_OVER;
2479 if (!result && value)
2480 return PARSE_TIME_UNDER;
2481 *ret = result;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002482 return NULL;
2483}
Willy Tarreau6911fa42007-03-04 18:06:08 +01002484
Emeric Brun39132b22010-01-04 14:57:24 +01002485/* this function converts the string starting at <text> to an unsigned int
2486 * stored in <ret>. If an error is detected, the pointer to the unexpected
Joseph Herlant32b83272018-11-15 11:58:28 -08002487 * character is returned. If the conversion is successful, NULL is returned.
Emeric Brun39132b22010-01-04 14:57:24 +01002488 */
2489const char *parse_size_err(const char *text, unsigned *ret) {
2490 unsigned value = 0;
2491
Christopher Faulet82635a02020-12-11 09:30:45 +01002492 if (!isdigit((unsigned char)*text))
2493 return text;
2494
Emeric Brun39132b22010-01-04 14:57:24 +01002495 while (1) {
2496 unsigned int j;
2497
2498 j = *text - '0';
2499 if (j > 9)
2500 break;
2501 if (value > ~0U / 10)
2502 return text;
2503 value *= 10;
2504 if (value > (value + j))
2505 return text;
2506 value += j;
2507 text++;
2508 }
2509
2510 switch (*text) {
2511 case '\0':
2512 break;
2513 case 'K':
2514 case 'k':
2515 if (value > ~0U >> 10)
2516 return text;
2517 value = value << 10;
2518 break;
2519 case 'M':
2520 case 'm':
2521 if (value > ~0U >> 20)
2522 return text;
2523 value = value << 20;
2524 break;
2525 case 'G':
2526 case 'g':
2527 if (value > ~0U >> 30)
2528 return text;
2529 value = value << 30;
2530 break;
2531 default:
2532 return text;
2533 }
2534
Godbach58048a22015-01-28 17:36:16 +08002535 if (*text != '\0' && *++text != '\0')
2536 return text;
2537
Emeric Brun39132b22010-01-04 14:57:24 +01002538 *ret = value;
2539 return NULL;
2540}
2541
Willy Tarreau126d4062013-12-03 17:50:47 +01002542/*
2543 * Parse binary string written in hexadecimal (source) and store the decoded
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002544 * result into binstr and set binstrlen to the length of binstr. Memory for
Willy Tarreau126d4062013-12-03 17:50:47 +01002545 * binstr is allocated by the function. In case of error, returns 0 with an
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002546 * error message in err. In success case, it returns the consumed length.
Willy Tarreau126d4062013-12-03 17:50:47 +01002547 */
2548int parse_binary(const char *source, char **binstr, int *binstrlen, char **err)
2549{
2550 int len;
2551 const char *p = source;
2552 int i,j;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002553 int alloc;
Willy Tarreau126d4062013-12-03 17:50:47 +01002554
2555 len = strlen(source);
2556 if (len % 2) {
2557 memprintf(err, "an even number of hex digit is expected");
2558 return 0;
2559 }
2560
2561 len = len >> 1;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002562
Willy Tarreau126d4062013-12-03 17:50:47 +01002563 if (!*binstr) {
Tim Duesterhuse52b6e52020-09-12 20:26:43 +02002564 *binstr = calloc(len, sizeof(**binstr));
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002565 if (!*binstr) {
2566 memprintf(err, "out of memory while loading string pattern");
2567 return 0;
2568 }
2569 alloc = 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002570 }
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002571 else {
2572 if (*binstrlen < len) {
Joseph Herlant76dbe782018-11-15 12:01:22 -08002573 memprintf(err, "no space available in the buffer. expect %d, provides %d",
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002574 len, *binstrlen);
2575 return 0;
2576 }
2577 alloc = 0;
2578 }
2579 *binstrlen = len;
Willy Tarreau126d4062013-12-03 17:50:47 +01002580
2581 i = j = 0;
2582 while (j < len) {
2583 if (!ishex(p[i++]))
2584 goto bad_input;
2585 if (!ishex(p[i++]))
2586 goto bad_input;
2587 (*binstr)[j++] = (hex2i(p[i-2]) << 4) + hex2i(p[i-1]);
2588 }
Thierry FOURNIERee330af2014-01-21 11:36:14 +01002589 return len << 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002590
2591bad_input:
2592 memprintf(err, "an hex digit is expected (found '%c')", p[i-1]);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002593 if (alloc)
2594 ha_free(binstr);
Willy Tarreau126d4062013-12-03 17:50:47 +01002595 return 0;
2596}
2597
Willy Tarreau946ba592009-05-10 15:41:18 +02002598/* copies at most <n> characters from <src> and always terminates with '\0' */
2599char *my_strndup(const char *src, int n)
2600{
2601 int len = 0;
2602 char *ret;
2603
2604 while (len < n && src[len])
2605 len++;
2606
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02002607 ret = malloc(len + 1);
Willy Tarreau946ba592009-05-10 15:41:18 +02002608 if (!ret)
2609 return ret;
2610 memcpy(ret, src, len);
2611 ret[len] = '\0';
2612 return ret;
2613}
2614
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +02002615/*
2616 * search needle in haystack
2617 * returns the pointer if found, returns NULL otherwise
2618 */
2619const void *my_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen)
2620{
2621 const void *c = NULL;
2622 unsigned char f;
2623
2624 if ((haystack == NULL) || (needle == NULL) || (haystacklen < needlelen))
2625 return NULL;
2626
2627 f = *(char *)needle;
2628 c = haystack;
2629 while ((c = memchr(c, f, haystacklen - (c - haystack))) != NULL) {
2630 if ((haystacklen - (c - haystack)) < needlelen)
2631 return NULL;
2632
2633 if (memcmp(c, needle, needlelen) == 0)
2634 return c;
2635 ++c;
2636 }
2637 return NULL;
2638}
2639
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002640/* get length of the initial segment consisting entirely of bytes in <accept> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002641size_t my_memspn(const void *str, size_t len, const void *accept, size_t acceptlen)
2642{
2643 size_t ret = 0;
2644
2645 while (ret < len && memchr(accept, *((int *)str), acceptlen)) {
2646 str++;
2647 ret++;
2648 }
2649 return ret;
2650}
2651
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002652/* get length of the initial segment consisting entirely of bytes not in <rejcet> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002653size_t my_memcspn(const void *str, size_t len, const void *reject, size_t rejectlen)
2654{
2655 size_t ret = 0;
2656
2657 while (ret < len) {
2658 if(memchr(reject, *((int *)str), rejectlen))
2659 return ret;
2660 str++;
2661 ret++;
2662 }
2663 return ret;
2664}
2665
Willy Tarreau482b00d2009-10-04 22:48:42 +02002666/* This function returns the first unused key greater than or equal to <key> in
2667 * ID tree <root>. Zero is returned if no place is found.
2668 */
2669unsigned int get_next_id(struct eb_root *root, unsigned int key)
2670{
2671 struct eb32_node *used;
2672
2673 do {
2674 used = eb32_lookup_ge(root, key);
2675 if (!used || used->key > key)
2676 return key; /* key is available */
2677 key++;
2678 } while (key);
2679 return key;
2680}
2681
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002682/* dump the full tree to <file> in DOT format for debugging purposes. Will
2683 * optionally highlight node <subj> if found, depending on operation <op> :
2684 * 0 : nothing
2685 * >0 : insertion, node/leaf are surrounded in red
2686 * <0 : removal, node/leaf are dashed with no background
2687 * Will optionally add "desc" as a label on the graph if set and non-null.
2688 */
2689void eb32sc_to_file(FILE *file, struct eb_root *root, const struct eb32sc_node *subj, int op, const char *desc)
Willy Tarreaued3cda02017-11-15 15:04:05 +01002690{
2691 struct eb32sc_node *node;
2692 unsigned long scope = -1;
2693
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002694 fprintf(file, "digraph ebtree {\n");
2695
2696 if (desc && *desc) {
2697 fprintf(file,
2698 " fontname=\"fixed\";\n"
2699 " fontsize=8;\n"
2700 " label=\"%s\";\n", desc);
2701 }
2702
Willy Tarreaued3cda02017-11-15 15:04:05 +01002703 fprintf(file,
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002704 " node [fontname=\"fixed\" fontsize=8 shape=\"box\" style=\"filled\" color=\"black\" fillcolor=\"white\"];\n"
2705 " edge [fontname=\"fixed\" fontsize=8 style=\"solid\" color=\"magenta\" dir=\"forward\"];\n"
Willy Tarreaued3cda02017-11-15 15:04:05 +01002706 " \"%lx_n\" [label=\"root\\n%lx\"]\n", (long)eb_root_to_node(root), (long)root
2707 );
2708
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002709 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002710 (long)eb_root_to_node(root),
2711 (long)eb_root_to_node(eb_clrtag(root->b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002712 eb_gettag(root->b[0]) == EB_LEAF ? 'l' : 'n');
2713
2714 node = eb32sc_first(root, scope);
2715 while (node) {
2716 if (node->node.node_p) {
2717 /* node part is used */
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002718 fprintf(file, " \"%lx_n\" [label=\"%lx\\nkey=%u\\nscope=%lx\\nbit=%d\" fillcolor=\"lightskyblue1\" %s];\n",
2719 (long)node, (long)node, node->key, node->node_s, node->node.bit,
2720 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002721
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002722 fprintf(file, " \"%lx_n\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002723 (long)node,
2724 (long)eb_root_to_node(eb_clrtag(node->node.node_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002725 eb_gettag(node->node.node_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002726
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002727 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002728 (long)node,
2729 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002730 eb_gettag(node->node.branches.b[0]) == EB_LEAF ? 'l' : 'n');
2731
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002732 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"R\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002733 (long)node,
2734 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[1])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002735 eb_gettag(node->node.branches.b[1]) == EB_LEAF ? 'l' : 'n');
2736 }
2737
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002738 fprintf(file, " \"%lx_l\" [label=\"%lx\\nkey=%u\\nscope=%lx\\npfx=%u\" fillcolor=\"yellow\" %s];\n",
2739 (long)node, (long)node, node->key, node->leaf_s, node->node.pfx,
2740 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002741
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002742 fprintf(file, " \"%lx_l\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002743 (long)node,
2744 (long)eb_root_to_node(eb_clrtag(node->node.leaf_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002745 eb_gettag(node->node.leaf_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002746 node = eb32sc_next(node, scope);
2747 }
2748 fprintf(file, "}\n");
2749}
2750
Willy Tarreau0dc9e6d2022-08-01 11:55:57 +02002751/* dump the full tree to <file> in DOT format for debugging purposes. Will
2752 * optionally highlight node <subj> if found, depending on operation <op> :
2753 * 0 : nothing
2754 * >0 : insertion, node/leaf are surrounded in red
2755 * <0 : removal, node/leaf are dashed with no background
2756 * Will optionally add "desc" as a label on the graph if set and non-null. The
2757 * key is printed as a u32 hex value. A full-sized hex dump would be better but
2758 * is left to be implemented.
2759 */
2760void ebmb_to_file(FILE *file, struct eb_root *root, const struct ebmb_node *subj, int op, const char *desc)
2761{
2762 struct ebmb_node *node;
2763
2764 fprintf(file, "digraph ebtree {\n");
2765
2766 if (desc && *desc) {
2767 fprintf(file,
2768 " fontname=\"fixed\";\n"
2769 " fontsize=8;\n"
2770 " label=\"%s\";\n", desc);
2771 }
2772
2773 fprintf(file,
2774 " node [fontname=\"fixed\" fontsize=8 shape=\"box\" style=\"filled\" color=\"black\" fillcolor=\"white\"];\n"
2775 " edge [fontname=\"fixed\" fontsize=8 style=\"solid\" color=\"magenta\" dir=\"forward\"];\n"
2776 " \"%lx_n\" [label=\"root\\n%lx\"]\n", (long)eb_root_to_node(root), (long)root
2777 );
2778
2779 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
2780 (long)eb_root_to_node(root),
2781 (long)eb_root_to_node(eb_clrtag(root->b[0])),
2782 eb_gettag(root->b[0]) == EB_LEAF ? 'l' : 'n');
2783
2784 node = ebmb_first(root);
2785 while (node) {
2786 if (node->node.node_p) {
2787 /* node part is used */
2788 fprintf(file, " \"%lx_n\" [label=\"%lx\\nkey=%#x\\nbit=%d\" fillcolor=\"lightskyblue1\" %s];\n",
2789 (long)node, (long)node, read_u32(node->key), node->node.bit,
2790 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
2791
2792 fprintf(file, " \"%lx_n\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
2793 (long)node,
2794 (long)eb_root_to_node(eb_clrtag(node->node.node_p)),
2795 eb_gettag(node->node.node_p) ? 'R' : 'L');
2796
2797 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
2798 (long)node,
2799 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[0])),
2800 eb_gettag(node->node.branches.b[0]) == EB_LEAF ? 'l' : 'n');
2801
2802 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"R\"];\n",
2803 (long)node,
2804 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[1])),
2805 eb_gettag(node->node.branches.b[1]) == EB_LEAF ? 'l' : 'n');
2806 }
2807
2808 fprintf(file, " \"%lx_l\" [label=\"%lx\\nkey=%#x\\npfx=%u\" fillcolor=\"yellow\" %s];\n",
2809 (long)node, (long)node, read_u32(node->key), node->node.pfx,
2810 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
2811
2812 fprintf(file, " \"%lx_l\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
2813 (long)node,
2814 (long)eb_root_to_node(eb_clrtag(node->node.leaf_p)),
2815 eb_gettag(node->node.leaf_p) ? 'R' : 'L');
2816 node = ebmb_next(node);
2817 }
2818 fprintf(file, "}\n");
2819}
2820
Willy Tarreau348238b2010-01-18 15:05:57 +01002821/* This function compares a sample word possibly followed by blanks to another
2822 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
2823 * otherwise zero. This intends to be used when checking HTTP headers for some
2824 * values. Note that it validates a word followed only by blanks but does not
2825 * validate a word followed by blanks then other chars.
2826 */
2827int word_match(const char *sample, int slen, const char *word, int wlen)
2828{
2829 if (slen < wlen)
2830 return 0;
2831
2832 while (wlen) {
2833 char c = *sample ^ *word;
2834 if (c && c != ('A' ^ 'a'))
2835 return 0;
2836 sample++;
2837 word++;
2838 slen--;
2839 wlen--;
2840 }
2841
2842 while (slen) {
2843 if (*sample != ' ' && *sample != '\t')
2844 return 0;
2845 sample++;
2846 slen--;
2847 }
2848 return 1;
2849}
Willy Tarreau482b00d2009-10-04 22:48:42 +02002850
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002851/* Converts any text-formatted IPv4 address to a host-order IPv4 address. It
2852 * is particularly fast because it avoids expensive operations such as
2853 * multiplies, which are optimized away at the end. It requires a properly
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002854 * formatted address though (3 points).
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002855 */
2856unsigned int inetaddr_host(const char *text)
2857{
2858 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2859 register unsigned int dig100, dig10, dig1;
2860 int s;
2861 const char *p, *d;
2862
2863 dig1 = dig10 = dig100 = ascii_zero;
2864 s = 24;
2865
2866 p = text;
2867 while (1) {
2868 if (((unsigned)(*p - '0')) <= 9) {
2869 p++;
2870 continue;
2871 }
2872
2873 /* here, we have a complete byte between <text> and <p> (exclusive) */
2874 if (p == text)
2875 goto end;
2876
2877 d = p - 1;
2878 dig1 |= (unsigned int)(*d << s);
2879 if (d == text)
2880 goto end;
2881
2882 d--;
2883 dig10 |= (unsigned int)(*d << s);
2884 if (d == text)
2885 goto end;
2886
2887 d--;
2888 dig100 |= (unsigned int)(*d << s);
2889 end:
2890 if (!s || *p != '.')
2891 break;
2892
2893 s -= 8;
2894 text = ++p;
2895 }
2896
2897 dig100 -= ascii_zero;
2898 dig10 -= ascii_zero;
2899 dig1 -= ascii_zero;
2900 return ((dig100 * 10) + dig10) * 10 + dig1;
2901}
2902
2903/*
2904 * Idem except the first unparsed character has to be passed in <stop>.
2905 */
2906unsigned int inetaddr_host_lim(const char *text, const char *stop)
2907{
2908 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2909 register unsigned int dig100, dig10, dig1;
2910 int s;
2911 const char *p, *d;
2912
2913 dig1 = dig10 = dig100 = ascii_zero;
2914 s = 24;
2915
2916 p = text;
2917 while (1) {
2918 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2919 p++;
2920 continue;
2921 }
2922
2923 /* here, we have a complete byte between <text> and <p> (exclusive) */
2924 if (p == text)
2925 goto end;
2926
2927 d = p - 1;
2928 dig1 |= (unsigned int)(*d << s);
2929 if (d == text)
2930 goto end;
2931
2932 d--;
2933 dig10 |= (unsigned int)(*d << s);
2934 if (d == text)
2935 goto end;
2936
2937 d--;
2938 dig100 |= (unsigned int)(*d << s);
2939 end:
2940 if (!s || p == stop || *p != '.')
2941 break;
2942
2943 s -= 8;
2944 text = ++p;
2945 }
2946
2947 dig100 -= ascii_zero;
2948 dig10 -= ascii_zero;
2949 dig1 -= ascii_zero;
2950 return ((dig100 * 10) + dig10) * 10 + dig1;
2951}
2952
2953/*
2954 * Idem except the pointer to first unparsed byte is returned into <ret> which
2955 * must not be NULL.
2956 */
Willy Tarreau74172752010-10-15 23:21:42 +02002957unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret)
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002958{
2959 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2960 register unsigned int dig100, dig10, dig1;
2961 int s;
Willy Tarreau74172752010-10-15 23:21:42 +02002962 char *p, *d;
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002963
2964 dig1 = dig10 = dig100 = ascii_zero;
2965 s = 24;
2966
2967 p = text;
2968 while (1) {
2969 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2970 p++;
2971 continue;
2972 }
2973
2974 /* here, we have a complete byte between <text> and <p> (exclusive) */
2975 if (p == text)
2976 goto end;
2977
2978 d = p - 1;
2979 dig1 |= (unsigned int)(*d << s);
2980 if (d == text)
2981 goto end;
2982
2983 d--;
2984 dig10 |= (unsigned int)(*d << s);
2985 if (d == text)
2986 goto end;
2987
2988 d--;
2989 dig100 |= (unsigned int)(*d << s);
2990 end:
2991 if (!s || p == stop || *p != '.')
2992 break;
2993
2994 s -= 8;
2995 text = ++p;
2996 }
2997
2998 *ret = p;
2999 dig100 -= ascii_zero;
3000 dig10 -= ascii_zero;
3001 dig1 -= ascii_zero;
3002 return ((dig100 * 10) + dig10) * 10 + dig1;
3003}
3004
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02003005/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
3006 * or the number of chars read in case of success. Maybe this could be replaced
3007 * by one of the functions above. Also, apparently this function does not support
3008 * hosts above 255 and requires exactly 4 octets.
Willy Tarreau075415a2013-12-12 11:29:39 +01003009 * The destination is only modified on success.
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02003010 */
3011int buf2ip(const char *buf, size_t len, struct in_addr *dst)
3012{
3013 const char *addr;
3014 int saw_digit, octets, ch;
3015 u_char tmp[4], *tp;
3016 const char *cp = buf;
3017
3018 saw_digit = 0;
3019 octets = 0;
3020 *(tp = tmp) = 0;
3021
3022 for (addr = buf; addr - buf < len; addr++) {
3023 unsigned char digit = (ch = *addr) - '0';
3024
3025 if (digit > 9 && ch != '.')
3026 break;
3027
3028 if (digit <= 9) {
3029 u_int new = *tp * 10 + digit;
3030
3031 if (new > 255)
3032 return 0;
3033
3034 *tp = new;
3035
3036 if (!saw_digit) {
3037 if (++octets > 4)
3038 return 0;
3039 saw_digit = 1;
3040 }
3041 } else if (ch == '.' && saw_digit) {
3042 if (octets == 4)
3043 return 0;
3044
3045 *++tp = 0;
3046 saw_digit = 0;
3047 } else
3048 return 0;
3049 }
3050
3051 if (octets < 4)
3052 return 0;
3053
3054 memcpy(&dst->s_addr, tmp, 4);
3055 return addr - cp;
3056}
3057
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003058/* This function converts the string in <buf> of the len <len> to
3059 * struct in6_addr <dst> which must be allocated by the caller.
3060 * This function returns 1 in success case, otherwise zero.
Willy Tarreau075415a2013-12-12 11:29:39 +01003061 * The destination is only modified on success.
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003062 */
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003063int buf2ip6(const char *buf, size_t len, struct in6_addr *dst)
3064{
Thierry FOURNIERcd659912013-12-11 12:33:54 +01003065 char null_term_ip6[INET6_ADDRSTRLEN + 1];
Willy Tarreau075415a2013-12-12 11:29:39 +01003066 struct in6_addr out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003067
Thierry FOURNIERcd659912013-12-11 12:33:54 +01003068 if (len > INET6_ADDRSTRLEN)
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003069 return 0;
3070
3071 memcpy(null_term_ip6, buf, len);
3072 null_term_ip6[len] = '\0';
3073
Willy Tarreau075415a2013-12-12 11:29:39 +01003074 if (!inet_pton(AF_INET6, null_term_ip6, &out))
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003075 return 0;
3076
Willy Tarreau075415a2013-12-12 11:29:39 +01003077 *dst = out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003078 return 1;
3079}
3080
Willy Tarreauacf95772010-06-14 19:09:21 +02003081/* To be used to quote config arg positions. Returns the short string at <ptr>
3082 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
3083 * if ptr is NULL or empty. The string is locally allocated.
3084 */
3085const char *quote_arg(const char *ptr)
3086{
Christopher Faulet1bc04c72017-10-29 20:14:08 +01003087 static THREAD_LOCAL char val[32];
Willy Tarreauacf95772010-06-14 19:09:21 +02003088 int i;
3089
3090 if (!ptr || !*ptr)
3091 return "end of line";
3092 val[0] = '\'';
Willy Tarreaude2dd6b2013-01-24 02:14:42 +01003093 for (i = 1; i < sizeof(val) - 2 && *ptr; i++)
Willy Tarreauacf95772010-06-14 19:09:21 +02003094 val[i] = *ptr++;
3095 val[i++] = '\'';
3096 val[i] = '\0';
3097 return val;
3098}
3099
Willy Tarreau5b180202010-07-18 10:40:48 +02003100/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
3101int get_std_op(const char *str)
3102{
3103 int ret = -1;
3104
3105 if (*str == 'e' && str[1] == 'q')
3106 ret = STD_OP_EQ;
3107 else if (*str == 'n' && str[1] == 'e')
3108 ret = STD_OP_NE;
3109 else if (*str == 'l') {
3110 if (str[1] == 'e') ret = STD_OP_LE;
3111 else if (str[1] == 't') ret = STD_OP_LT;
3112 }
3113 else if (*str == 'g') {
3114 if (str[1] == 'e') ret = STD_OP_GE;
3115 else if (str[1] == 't') ret = STD_OP_GT;
3116 }
3117
3118 if (ret == -1 || str[2] != '\0')
3119 return -1;
3120 return ret;
3121}
3122
Willy Tarreau4c14eaa2010-11-24 14:01:45 +01003123/* hash a 32-bit integer to another 32-bit integer */
3124unsigned int full_hash(unsigned int a)
3125{
3126 return __full_hash(a);
3127}
3128
Willy Tarreauf3241112019-02-26 09:56:22 +01003129/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
3130 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
3131 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
3132 * a popcount variant and is described here :
3133 * https://graphics.stanford.edu/~seander/bithacks.html
3134 */
3135unsigned int mask_find_rank_bit(unsigned int r, unsigned long m)
3136{
3137 unsigned long a, b, c, d;
3138 unsigned int s;
3139 unsigned int t;
3140
3141 a = m - ((m >> 1) & ~0UL/3);
3142 b = (a & ~0UL/5) + ((a >> 2) & ~0UL/5);
3143 c = (b + (b >> 4)) & ~0UL/0x11;
3144 d = (c + (c >> 8)) & ~0UL/0x101;
3145
3146 r++; // make r be 1..64
3147
3148 t = 0;
3149 s = LONGBITS;
3150 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01003151 unsigned long d2 = (d >> 16) >> 16;
3152 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01003153 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
3154 }
3155
3156 t = (d >> (s - 16)) & 0xff;
3157 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
3158 t = (c >> (s - 8)) & 0xf;
3159 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
3160 t = (b >> (s - 4)) & 0x7;
3161 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
3162 t = (a >> (s - 2)) & 0x3;
3163 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
3164 t = (m >> (s - 1)) & 0x1;
3165 s -= ((t - r) & 256) >> 8;
3166
3167 return s - 1;
3168}
3169
3170/* Same as mask_find_rank_bit() above but makes use of pre-computed bitmaps
3171 * based on <m>, in <a..d>. These ones must be updated whenever <m> changes
3172 * using mask_prep_rank_map() below.
3173 */
3174unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
3175 unsigned long a, unsigned long b,
3176 unsigned long c, unsigned long d)
3177{
3178 unsigned int s;
3179 unsigned int t;
3180
3181 r++; // make r be 1..64
3182
3183 t = 0;
3184 s = LONGBITS;
3185 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01003186 unsigned long d2 = (d >> 16) >> 16;
3187 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01003188 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
3189 }
3190
3191 t = (d >> (s - 16)) & 0xff;
3192 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
3193 t = (c >> (s - 8)) & 0xf;
3194 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
3195 t = (b >> (s - 4)) & 0x7;
3196 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
3197 t = (a >> (s - 2)) & 0x3;
3198 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
3199 t = (m >> (s - 1)) & 0x1;
3200 s -= ((t - r) & 256) >> 8;
3201
3202 return s - 1;
3203}
3204
3205/* Prepare the bitmaps used by the fast implementation of the find_rank_bit()
3206 * above.
3207 */
3208void mask_prep_rank_map(unsigned long m,
3209 unsigned long *a, unsigned long *b,
3210 unsigned long *c, unsigned long *d)
3211{
3212 *a = m - ((m >> 1) & ~0UL/3);
3213 *b = (*a & ~0UL/5) + ((*a >> 2) & ~0UL/5);
3214 *c = (*b + (*b >> 4)) & ~0UL/0x11;
3215 *d = (*c + (*c >> 8)) & ~0UL/0x101;
3216}
3217
Willy Tarreauc7a8a3c2022-06-21 20:19:54 +02003218/* Returns the position of one bit set in <v>, starting at position <bit>, and
3219 * searching in other halves if not found. This is intended to be used to
3220 * report the position of one bit set among several based on a counter or a
3221 * random generator while preserving a relatively good distribution so that
3222 * values made of holes in the middle do not see one of the bits around the
3223 * hole being returned much more often than the other one. It can be seen as a
3224 * disturbed ffsl() where the initial search starts at bit <bit>. The look up
3225 * is performed in O(logN) time for N bit words, yielding a bit among 64 in
3226 * about 16 cycles. Its usage differs from the rank find function in that the
3227 * bit passed doesn't need to be limited to the value's popcount, making the
3228 * function easier to use for random picking, and twice as fast. Passing value
3229 * 0 for <v> makes no sense and -1 is returned in this case.
3230 */
3231int one_among_mask(unsigned long v, int bit)
3232{
3233 /* note, these masks may be produced by ~0UL/((1UL<<scale)+1) but
3234 * that's more expensive.
3235 */
3236 static const unsigned long halves[] = {
3237 (unsigned long)0x5555555555555555ULL,
3238 (unsigned long)0x3333333333333333ULL,
3239 (unsigned long)0x0F0F0F0F0F0F0F0FULL,
3240 (unsigned long)0x00FF00FF00FF00FFULL,
3241 (unsigned long)0x0000FFFF0000FFFFULL,
3242 (unsigned long)0x00000000FFFFFFFFULL
3243 };
3244 unsigned long halfword = ~0UL;
3245 int scope = 0;
3246 int mirror;
3247 int scale;
3248
3249 if (!v)
3250 return -1;
3251
3252 /* we check if the exact bit is set or if it's present in a mirror
3253 * position based on the current scale we're checking, in which case
3254 * it's returned with its current (or mirrored) value. Otherwise we'll
3255 * make sure there's at least one bit in the half we're in, and will
3256 * scale down to a smaller scope and try again, until we find the
3257 * closest bit.
3258 */
3259 for (scale = (sizeof(long) > 4) ? 5 : 4; scale >= 0; scale--) {
3260 halfword >>= (1UL << scale);
3261 scope |= (1UL << scale);
3262 mirror = bit ^ (1UL << scale);
3263 if (v & ((1UL << bit) | (1UL << mirror)))
3264 return (v & (1UL << bit)) ? bit : mirror;
3265
3266 if (!((v >> (bit & scope)) & halves[scale] & halfword))
3267 bit = mirror;
3268 }
3269 return bit;
3270}
3271
David du Colombier4f92d322011-03-24 11:09:31 +01003272/* Return non-zero if IPv4 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003273 * otherwise zero. Note that <addr> may not necessarily be aligned
3274 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003275 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003276int in_net_ipv4(const void *addr, const struct in_addr *mask, const struct in_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003277{
Willy Tarreaueec1d382016-07-13 11:59:39 +02003278 struct in_addr addr_copy;
3279
3280 memcpy(&addr_copy, addr, sizeof(addr_copy));
3281 return((addr_copy.s_addr & mask->s_addr) == (net->s_addr & mask->s_addr));
David du Colombier4f92d322011-03-24 11:09:31 +01003282}
3283
3284/* Return non-zero if IPv6 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003285 * otherwise zero. Note that <addr> may not necessarily be aligned
3286 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003287 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003288int in_net_ipv6(const void *addr, const struct in6_addr *mask, const struct in6_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003289{
3290 int i;
Willy Tarreaueec1d382016-07-13 11:59:39 +02003291 struct in6_addr addr_copy;
David du Colombier4f92d322011-03-24 11:09:31 +01003292
Willy Tarreaueec1d382016-07-13 11:59:39 +02003293 memcpy(&addr_copy, addr, sizeof(addr_copy));
David du Colombier4f92d322011-03-24 11:09:31 +01003294 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
Willy Tarreaueec1d382016-07-13 11:59:39 +02003295 if (((((int *)&addr_copy)[i] & ((int *)mask)[i])) !=
David du Colombier4f92d322011-03-24 11:09:31 +01003296 (((int *)net)[i] & ((int *)mask)[i]))
3297 return 0;
3298 return 1;
3299}
3300
3301/* RFC 4291 prefix */
3302const char rfc4291_pfx[] = { 0x00, 0x00, 0x00, 0x00,
3303 0x00, 0x00, 0x00, 0x00,
3304 0x00, 0x00, 0xFF, 0xFF };
3305
Joseph Herlant32b83272018-11-15 11:58:28 -08003306/* Map IPv4 address on IPv6 address, as specified in RFC 3513.
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003307 * Input and output may overlap.
3308 */
David du Colombier4f92d322011-03-24 11:09:31 +01003309void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr)
3310{
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003311 struct in_addr tmp_addr;
3312
3313 tmp_addr.s_addr = sin_addr->s_addr;
David du Colombier4f92d322011-03-24 11:09:31 +01003314 memcpy(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx));
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003315 memcpy(sin6_addr->s6_addr+12, &tmp_addr.s_addr, 4);
David du Colombier4f92d322011-03-24 11:09:31 +01003316}
3317
Joseph Herlant32b83272018-11-15 11:58:28 -08003318/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01003319 * Return true if conversion is possible and false otherwise.
3320 */
3321int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr)
3322{
3323 if (memcmp(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx)) == 0) {
3324 memcpy(&(sin_addr->s_addr), &(sin6_addr->s6_addr[12]),
3325 sizeof(struct in_addr));
3326 return 1;
3327 }
3328
3329 return 0;
3330}
3331
Amaury Denoyelle21e611d2022-12-01 17:46:45 +01003332/* compare two struct sockaddr_storage, including port if <check_port> is true,
3333 * and return:
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003334 * 0 (true) if the addr is the same in both
3335 * 1 (false) if the addr is not the same in both
3336 * -1 (unable) if one of the addr is not AF_INET*
3337 */
Amaury Denoyelle21e611d2022-12-01 17:46:45 +01003338int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2, int check_port)
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003339{
3340 if ((ss1->ss_family != AF_INET) && (ss1->ss_family != AF_INET6))
3341 return -1;
3342
3343 if ((ss2->ss_family != AF_INET) && (ss2->ss_family != AF_INET6))
3344 return -1;
3345
3346 if (ss1->ss_family != ss2->ss_family)
3347 return 1;
3348
3349 switch (ss1->ss_family) {
3350 case AF_INET:
Amaury Denoyelle21e611d2022-12-01 17:46:45 +01003351 return (memcmp(&((struct sockaddr_in *)ss1)->sin_addr,
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003352 &((struct sockaddr_in *)ss2)->sin_addr,
Amaury Denoyelle21e611d2022-12-01 17:46:45 +01003353 sizeof(struct in_addr)) != 0) ||
3354 (check_port && get_net_port(ss1) != get_net_port(ss2));
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003355 case AF_INET6:
Amaury Denoyelle21e611d2022-12-01 17:46:45 +01003356 return (memcmp(&((struct sockaddr_in6 *)ss1)->sin6_addr,
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003357 &((struct sockaddr_in6 *)ss2)->sin6_addr,
Amaury Denoyelle21e611d2022-12-01 17:46:45 +01003358 sizeof(struct in6_addr)) != 0) ||
3359 (check_port && get_net_port(ss1) != get_net_port(ss2));
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003360 }
3361
3362 return 1;
3363}
3364
Christopher Faulet9553de72021-02-26 09:12:50 +01003365/* compare a struct sockaddr_storage to a struct net_addr and return :
3366 * 0 (true) if <addr> is matching <net>
3367 * 1 (false) if <addr> is not matching <net>
3368 * -1 (unable) if <addr> or <net> is not AF_INET*
3369 */
3370int ipcmp2net(const struct sockaddr_storage *addr, const struct net_addr *net)
3371{
3372 if ((addr->ss_family != AF_INET) && (addr->ss_family != AF_INET6))
3373 return -1;
3374
3375 if ((net->family != AF_INET) && (net->family != AF_INET6))
3376 return -1;
3377
3378 if (addr->ss_family != net->family)
3379 return 1;
3380
3381 if (addr->ss_family == AF_INET &&
3382 (((struct sockaddr_in *)addr)->sin_addr.s_addr & net->addr.v4.mask.s_addr) == net->addr.v4.ip.s_addr)
3383 return 0;
3384 else {
3385 const struct in6_addr *addr6 = &(((const struct sockaddr_in6*)addr)->sin6_addr);
3386 const struct in6_addr *nip6 = &net->addr.v6.ip;
3387 const struct in6_addr *nmask6 = &net->addr.v6.mask;
3388
3389 if ((read_u32(&addr6->s6_addr[0]) & read_u32(&nmask6->s6_addr[0])) == read_u32(&nip6->s6_addr[0]) &&
3390 (read_u32(&addr6->s6_addr[4]) & read_u32(&nmask6->s6_addr[4])) == read_u32(&nip6->s6_addr[4]) &&
3391 (read_u32(&addr6->s6_addr[8]) & read_u32(&nmask6->s6_addr[8])) == read_u32(&nip6->s6_addr[8]) &&
3392 (read_u32(&addr6->s6_addr[12]) & read_u32(&nmask6->s6_addr[12])) == read_u32(&nip6->s6_addr[12]))
3393 return 0;
3394 }
3395
3396 return 1;
3397}
3398
Baptiste Assmann08396c82016-01-31 00:27:17 +01003399/* copy IP address from <source> into <dest>
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003400 * The caller must allocate and clear <dest> before calling.
3401 * The source must be in either AF_INET or AF_INET6 family, or the destination
3402 * address will be undefined. If the destination address used to hold a port,
3403 * it is preserved, so that this function can be used to switch to another
3404 * address family with no risk. Returns a pointer to the destination.
Baptiste Assmann08396c82016-01-31 00:27:17 +01003405 */
3406struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest)
3407{
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003408 int prev_port;
3409
3410 prev_port = get_net_port(dest);
3411 memset(dest, 0, sizeof(*dest));
Baptiste Assmann08396c82016-01-31 00:27:17 +01003412 dest->ss_family = source->ss_family;
3413
3414 /* copy new addr and apply it */
3415 switch (source->ss_family) {
3416 case AF_INET:
3417 ((struct sockaddr_in *)dest)->sin_addr.s_addr = ((struct sockaddr_in *)source)->sin_addr.s_addr;
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003418 ((struct sockaddr_in *)dest)->sin_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003419 break;
3420 case AF_INET6:
3421 memcpy(((struct sockaddr_in6 *)dest)->sin6_addr.s6_addr, ((struct sockaddr_in6 *)source)->sin6_addr.s6_addr, sizeof(struct in6_addr));
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003422 ((struct sockaddr_in6 *)dest)->sin6_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003423 break;
3424 }
3425
3426 return dest;
3427}
3428
William Lallemand421f5b52012-02-06 18:15:57 +01003429char *human_time(int t, short hz_div) {
3430 static char rv[sizeof("24855d23h")+1]; // longest of "23h59m" and "59m59s"
3431 char *p = rv;
Willy Tarreau761b3d52014-04-14 14:53:06 +02003432 char *end = rv + sizeof(rv);
William Lallemand421f5b52012-02-06 18:15:57 +01003433 int cnt=2; // print two numbers
3434
3435 if (unlikely(t < 0 || hz_div <= 0)) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003436 snprintf(p, end - p, "?");
William Lallemand421f5b52012-02-06 18:15:57 +01003437 return rv;
3438 }
3439
3440 if (unlikely(hz_div > 1))
3441 t /= hz_div;
3442
3443 if (t >= DAY) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003444 p += snprintf(p, end - p, "%dd", t / DAY);
William Lallemand421f5b52012-02-06 18:15:57 +01003445 cnt--;
3446 }
3447
3448 if (cnt && t % DAY / HOUR) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003449 p += snprintf(p, end - p, "%dh", t % DAY / HOUR);
William Lallemand421f5b52012-02-06 18:15:57 +01003450 cnt--;
3451 }
3452
3453 if (cnt && t % HOUR / MINUTE) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003454 p += snprintf(p, end - p, "%dm", t % HOUR / MINUTE);
William Lallemand421f5b52012-02-06 18:15:57 +01003455 cnt--;
3456 }
3457
3458 if ((cnt && t % MINUTE) || !t) // also display '0s'
Willy Tarreau761b3d52014-04-14 14:53:06 +02003459 p += snprintf(p, end - p, "%ds", t % MINUTE / SEC);
William Lallemand421f5b52012-02-06 18:15:57 +01003460
3461 return rv;
3462}
3463
3464const char *monthname[12] = {
3465 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
3466 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
3467};
3468
3469/* date2str_log: write a date in the format :
3470 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
3471 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3472 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
3473 *
3474 * without using sprintf. return a pointer to the last char written (\0) or
3475 * NULL if there isn't enough space.
3476 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02003477char *date2str_log(char *dst, const struct tm *tm, const struct timeval *date, size_t size)
William Lallemand421f5b52012-02-06 18:15:57 +01003478{
3479
3480 if (size < 25) /* the size is fixed: 24 chars + \0 */
3481 return NULL;
3482
3483 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003484 if (!dst)
3485 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003486 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003487
William Lallemand421f5b52012-02-06 18:15:57 +01003488 memcpy(dst, monthname[tm->tm_mon], 3); // month
3489 dst += 3;
3490 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003491
William Lallemand421f5b52012-02-06 18:15:57 +01003492 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003493 if (!dst)
3494 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003495 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003496
William Lallemand421f5b52012-02-06 18:15:57 +01003497 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003498 if (!dst)
3499 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003500 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003501
William Lallemand421f5b52012-02-06 18:15:57 +01003502 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003503 if (!dst)
3504 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003505 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003506
William Lallemand421f5b52012-02-06 18:15:57 +01003507 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003508 if (!dst)
3509 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003510 *dst++ = '.';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003511
Willy Tarreau7d9421d2020-02-29 09:08:02 +01003512 dst = utoa_pad((unsigned int)(date->tv_usec/1000)%1000, dst, 4); // milliseconds
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003513 if (!dst)
3514 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003515 *dst = '\0';
3516
3517 return dst;
3518}
3519
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003520/* Base year used to compute leap years */
3521#define TM_YEAR_BASE 1900
3522
3523/* Return the difference in seconds between two times (leap seconds are ignored).
3524 * Retrieved from glibc 2.18 source code.
3525 */
3526static int my_tm_diff(const struct tm *a, const struct tm *b)
3527{
3528 /* Compute intervening leap days correctly even if year is negative.
3529 * Take care to avoid int overflow in leap day calculations,
3530 * but it's OK to assume that A and B are close to each other.
3531 */
3532 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
3533 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
3534 int a100 = a4 / 25 - (a4 % 25 < 0);
3535 int b100 = b4 / 25 - (b4 % 25 < 0);
3536 int a400 = a100 >> 2;
3537 int b400 = b100 >> 2;
3538 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
3539 int years = a->tm_year - b->tm_year;
3540 int days = (365 * years + intervening_leap_days
3541 + (a->tm_yday - b->tm_yday));
3542 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
3543 + (a->tm_min - b->tm_min))
3544 + (a->tm_sec - b->tm_sec));
3545}
3546
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003547/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003548 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003549 * The string returned has the same format as returned by strftime(... "%z", tm).
3550 * Offsets are kept in an internal cache for better performances.
3551 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003552const char *get_gmt_offset(time_t t, struct tm *tm)
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003553{
3554 /* Cache offsets from GMT (depending on whether DST is active or not) */
Christopher Faulet1bc04c72017-10-29 20:14:08 +01003555 static THREAD_LOCAL char gmt_offsets[2][5+1] = { "", "" };
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003556
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003557 char *gmt_offset;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003558 struct tm tm_gmt;
3559 int diff;
3560 int isdst = tm->tm_isdst;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003561
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003562 /* Pretend DST not active if its status is unknown */
3563 if (isdst < 0)
3564 isdst = 0;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003565
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003566 /* Fetch the offset and initialize it if needed */
3567 gmt_offset = gmt_offsets[isdst & 0x01];
3568 if (unlikely(!*gmt_offset)) {
3569 get_gmtime(t, &tm_gmt);
3570 diff = my_tm_diff(tm, &tm_gmt);
3571 if (diff < 0) {
3572 diff = -diff;
3573 *gmt_offset = '-';
3574 } else {
3575 *gmt_offset = '+';
3576 }
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003577 diff %= 86400U;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003578 diff /= 60; /* Convert to minutes */
3579 snprintf(gmt_offset+1, 4+1, "%02d%02d", diff/60, diff%60);
3580 }
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003581
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003582 return gmt_offset;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003583}
3584
William Lallemand421f5b52012-02-06 18:15:57 +01003585/* gmt2str_log: write a date in the format :
3586 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
3587 * return a pointer to the last char written (\0) or
3588 * NULL if there isn't enough space.
3589 */
3590char *gmt2str_log(char *dst, struct tm *tm, size_t size)
3591{
Yuxans Yao4e25b012012-10-19 10:36:09 +08003592 if (size < 27) /* the size is fixed: 26 chars + \0 */
William Lallemand421f5b52012-02-06 18:15:57 +01003593 return NULL;
3594
3595 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003596 if (!dst)
3597 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003598 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003599
William Lallemand421f5b52012-02-06 18:15:57 +01003600 memcpy(dst, monthname[tm->tm_mon], 3); // month
3601 dst += 3;
3602 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003603
William Lallemand421f5b52012-02-06 18:15:57 +01003604 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003605 if (!dst)
3606 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003607 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003608
William Lallemand421f5b52012-02-06 18:15:57 +01003609 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003610 if (!dst)
3611 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003612 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003613
William Lallemand421f5b52012-02-06 18:15:57 +01003614 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003615 if (!dst)
3616 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003617 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003618
William Lallemand421f5b52012-02-06 18:15:57 +01003619 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003620 if (!dst)
3621 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003622 *dst++ = ' ';
3623 *dst++ = '+';
3624 *dst++ = '0';
3625 *dst++ = '0';
3626 *dst++ = '0';
3627 *dst++ = '0';
3628 *dst = '\0';
3629
3630 return dst;
3631}
3632
Yuxans Yao4e25b012012-10-19 10:36:09 +08003633/* localdate2str_log: write a date in the format :
3634 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003635 * Both t and tm must represent the same time.
3636 * return a pointer to the last char written (\0) or
3637 * NULL if there isn't enough space.
Yuxans Yao4e25b012012-10-19 10:36:09 +08003638 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003639char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size)
Yuxans Yao4e25b012012-10-19 10:36:09 +08003640{
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003641 const char *gmt_offset;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003642 if (size < 27) /* the size is fixed: 26 chars + \0 */
3643 return NULL;
3644
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003645 gmt_offset = get_gmt_offset(t, tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003646
Yuxans Yao4e25b012012-10-19 10:36:09 +08003647 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003648 if (!dst)
3649 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003650 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003651
Yuxans Yao4e25b012012-10-19 10:36:09 +08003652 memcpy(dst, monthname[tm->tm_mon], 3); // month
3653 dst += 3;
3654 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003655
Yuxans Yao4e25b012012-10-19 10:36:09 +08003656 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003657 if (!dst)
3658 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003659 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003660
Yuxans Yao4e25b012012-10-19 10:36:09 +08003661 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003662 if (!dst)
3663 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003664 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003665
Yuxans Yao4e25b012012-10-19 10:36:09 +08003666 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003667 if (!dst)
3668 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003669 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003670
Yuxans Yao4e25b012012-10-19 10:36:09 +08003671 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003672 if (!dst)
3673 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003674 *dst++ = ' ';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003675
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003676 memcpy(dst, gmt_offset, 5); // Offset from local time to GMT
Yuxans Yao4e25b012012-10-19 10:36:09 +08003677 dst += 5;
3678 *dst = '\0';
3679
3680 return dst;
3681}
3682
Willy Tarreaucb1949b2017-07-19 19:05:29 +02003683/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
3684 * It is meant as a portable replacement for timegm() for use with valid inputs.
3685 * Returns undefined results for invalid dates (eg: months out of range 0..11).
3686 */
3687time_t my_timegm(const struct tm *tm)
3688{
3689 /* Each month has 28, 29, 30 or 31 days, or 28+N. The date in the year
3690 * is thus (current month - 1)*28 + cumulated_N[month] to count the
3691 * sum of the extra N days for elapsed months. The sum of all these N
3692 * days doesn't exceed 30 for a complete year (366-12*28) so it fits
3693 * in a 5-bit word. This means that with 60 bits we can represent a
3694 * matrix of all these values at once, which is fast and efficient to
3695 * access. The extra February day for leap years is not counted here.
3696 *
3697 * Jan : none = 0 (0)
3698 * Feb : Jan = 3 (3)
3699 * Mar : Jan..Feb = 3 (3 + 0)
3700 * Apr : Jan..Mar = 6 (3 + 0 + 3)
3701 * May : Jan..Apr = 8 (3 + 0 + 3 + 2)
3702 * Jun : Jan..May = 11 (3 + 0 + 3 + 2 + 3)
3703 * Jul : Jan..Jun = 13 (3 + 0 + 3 + 2 + 3 + 2)
3704 * Aug : Jan..Jul = 16 (3 + 0 + 3 + 2 + 3 + 2 + 3)
3705 * Sep : Jan..Aug = 19 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3)
3706 * Oct : Jan..Sep = 21 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2)
3707 * Nov : Jan..Oct = 24 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3)
3708 * Dec : Jan..Nov = 26 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3 + 2)
3709 */
3710 uint64_t extra =
3711 ( 0ULL << 0*5) + ( 3ULL << 1*5) + ( 3ULL << 2*5) + /* Jan, Feb, Mar, */
3712 ( 6ULL << 3*5) + ( 8ULL << 4*5) + (11ULL << 5*5) + /* Apr, May, Jun, */
3713 (13ULL << 6*5) + (16ULL << 7*5) + (19ULL << 8*5) + /* Jul, Aug, Sep, */
3714 (21ULL << 9*5) + (24ULL << 10*5) + (26ULL << 11*5); /* Oct, Nov, Dec, */
3715
3716 unsigned int y = tm->tm_year + 1900;
3717 unsigned int m = tm->tm_mon;
3718 unsigned long days = 0;
3719
3720 /* days since 1/1/1970 for full years */
3721 days += days_since_zero(y) - days_since_zero(1970);
3722
3723 /* days for full months in the current year */
3724 days += 28 * m + ((extra >> (m * 5)) & 0x1f);
3725
3726 /* count + 1 after March for leap years. A leap year is a year multiple
3727 * of 4, unless it's multiple of 100 without being multiple of 400. 2000
3728 * is leap, 1900 isn't, 1904 is.
3729 */
3730 if ((m > 1) && !(y & 3) && ((y % 100) || !(y % 400)))
3731 days++;
3732
3733 days += tm->tm_mday - 1;
3734 return days * 86400ULL + tm->tm_hour * 3600 + tm->tm_min * 60 + tm->tm_sec;
3735}
3736
Thierry Fournier93127942016-01-20 18:49:45 +01003737/* This function check a char. It returns true and updates
3738 * <date> and <len> pointer to the new position if the
3739 * character is found.
3740 */
3741static inline int parse_expect_char(const char **date, int *len, char c)
3742{
3743 if (*len < 1 || **date != c)
3744 return 0;
3745 (*len)--;
3746 (*date)++;
3747 return 1;
3748}
3749
3750/* This function expects a string <str> of len <l>. It return true and updates.
3751 * <date> and <len> if the string matches, otherwise, it returns false.
3752 */
3753static inline int parse_strcmp(const char **date, int *len, char *str, int l)
3754{
3755 if (*len < l || strncmp(*date, str, l) != 0)
3756 return 0;
3757 (*len) -= l;
3758 (*date) += l;
3759 return 1;
3760}
3761
3762/* This macro converts 3 chars name in integer. */
3763#define STR2I3(__a, __b, __c) ((__a) * 65536 + (__b) * 256 + (__c))
3764
3765/* day-name = %x4D.6F.6E ; "Mon", case-sensitive
3766 * / %x54.75.65 ; "Tue", case-sensitive
3767 * / %x57.65.64 ; "Wed", case-sensitive
3768 * / %x54.68.75 ; "Thu", case-sensitive
3769 * / %x46.72.69 ; "Fri", case-sensitive
3770 * / %x53.61.74 ; "Sat", case-sensitive
3771 * / %x53.75.6E ; "Sun", case-sensitive
3772 *
3773 * This array must be alphabetically sorted
3774 */
3775static inline int parse_http_dayname(const char **date, int *len, struct tm *tm)
3776{
3777 if (*len < 3)
3778 return 0;
3779 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3780 case STR2I3('M','o','n'): tm->tm_wday = 1; break;
3781 case STR2I3('T','u','e'): tm->tm_wday = 2; break;
3782 case STR2I3('W','e','d'): tm->tm_wday = 3; break;
3783 case STR2I3('T','h','u'): tm->tm_wday = 4; break;
3784 case STR2I3('F','r','i'): tm->tm_wday = 5; break;
3785 case STR2I3('S','a','t'): tm->tm_wday = 6; break;
3786 case STR2I3('S','u','n'): tm->tm_wday = 7; break;
3787 default: return 0;
3788 }
3789 *len -= 3;
3790 *date += 3;
3791 return 1;
3792}
3793
3794/* month = %x4A.61.6E ; "Jan", case-sensitive
3795 * / %x46.65.62 ; "Feb", case-sensitive
3796 * / %x4D.61.72 ; "Mar", case-sensitive
3797 * / %x41.70.72 ; "Apr", case-sensitive
3798 * / %x4D.61.79 ; "May", case-sensitive
3799 * / %x4A.75.6E ; "Jun", case-sensitive
3800 * / %x4A.75.6C ; "Jul", case-sensitive
3801 * / %x41.75.67 ; "Aug", case-sensitive
3802 * / %x53.65.70 ; "Sep", case-sensitive
3803 * / %x4F.63.74 ; "Oct", case-sensitive
3804 * / %x4E.6F.76 ; "Nov", case-sensitive
3805 * / %x44.65.63 ; "Dec", case-sensitive
3806 *
3807 * This array must be alphabetically sorted
3808 */
3809static inline int parse_http_monthname(const char **date, int *len, struct tm *tm)
3810{
3811 if (*len < 3)
3812 return 0;
3813 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3814 case STR2I3('J','a','n'): tm->tm_mon = 0; break;
3815 case STR2I3('F','e','b'): tm->tm_mon = 1; break;
3816 case STR2I3('M','a','r'): tm->tm_mon = 2; break;
3817 case STR2I3('A','p','r'): tm->tm_mon = 3; break;
3818 case STR2I3('M','a','y'): tm->tm_mon = 4; break;
3819 case STR2I3('J','u','n'): tm->tm_mon = 5; break;
3820 case STR2I3('J','u','l'): tm->tm_mon = 6; break;
3821 case STR2I3('A','u','g'): tm->tm_mon = 7; break;
3822 case STR2I3('S','e','p'): tm->tm_mon = 8; break;
3823 case STR2I3('O','c','t'): tm->tm_mon = 9; break;
3824 case STR2I3('N','o','v'): tm->tm_mon = 10; break;
3825 case STR2I3('D','e','c'): tm->tm_mon = 11; break;
3826 default: return 0;
3827 }
3828 *len -= 3;
3829 *date += 3;
3830 return 1;
3831}
3832
3833/* day-name-l = %x4D.6F.6E.64.61.79 ; "Monday", case-sensitive
3834 * / %x54.75.65.73.64.61.79 ; "Tuesday", case-sensitive
3835 * / %x57.65.64.6E.65.73.64.61.79 ; "Wednesday", case-sensitive
3836 * / %x54.68.75.72.73.64.61.79 ; "Thursday", case-sensitive
3837 * / %x46.72.69.64.61.79 ; "Friday", case-sensitive
3838 * / %x53.61.74.75.72.64.61.79 ; "Saturday", case-sensitive
3839 * / %x53.75.6E.64.61.79 ; "Sunday", case-sensitive
3840 *
3841 * This array must be alphabetically sorted
3842 */
3843static inline int parse_http_ldayname(const char **date, int *len, struct tm *tm)
3844{
3845 if (*len < 6) /* Minimum length. */
3846 return 0;
3847 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3848 case STR2I3('M','o','n'):
3849 RET0_UNLESS(parse_strcmp(date, len, "Monday", 6));
3850 tm->tm_wday = 1;
3851 return 1;
3852 case STR2I3('T','u','e'):
3853 RET0_UNLESS(parse_strcmp(date, len, "Tuesday", 7));
3854 tm->tm_wday = 2;
3855 return 1;
3856 case STR2I3('W','e','d'):
3857 RET0_UNLESS(parse_strcmp(date, len, "Wednesday", 9));
3858 tm->tm_wday = 3;
3859 return 1;
3860 case STR2I3('T','h','u'):
3861 RET0_UNLESS(parse_strcmp(date, len, "Thursday", 8));
3862 tm->tm_wday = 4;
3863 return 1;
3864 case STR2I3('F','r','i'):
3865 RET0_UNLESS(parse_strcmp(date, len, "Friday", 6));
3866 tm->tm_wday = 5;
3867 return 1;
3868 case STR2I3('S','a','t'):
3869 RET0_UNLESS(parse_strcmp(date, len, "Saturday", 8));
3870 tm->tm_wday = 6;
3871 return 1;
3872 case STR2I3('S','u','n'):
3873 RET0_UNLESS(parse_strcmp(date, len, "Sunday", 6));
3874 tm->tm_wday = 7;
3875 return 1;
3876 }
3877 return 0;
3878}
3879
3880/* This function parses exactly 1 digit and returns the numeric value in "digit". */
3881static inline int parse_digit(const char **date, int *len, int *digit)
3882{
3883 if (*len < 1 || **date < '0' || **date > '9')
3884 return 0;
3885 *digit = (**date - '0');
3886 (*date)++;
3887 (*len)--;
3888 return 1;
3889}
3890
3891/* This function parses exactly 2 digits and returns the numeric value in "digit". */
3892static inline int parse_2digit(const char **date, int *len, int *digit)
3893{
3894 int value;
3895
3896 RET0_UNLESS(parse_digit(date, len, &value));
3897 (*digit) = value * 10;
3898 RET0_UNLESS(parse_digit(date, len, &value));
3899 (*digit) += value;
3900
3901 return 1;
3902}
3903
3904/* This function parses exactly 4 digits and returns the numeric value in "digit". */
3905static inline int parse_4digit(const char **date, int *len, int *digit)
3906{
3907 int value;
3908
3909 RET0_UNLESS(parse_digit(date, len, &value));
3910 (*digit) = value * 1000;
3911
3912 RET0_UNLESS(parse_digit(date, len, &value));
3913 (*digit) += value * 100;
3914
3915 RET0_UNLESS(parse_digit(date, len, &value));
3916 (*digit) += value * 10;
3917
3918 RET0_UNLESS(parse_digit(date, len, &value));
3919 (*digit) += value;
3920
3921 return 1;
3922}
3923
3924/* time-of-day = hour ":" minute ":" second
3925 * ; 00:00:00 - 23:59:60 (leap second)
3926 *
3927 * hour = 2DIGIT
3928 * minute = 2DIGIT
3929 * second = 2DIGIT
3930 */
3931static inline int parse_http_time(const char **date, int *len, struct tm *tm)
3932{
3933 RET0_UNLESS(parse_2digit(date, len, &tm->tm_hour)); /* hour 2DIGIT */
3934 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3935 RET0_UNLESS(parse_2digit(date, len, &tm->tm_min)); /* min 2DIGIT */
3936 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3937 RET0_UNLESS(parse_2digit(date, len, &tm->tm_sec)); /* sec 2DIGIT */
3938 return 1;
3939}
3940
3941/* From RFC7231
3942 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3943 *
3944 * IMF-fixdate = day-name "," SP date1 SP time-of-day SP GMT
3945 * ; fixed length/zone/capitalization subset of the format
3946 * ; see Section 3.3 of [RFC5322]
3947 *
3948 *
3949 * date1 = day SP month SP year
3950 * ; e.g., 02 Jun 1982
3951 *
3952 * day = 2DIGIT
3953 * year = 4DIGIT
3954 *
3955 * GMT = %x47.4D.54 ; "GMT", case-sensitive
3956 *
3957 * time-of-day = hour ":" minute ":" second
3958 * ; 00:00:00 - 23:59:60 (leap second)
3959 *
3960 * hour = 2DIGIT
3961 * minute = 2DIGIT
3962 * second = 2DIGIT
3963 *
3964 * DIGIT = decimal 0-9
3965 */
3966int parse_imf_date(const char *date, int len, struct tm *tm)
3967{
David Carlier327298c2016-11-20 10:42:38 +00003968 /* tm_gmtoff, if present, ought to be zero'ed */
3969 memset(tm, 0, sizeof(*tm));
3970
Thierry Fournier93127942016-01-20 18:49:45 +01003971 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3972 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3973 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3974 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3975 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3976 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3977 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3978 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3979 tm->tm_year -= 1900;
3980 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3981 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3982 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3983 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3984 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003985 return 1;
3986}
3987
3988/* From RFC7231
3989 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3990 *
3991 * rfc850-date = day-name-l "," SP date2 SP time-of-day SP GMT
3992 * date2 = day "-" month "-" 2DIGIT
3993 * ; e.g., 02-Jun-82
3994 *
3995 * day = 2DIGIT
3996 */
3997int parse_rfc850_date(const char *date, int len, struct tm *tm)
3998{
3999 int year;
4000
David Carlier327298c2016-11-20 10:42:38 +00004001 /* tm_gmtoff, if present, ought to be zero'ed */
4002 memset(tm, 0, sizeof(*tm));
4003
Thierry Fournier93127942016-01-20 18:49:45 +01004004 RET0_UNLESS(parse_http_ldayname(&date, &len, tm)); /* Read the day name */
4005 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
4006 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
4007 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
4008 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
4009 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
4010 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
4011
4012 /* year = 2DIGIT
4013 *
4014 * Recipients of a timestamp value in rfc850-(*date) format, which uses a
4015 * two-digit year, MUST interpret a timestamp that appears to be more
4016 * than 50 years in the future as representing the most recent year in
4017 * the past that had the same last two digits.
4018 */
4019 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_year));
4020
4021 /* expect SP */
4022 if (!parse_expect_char(&date, &len, ' ')) {
4023 /* Maybe we have the date with 4 digits. */
4024 RET0_UNLESS(parse_2digit(&date, &len, &year));
4025 tm->tm_year = (tm->tm_year * 100 + year) - 1900;
4026 /* expect SP */
4027 RET0_UNLESS(parse_expect_char(&date, &len, ' '));
4028 } else {
4029 /* I fix 60 as pivot: >60: +1900, <60: +2000. Note that the
4030 * tm_year is the number of year since 1900, so for +1900, we
4031 * do nothing, and for +2000, we add 100.
4032 */
4033 if (tm->tm_year <= 60)
4034 tm->tm_year += 100;
4035 }
4036
4037 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
4038 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
4039 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
4040 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01004041
4042 return 1;
4043}
4044
4045/* From RFC7231
4046 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
4047 *
4048 * asctime-date = day-name SP date3 SP time-of-day SP year
4049 * date3 = month SP ( 2DIGIT / ( SP 1DIGIT ))
4050 * ; e.g., Jun 2
4051 *
4052 * HTTP-date is case sensitive. A sender MUST NOT generate additional
4053 * whitespace in an HTTP-date beyond that specifically included as SP in
4054 * the grammar.
4055 */
4056int parse_asctime_date(const char *date, int len, struct tm *tm)
4057{
David Carlier327298c2016-11-20 10:42:38 +00004058 /* tm_gmtoff, if present, ought to be zero'ed */
4059 memset(tm, 0, sizeof(*tm));
4060
Thierry Fournier93127942016-01-20 18:49:45 +01004061 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
4062 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
4063 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* expect month */
4064 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
4065
4066 /* expect SP and 1DIGIT or 2DIGIT */
4067 if (parse_expect_char(&date, &len, ' '))
4068 RET0_UNLESS(parse_digit(&date, &len, &tm->tm_mday));
4069 else
4070 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday));
4071
4072 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
4073 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
4074 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
4075 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
4076 tm->tm_year -= 1900;
4077 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01004078 return 1;
4079}
4080
4081/* From RFC7231
4082 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
4083 *
4084 * HTTP-date = IMF-fixdate / obs-date
4085 * obs-date = rfc850-date / asctime-date
4086 *
4087 * parses an HTTP date in the RFC format and is accepted
4088 * alternatives. <date> is the strinf containing the date,
4089 * len is the len of the string. <tm> is filled with the
4090 * parsed time. We must considers this time as GMT.
4091 */
4092int parse_http_date(const char *date, int len, struct tm *tm)
4093{
4094 if (parse_imf_date(date, len, tm))
4095 return 1;
4096
4097 if (parse_rfc850_date(date, len, tm))
4098 return 1;
4099
4100 if (parse_asctime_date(date, len, tm))
4101 return 1;
4102
4103 return 0;
4104}
4105
Willy Tarreau4deeb102021-01-29 10:47:52 +01004106/* print the time <ns> in a short form (exactly 7 chars) at the end of buffer
4107 * <out>. "-" is printed if the value is zero, "inf" if larger than 1000 years.
4108 * It returns the new buffer length, or 0 if it doesn't fit. The value will be
4109 * surrounded by <pfx> and <sfx> respectively if not NULL.
4110 */
4111int print_time_short(struct buffer *out, const char *pfx, uint64_t ns, const char *sfx)
4112{
4113 double val = ns; // 52 bits of mantissa keep ns accuracy over 52 days
4114 const char *unit;
4115
4116 if (!pfx)
4117 pfx = "";
4118 if (!sfx)
4119 sfx = "";
4120
4121 do {
4122 unit = " - "; if (val <= 0.0) break;
4123 unit = "ns"; if (val < 1000.0) break;
4124 unit = "us"; val /= 1000.0; if (val < 1000.0) break;
4125 unit = "ms"; val /= 1000.0; if (val < 1000.0) break;
4126 unit = "s "; val /= 1000.0; if (val < 60.0) break;
4127 unit = "m "; val /= 60.0; if (val < 60.0) break;
4128 unit = "h "; val /= 60.0; if (val < 24.0) break;
4129 unit = "d "; val /= 24.0; if (val < 365.0) break;
4130 unit = "yr"; val /= 365.0; if (val < 1000.0) break;
4131 unit = " inf "; val = 0.0; break;
4132 } while (0);
4133
4134 if (val <= 0.0)
4135 return chunk_appendf(out, "%s%7s%s", pfx, unit, sfx);
4136 else if (val < 10.0)
4137 return chunk_appendf(out, "%s%1.3f%s%s", pfx, val, unit, sfx);
4138 else if (val < 100.0)
4139 return chunk_appendf(out, "%s%2.2f%s%s", pfx, val, unit, sfx);
4140 else
4141 return chunk_appendf(out, "%s%3.1f%s%s", pfx, val, unit, sfx);
4142}
4143
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004144/* Dynamically allocates a string of the proper length to hold the formatted
4145 * output. NULL is returned on error. The caller is responsible for freeing the
4146 * memory area using free(). The resulting string is returned in <out> if the
4147 * pointer is not NULL. A previous version of <out> might be used to build the
4148 * new string, and it will be freed before returning if it is not NULL, which
4149 * makes it possible to build complex strings from iterative calls without
4150 * having to care about freeing intermediate values, as in the example below :
4151 *
4152 * memprintf(&err, "invalid argument: '%s'", arg);
4153 * ...
4154 * memprintf(&err, "parser said : <%s>\n", *err);
4155 * ...
4156 * free(*err);
4157 *
4158 * This means that <err> must be initialized to NULL before first invocation.
4159 * The return value also holds the allocated string, which eases error checking
4160 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02004161 * passed instead and it will be ignored. The returned message will then also
4162 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004163 *
4164 * It is also convenient to use it without any free except the last one :
4165 * err = NULL;
4166 * if (!fct1(err)) report(*err);
4167 * if (!fct2(err)) report(*err);
4168 * if (!fct3(err)) report(*err);
4169 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02004170 *
4171 * memprintf relies on memvprintf. This last version can be called from any
4172 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004173 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02004174char *memvprintf(char **out, const char *format, va_list orig_args)
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004175{
4176 va_list args;
4177 char *ret = NULL;
4178 int allocated = 0;
4179 int needed = 0;
4180
Willy Tarreaueb6cead2012-09-20 19:43:14 +02004181 if (!out)
4182 return NULL;
4183
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004184 do {
Willy Tarreaue0609f52019-03-29 19:13:23 +01004185 char buf1;
4186
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004187 /* vsnprintf() will return the required length even when the
4188 * target buffer is NULL. We do this in a loop just in case
4189 * intermediate evaluations get wrong.
4190 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02004191 va_copy(args, orig_args);
Willy Tarreaue0609f52019-03-29 19:13:23 +01004192 needed = vsnprintf(ret ? ret : &buf1, allocated, format, args);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004193 va_end(args);
Willy Tarreau1b2fed62013-04-01 22:48:54 +02004194 if (needed < allocated) {
4195 /* Note: on Solaris 8, the first iteration always
4196 * returns -1 if allocated is zero, so we force a
4197 * retry.
4198 */
4199 if (!allocated)
4200 needed = 0;
4201 else
4202 break;
4203 }
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004204
Willy Tarreau1b2fed62013-04-01 22:48:54 +02004205 allocated = needed + 1;
Hubert Verstraete831962e2016-06-28 22:44:26 +02004206 ret = my_realloc2(ret, allocated);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004207 } while (ret);
4208
4209 if (needed < 0) {
4210 /* an error was encountered */
Willy Tarreau61cfdf42021-02-20 10:46:51 +01004211 ha_free(&ret);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004212 }
4213
4214 if (out) {
4215 free(*out);
4216 *out = ret;
4217 }
4218
4219 return ret;
4220}
William Lallemand421f5b52012-02-06 18:15:57 +01004221
Christopher Faulet93a518f2017-10-24 11:25:33 +02004222char *memprintf(char **out, const char *format, ...)
4223{
4224 va_list args;
4225 char *ret = NULL;
4226
4227 va_start(args, format);
4228 ret = memvprintf(out, format, args);
4229 va_end(args);
4230
4231 return ret;
4232}
4233
Willy Tarreau21c705b2012-09-14 11:40:36 +02004234/* Used to add <level> spaces before each line of <out>, unless there is only one line.
4235 * The input argument is automatically freed and reassigned. The result will have to be
Willy Tarreau70eec382012-10-10 08:56:47 +02004236 * freed by the caller. It also supports being passed a NULL which results in the same
4237 * output.
Willy Tarreau21c705b2012-09-14 11:40:36 +02004238 * Example of use :
4239 * parse(cmd, &err); (callee: memprintf(&err, ...))
4240 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
4241 * free(err);
4242 */
4243char *indent_msg(char **out, int level)
4244{
4245 char *ret, *in, *p;
4246 int needed = 0;
4247 int lf = 0;
4248 int lastlf = 0;
4249 int len;
4250
Willy Tarreau70eec382012-10-10 08:56:47 +02004251 if (!out || !*out)
4252 return NULL;
4253
Willy Tarreau21c705b2012-09-14 11:40:36 +02004254 in = *out - 1;
4255 while ((in = strchr(in + 1, '\n')) != NULL) {
4256 lastlf = in - *out;
4257 lf++;
4258 }
4259
4260 if (!lf) /* single line, no LF, return it as-is */
4261 return *out;
4262
4263 len = strlen(*out);
4264
4265 if (lf == 1 && lastlf == len - 1) {
4266 /* single line, LF at end, strip it and return as-is */
4267 (*out)[lastlf] = 0;
4268 return *out;
4269 }
4270
4271 /* OK now we have at least one LF, we need to process the whole string
4272 * as a multi-line string. What we'll do :
4273 * - prefix with an LF if there is none
4274 * - add <level> spaces before each line
4275 * This means at most ( 1 + level + (len-lf) + lf*<1+level) ) =
4276 * 1 + level + len + lf * level = 1 + level * (lf + 1) + len.
4277 */
4278
4279 needed = 1 + level * (lf + 1) + len + 1;
4280 p = ret = malloc(needed);
4281 in = *out;
4282
4283 /* skip initial LFs */
4284 while (*in == '\n')
4285 in++;
4286
4287 /* copy each line, prefixed with LF and <level> spaces, and without the trailing LF */
4288 while (*in) {
4289 *p++ = '\n';
4290 memset(p, ' ', level);
4291 p += level;
4292 do {
4293 *p++ = *in++;
4294 } while (*in && *in != '\n');
4295 if (*in)
4296 in++;
4297 }
4298 *p = 0;
4299
4300 free(*out);
4301 *out = ret;
4302
4303 return ret;
4304}
4305
Willy Tarreaua2c99112019-08-21 13:17:37 +02004306/* makes a copy of message <in> into <out>, with each line prefixed with <pfx>
4307 * and end of lines replaced with <eol> if not 0. The first line to indent has
4308 * to be indicated in <first> (starts at zero), so that it is possible to skip
4309 * indenting the first line if it has to be appended after an existing message.
4310 * Empty strings are never indented, and NULL strings are considered empty both
4311 * for <in> and <pfx>. It returns non-zero if an EOL was appended as the last
4312 * character, non-zero otherwise.
4313 */
4314int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first)
4315{
4316 int bol, lf;
4317 int pfxlen = pfx ? strlen(pfx) : 0;
4318
4319 if (!in)
4320 return 0;
4321
4322 bol = 1;
4323 lf = 0;
4324 while (*in) {
4325 if (bol && pfxlen) {
4326 if (first > 0)
4327 first--;
4328 else
4329 b_putblk(out, pfx, pfxlen);
4330 bol = 0;
4331 }
4332
4333 lf = (*in == '\n');
4334 bol |= lf;
4335 b_putchr(out, (lf && eol) ? eol : *in);
4336 in++;
4337 }
4338 return lf;
4339}
4340
Willy Tarreau9d22e562019-03-29 18:49:09 +01004341/* removes environment variable <name> from the environment as found in
4342 * environ. This is only provided as an alternative for systems without
4343 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05004344 * The principle is to scan environ for each occurrence of variable name
Willy Tarreau9d22e562019-03-29 18:49:09 +01004345 * <name> and to replace the matching pointers with the last pointer of
4346 * the array (since variables are not ordered).
4347 * It always returns 0 (success).
4348 */
4349int my_unsetenv(const char *name)
4350{
4351 extern char **environ;
4352 char **p = environ;
4353 int vars;
4354 int next;
4355 int len;
4356
4357 len = strlen(name);
4358 for (vars = 0; p[vars]; vars++)
4359 ;
4360 next = 0;
4361 while (next < vars) {
4362 if (strncmp(p[next], name, len) != 0 || p[next][len] != '=') {
4363 next++;
4364 continue;
4365 }
4366 if (next < vars - 1)
4367 p[next] = p[vars - 1];
4368 p[--vars] = NULL;
4369 }
4370 return 0;
4371}
4372
Willy Tarreaudad36a32013-03-11 01:20:04 +01004373/* Convert occurrences of environment variables in the input string to their
4374 * corresponding value. A variable is identified as a series of alphanumeric
4375 * characters or underscores following a '$' sign. The <in> string must be
4376 * free()able. NULL returns NULL. The resulting string might be reallocated if
4377 * some expansion is made. Variable names may also be enclosed into braces if
4378 * needed (eg: to concatenate alphanum characters).
4379 */
4380char *env_expand(char *in)
4381{
4382 char *txt_beg;
4383 char *out;
4384 char *txt_end;
4385 char *var_beg;
4386 char *var_end;
4387 char *value;
4388 char *next;
4389 int out_len;
4390 int val_len;
4391
4392 if (!in)
4393 return in;
4394
4395 value = out = NULL;
4396 out_len = 0;
4397
4398 txt_beg = in;
4399 do {
4400 /* look for next '$' sign in <in> */
4401 for (txt_end = txt_beg; *txt_end && *txt_end != '$'; txt_end++);
4402
4403 if (!*txt_end && !out) /* end and no expansion performed */
4404 return in;
4405
4406 val_len = 0;
4407 next = txt_end;
4408 if (*txt_end == '$') {
4409 char save;
4410
4411 var_beg = txt_end + 1;
4412 if (*var_beg == '{')
4413 var_beg++;
4414
4415 var_end = var_beg;
Willy Tarreau90807112020-02-25 08:16:33 +01004416 while (isalnum((unsigned char)*var_end) || *var_end == '_') {
Willy Tarreaudad36a32013-03-11 01:20:04 +01004417 var_end++;
4418 }
4419
4420 next = var_end;
4421 if (*var_end == '}' && (var_beg > txt_end + 1))
4422 next++;
4423
4424 /* get value of the variable name at this location */
4425 save = *var_end;
4426 *var_end = '\0';
4427 value = getenv(var_beg);
4428 *var_end = save;
4429 val_len = value ? strlen(value) : 0;
4430 }
4431
Hubert Verstraete831962e2016-06-28 22:44:26 +02004432 out = my_realloc2(out, out_len + (txt_end - txt_beg) + val_len + 1);
Willy Tarreaudad36a32013-03-11 01:20:04 +01004433 if (txt_end > txt_beg) {
4434 memcpy(out + out_len, txt_beg, txt_end - txt_beg);
4435 out_len += txt_end - txt_beg;
4436 }
4437 if (val_len) {
4438 memcpy(out + out_len, value, val_len);
4439 out_len += val_len;
4440 }
4441 out[out_len] = 0;
4442 txt_beg = next;
4443 } while (*txt_beg);
4444
4445 /* here we know that <out> was allocated and that we don't need <in> anymore */
4446 free(in);
4447 return out;
4448}
4449
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004450
4451/* same as strstr() but case-insensitive and with limit length */
4452const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2)
4453{
4454 char *pptr, *sptr, *start;
Willy Tarreauc8746532014-05-28 23:05:07 +02004455 unsigned int slen, plen;
4456 unsigned int tmp1, tmp2;
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004457
4458 if (str1 == NULL || len_str1 == 0) // search pattern into an empty string => search is not found
4459 return NULL;
4460
4461 if (str2 == NULL || len_str2 == 0) // pattern is empty => every str1 match
4462 return str1;
4463
4464 if (len_str1 < len_str2) // pattern is longer than string => search is not found
4465 return NULL;
4466
4467 for (tmp1 = 0, start = (char *)str1, pptr = (char *)str2, slen = len_str1, plen = len_str2; slen >= plen; start++, slen--) {
Willy Tarreauf278eec2020-07-05 21:46:32 +02004468 while (toupper((unsigned char)*start) != toupper((unsigned char)*str2)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004469 start++;
4470 slen--;
4471 tmp1++;
4472
4473 if (tmp1 >= len_str1)
4474 return NULL;
4475
4476 /* if pattern longer than string */
4477 if (slen < plen)
4478 return NULL;
4479 }
4480
4481 sptr = start;
4482 pptr = (char *)str2;
4483
4484 tmp2 = 0;
Willy Tarreauf278eec2020-07-05 21:46:32 +02004485 while (toupper((unsigned char)*sptr) == toupper((unsigned char)*pptr)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004486 sptr++;
4487 pptr++;
4488 tmp2++;
4489
4490 if (*pptr == '\0' || tmp2 == len_str2) /* end of pattern found */
4491 return start;
4492 if (*sptr == '\0' || tmp2 == len_str1) /* end of string found and the pattern is not fully found */
4493 return NULL;
4494 }
4495 }
4496 return NULL;
4497}
4498
Willy Tarreau3ff476e2022-03-30 10:02:56 +02004499/* Returns true if s1 < s2 < s3 otherwise zero. Both s1 and s3 may be NULL and
4500 * in this case only non-null strings are compared. This allows to pass initial
4501 * values in iterators and in sort functions.
4502 */
4503int strordered(const char *s1, const char *s2, const char *s3)
4504{
4505 return (!s1 || strcmp(s1, s2) < 0) && (!s3 || strcmp(s2, s3) < 0);
4506}
4507
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004508/* This function read the next valid utf8 char.
4509 * <s> is the byte srray to be decode, <len> is its length.
4510 * The function returns decoded char encoded like this:
4511 * The 4 msb are the return code (UTF8_CODE_*), the 4 lsb
4512 * are the length read. The decoded character is stored in <c>.
4513 */
4514unsigned char utf8_next(const char *s, int len, unsigned int *c)
4515{
4516 const unsigned char *p = (unsigned char *)s;
4517 int dec;
4518 unsigned char code = UTF8_CODE_OK;
4519
4520 if (len < 1)
4521 return UTF8_CODE_OK;
4522
4523 /* Check the type of UTF8 sequence
4524 *
4525 * 0... .... 0x00 <= x <= 0x7f : 1 byte: ascii char
4526 * 10.. .... 0x80 <= x <= 0xbf : invalid sequence
4527 * 110. .... 0xc0 <= x <= 0xdf : 2 bytes
4528 * 1110 .... 0xe0 <= x <= 0xef : 3 bytes
4529 * 1111 0... 0xf0 <= x <= 0xf7 : 4 bytes
4530 * 1111 10.. 0xf8 <= x <= 0xfb : 5 bytes
4531 * 1111 110. 0xfc <= x <= 0xfd : 6 bytes
4532 * 1111 111. 0xfe <= x <= 0xff : invalid sequence
4533 */
4534 switch (*p) {
4535 case 0x00 ... 0x7f:
4536 *c = *p;
4537 return UTF8_CODE_OK | 1;
4538
4539 case 0x80 ... 0xbf:
4540 *c = *p;
4541 return UTF8_CODE_BADSEQ | 1;
4542
4543 case 0xc0 ... 0xdf:
4544 if (len < 2) {
4545 *c = *p;
4546 return UTF8_CODE_BADSEQ | 1;
4547 }
4548 *c = *p & 0x1f;
4549 dec = 1;
4550 break;
4551
4552 case 0xe0 ... 0xef:
4553 if (len < 3) {
4554 *c = *p;
4555 return UTF8_CODE_BADSEQ | 1;
4556 }
4557 *c = *p & 0x0f;
4558 dec = 2;
4559 break;
4560
4561 case 0xf0 ... 0xf7:
4562 if (len < 4) {
4563 *c = *p;
4564 return UTF8_CODE_BADSEQ | 1;
4565 }
4566 *c = *p & 0x07;
4567 dec = 3;
4568 break;
4569
4570 case 0xf8 ... 0xfb:
4571 if (len < 5) {
4572 *c = *p;
4573 return UTF8_CODE_BADSEQ | 1;
4574 }
4575 *c = *p & 0x03;
4576 dec = 4;
4577 break;
4578
4579 case 0xfc ... 0xfd:
4580 if (len < 6) {
4581 *c = *p;
4582 return UTF8_CODE_BADSEQ | 1;
4583 }
4584 *c = *p & 0x01;
4585 dec = 5;
4586 break;
4587
4588 case 0xfe ... 0xff:
4589 default:
4590 *c = *p;
4591 return UTF8_CODE_BADSEQ | 1;
4592 }
4593
4594 p++;
4595
4596 while (dec > 0) {
4597
4598 /* need 0x10 for the 2 first bits */
4599 if ( ( *p & 0xc0 ) != 0x80 )
4600 return UTF8_CODE_BADSEQ | ((p-(unsigned char *)s)&0xffff);
4601
4602 /* add data at char */
4603 *c = ( *c << 6 ) | ( *p & 0x3f );
4604
4605 dec--;
4606 p++;
4607 }
4608
4609 /* Check ovelong encoding.
4610 * 1 byte : 5 + 6 : 11 : 0x80 ... 0x7ff
4611 * 2 bytes : 4 + 6 + 6 : 16 : 0x800 ... 0xffff
4612 * 3 bytes : 3 + 6 + 6 + 6 : 21 : 0x10000 ... 0x1fffff
4613 */
Thierry FOURNIER9e7ec082015-03-12 19:32:38 +01004614 if (( *c <= 0x7f && (p-(unsigned char *)s) > 1) ||
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004615 (*c >= 0x80 && *c <= 0x7ff && (p-(unsigned char *)s) > 2) ||
4616 (*c >= 0x800 && *c <= 0xffff && (p-(unsigned char *)s) > 3) ||
4617 (*c >= 0x10000 && *c <= 0x1fffff && (p-(unsigned char *)s) > 4))
4618 code |= UTF8_CODE_OVERLONG;
4619
4620 /* Check invalid UTF8 range. */
4621 if ((*c >= 0xd800 && *c <= 0xdfff) ||
4622 (*c >= 0xfffe && *c <= 0xffff))
4623 code |= UTF8_CODE_INVRANGE;
4624
4625 return code | ((p-(unsigned char *)s)&0x0f);
4626}
4627
Maxime de Roucydc887852016-05-13 23:52:54 +02004628/* append a copy of string <str> (in a wordlist) at the end of the list <li>
4629 * On failure : return 0 and <err> filled with an error message.
4630 * The caller is responsible for freeing the <err> and <str> copy
4631 * memory area using free()
4632 */
4633int list_append_word(struct list *li, const char *str, char **err)
4634{
4635 struct wordlist *wl;
4636
4637 wl = calloc(1, sizeof(*wl));
4638 if (!wl) {
4639 memprintf(err, "out of memory");
4640 goto fail_wl;
4641 }
4642
4643 wl->s = strdup(str);
4644 if (!wl->s) {
4645 memprintf(err, "out of memory");
4646 goto fail_wl_s;
4647 }
4648
Willy Tarreau2b718102021-04-21 07:32:39 +02004649 LIST_APPEND(li, &wl->list);
Maxime de Roucydc887852016-05-13 23:52:54 +02004650
4651 return 1;
4652
4653fail_wl_s:
4654 free(wl->s);
4655fail_wl:
4656 free(wl);
4657 return 0;
4658}
4659
Willy Tarreau37101052019-05-20 16:48:20 +02004660/* indicates if a memory location may safely be read or not. The trick consists
4661 * in performing a harmless syscall using this location as an input and letting
4662 * the operating system report whether it's OK or not. For this we have the
4663 * stat() syscall, which will return EFAULT when the memory location supposed
4664 * to contain the file name is not readable. If it is readable it will then
4665 * either return 0 if the area contains an existing file name, or -1 with
4666 * another code. This must not be abused, and some audit systems might detect
4667 * this as abnormal activity. It's used only for unsafe dumps.
4668 */
4669int may_access(const void *ptr)
4670{
4671 struct stat buf;
4672
4673 if (stat(ptr, &buf) == 0)
4674 return 1;
4675 if (errno == EFAULT)
4676 return 0;
4677 return 1;
4678}
4679
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004680/* print a string of text buffer to <out>. The format is :
4681 * Non-printable chars \t, \n, \r and \e are * encoded in C format.
4682 * Other non-printable chars are encoded "\xHH". Space, '\', and '=' are also escaped.
4683 * Print stopped if null char or <bsize> is reached, or if no more place in the chunk.
4684 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004685int dump_text(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004686{
4687 unsigned char c;
Tim Duesterhus18795d42021-08-29 00:58:22 +02004688 size_t ptr = 0;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004689
Tim Duesterhus18795d42021-08-29 00:58:22 +02004690 while (ptr < bsize && buf[ptr]) {
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004691 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004692 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\' && c != ' ' && c != '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004693 if (out->data > out->size - 1)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004694 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004695 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004696 }
4697 else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\' || c == ' ' || c == '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004698 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004699 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004700 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004701 switch (c) {
4702 case ' ': c = ' '; break;
4703 case '\t': c = 't'; break;
4704 case '\n': c = 'n'; break;
4705 case '\r': c = 'r'; break;
4706 case '\e': c = 'e'; break;
4707 case '\\': c = '\\'; break;
4708 case '=': c = '='; break;
4709 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004710 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004711 }
4712 else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004713 if (out->data > out->size - 4)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004714 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004715 out->area[out->data++] = '\\';
4716 out->area[out->data++] = 'x';
4717 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4718 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004719 }
4720 ptr++;
4721 }
4722
4723 return ptr;
4724}
4725
4726/* print a buffer in hexa.
4727 * Print stopped if <bsize> is reached, or if no more place in the chunk.
4728 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004729int dump_binary(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004730{
4731 unsigned char c;
4732 int ptr = 0;
4733
4734 while (ptr < bsize) {
4735 c = buf[ptr];
4736
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004737 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004738 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004739 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4740 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004741
4742 ptr++;
4743 }
4744 return ptr;
4745}
4746
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004747/* Appends into buffer <out> a hex dump of memory area <buf> for <len> bytes,
4748 * prepending each line with prefix <pfx>. The output is *not* initialized.
4749 * The output will not wrap pas the buffer's end so it is more optimal if the
4750 * caller makes sure the buffer is aligned first. A trailing zero will always
4751 * be appended (and not counted) if there is room for it. The caller must make
Willy Tarreau37101052019-05-20 16:48:20 +02004752 * sure that the area is dumpable first. If <unsafe> is non-null, the memory
4753 * locations are checked first for being readable.
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004754 */
Willy Tarreau37101052019-05-20 16:48:20 +02004755void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe)
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004756{
4757 const unsigned char *d = buf;
4758 int i, j, start;
4759
4760 d = (const unsigned char *)(((unsigned long)buf) & -16);
4761 start = ((unsigned long)buf) & 15;
4762
4763 for (i = 0; i < start + len; i += 16) {
4764 chunk_appendf(out, (sizeof(void *) == 4) ? "%s%8p: " : "%s%16p: ", pfx, d + i);
4765
Willy Tarreau37101052019-05-20 16:48:20 +02004766 // 0: unchecked, 1: checked safe, 2: danger
4767 unsafe = !!unsafe;
4768 if (unsafe && !may_access(d + i))
4769 unsafe = 2;
4770
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004771 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004772 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004773 chunk_strcat(out, "'' ");
Willy Tarreau37101052019-05-20 16:48:20 +02004774 else if (unsafe > 1)
4775 chunk_strcat(out, "** ");
4776 else
4777 chunk_appendf(out, "%02x ", d[i + j]);
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004778
4779 if (j == 7)
4780 chunk_strcat(out, "- ");
4781 }
4782 chunk_strcat(out, " ");
4783 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004784 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004785 chunk_strcat(out, "'");
Willy Tarreau37101052019-05-20 16:48:20 +02004786 else if (unsafe > 1)
4787 chunk_strcat(out, "*");
Willy Tarreau90807112020-02-25 08:16:33 +01004788 else if (isprint((unsigned char)d[i + j]))
Willy Tarreau37101052019-05-20 16:48:20 +02004789 chunk_appendf(out, "%c", d[i + j]);
4790 else
4791 chunk_strcat(out, ".");
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004792 }
4793 chunk_strcat(out, "\n");
4794 }
4795}
4796
Willy Tarreau762fb3e2020-03-03 15:57:10 +01004797/* dumps <pfx> followed by <n> bytes from <addr> in hex form into buffer <buf>
4798 * enclosed in brackets after the address itself, formatted on 14 chars
4799 * including the "0x" prefix. This is meant to be used as a prefix for code
4800 * areas. For example:
4801 * "0x7f10b6557690 [48 c7 c0 0f 00 00 00 0f]"
4802 * It relies on may_access() to know if the bytes are dumpable, otherwise "--"
4803 * is emitted. A NULL <pfx> will be considered empty.
4804 */
4805void dump_addr_and_bytes(struct buffer *buf, const char *pfx, const void *addr, int n)
4806{
4807 int ok = 0;
4808 int i;
4809
4810 chunk_appendf(buf, "%s%#14lx [", pfx ? pfx : "", (long)addr);
4811
4812 for (i = 0; i < n; i++) {
4813 if (i == 0 || (((long)(addr + i) ^ (long)(addr)) & 4096))
4814 ok = may_access(addr + i);
4815 if (ok)
4816 chunk_appendf(buf, "%02x%s", ((uint8_t*)addr)[i], (i<n-1) ? " " : "]");
4817 else
4818 chunk_appendf(buf, "--%s", (i<n-1) ? " " : "]");
4819 }
4820}
4821
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004822/* print a line of text buffer (limited to 70 bytes) to <out>. The format is :
4823 * <2 spaces> <offset=5 digits> <space or plus> <space> <70 chars max> <\n>
4824 * which is 60 chars per line. Non-printable chars \t, \n, \r and \e are
4825 * encoded in C format. Other non-printable chars are encoded "\xHH". Original
4826 * lines are respected within the limit of 70 output chars. Lines that are
4827 * continuation of a previous truncated line begin with "+" instead of " "
4828 * after the offset. The new pointer is returned.
4829 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004830int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004831 int *line, int ptr)
4832{
4833 int end;
4834 unsigned char c;
4835
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004836 end = out->data + 80;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004837 if (end > out->size)
4838 return ptr;
4839
4840 chunk_appendf(out, " %05d%c ", ptr, (ptr == *line) ? ' ' : '+');
4841
4842 while (ptr < len && ptr < bsize) {
4843 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004844 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004845 if (out->data > end - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004846 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004847 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004848 } else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004849 if (out->data > end - 3)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004850 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004851 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004852 switch (c) {
4853 case '\t': c = 't'; break;
4854 case '\n': c = 'n'; break;
4855 case '\r': c = 'r'; break;
4856 case '\e': c = 'e'; break;
4857 case '\\': c = '\\'; break;
4858 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004859 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004860 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004861 if (out->data > end - 5)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004862 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004863 out->area[out->data++] = '\\';
4864 out->area[out->data++] = 'x';
4865 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4866 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004867 }
4868 if (buf[ptr++] == '\n') {
4869 /* we had a line break, let's return now */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004870 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004871 *line = ptr;
4872 return ptr;
4873 }
4874 }
4875 /* we have an incomplete line, we return it as-is */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004876 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004877 return ptr;
4878}
4879
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004880/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02004881 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
4882 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004883 */
Willy Tarreaued936c52017-04-27 18:03:20 +02004884void debug_hexdump(FILE *out, const char *pfx, const char *buf,
4885 unsigned int baseaddr, int len)
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004886{
Willy Tarreau73459792017-04-11 07:58:08 +02004887 unsigned int i;
4888 int b, j;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004889
4890 for (i = 0; i < (len + (baseaddr & 15)); i += 16) {
4891 b = i - (baseaddr & 15);
Willy Tarreaued936c52017-04-27 18:03:20 +02004892 fprintf(out, "%s%08x: ", pfx ? pfx : "", i + (baseaddr & ~15));
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004893 for (j = 0; j < 8; j++) {
4894 if (b + j >= 0 && b + j < len)
4895 fprintf(out, "%02x ", (unsigned char)buf[b + j]);
4896 else
4897 fprintf(out, " ");
4898 }
4899
4900 if (b + j >= 0 && b + j < len)
4901 fputc('-', out);
4902 else
4903 fputc(' ', out);
4904
4905 for (j = 8; j < 16; j++) {
4906 if (b + j >= 0 && b + j < len)
4907 fprintf(out, " %02x", (unsigned char)buf[b + j]);
4908 else
4909 fprintf(out, " ");
4910 }
4911
4912 fprintf(out, " ");
4913 for (j = 0; j < 16; j++) {
4914 if (b + j >= 0 && b + j < len) {
4915 if (isprint((unsigned char)buf[b + j]))
4916 fputc((unsigned char)buf[b + j], out);
4917 else
4918 fputc('.', out);
4919 }
4920 else
4921 fputc(' ', out);
4922 }
4923 fputc('\n', out);
4924 }
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004925}
4926
Willy Tarreaubb869862020-04-16 10:52:41 +02004927/* Tries to report the executable path name on platforms supporting this. If
4928 * not found or not possible, returns NULL.
4929 */
4930const char *get_exec_path()
4931{
4932 const char *ret = NULL;
4933
David Carlier43a56852022-03-04 15:50:48 +00004934#if defined(__linux__) && defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
Willy Tarreaubb869862020-04-16 10:52:41 +02004935 long execfn = getauxval(AT_EXECFN);
4936
4937 if (execfn && execfn != ENOENT)
4938 ret = (const char *)execfn;
devnexen@gmail.comc4e52322021-08-17 12:55:49 +01004939#elif defined(__FreeBSD__)
4940 Elf_Auxinfo *auxv;
4941 for (auxv = __elf_aux_vector; auxv->a_type != AT_NULL; ++auxv) {
4942 if (auxv->a_type == AT_EXECPATH) {
4943 ret = (const char *)auxv->a_un.a_ptr;
4944 break;
4945 }
4946 }
David Carlierbd2cced2021-08-17 08:44:25 +01004947#elif defined(__NetBSD__)
4948 AuxInfo *auxv;
4949 for (auxv = _dlauxinfo(); auxv->a_type != AT_NULL; ++auxv) {
4950 if (auxv->a_type == AT_SUN_EXECNAME) {
4951 ret = (const char *)auxv->a_v;
4952 break;
4953 }
4954 }
David Carlier7198c702022-05-14 17:15:49 +01004955#elif defined(__sun)
4956 ret = getexecname();
Willy Tarreaubb869862020-04-16 10:52:41 +02004957#endif
4958 return ret;
4959}
4960
Baruch Siache1651b22020-07-24 07:52:20 +03004961#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreau9133e482020-03-04 10:19:36 +01004962/* calls dladdr() or dladdr1() on <addr> and <dli>. If dladdr1 is available,
4963 * also returns the symbol size in <size>, otherwise returns 0 there.
4964 */
4965static int dladdr_and_size(const void *addr, Dl_info *dli, size_t *size)
4966{
4967 int ret;
Willy Tarreau7b2108c2021-08-30 10:15:35 +02004968#if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 3)) // most detailed one
Willy Tarreauf3d5c4b2022-01-28 09:42:29 +01004969 const ElfW(Sym) *sym __attribute__((may_alias));
Willy Tarreau9133e482020-03-04 10:19:36 +01004970
4971 ret = dladdr1(addr, dli, (void **)&sym, RTLD_DL_SYMENT);
4972 if (ret)
4973 *size = sym ? sym->st_size : 0;
4974#else
David Carlierae5c42f2021-12-31 08:15:29 +00004975#if defined(__sun)
4976 ret = dladdr((void *)addr, dli);
4977#else
Willy Tarreau9133e482020-03-04 10:19:36 +01004978 ret = dladdr(addr, dli);
David Carlierae5c42f2021-12-31 08:15:29 +00004979#endif
Willy Tarreau9133e482020-03-04 10:19:36 +01004980 *size = 0;
4981#endif
4982 return ret;
4983}
Willy Tarreau64192392021-05-05 09:06:21 +02004984
Willy Tarreau5b3cd952022-07-18 13:58:17 +02004985/* Sets build_is_static to true if we detect a static build. Some older glibcs
4986 * tend to crash inside dlsym() in static builds, but tests show that at least
4987 * dladdr() still works (and will fail to resolve anything of course). Thus we
4988 * try to determine if we're on a static build to avoid calling dlsym() in this
4989 * case.
Willy Tarreau288dc1d2022-07-16 13:49:34 +02004990 */
Willy Tarreau5b3cd952022-07-18 13:58:17 +02004991void check_if_static_build()
Willy Tarreau288dc1d2022-07-16 13:49:34 +02004992{
Willy Tarreau5b3cd952022-07-18 13:58:17 +02004993 Dl_info dli = { };
4994 size_t size = 0;
4995
4996 /* Now let's try to be smarter */
4997 if (!dladdr_and_size(&main, &dli, &size))
4998 build_is_static = 1;
4999 else
5000 build_is_static = 0;
Willy Tarreau288dc1d2022-07-16 13:49:34 +02005001}
5002
Willy Tarreau5b3cd952022-07-18 13:58:17 +02005003INITCALL0(STG_PREPARE, check_if_static_build);
Willy Tarreau288dc1d2022-07-16 13:49:34 +02005004
Willy Tarreau64192392021-05-05 09:06:21 +02005005/* Tries to retrieve the address of the first occurrence symbol <name>.
5006 * Note that NULL in return is not always an error as a symbol may have that
5007 * address in special situations.
5008 */
5009void *get_sym_curr_addr(const char *name)
5010{
5011 void *ptr = NULL;
5012
5013#ifdef RTLD_DEFAULT
Willy Tarreau5b3cd952022-07-18 13:58:17 +02005014 if (!build_is_static)
Willy Tarreau288dc1d2022-07-16 13:49:34 +02005015 ptr = dlsym(RTLD_DEFAULT, name);
Willy Tarreau64192392021-05-05 09:06:21 +02005016#endif
5017 return ptr;
5018}
5019
5020
5021/* Tries to retrieve the address of the next occurrence of symbol <name>
5022 * Note that NULL in return is not always an error as a symbol may have that
5023 * address in special situations.
5024 */
5025void *get_sym_next_addr(const char *name)
5026{
5027 void *ptr = NULL;
5028
5029#ifdef RTLD_NEXT
Willy Tarreau5b3cd952022-07-18 13:58:17 +02005030 if (!build_is_static)
Willy Tarreau288dc1d2022-07-16 13:49:34 +02005031 ptr = dlsym(RTLD_NEXT, name);
Willy Tarreau9133e482020-03-04 10:19:36 +01005032#endif
Willy Tarreau64192392021-05-05 09:06:21 +02005033 return ptr;
5034}
5035
5036#else /* elf & linux & dl */
5037
5038/* no possible resolving on other platforms at the moment */
5039void *get_sym_curr_addr(const char *name)
5040{
5041 return NULL;
5042}
5043
5044void *get_sym_next_addr(const char *name)
5045{
5046 return NULL;
5047}
5048
5049#endif /* elf & linux & dl */
Willy Tarreau9133e482020-03-04 10:19:36 +01005050
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005051/* Tries to append to buffer <buf> some indications about the symbol at address
5052 * <addr> using the following form:
5053 * lib:+0xoffset (unresolvable address from lib's base)
5054 * main+0xoffset (unresolvable address from main (+/-))
5055 * lib:main+0xoffset (unresolvable lib address from main (+/-))
5056 * name (resolved exact exec address)
5057 * lib:name (resolved exact lib address)
5058 * name+0xoffset/0xsize (resolved address within exec symbol)
5059 * lib:name+0xoffset/0xsize (resolved address within lib symbol)
5060 *
5061 * The file name (lib or executable) is limited to what lies between the last
5062 * '/' and the first following '.'. An optional prefix <pfx> is prepended before
5063 * the output if not null. The file is not dumped when it's the same as the one
Baruch Siache1651b22020-07-24 07:52:20 +03005064 * that contains the "main" symbol, or when __ELF__ && USE_DL are not set.
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005065 *
5066 * The symbol's base address is returned, or NULL when unresolved, in order to
5067 * allow the caller to match it against known ones.
5068 */
Willy Tarreau45fd1032021-01-20 14:37:59 +01005069const void *resolve_sym_name(struct buffer *buf, const char *pfx, const void *addr)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005070{
5071 const struct {
5072 const void *func;
5073 const char *name;
5074 } fcts[] = {
5075 { .func = process_stream, .name = "process_stream" },
5076 { .func = task_run_applet, .name = "task_run_applet" },
Willy Tarreau462b9892022-05-18 18:06:53 +02005077 { .func = sc_conn_io_cb, .name = "sc_conn_io_cb" },
Willy Tarreau586f71b2020-12-11 15:54:36 +01005078 { .func = sock_conn_iocb, .name = "sock_conn_iocb" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005079 { .func = dgram_fd_handler, .name = "dgram_fd_handler" },
5080 { .func = listener_accept, .name = "listener_accept" },
Willy Tarreaud597ec22021-01-29 14:29:06 +01005081 { .func = manage_global_listener_queue, .name = "manage_global_listener_queue" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005082 { .func = poller_pipe_io_handler, .name = "poller_pipe_io_handler" },
5083 { .func = mworker_accept_wrapper, .name = "mworker_accept_wrapper" },
Willy Tarreau02922e12021-01-29 12:27:57 +01005084 { .func = session_expire_embryonic, .name = "session_expire_embryonic" },
Willy Tarreaufb5401f2021-01-29 12:25:23 +01005085#ifdef USE_THREAD
5086 { .func = accept_queue_process, .name = "accept_queue_process" },
5087#endif
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005088#ifdef USE_LUA
5089 { .func = hlua_process_task, .name = "hlua_process_task" },
5090#endif
Ilya Shipitsinbdec3ba2020-11-14 01:56:34 +05005091#ifdef SSL_MODE_ASYNC
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005092 { .func = ssl_async_fd_free, .name = "ssl_async_fd_free" },
5093 { .func = ssl_async_fd_handler, .name = "ssl_async_fd_handler" },
5094#endif
Willy Tarreau8f6da642023-03-10 12:04:02 +01005095#ifdef USE_QUIC
5096 { .func = quic_conn_sock_fd_iocb, .name = "quic_conn_sock_fd_iocb" },
5097#endif
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005098 };
5099
Baruch Siache1651b22020-07-24 07:52:20 +03005100#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005101 Dl_info dli, dli_main;
Willy Tarreau9133e482020-03-04 10:19:36 +01005102 size_t size;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005103 const char *fname, *p;
5104#endif
5105 int i;
5106
5107 if (pfx)
5108 chunk_appendf(buf, "%s", pfx);
5109
5110 for (i = 0; i < sizeof(fcts) / sizeof(fcts[0]); i++) {
5111 if (addr == fcts[i].func) {
5112 chunk_appendf(buf, "%s", fcts[i].name);
5113 return addr;
5114 }
5115 }
5116
Baruch Siache1651b22020-07-24 07:52:20 +03005117#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005118 /* Now let's try to be smarter */
Willy Tarreau9133e482020-03-04 10:19:36 +01005119 if (!dladdr_and_size(addr, &dli, &size))
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005120 goto unknown;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005121
5122 /* 1. prefix the library name if it's not the same object as the one
5123 * that contains the main function. The name is picked between last '/'
5124 * and first following '.'.
5125 */
5126 if (!dladdr(main, &dli_main))
5127 dli_main.dli_fbase = NULL;
5128
5129 if (dli_main.dli_fbase != dli.dli_fbase) {
5130 fname = dli.dli_fname;
5131 p = strrchr(fname, '/');
5132 if (p++)
5133 fname = p;
5134 p = strchr(fname, '.');
5135 if (!p)
5136 p = fname + strlen(fname);
5137
5138 chunk_appendf(buf, "%.*s:", (int)(long)(p - fname), fname);
5139 }
5140
5141 /* 2. symbol name */
5142 if (dli.dli_sname) {
5143 /* known, dump it and return symbol's address (exact or relative) */
5144 chunk_appendf(buf, "%s", dli.dli_sname);
5145 if (addr != dli.dli_saddr) {
5146 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_saddr));
Willy Tarreau9133e482020-03-04 10:19:36 +01005147 if (size)
5148 chunk_appendf(buf, "/%#lx", (long)size);
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005149 }
5150 return dli.dli_saddr;
5151 }
5152 else if (dli_main.dli_fbase != dli.dli_fbase) {
5153 /* unresolved symbol from a known library, report relative offset */
5154 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_fbase));
5155 return NULL;
5156 }
Baruch Siache1651b22020-07-24 07:52:20 +03005157#endif /* __ELF__ && !__linux__ || USE_DL */
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01005158 unknown:
5159 /* unresolved symbol from the main file, report relative offset to main */
5160 if ((void*)addr < (void*)main)
5161 chunk_appendf(buf, "main-%#lx", (long)((void*)main - addr));
5162 else
5163 chunk_appendf(buf, "main+%#lx", (long)(addr - (void*)main));
5164 return NULL;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01005165}
5166
Willy Tarreau6ab7b212021-12-28 09:57:10 +01005167/* On systems where this is supported, let's provide a possibility to enumerate
5168 * the list of object files. The output is appended to a buffer initialized by
5169 * the caller, with one name per line. A trailing zero is always emitted if data
5170 * are written. Only real objects are dumped (executable and .so libs). The
5171 * function returns non-zero if it dumps anything. These functions do not make
5172 * use of the trash so that it is possible for the caller to call them with the
5173 * trash on input. The output format may be platform-specific but at least one
5174 * version must emit raw object file names when argument is zero.
5175 */
5176#if defined(HA_HAVE_DUMP_LIBS)
5177# if defined(HA_HAVE_DL_ITERATE_PHDR)
5178/* the private <data> we pass below is a dump context initialized like this */
5179struct dl_dump_ctx {
5180 struct buffer *buf;
5181 int with_addr;
5182};
5183
5184static int dl_dump_libs_cb(struct dl_phdr_info *info, size_t size, void *data)
5185{
5186 struct dl_dump_ctx *ctx = data;
5187 const char *fname;
5188 size_t p1, p2, beg, end;
5189 int idx;
5190
5191 if (!info || !info->dlpi_name)
5192 goto leave;
5193
5194 if (!*info->dlpi_name)
5195 fname = get_exec_path();
5196 else if (strchr(info->dlpi_name, '/'))
5197 fname = info->dlpi_name;
5198 else
5199 /* else it's a VDSO or similar and we're not interested */
5200 goto leave;
5201
5202 if (!ctx->with_addr)
5203 goto dump_name;
5204
5205 /* virtual addresses are relative to the load address and are per
5206 * pseudo-header, so we have to scan them all to find the furthest
5207 * one from the beginning. In this case we only dump entries if
5208 * they have at least one section.
5209 */
5210 beg = ~0; end = 0;
5211 for (idx = 0; idx < info->dlpi_phnum; idx++) {
5212 if (!info->dlpi_phdr[idx].p_memsz)
5213 continue;
5214 p1 = info->dlpi_phdr[idx].p_vaddr;
5215 if (p1 < beg)
5216 beg = p1;
5217 p2 = p1 + info->dlpi_phdr[idx].p_memsz - 1;
5218 if (p2 > end)
5219 end = p2;
5220 }
5221
5222 if (!idx)
5223 goto leave;
5224
5225 chunk_appendf(ctx->buf, "0x%012llx-0x%012llx (0x%07llx) ",
5226 (ullong)info->dlpi_addr + beg,
5227 (ullong)info->dlpi_addr + end,
5228 (ullong)(end - beg + 1));
5229 dump_name:
5230 chunk_appendf(ctx->buf, "%s\n", fname);
5231 leave:
5232 return 0;
5233}
5234
5235/* dumps lib names and optionally address ranges */
5236int dump_libs(struct buffer *output, int with_addr)
5237{
5238 struct dl_dump_ctx ctx = { .buf = output, .with_addr = with_addr };
5239 size_t old_data = output->data;
5240
5241 dl_iterate_phdr(dl_dump_libs_cb, &ctx);
5242 return output->data != old_data;
5243}
5244# else // no DL_ITERATE_PHDR
5245# error "No dump_libs() function for this platform"
5246# endif
5247#else // no HA_HAVE_DUMP_LIBS
5248
5249/* unsupported platform: do not dump anything */
5250int dump_libs(struct buffer *output, int with_addr)
5251{
5252 return 0;
5253}
5254
5255#endif // HA_HAVE_DUMP_LIBS
5256
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005257/*
5258 * Allocate an array of unsigned int with <nums> as address from <str> string
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05005259 * made of integer separated by dot characters.
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005260 *
5261 * First, initializes the value with <sz> as address to 0 and initializes the
5262 * array with <nums> as address to NULL. Then allocates the array with <nums> as
5263 * address updating <sz> pointed value to the size of this array.
5264 *
5265 * Returns 1 if succeeded, 0 if not.
5266 */
5267int parse_dotted_uints(const char *str, unsigned int **nums, size_t *sz)
5268{
5269 unsigned int *n;
5270 const char *s, *end;
5271
5272 s = str;
5273 *sz = 0;
5274 end = str + strlen(str);
5275 *nums = n = NULL;
5276
5277 while (1) {
5278 unsigned int r;
5279
5280 if (s >= end)
5281 break;
5282
5283 r = read_uint(&s, end);
5284 /* Expected characters after having read an uint: '\0' or '.',
5285 * if '.', must not be terminal.
5286 */
Christopher Faulet4b524122021-02-11 10:42:41 +01005287 if (*s != '\0'&& (*s++ != '.' || s == end)) {
5288 free(n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005289 return 0;
Christopher Faulet4b524122021-02-11 10:42:41 +01005290 }
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005291
Frédéric Lécaille12a71842019-02-26 18:19:48 +01005292 n = my_realloc2(n, (*sz + 1) * sizeof *n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005293 if (!n)
5294 return 0;
5295
5296 n[(*sz)++] = r;
5297 }
5298 *nums = n;
5299
5300 return 1;
5301}
5302
Willy Tarreau4d589e72019-08-23 19:02:26 +02005303
5304/* returns the number of bytes needed to encode <v> as a varint. An inline
5305 * version exists for use with constants (__varint_bytes()).
5306 */
5307int varint_bytes(uint64_t v)
5308{
5309 int len = 1;
5310
5311 if (v >= 240) {
5312 v = (v - 240) >> 4;
5313 while (1) {
5314 len++;
5315 if (v < 128)
5316 break;
5317 v = (v - 128) >> 7;
5318 }
5319 }
5320 return len;
5321}
5322
Willy Tarreau52bf8392020-03-08 00:42:37 +01005323
5324/* Random number generator state, see below */
Willy Tarreau1544c142020-03-12 00:31:18 +01005325static uint64_t ha_random_state[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01005326
5327/* This is a thread-safe implementation of xoroshiro128** described below:
5328 * http://prng.di.unimi.it/
5329 * It features a 2^128 long sequence, returns 64 high-quality bits on each call,
5330 * supports fast jumps and passes all common quality tests. It is thread-safe,
5331 * uses a double-cas on 64-bit architectures supporting it, and falls back to a
5332 * local lock on other ones.
5333 */
5334uint64_t ha_random64()
5335{
Willy Tarreau1544c142020-03-12 00:31:18 +01005336 uint64_t old[2] ALIGNED(2*sizeof(uint64_t));
5337 uint64_t new[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01005338
5339#if defined(USE_THREAD) && (!defined(HA_CAS_IS_8B) || !defined(HA_HAVE_CAS_DW))
5340 static HA_SPINLOCK_T rand_lock;
5341
5342 HA_SPIN_LOCK(OTHER_LOCK, &rand_lock);
5343#endif
5344
5345 old[0] = ha_random_state[0];
5346 old[1] = ha_random_state[1];
5347
5348#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
5349 do {
5350#endif
Willy Tarreau52bf8392020-03-08 00:42:37 +01005351 new[1] = old[0] ^ old[1];
5352 new[0] = rotl64(old[0], 24) ^ new[1] ^ (new[1] << 16); // a, b
5353 new[1] = rotl64(new[1], 37); // c
5354
5355#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
5356 } while (unlikely(!_HA_ATOMIC_DWCAS(ha_random_state, old, new)));
5357#else
5358 ha_random_state[0] = new[0];
5359 ha_random_state[1] = new[1];
5360#if defined(USE_THREAD)
5361 HA_SPIN_UNLOCK(OTHER_LOCK, &rand_lock);
5362#endif
5363#endif
Willy Tarreaub2475a12021-05-09 10:26:14 +02005364 return rotl64(old[0] * 5, 7) * 9;
Willy Tarreau52bf8392020-03-08 00:42:37 +01005365}
5366
5367/* seeds the random state using up to <len> bytes from <seed>, starting with
5368 * the first non-zero byte.
5369 */
5370void ha_random_seed(const unsigned char *seed, size_t len)
5371{
5372 size_t pos;
5373
5374 /* the seed must not be all zeroes, so we pre-fill it with alternating
5375 * bits and overwrite part of them with the block starting at the first
5376 * non-zero byte from the seed.
5377 */
5378 memset(ha_random_state, 0x55, sizeof(ha_random_state));
5379
5380 for (pos = 0; pos < len; pos++)
5381 if (seed[pos] != 0)
5382 break;
5383
5384 if (pos == len)
5385 return;
5386
5387 seed += pos;
5388 len -= pos;
5389
5390 if (len > sizeof(ha_random_state))
5391 len = sizeof(ha_random_state);
5392
5393 memcpy(ha_random_state, seed, len);
5394}
5395
5396/* This causes a jump to (dist * 2^96) places in the pseudo-random sequence,
5397 * and is equivalent to calling ha_random64() as many times. It is used to
5398 * provide non-overlapping sequences of 2^96 numbers (~7*10^28) to up to 2^32
5399 * different generators (i.e. different processes after a fork). The <dist>
5400 * argument is the distance to jump to and is used in a loop so it rather not
5401 * be too large if the processing time is a concern.
5402 *
5403 * BEWARE: this function is NOT thread-safe and must not be called during
5404 * concurrent accesses to ha_random64().
5405 */
5406void ha_random_jump96(uint32_t dist)
5407{
5408 while (dist--) {
5409 uint64_t s0 = 0;
5410 uint64_t s1 = 0;
5411 int b;
5412
5413 for (b = 0; b < 64; b++) {
5414 if ((0xd2a98b26625eee7bULL >> b) & 1) {
5415 s0 ^= ha_random_state[0];
5416 s1 ^= ha_random_state[1];
5417 }
5418 ha_random64();
5419 }
5420
5421 for (b = 0; b < 64; b++) {
5422 if ((0xdddf9b1090aa7ac1ULL >> b) & 1) {
5423 s0 ^= ha_random_state[0];
5424 s1 ^= ha_random_state[1];
5425 }
5426 ha_random64();
5427 }
5428 ha_random_state[0] = s0;
5429 ha_random_state[1] = s1;
5430 }
5431}
5432
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01005433/* Generates an RFC4122 UUID into chunk <output> which must be at least 37
5434 * bytes large.
5435 */
5436void ha_generate_uuid(struct buffer *output)
5437{
5438 uint32_t rnd[4];
5439 uint64_t last;
5440
5441 last = ha_random64();
5442 rnd[0] = last;
5443 rnd[1] = last >> 32;
5444
5445 last = ha_random64();
5446 rnd[2] = last;
5447 rnd[3] = last >> 32;
5448
5449 chunk_printf(output, "%8.8x-%4.4x-%4.4x-%4.4x-%12.12llx",
5450 rnd[0],
5451 rnd[1] & 0xFFFF,
5452 ((rnd[1] >> 16u) & 0xFFF) | 0x4000, // highest 4 bits indicate the uuid version
5453 (rnd[2] & 0x3FFF) | 0x8000, // the highest 2 bits indicate the UUID variant (10),
5454 (long long)((rnd[2] >> 14u) | ((uint64_t) rnd[3] << 18u)) & 0xFFFFFFFFFFFFull);
5455}
5456
5457
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005458/* only used by parse_line() below. It supports writing in place provided that
5459 * <in> is updated to the next location before calling it. In that case, the
5460 * char at <in> may be overwritten.
5461 */
5462#define EMIT_CHAR(x) \
5463 do { \
5464 char __c = (char)(x); \
5465 if ((opts & PARSE_OPT_INPLACE) && out+outpos > in) \
5466 err |= PARSE_ERR_OVERLAP; \
5467 if (outpos >= outmax) \
5468 err |= PARSE_ERR_TOOLARGE; \
5469 if (!err) \
5470 out[outpos] = __c; \
5471 outpos++; \
5472 } while (0)
5473
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05005474/* Parse <in>, copy it into <out> split into isolated words whose pointers
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005475 * are put in <args>. If more than <outlen> bytes have to be emitted, the
5476 * extraneous ones are not emitted but <outlen> is updated so that the caller
5477 * knows how much to realloc. Similarly, <args> are not updated beyond <nbargs>
5478 * but the returned <nbargs> indicates how many were found. All trailing args
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005479 * up to <nbargs> point to the trailing zero, and as long as <nbargs> is > 0,
5480 * it is guaranteed that at least one arg will point to the zero. It is safe
5481 * to call it with a NULL <args> if <nbargs> is 0.
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005482 *
5483 * <out> may overlap with <in> provided that it never goes further, in which
5484 * case the parser will accept to perform in-place parsing and unquoting/
5485 * unescaping but only if environment variables do not lead to expansion that
5486 * causes overlapping, otherwise the input string being destroyed, the error
5487 * will not be recoverable. Note that even during out-of-place <in> will
5488 * experience temporary modifications in-place for variable resolution and must
5489 * be writable, and will also receive zeroes to delimit words when using
5490 * in-place copy. Parsing options <opts> taken from PARSE_OPT_*. Return value
5491 * is zero on success otherwise a bitwise-or of PARSE_ERR_*. Upon error, the
5492 * starting point of the first invalid character sequence or unmatched
5493 * quote/brace is reported in <errptr> if not NULL. When using in-place parsing
5494 * error reporting might be difficult since zeroes will have been inserted into
5495 * the string. One solution for the caller may consist in replacing all args
5496 * delimiters with spaces in this case.
5497 */
Maximilian Mader29c6cd72021-06-06 00:50:21 +02005498uint32_t parse_line(char *in, char *out, size_t *outlen, char **args, int *nbargs, uint32_t opts, const char **errptr)
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005499{
5500 char *quote = NULL;
5501 char *brace = NULL;
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005502 char *word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005503 unsigned char hex1, hex2;
5504 size_t outmax = *outlen;
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005505 int argsmax = *nbargs - 1;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005506 size_t outpos = 0;
5507 int squote = 0;
5508 int dquote = 0;
5509 int arg = 0;
5510 uint32_t err = 0;
5511
5512 *nbargs = 0;
5513 *outlen = 0;
5514
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005515 /* argsmax may be -1 here, protecting args[] from any write */
5516 if (arg < argsmax)
5517 args[arg] = out;
5518
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005519 while (1) {
5520 if (*in >= '-' && *in != '\\') {
5521 /* speedup: directly send all regular chars starting
5522 * with '-', '.', '/', alnum etc...
5523 */
5524 EMIT_CHAR(*in++);
5525 continue;
5526 }
5527 else if (*in == '\0' || *in == '\n' || *in == '\r') {
5528 /* end of line */
5529 break;
5530 }
5531 else if (*in == '#' && (opts & PARSE_OPT_SHARP) && !squote && !dquote) {
5532 /* comment */
5533 break;
5534 }
5535 else if (*in == '"' && !squote && (opts & PARSE_OPT_DQUOTE)) { /* double quote outside single quotes */
5536 if (dquote) {
5537 dquote = 0;
5538 quote = NULL;
5539 }
5540 else {
5541 dquote = 1;
5542 quote = in;
5543 }
5544 in++;
5545 continue;
5546 }
5547 else if (*in == '\'' && !dquote && (opts & PARSE_OPT_SQUOTE)) { /* single quote outside double quotes */
5548 if (squote) {
5549 squote = 0;
5550 quote = NULL;
5551 }
5552 else {
5553 squote = 1;
5554 quote = in;
5555 }
5556 in++;
5557 continue;
5558 }
5559 else if (*in == '\\' && !squote && (opts & PARSE_OPT_BKSLASH)) {
5560 /* first, we'll replace \\, \<space>, \#, \r, \n, \t, \xXX with their
5561 * C equivalent value but only when they have a special meaning and within
5562 * double quotes for some of them. Other combinations left unchanged (eg: \1).
5563 */
5564 char tosend = *in;
5565
5566 switch (in[1]) {
5567 case ' ':
5568 case '\\':
5569 tosend = in[1];
5570 in++;
5571 break;
5572
5573 case 't':
5574 tosend = '\t';
5575 in++;
5576 break;
5577
5578 case 'n':
5579 tosend = '\n';
5580 in++;
5581 break;
5582
5583 case 'r':
5584 tosend = '\r';
5585 in++;
5586 break;
5587
5588 case '#':
5589 /* escaping of "#" only if comments are supported */
5590 if (opts & PARSE_OPT_SHARP)
5591 in++;
5592 tosend = *in;
5593 break;
5594
5595 case '\'':
5596 /* escaping of "'" only outside single quotes and only if single quotes are supported */
5597 if (opts & PARSE_OPT_SQUOTE && !squote)
5598 in++;
5599 tosend = *in;
5600 break;
5601
5602 case '"':
5603 /* escaping of '"' only outside single quotes and only if double quotes are supported */
5604 if (opts & PARSE_OPT_DQUOTE && !squote)
5605 in++;
5606 tosend = *in;
5607 break;
5608
5609 case '$':
5610 /* escaping of '$' only inside double quotes and only if env supported */
5611 if (opts & PARSE_OPT_ENV && dquote)
5612 in++;
5613 tosend = *in;
5614 break;
5615
5616 case 'x':
5617 if (!ishex(in[2]) || !ishex(in[3])) {
5618 /* invalid or incomplete hex sequence */
5619 err |= PARSE_ERR_HEX;
5620 if (errptr)
5621 *errptr = in;
5622 goto leave;
5623 }
Willy Tarreauf278eec2020-07-05 21:46:32 +02005624 hex1 = toupper((unsigned char)in[2]) - '0';
5625 hex2 = toupper((unsigned char)in[3]) - '0';
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005626 if (hex1 > 9) hex1 -= 'A' - '9' - 1;
5627 if (hex2 > 9) hex2 -= 'A' - '9' - 1;
5628 tosend = (hex1 << 4) + hex2;
5629 in += 3;
5630 break;
5631
5632 default:
5633 /* other combinations are not escape sequences */
5634 break;
5635 }
5636
5637 in++;
5638 EMIT_CHAR(tosend);
5639 }
5640 else if (isspace((unsigned char)*in) && !squote && !dquote) {
5641 /* a non-escaped space is an argument separator */
5642 while (isspace((unsigned char)*in))
5643 in++;
5644 EMIT_CHAR(0);
5645 arg++;
5646 if (arg < argsmax)
5647 args[arg] = out + outpos;
5648 else
5649 err |= PARSE_ERR_TOOMANY;
5650 }
5651 else if (*in == '$' && (opts & PARSE_OPT_ENV) && (dquote || !(opts & PARSE_OPT_DQUOTE))) {
5652 /* environment variables are evaluated anywhere, or only
5653 * inside double quotes if they are supported.
5654 */
5655 char *var_name;
5656 char save_char;
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005657 const char *value;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005658
5659 in++;
5660
5661 if (*in == '{')
5662 brace = in++;
5663
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005664 if (!isalpha((unsigned char)*in) && *in != '_' && *in != '.') {
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005665 /* unacceptable character in variable name */
5666 err |= PARSE_ERR_VARNAME;
5667 if (errptr)
5668 *errptr = in;
5669 goto leave;
5670 }
5671
5672 var_name = in;
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005673 if (*in == '.')
5674 in++;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005675 while (isalnum((unsigned char)*in) || *in == '_')
5676 in++;
5677
5678 save_char = *in;
5679 *in = '\0';
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005680 if (unlikely(*var_name == '.')) {
5681 /* internal pseudo-variables */
5682 if (strcmp(var_name, ".LINE") == 0)
5683 value = ultoa(global.cfg_curr_line);
5684 else if (strcmp(var_name, ".FILE") == 0)
5685 value = global.cfg_curr_file;
5686 else if (strcmp(var_name, ".SECTION") == 0)
5687 value = global.cfg_curr_section;
5688 else {
5689 /* unsupported internal variable name */
5690 err |= PARSE_ERR_VARNAME;
5691 if (errptr)
5692 *errptr = var_name;
5693 goto leave;
5694 }
5695 } else {
5696 value = getenv(var_name);
5697 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005698 *in = save_char;
5699
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005700 /* support for '[*]' sequence to force word expansion,
5701 * only available inside braces */
5702 if (*in == '[' && brace && (opts & PARSE_OPT_WORD_EXPAND)) {
5703 word_expand = in++;
5704
5705 if (*in++ != '*' || *in++ != ']') {
5706 err |= PARSE_ERR_WRONG_EXPAND;
5707 if (errptr)
5708 *errptr = word_expand;
5709 goto leave;
5710 }
5711 }
5712
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005713 if (brace) {
Willy Tarreauec347b12021-11-18 17:42:50 +01005714 if (*in == '-') {
5715 /* default value starts just after the '-' */
5716 if (!value)
5717 value = in + 1;
5718
5719 while (*in && *in != '}')
5720 in++;
5721 if (!*in)
5722 goto no_brace;
5723 *in = 0; // terminate the default value
5724 }
5725 else if (*in != '}') {
5726 no_brace:
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005727 /* unmatched brace */
5728 err |= PARSE_ERR_BRACE;
5729 if (errptr)
5730 *errptr = brace;
5731 goto leave;
5732 }
Willy Tarreauec347b12021-11-18 17:42:50 +01005733
5734 /* brace found, skip it */
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005735 in++;
5736 brace = NULL;
5737 }
5738
5739 if (value) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005740 while (*value) {
5741 /* expand as individual parameters on a space character */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005742 if (word_expand && isspace((unsigned char)*value)) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005743 EMIT_CHAR(0);
5744 ++arg;
5745 if (arg < argsmax)
5746 args[arg] = out + outpos;
5747 else
5748 err |= PARSE_ERR_TOOMANY;
5749
5750 /* skip consecutive spaces */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005751 while (isspace((unsigned char)*++value))
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005752 ;
5753 } else {
5754 EMIT_CHAR(*value++);
5755 }
5756 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005757 }
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005758 word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005759 }
5760 else {
5761 /* any other regular char */
5762 EMIT_CHAR(*in++);
5763 }
5764 }
5765
5766 /* end of output string */
5767 EMIT_CHAR(0);
Erwan Le Goas8a6767d2022-09-23 15:06:34 +02005768
Willy Tarreau94ab1392022-10-03 08:27:55 +02005769 /* Don't add an empty arg after trailing spaces. Note that args[arg]
5770 * may contain some distances relative to NULL if <out> was NULL, or
5771 * pointers beyond the end of <out> in case <outlen> is too short, thus
5772 * we must not dereference it.
Erwan Le Goas8a6767d2022-09-23 15:06:34 +02005773 */
Willy Tarreau94ab1392022-10-03 08:27:55 +02005774 if (arg < argsmax && args[arg] != out + outpos - 1)
Erwan Le Goas8a6767d2022-09-23 15:06:34 +02005775 arg++;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005776
5777 if (quote) {
5778 /* unmatched quote */
5779 err |= PARSE_ERR_QUOTE;
5780 if (errptr)
5781 *errptr = quote;
5782 goto leave;
5783 }
5784 leave:
5785 *nbargs = arg;
5786 *outlen = outpos;
5787
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005788 /* empty all trailing args by making them point to the trailing zero,
5789 * at least the last one in any case.
5790 */
5791 if (arg > argsmax)
5792 arg = argsmax;
5793
5794 while (arg >= 0 && arg <= argsmax)
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005795 args[arg++] = out + outpos - 1;
5796
5797 return err;
5798}
5799#undef EMIT_CHAR
5800
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005801/* This is used to sanitize an input line that's about to be used for error reporting.
5802 * It will adjust <line> to print approximately <width> chars around <pos>, trying to
5803 * preserve the beginning, with leading or trailing "..." when the line is truncated.
5804 * If non-printable chars are present in the output. It returns the new offset <pos>
5805 * in the modified line. Non-printable characters are replaced with '?'. <width> must
5806 * be at least 6 to support two "..." otherwise the result is undefined. The line
5807 * itself must have at least 7 chars allocated for the same reason.
5808 */
5809size_t sanitize_for_printing(char *line, size_t pos, size_t width)
5810{
5811 size_t shift = 0;
5812 char *out = line;
5813 char *in = line;
5814 char *end = line + width;
5815
5816 if (pos >= width) {
5817 /* if we have to shift, we'll be out of context, so let's
5818 * try to put <pos> at the center of width.
5819 */
5820 shift = pos - width / 2;
5821 in += shift + 3;
5822 end = out + width - 3;
5823 out[0] = out[1] = out[2] = '.';
5824 out += 3;
5825 }
5826
5827 while (out < end && *in) {
5828 if (isspace((unsigned char)*in))
5829 *out++ = ' ';
5830 else if (isprint((unsigned char)*in))
5831 *out++ = *in;
5832 else
5833 *out++ = '?';
5834 in++;
5835 }
5836
5837 if (end < line + width) {
5838 out[0] = out[1] = out[2] = '.';
5839 out += 3;
5840 }
5841
5842 *out++ = 0;
5843 return pos - shift;
5844}
Willy Tarreau06e69b52021-03-02 14:01:35 +01005845
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005846/* Update array <fp> with the fingerprint of word <word> by counting the
Willy Tarreauba2c4452021-03-12 09:01:52 +01005847 * transitions between characters. <fp> is a 1024-entries array indexed as
5848 * 32*from+to. Positions for 'from' and 'to' are:
Willy Tarreau9294e882021-03-15 09:34:27 +01005849 * 1..26=letter, 27=digit, 28=other/begin/end.
5850 * Row "from=0" is used to mark the character's presence. Others unused.
Willy Tarreauba2c4452021-03-12 09:01:52 +01005851 */
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005852void update_word_fingerprint(uint8_t *fp, const char *word)
Willy Tarreauba2c4452021-03-12 09:01:52 +01005853{
5854 const char *p;
5855 int from, to;
5856 int c;
5857
Willy Tarreauba2c4452021-03-12 09:01:52 +01005858 from = 28; // begin
5859 for (p = word; *p; p++) {
5860 c = tolower(*p);
5861 switch(c) {
Willy Tarreau9294e882021-03-15 09:34:27 +01005862 case 'a'...'z': to = c - 'a' + 1; break;
5863 case 'A'...'Z': to = tolower(c) - 'a' + 1; break;
5864 case '0'...'9': to = 27; break;
5865 default: to = 28; break;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005866 }
Willy Tarreau9294e882021-03-15 09:34:27 +01005867 fp[to] = 1;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005868 fp[32 * from + to]++;
5869 from = to;
5870 }
5871 to = 28; // end
5872 fp[32 * from + to]++;
5873}
5874
Erwan Le Goas9c766372022-09-14 17:40:24 +02005875/* This function hashes a word, scramble is the anonymizing key, returns
5876 * the hashed word when the key (scramble) != 0, else returns the word.
5877 * This function can be called NB_L_HASH_WORD times in a row, don't call
5878 * it if you called it more than NB_L_HASH_WORD.
5879 */
5880const char *hash_anon(uint32_t scramble, const char *string2hash, const char *prefix, const char *suffix)
5881{
5882 index_hash++;
Erwan Le Goasd2605cf2022-09-21 16:24:23 +02005883 if (index_hash == NB_L_HASH_WORD)
Erwan Le Goas9c766372022-09-14 17:40:24 +02005884 index_hash = 0;
5885
5886 /* don't hash empty strings */
5887 if (!string2hash[0] || (string2hash[0] == ' ' && string2hash[1] == 0))
5888 return string2hash;
5889
5890 if (scramble != 0) {
5891 snprintf(hash_word[index_hash], sizeof(hash_word[index_hash]), "%s%06x%s",
5892 prefix, HA_ANON(scramble, string2hash, strlen(string2hash)), suffix);
5893 return hash_word[index_hash];
5894 }
5895 else
5896 return string2hash;
5897}
5898
5899/* This function hashes or not an ip address ipstring, scramble is the anonymizing
5900 * key, returns the hashed ip with his port or ipstring when there is nothing to hash.
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005901 * Put hasport equal 0 to point out ipstring has no port, else put an other int.
5902 * Without port, return a simple hash or ipstring.
Erwan Le Goas9c766372022-09-14 17:40:24 +02005903 */
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005904const char *hash_ipanon(uint32_t scramble, char *ipstring, int hasport)
Erwan Le Goas9c766372022-09-14 17:40:24 +02005905{
5906 char *errmsg = NULL;
5907 struct sockaddr_storage *sa;
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005908 struct sockaddr_storage ss;
Erwan Le Goas9c766372022-09-14 17:40:24 +02005909 char addr[46];
5910 int port;
5911
5912 index_hash++;
Erwan Le Goasd2605cf2022-09-21 16:24:23 +02005913 if (index_hash == NB_L_HASH_WORD) {
Erwan Le Goas9c766372022-09-14 17:40:24 +02005914 index_hash = 0;
5915 }
5916
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005917 if (scramble == 0) {
Erwan Le Goas9c766372022-09-14 17:40:24 +02005918 return ipstring;
5919 }
Christopher Faulet015bbc22022-09-29 11:53:07 +02005920 if (strcmp(ipstring, "localhost") == 0 ||
5921 strcmp(ipstring, "stdout") == 0 ||
5922 strcmp(ipstring, "stderr") == 0 ||
5923 strncmp(ipstring, "fd@", 3) == 0 ||
5924 strncmp(ipstring, "sockpair@", 9) == 0) {
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005925 return ipstring;
5926 }
Erwan Le Goas9c766372022-09-14 17:40:24 +02005927 else {
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005928 if (hasport == 0) {
5929 memset(&ss, 0, sizeof(ss));
5930 if (str2ip2(ipstring, &ss, 1) == NULL) {
5931 return HA_ANON_STR(scramble, ipstring);
5932 }
5933 sa = &ss;
Erwan Le Goas9c766372022-09-14 17:40:24 +02005934 }
5935 else {
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005936 sa = str2sa_range(ipstring, NULL, NULL, NULL, NULL, NULL, &errmsg, NULL, NULL,
Christopher Faulet7e50e4b2022-09-29 11:46:34 +02005937 PA_O_PORT_OK | PA_O_STREAM | PA_O_DGRAM | PA_O_XPRT | PA_O_CONNECT |
5938 PA_O_PORT_RANGE | PA_O_PORT_OFS | PA_O_RESOLVE);
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005939 if (sa == NULL) {
5940 return HA_ANON_STR(scramble, ipstring);
5941 }
5942 }
5943 addr_to_str(sa, addr, sizeof(addr));
5944 port = get_host_port(sa);
Erwan Le Goas9c766372022-09-14 17:40:24 +02005945
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005946 switch(sa->ss_family) {
5947 case AF_INET:
5948 if (strncmp(addr, "127", 3) == 0 || strncmp(addr, "255", 3) == 0 || strncmp(addr, "0", 1) == 0) {
5949 return ipstring;
5950 }
5951 else {
5952 if (port != 0) {
5953 snprintf(hash_word[index_hash], sizeof(hash_word[index_hash]), "IPV4(%06x):%d", HA_ANON(scramble, addr, strlen(addr)), port);
5954 return hash_word[index_hash];
Erwan Le Goas9c766372022-09-14 17:40:24 +02005955 }
5956 else {
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005957 snprintf(hash_word[index_hash], sizeof(hash_word[index_hash]), "IPV4(%06x)", HA_ANON(scramble, addr, strlen(addr)));
5958 return hash_word[index_hash];
Erwan Le Goas9c766372022-09-14 17:40:24 +02005959 }
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005960 }
5961 break;
Erwan Le Goas9c766372022-09-14 17:40:24 +02005962
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005963 case AF_INET6:
5964 if (strcmp(addr, "::1") == 0) {
5965 return ipstring;
5966 }
5967 else {
5968 if (port != 0) {
5969 snprintf(hash_word[index_hash], sizeof(hash_word[index_hash]), "IPV6(%06x):%d", HA_ANON(scramble, addr, strlen(addr)), port);
5970 return hash_word[index_hash];
Erwan Le Goas9c766372022-09-14 17:40:24 +02005971 }
5972 else {
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005973 snprintf(hash_word[index_hash], sizeof(hash_word[index_hash]), "IPV6(%06x)", HA_ANON(scramble, addr, strlen(addr)));
5974 return hash_word[index_hash];
Erwan Le Goas9c766372022-09-14 17:40:24 +02005975 }
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005976 }
5977 break;
Erwan Le Goas9c766372022-09-14 17:40:24 +02005978
Erwan Le Goas5eef1582022-09-29 10:25:31 +02005979 case AF_UNIX:
5980 return HA_ANON_STR(scramble, ipstring);
5981 break;
5982
5983 default:
5984 return ipstring;
5985 break;
5986 };
Erwan Le Goas9c766372022-09-14 17:40:24 +02005987 }
5988 return ipstring;
5989}
5990
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005991/* Initialize array <fp> with the fingerprint of word <word> by counting the
5992 * transitions between characters. <fp> is a 1024-entries array indexed as
5993 * 32*from+to. Positions for 'from' and 'to' are:
5994 * 0..25=letter, 26=digit, 27=other, 28=begin, 29=end, others unused.
5995 */
5996void make_word_fingerprint(uint8_t *fp, const char *word)
5997{
5998 memset(fp, 0, 1024);
5999 update_word_fingerprint(fp, word);
6000}
6001
Willy Tarreauba2c4452021-03-12 09:01:52 +01006002/* Return the distance between two word fingerprints created by function
6003 * make_word_fingerprint(). It's a positive integer calculated as the sum of
Willy Tarreau714c4c12021-03-15 09:44:53 +01006004 * the differences between each location.
Willy Tarreauba2c4452021-03-12 09:01:52 +01006005 */
6006int word_fingerprint_distance(const uint8_t *fp1, const uint8_t *fp2)
6007{
6008 int i, k, dist = 0;
6009
6010 for (i = 0; i < 1024; i++) {
6011 k = (int)fp1[i] - (int)fp2[i];
Willy Tarreau714c4c12021-03-15 09:44:53 +01006012 dist += abs(k);
Willy Tarreauba2c4452021-03-12 09:01:52 +01006013 }
6014 return dist;
6015}
6016
William Lallemand3aeb3f92021-08-21 23:59:56 +02006017/*
6018 * This function compares the loaded openssl version with a string <version>
6019 * This function use the same return code as compare_current_version:
6020 *
6021 * -1 : the version in argument is older than the current openssl version
6022 * 0 : the version in argument is the same as the current openssl version
6023 * 1 : the version in argument is newer than the current openssl version
6024 *
6025 * Or some errors:
6026 * -2 : openssl is not available on this process
6027 * -3 : the version in argument is not parsable
6028 */
6029int openssl_compare_current_version(const char *version)
6030{
6031#ifdef USE_OPENSSL
6032 int numversion;
6033
6034 numversion = openssl_version_parser(version);
6035 if (numversion == 0)
6036 return -3;
6037
6038 if (numversion < OPENSSL_VERSION_NUMBER)
6039 return -1;
6040 else if (numversion > OPENSSL_VERSION_NUMBER)
6041 return 1;
6042 else
6043 return 0;
6044#else
6045 return -2;
6046#endif
6047}
6048
Remi Tricot-Le Bretonb01179a2021-10-11 15:34:12 +02006049/*
6050 * This function compares the loaded openssl name with a string <name>
6051 * This function returns 0 if the OpenSSL name starts like the passed parameter,
6052 * 1 otherwise.
6053 */
6054int openssl_compare_current_name(const char *name)
6055{
6056#ifdef USE_OPENSSL
6057 int name_len = 0;
6058 const char *openssl_version = OpenSSL_version(OPENSSL_VERSION);
6059
6060 if (name) {
6061 name_len = strlen(name);
6062 if (strlen(name) <= strlen(openssl_version))
6063 return strncmp(openssl_version, name, name_len);
6064 }
6065#endif
6066 return 1;
6067}
6068
Willy Tarreau40dde2d2022-06-19 16:41:59 +02006069#if defined(RTLD_DEFAULT) || defined(RTLD_NEXT)
6070/* redefine dlopen() so that we can detect unexpected replacement of some
6071 * critical symbols, typically init/alloc/free functions coming from alternate
6072 * libraries. When called, a tainted flag is set (TAINTED_SHARED_LIBS).
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006073 * It's important to understand that the dynamic linker will present the
6074 * first loaded of each symbol to all libs, so that if haproxy is linked
6075 * with a new lib that uses a static inline or a #define to replace an old
6076 * function, and a dependency was linked against an older version of that
6077 * lib that had a function there, that lib would use all of the newer
6078 * versions of the functions that are already loaded in haproxy, except
6079 * for that unique function which would continue to be the old one. This
6080 * creates all sort of problems when init code allocates smaller structs
6081 * than required for example but uses new functions on them, etc. Thus what
6082 * we do here is to try to detect API consistency: we take a fingerprint of
6083 * a number of known functions, and verify that if they change in a loaded
6084 * library, either there all appeared or all disappeared, but not partially.
6085 * We can check up to 64 symbols that belong to individual groups that are
6086 * checked together.
Willy Tarreau40dde2d2022-06-19 16:41:59 +02006087 */
6088void *dlopen(const char *filename, int flags)
6089{
6090 static void *(*_dlopen)(const char *filename, int flags);
Willy Tarreau177aed52022-06-19 16:49:51 +02006091 struct {
6092 const char *name;
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006093 uint64_t bit, grp;
Willy Tarreau177aed52022-06-19 16:49:51 +02006094 void *curr, *next;
6095 } check_syms[] = {
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006096 /* openssl checks: group bits 0x7ff */
6097 { .name="OPENSSL_init", .bit = 0x0000000000000001, .grp = 0x00000000000003ff, }, // openssl 1.0 / 1.1 / 3.0
6098 { .name="OPENSSL_init_crypto", .bit = 0x0000000000000002, .grp = 0x00000000000003ff, }, // openssl 1.1 / 3.0 (libcrypto)
6099 { .name="OPENSSL_init_ssl", .bit = 0x0000000000000004, .grp = 0x00000000000003ff, }, // openssl 1.1 / 3.0 (libssl)
6100 { .name="SSL_library_init", .bit = 0x0000000000000008, .grp = 0x00000000000003ff, }, // openssl 1.x
6101 { .name="ENGINE_init", .bit = 0x0000000000000010, .grp = 0x00000000000003ff, }, // openssl 1.x / 3.x with engine
6102 { .name="EVP_CIPHER_CTX_init", .bit = 0x0000000000000020, .grp = 0x00000000000003ff, }, // openssl 1.0
6103 { .name="HMAC_Init", .bit = 0x0000000000000040, .grp = 0x00000000000003ff, }, // openssl 1.x
6104 { .name="SSL_is_quic", .bit = 0x0000000000000080, .grp = 0x00000000000003ff, }, // quictls
6105 { .name="SSL_CTX_new_ex", .bit = 0x0000000000000100, .grp = 0x00000000000003ff, }, // openssl 3.x
6106 { .name="SSL_CTX_get0_security_ex_data", .bit = 0x0000000000000200, .grp = 0x00000000000003ff, }, // openssl 1.x / 3.x
Willy Tarreau177aed52022-06-19 16:49:51 +02006107 /* insert only above, 0 must be the last one */
6108 { 0 },
6109 };
6110 const char *trace;
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006111 uint64_t own_fp, lib_fp; // symbols fingerprints
Willy Tarreau177aed52022-06-19 16:49:51 +02006112 void *addr;
Willy Tarreau40dde2d2022-06-19 16:41:59 +02006113 void *ret;
Willy Tarreau177aed52022-06-19 16:49:51 +02006114 int sym = 0;
Willy Tarreau40dde2d2022-06-19 16:41:59 +02006115
6116 if (!_dlopen) {
6117 _dlopen = get_sym_next_addr("dlopen");
6118 if (!_dlopen || _dlopen == dlopen) {
6119 _dlopen = NULL;
6120 return NULL;
6121 }
6122 }
6123
Willy Tarreau177aed52022-06-19 16:49:51 +02006124 /* save a few pointers to critical symbols. We keep a copy of both the
6125 * current and the next value, because we might already have replaced
Willy Tarreau58912b82023-03-22 15:47:51 +01006126 * some of them in an inconsistent way (i.e. not all), and we're only
Willy Tarreau177aed52022-06-19 16:49:51 +02006127 * interested in verifying that a loaded library doesn't come with a
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006128 * completely different definition that would be incompatible. We'll
6129 * keep a fingerprint of our own symbols.
Willy Tarreau177aed52022-06-19 16:49:51 +02006130 */
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006131 own_fp = 0;
Willy Tarreau177aed52022-06-19 16:49:51 +02006132 for (sym = 0; check_syms[sym].name; sym++) {
6133 check_syms[sym].curr = get_sym_curr_addr(check_syms[sym].name);
6134 check_syms[sym].next = get_sym_next_addr(check_syms[sym].name);
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006135 if (check_syms[sym].curr || check_syms[sym].next)
6136 own_fp |= check_syms[sym].bit;
Willy Tarreau177aed52022-06-19 16:49:51 +02006137 }
Willy Tarreau40dde2d2022-06-19 16:41:59 +02006138
6139 /* now open the requested lib */
6140 ret = _dlopen(filename, flags);
6141 if (!ret)
6142 return ret;
6143
6144 mark_tainted(TAINTED_SHARED_LIBS);
6145
Willy Tarreau177aed52022-06-19 16:49:51 +02006146 /* and check that critical symbols didn't change */
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006147 lib_fp = 0;
Willy Tarreau177aed52022-06-19 16:49:51 +02006148 for (sym = 0; check_syms[sym].name; sym++) {
Willy Tarreau177aed52022-06-19 16:49:51 +02006149 addr = dlsym(ret, check_syms[sym].name);
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006150 if (addr)
6151 lib_fp |= check_syms[sym].bit;
6152 }
Willy Tarreau177aed52022-06-19 16:49:51 +02006153
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006154 if (lib_fp != own_fp) {
6155 /* let's check what changed: */
6156 uint64_t mask = 0;
Willy Tarreau177aed52022-06-19 16:49:51 +02006157
Willy Tarreauc3b297d2023-03-22 17:01:32 +01006158 for (sym = 0; check_syms[sym].name; sym++) {
6159 mask = check_syms[sym].grp;
6160
6161 /* new group of symbols. If they all appeared together
6162 * their use will be consistent. If none appears, it's
6163 * just that the lib doesn't use them. If some appear
6164 * or disappear, it means the lib relies on a different
6165 * dependency and will end up with a mix.
6166 */
6167 if (!(own_fp & mask) || !(lib_fp & mask) ||
6168 (own_fp & mask) == (lib_fp & mask))
6169 continue;
6170
6171 /* let's report a symbol that really changes */
6172 if (!((own_fp ^ lib_fp) & check_syms[sym].bit))
6173 continue;
6174
6175 /* OK it's clear that this symbol was redefined */
6176 mark_tainted(TAINTED_REDEFINITION);
6177
6178 trace = hlua_show_current_location("\n ");
6179 ha_warning("dlopen(): shared library '%s' brings a different and inconsistent definition of symbol '%s'. The process cannot be trusted anymore!%s%s\n",
6180 filename, check_syms[sym].name,
6181 trace ? " Suspected call location: \n " : "",
6182 trace ? trace : "");
6183 }
Willy Tarreau177aed52022-06-19 16:49:51 +02006184 }
6185
Willy Tarreau40dde2d2022-06-19 16:41:59 +02006186 return ret;
6187}
6188#endif
6189
Willy Tarreau06e69b52021-03-02 14:01:35 +01006190static int init_tools_per_thread()
6191{
6192 /* Let's make each thread start from a different position */
6193 statistical_prng_state += tid * MAX_THREADS;
6194 if (!statistical_prng_state)
6195 statistical_prng_state++;
6196 return 1;
6197}
6198REGISTER_PER_THREAD_INIT(init_tools_per_thread);
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02006199
Willy Tarreaubaaee002006-06-26 02:48:02 +02006200/*
6201 * Local variables:
6202 * c-indent-level: 8
6203 * c-basic-offset: 8
6204 * End:
6205 */