blob: 91396a3db5108ea4ba82c4340feded40d6e3c767 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * General logging functions.
3 *
Willy Tarreaub7f694f2008-06-22 17:18:02 +02004 * Copyright 2000-2008 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
Willy Tarreau8a3f52f2012-12-20 21:23:42 +010013#include <ctype.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020014#include <stdarg.h>
15#include <stdio.h>
16#include <stdlib.h>
17#include <string.h>
18#include <syslog.h>
19#include <time.h>
20#include <unistd.h>
Robert Tsai81ae1952007-12-05 10:47:29 +010021#include <errno.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020022
23#include <sys/time.h>
Willy Tarreau077edcb2016-08-10 18:30:56 +020024#include <sys/uio.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020025
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020026#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020027#include <haproxy/applet.h>
Emeric Brun12941c82020-07-07 14:19:42 +020028#include <haproxy/cfgparse.h>
Willy Tarreau55542642021-10-08 09:33:24 +020029#include <haproxy/clock.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020030#include <haproxy/fd.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020031#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020032#include <haproxy/global.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020033#include <haproxy/http.h>
Willy Tarreaub7fc4c42021-10-06 18:56:42 +020034#include <haproxy/http_ana.h>
Emeric Brun12941c82020-07-07 14:19:42 +020035#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020036#include <haproxy/log.h>
Emeric Brun12941c82020-07-07 14:19:42 +020037#include <haproxy/proxy.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020038#include <haproxy/sample.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020039#include <haproxy/sc_strm.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/sink.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020041#include <haproxy/ssl_sock.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020042#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020043#include <haproxy/stream.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020044#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020045#include <haproxy/tools.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020046
Emeric Brun45c457a2020-07-09 23:23:34 +020047/* global recv logs counter */
48int cum_log_messages;
Willy Tarreaubaaee002006-06-26 02:48:02 +020049
Emeric Brun12941c82020-07-07 14:19:42 +020050/* log forward proxy list */
51struct proxy *cfg_log_forward;
52
Emeric Brun54648852020-07-06 15:54:06 +020053struct log_fmt_st {
Dragan Dosen43885c72015-10-01 13:18:13 +020054 char *name;
Dragan Dosen43885c72015-10-01 13:18:13 +020055};
56
Emeric Brun54648852020-07-06 15:54:06 +020057static const struct log_fmt_st log_formats[LOG_FORMATS] = {
Emeric Brun0237c4e2020-11-27 16:24:34 +010058 [LOG_FORMAT_LOCAL] = {
59 .name = "local",
60 },
Dragan Dosen43885c72015-10-01 13:18:13 +020061 [LOG_FORMAT_RFC3164] = {
62 .name = "rfc3164",
Dragan Dosen43885c72015-10-01 13:18:13 +020063 },
64 [LOG_FORMAT_RFC5424] = {
65 .name = "rfc5424",
Emeric Brun54648852020-07-06 15:54:06 +020066 },
67 [LOG_FORMAT_PRIO] = {
68 .name = "priority",
Willy Tarreaue8746a02018-11-12 08:45:00 +010069 },
70 [LOG_FORMAT_SHORT] = {
71 .name = "short",
Emeric Brun54648852020-07-06 15:54:06 +020072 },
73 [LOG_FORMAT_TIMED] = {
74 .name = "timed",
75 },
76 [LOG_FORMAT_ISO] = {
77 .name = "iso",
Willy Tarreaue8746a02018-11-12 08:45:00 +010078 },
Willy Tarreauc1b06452018-11-12 11:57:56 +010079 [LOG_FORMAT_RAW] = {
80 .name = "raw",
Willy Tarreauc1b06452018-11-12 11:57:56 +010081 },
Dragan Dosen1322d092015-09-22 16:05:32 +020082};
83
Dragan Dosen835b9212016-02-12 13:23:03 +010084/*
85 * This map is used with all the FD_* macros to check whether a particular bit
Willy Tarreau1bfd6022019-06-07 11:10:07 +020086 * is set or not. Each bit represents an ACSII code. ha_bit_set() sets those
87 * bytes which should be escaped. When ha_bit_test() returns non-zero, it means
88 * that the byte should be escaped. Be careful to always pass bytes from 0 to
89 * 255 exclusively to the macros.
Dragan Dosen835b9212016-02-12 13:23:03 +010090 */
Willy Tarreau1bfd6022019-06-07 11:10:07 +020091long rfc5424_escape_map[(256/8) / sizeof(long)];
92long hdr_encode_map[(256/8) / sizeof(long)];
93long url_encode_map[(256/8) / sizeof(long)];
94long http_encode_map[(256/8) / sizeof(long)];
Dragan Dosen835b9212016-02-12 13:23:03 +010095
Dragan Dosen835b9212016-02-12 13:23:03 +010096
Willy Tarreaubaaee002006-06-26 02:48:02 +020097const char *log_facilities[NB_LOG_FACILITIES] = {
98 "kern", "user", "mail", "daemon",
99 "auth", "syslog", "lpr", "news",
100 "uucp", "cron", "auth2", "ftp",
101 "ntp", "audit", "alert", "cron2",
102 "local0", "local1", "local2", "local3",
103 "local4", "local5", "local6", "local7"
104};
105
Willy Tarreaubaaee002006-06-26 02:48:02 +0200106const char *log_levels[NB_LOG_LEVELS] = {
107 "emerg", "alert", "crit", "err",
108 "warning", "notice", "info", "debug"
109};
110
Willy Tarreau570f2212013-06-10 16:42:09 +0200111const char sess_term_cond[16] = "-LcCsSPRIDKUIIII"; /* normal, Local, CliTo, CliErr, SrvTo, SrvErr, PxErr, Resource, Internal, Down, Killed, Up, -- */
Willy Tarreaub8750a82006-09-03 09:56:00 +0200112const char sess_fin_state[8] = "-RCHDLQT"; /* cliRequest, srvConnect, srvHeader, Data, Last, Queue, Tarpit */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200113
William Lallemand723b73a2012-02-08 16:37:49 +0100114
115/* log_format */
116struct logformat_type {
117 char *name;
118 int type;
William Lallemandbddd4fd2012-02-27 11:23:10 +0100119 int mode;
William Lallemand5e19a282012-04-02 16:22:10 +0200120 int lw; /* logwait bitsfield */
William Lallemandb7ff6a32012-03-02 14:35:21 +0100121 int (*config_callback)(struct logformat_node *node, struct proxy *curproxy);
William Lallemand723b73a2012-02-08 16:37:49 +0100122};
123
William Lallemandb7ff6a32012-03-02 14:35:21 +0100124int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy);
125
William Lallemand723b73a2012-02-08 16:37:49 +0100126/* log_format variable names */
127static const struct logformat_type logformat_keywords[] = {
William Lallemand5e19a282012-04-02 16:22:10 +0200128 { "o", LOG_FMT_GLOBAL, PR_MODE_TCP, 0, NULL }, /* global option */
Willy Tarreau2beef582012-12-20 17:22:52 +0100129
130 /* please keep these lines sorted ! */
131 { "B", LOG_FMT_BYTES, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from server to client */
132 { "CC", LOG_FMT_CCLIENT, PR_MODE_HTTP, LW_REQHDR, NULL }, /* client cookie */
133 { "CS", LOG_FMT_CSERVER, PR_MODE_HTTP, LW_RSPHDR, NULL }, /* server cookie */
134 { "H", LOG_FMT_HOSTNAME, PR_MODE_TCP, LW_INIT, NULL }, /* Hostname */
Tim Duesterhuscf6e0c82020-03-13 12:34:24 +0100135 { "ID", LOG_FMT_UNIQUEID, PR_MODE_TCP, LW_BYTES, NULL }, /* Unique ID */
Willy Tarreau4bf99632014-06-13 12:21:40 +0200136 { "ST", LOG_FMT_STATUS, PR_MODE_TCP, LW_RESP, NULL }, /* status code */
William Lallemand5e19a282012-04-02 16:22:10 +0200137 { "T", LOG_FMT_DATEGMT, PR_MODE_TCP, LW_INIT, NULL }, /* date GMT */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200138 { "Ta", LOG_FMT_Ta, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time active (tr to end) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100139 { "Tc", LOG_FMT_TC, PR_MODE_TCP, LW_BYTES, NULL }, /* Tc */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200140 { "Th", LOG_FMT_Th, PR_MODE_TCP, LW_BYTES, NULL }, /* Time handshake */
141 { "Ti", LOG_FMT_Ti, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time idle */
142 { "Tl", LOG_FMT_DATELOCAL, PR_MODE_TCP, LW_INIT, NULL }, /* date local timezone */
143 { "Tq", LOG_FMT_TQ, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tq=Th+Ti+TR */
144 { "Tr", LOG_FMT_Tr, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tr */
145 { "TR", LOG_FMT_TR, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time to receive a valid request */
Willy Tarreau27b639d2016-05-17 17:55:27 +0200146 { "Td", LOG_FMT_TD, PR_MODE_TCP, LW_BYTES, NULL }, /* Td = Tt - (Tq + Tw + Tc + Tr) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100147 { "Ts", LOG_FMT_TS, PR_MODE_TCP, LW_INIT, NULL }, /* timestamp GMT */
William Lallemand5e19a282012-04-02 16:22:10 +0200148 { "Tt", LOG_FMT_TT, PR_MODE_TCP, LW_BYTES, NULL }, /* Tt */
Damien Claisse57c8eb92020-04-28 12:09:19 +0000149 { "Tu", LOG_FMT_TU, PR_MODE_TCP, LW_BYTES, NULL }, /* Tu = Tt -Ti */
Willy Tarreau2beef582012-12-20 17:22:52 +0100150 { "Tw", LOG_FMT_TW, PR_MODE_TCP, LW_BYTES, NULL }, /* Tw */
151 { "U", LOG_FMT_BYTES_UP, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from client to server */
William Lallemand5e19a282012-04-02 16:22:10 +0200152 { "ac", LOG_FMT_ACTCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* actconn */
Willy Tarreau2beef582012-12-20 17:22:52 +0100153 { "b", LOG_FMT_BACKEND, PR_MODE_TCP, LW_INIT, NULL }, /* backend */
William Lallemand5e19a282012-04-02 16:22:10 +0200154 { "bc", LOG_FMT_BECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* beconn */
Willy Tarreau2beef582012-12-20 17:22:52 +0100155 { "bi", LOG_FMT_BACKENDIP, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source ip */
156 { "bp", LOG_FMT_BACKENDPORT, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source port */
William Lallemand5e19a282012-04-02 16:22:10 +0200157 { "bq", LOG_FMT_BCKQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* backend_queue */
Willy Tarreaud02286d2017-06-23 11:23:43 +0200158 { "ci", LOG_FMT_CLIENTIP, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client ip */
159 { "cp", LOG_FMT_CLIENTPORT, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client port */
Willy Tarreau2beef582012-12-20 17:22:52 +0100160 { "f", LOG_FMT_FRONTEND, PR_MODE_TCP, LW_INIT, NULL }, /* frontend */
161 { "fc", LOG_FMT_FECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* feconn */
Willy Tarreaud02286d2017-06-23 11:23:43 +0200162 { "fi", LOG_FMT_FRONTENDIP, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend ip */
163 { "fp", LOG_FMT_FRONTENDPORT, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend port */
Willy Tarreau2beef582012-12-20 17:22:52 +0100164 { "ft", LOG_FMT_FRONTEND_XPRT, PR_MODE_TCP, LW_INIT, NULL }, /* frontend with transport mode */
Willy Tarreaud9ed3d22014-06-13 12:23:06 +0200165 { "hr", LOG_FMT_HDRREQUEST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request */
166 { "hrl", LOG_FMT_HDRREQUESTLIST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request list */
167 { "hs", LOG_FMT_HDRRESPONS, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response */
168 { "hsl", LOG_FMT_HDRRESPONSLIST, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response list */
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +0000169 { "HM", LOG_FMT_HTTP_METHOD, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP method */
Maciej Zdebfcdfd852020-11-30 18:27:47 +0000170 { "HP", LOG_FMT_HTTP_PATH, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP relative or absolute path */
171 { "HPO", LOG_FMT_HTTP_PATH_ONLY, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP path only (without host nor query string) */
Andrew Hayworthe63ac872015-07-31 16:14:16 +0000172 { "HQ", LOG_FMT_HTTP_QUERY, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP query */
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +0000173 { "HU", LOG_FMT_HTTP_URI, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP full URI */
174 { "HV", LOG_FMT_HTTP_VERSION, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP version */
Willy Tarreau7346acb2014-08-28 15:03:15 +0200175 { "lc", LOG_FMT_LOGCNT, PR_MODE_TCP, LW_INIT, NULL }, /* log counter */
Willy Tarreau2beef582012-12-20 17:22:52 +0100176 { "ms", LOG_FMT_MS, PR_MODE_TCP, LW_INIT, NULL }, /* accept date millisecond */
William Lallemand5e19a282012-04-02 16:22:10 +0200177 { "pid", LOG_FMT_PID, PR_MODE_TCP, LW_INIT, NULL }, /* log pid */
Willy Tarreau2beef582012-12-20 17:22:52 +0100178 { "r", LOG_FMT_REQ, PR_MODE_HTTP, LW_REQ, NULL }, /* request */
179 { "rc", LOG_FMT_RETRIES, PR_MODE_TCP, LW_BYTES, NULL }, /* retries */
Willy Tarreau1f0da242014-01-25 11:01:50 +0100180 { "rt", LOG_FMT_COUNTER, PR_MODE_TCP, LW_REQ, NULL }, /* request counter (HTTP or TCP session) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100181 { "s", LOG_FMT_SERVER, PR_MODE_TCP, LW_SVID, NULL }, /* server */
182 { "sc", LOG_FMT_SRVCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_conn */
183 { "si", LOG_FMT_SERVERIP, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination ip */
184 { "sp", LOG_FMT_SERVERPORT, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination port */
185 { "sq", LOG_FMT_SRVQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_queue */
Willy Tarreauffc3fcd2012-10-12 20:17:54 +0200186 { "sslc", LOG_FMT_SSL_CIPHER, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL ciphers */
187 { "sslv", LOG_FMT_SSL_VERSION, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL protocol version */
Willy Tarreau2beef582012-12-20 17:22:52 +0100188 { "t", LOG_FMT_DATE, PR_MODE_TCP, LW_INIT, NULL }, /* date */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200189 { "tr", LOG_FMT_tr, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request */
190 { "trg",LOG_FMT_trg, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, GMT */
191 { "trl",LOG_FMT_trl, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, local */
Willy Tarreau2beef582012-12-20 17:22:52 +0100192 { "ts", LOG_FMT_TERMSTATE, PR_MODE_TCP, LW_BYTES, NULL },/* termination state */
193 { "tsc", LOG_FMT_TERMSTATE_CK, PR_MODE_TCP, LW_INIT, NULL },/* termination state */
William Lallemand5e19a282012-04-02 16:22:10 +0200194 { 0, 0, 0, 0, NULL }
William Lallemand723b73a2012-02-08 16:37:49 +0100195};
196
William Lallemandbe6a8732022-12-22 15:37:01 +0100197char httpclient_log_format[] = "%ci:%cp [%tr] %ft -/- %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r";
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200198char default_http_log_format[] = "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r"; // default format
Willy Tarreau68574dd2021-11-05 19:14:55 +0100199char default_https_log_format[] = "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r %[fc_err]/%[ssl_fc_err,hex]/%[ssl_c_err]/%[ssl_c_ca_err]/%[ssl_fc_is_resumed] %[ssl_fc_sni]/%sslv/%sslc";
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200200char clf_http_log_format[] = "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl";
Willy Tarreau2beef582012-12-20 17:22:52 +0100201char default_tcp_log_format[] = "%ci:%cp [%t] %ft %b/%s %Tw/%Tc/%Tt %B %ts %ac/%fc/%bc/%sc/%rc %sq/%bq";
William Lallemand723b73a2012-02-08 16:37:49 +0100202char *log_format = NULL;
203
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200204/* Default string used for structured-data part in RFC5424 formatted
205 * syslog messages.
206 */
207char default_rfc5424_sd_log_format[] = "- ";
Dragan Dosen1322d092015-09-22 16:05:32 +0200208
Willy Tarreau13ef7732018-11-12 07:25:28 +0100209/* total number of dropped logs */
210unsigned int dropped_logs = 0;
211
Dragan Dosen59cee972015-09-19 22:09:02 +0200212/* This is a global syslog message buffer, common to all outgoing
213 * messages. It contains only the data part.
Willy Tarreaub1a2faf2012-03-19 16:51:53 +0100214 */
Christopher Fauletf8188c62017-06-02 16:20:16 +0200215THREAD_LOCAL char *logline = NULL;
Willy Tarreaub1a2faf2012-03-19 16:51:53 +0100216
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200217/* A global syslog message buffer, common to all RFC5424 syslog messages.
218 * Currently, it is used for generating the structured-data part.
219 */
Christopher Fauletf8188c62017-06-02 16:20:16 +0200220THREAD_LOCAL char *logline_rfc5424 = NULL;
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200221
William Lallemand723b73a2012-02-08 16:37:49 +0100222struct logformat_var_args {
223 char *name;
224 int mask;
225};
226
227struct logformat_var_args var_args_list[] = {
228// global
229 { "M", LOG_OPT_MANDATORY },
230 { "Q", LOG_OPT_QUOTE },
William Lallemand5f232402012-04-05 18:02:55 +0200231 { "X", LOG_OPT_HEXA },
Dragan Dosen835b9212016-02-12 13:23:03 +0100232 { "E", LOG_OPT_ESC },
William Lallemand723b73a2012-02-08 16:37:49 +0100233 { 0, 0 }
234};
235
236/*
William Lallemandb7ff6a32012-03-02 14:35:21 +0100237 * callback used to configure addr source retrieval
238 */
239int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy)
240{
241 curproxy->options2 |= PR_O2_SRC_ADDR;
242
243 return 0;
244}
245
246
247/*
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100248 * Parse args in a logformat_var. Returns 0 in error
249 * case, otherwise, it returns 1.
William Lallemand723b73a2012-02-08 16:37:49 +0100250 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100251int parse_logformat_var_args(char *args, struct logformat_node *node, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100252{
253 int i = 0;
254 int end = 0;
255 int flags = 0; // 1 = + 2 = -
256 char *sp = NULL; // start pointer
257
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100258 if (args == NULL) {
259 memprintf(err, "internal error: parse_logformat_var_args() expects non null 'args'");
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100260 return 0;
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100261 }
William Lallemand723b73a2012-02-08 16:37:49 +0100262
263 while (1) {
264 if (*args == '\0')
265 end = 1;
266
267 if (*args == '+') {
268 // add flag
269 sp = args + 1;
270 flags = 1;
271 }
272 if (*args == '-') {
273 // delete flag
274 sp = args + 1;
275 flags = 2;
276 }
277
278 if (*args == '\0' || *args == ',') {
279 *args = '\0';
Willy Tarreau254d44c2012-12-20 18:19:26 +0100280 for (i = 0; sp && var_args_list[i].name; i++) {
William Lallemand723b73a2012-02-08 16:37:49 +0100281 if (strcmp(sp, var_args_list[i].name) == 0) {
282 if (flags == 1) {
283 node->options |= var_args_list[i].mask;
284 break;
285 } else if (flags == 2) {
286 node->options &= ~var_args_list[i].mask;
287 break;
288 }
289 }
290 }
291 sp = NULL;
292 if (end)
293 break;
294 }
Willy Tarreau254d44c2012-12-20 18:19:26 +0100295 args++;
William Lallemand723b73a2012-02-08 16:37:49 +0100296 }
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100297 return 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100298}
299
300/*
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100301 * Parse a variable '%varname' or '%{args}varname' in log-format. The caller
302 * must pass the args part in the <arg> pointer with its length in <arg_len>,
303 * and varname with its length in <var> and <var_len> respectively. <arg> is
304 * ignored when arg_len is 0. Neither <var> nor <var_len> may be null.
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100305 * Returns false in error case and err is filled, otherwise returns true.
William Lallemand723b73a2012-02-08 16:37:49 +0100306 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100307int parse_logformat_var(char *arg, int arg_len, char *var, int var_len, struct proxy *curproxy, struct list *list_format, int *defoptions, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100308{
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100309 int j;
Dragan Dosen61302da2019-04-30 00:40:02 +0200310 struct logformat_node *node = NULL;
William Lallemand723b73a2012-02-08 16:37:49 +0100311
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100312 for (j = 0; logformat_keywords[j].name; j++) { // search a log type
313 if (strlen(logformat_keywords[j].name) == var_len &&
314 strncmp(var, logformat_keywords[j].name, var_len) == 0) {
315 if (logformat_keywords[j].mode != PR_MODE_HTTP || curproxy->mode == PR_MODE_HTTP) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200316 node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100317 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100318 memprintf(err, "out of memory error");
Dragan Dosen61302da2019-04-30 00:40:02 +0200319 goto error_free;
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100320 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100321 node->type = logformat_keywords[j].type;
322 node->options = *defoptions;
323 if (arg_len) {
324 node->arg = my_strndup(arg, arg_len);
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100325 if (!parse_logformat_var_args(node->arg, node, err))
Dragan Dosen61302da2019-04-30 00:40:02 +0200326 goto error_free;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100327 }
328 if (node->type == LOG_FMT_GLOBAL) {
329 *defoptions = node->options;
330 free(node->arg);
331 free(node);
332 } else {
333 if (logformat_keywords[j].config_callback &&
334 logformat_keywords[j].config_callback(node, curproxy) != 0) {
Dragan Dosen61302da2019-04-30 00:40:02 +0200335 goto error_free;
William Lallemand723b73a2012-02-08 16:37:49 +0100336 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100337 curproxy->to_log |= logformat_keywords[j].lw;
Willy Tarreau2b718102021-04-21 07:32:39 +0200338 LIST_APPEND(list_format, &node->list);
William Lallemand723b73a2012-02-08 16:37:49 +0100339 }
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100340 return 1;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100341 } else {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100342 memprintf(err, "format variable '%s' is reserved for HTTP mode",
343 logformat_keywords[j].name);
Dragan Dosen61302da2019-04-30 00:40:02 +0200344 goto error_free;
William Lallemand723b73a2012-02-08 16:37:49 +0100345 }
William Lallemand723b73a2012-02-08 16:37:49 +0100346 }
347 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100348
349 j = var[var_len];
350 var[var_len] = 0;
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100351 memprintf(err, "no such format variable '%s'. If you wanted to emit the '%%' character verbatim, you need to use '%%%%'", var);
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100352 var[var_len] = j;
Dragan Dosen61302da2019-04-30 00:40:02 +0200353
354 error_free:
355 if (node) {
356 free(node->arg);
357 free(node);
358 }
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100359 return 0;
William Lallemand723b73a2012-02-08 16:37:49 +0100360}
361
362/*
363 * push to the logformat linked list
364 *
365 * start: start pointer
366 * end: end text pointer
367 * type: string type
William Lallemand1d705562012-03-12 12:46:41 +0100368 * list_format: destination list
William Lallemand723b73a2012-02-08 16:37:49 +0100369 *
370 * LOG_TEXT: copy chars from start to end excluding end.
371 *
372*/
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100373int add_to_logformat_list(char *start, char *end, int type, struct list *list_format, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100374{
375 char *str;
376
Willy Tarreaua3571662012-12-20 21:59:12 +0100377 if (type == LF_TEXT) { /* type text */
Vincent Bernat02779b62016-04-03 13:48:43 +0200378 struct logformat_node *node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100379 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100380 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100381 return 0;
382 }
Vincent Bernat02779b62016-04-03 13:48:43 +0200383 str = calloc(1, end - start + 1);
William Lallemand723b73a2012-02-08 16:37:49 +0100384 strncpy(str, start, end - start);
William Lallemand723b73a2012-02-08 16:37:49 +0100385 str[end - start] = '\0';
386 node->arg = str;
William Lallemand1d705562012-03-12 12:46:41 +0100387 node->type = LOG_FMT_TEXT; // type string
Willy Tarreau2b718102021-04-21 07:32:39 +0200388 LIST_APPEND(list_format, &node->list);
Willy Tarreaua3571662012-12-20 21:59:12 +0100389 } else if (type == LF_SEPARATOR) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200390 struct logformat_node *node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100391 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100392 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100393 return 0;
394 }
William Lallemand1d705562012-03-12 12:46:41 +0100395 node->type = LOG_FMT_SEPARATOR;
Willy Tarreau2b718102021-04-21 07:32:39 +0200396 LIST_APPEND(list_format, &node->list);
William Lallemand723b73a2012-02-08 16:37:49 +0100397 }
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100398 return 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100399}
400
401/*
Willy Tarreauc8368452012-12-21 00:09:23 +0100402 * Parse the sample fetch expression <text> and add a node to <list_format> upon
403 * success. At the moment, sample converters are not yet supported but fetch arguments
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100404 * should work. The curpx->conf.args.ctx must be set by the caller. If an end pointer
405 * is passed in <endptr>, it will be updated with the pointer to the first character
406 * not part of the sample expression.
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100407 *
408 * In error case, the function returns 0, otherwise it returns 1.
Willy Tarreauc8368452012-12-21 00:09:23 +0100409 */
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100410int add_sample_to_logformat_list(char *text, char *arg, int arg_len, struct proxy *curpx, struct list *list_format, int options, int cap, char **err, char **endptr)
Willy Tarreauc8368452012-12-21 00:09:23 +0100411{
412 char *cmd[2];
Dragan Dosen61302da2019-04-30 00:40:02 +0200413 struct sample_expr *expr = NULL;
414 struct logformat_node *node = NULL;
Willy Tarreauc8368452012-12-21 00:09:23 +0100415 int cmd_arg;
416
417 cmd[0] = text;
418 cmd[1] = "";
419 cmd_arg = 0;
420
Christopher Fauleteaba25d2021-09-30 16:22:51 +0200421 expr = sample_parse_expr(cmd, &cmd_arg, curpx->conf.args.file, curpx->conf.args.line, err,
Christopher Faulet6ff7de52021-10-13 15:18:36 +0200422 &curpx->conf.args, endptr);
Willy Tarreauc8368452012-12-21 00:09:23 +0100423 if (!expr) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100424 memprintf(err, "failed to parse sample expression <%s> : %s", text, *err);
Dragan Dosen61302da2019-04-30 00:40:02 +0200425 goto error_free;
Willy Tarreauc8368452012-12-21 00:09:23 +0100426 }
427
Vincent Bernat02779b62016-04-03 13:48:43 +0200428 node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100429 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100430 memprintf(err, "out of memory error");
Dragan Dosen61302da2019-04-30 00:40:02 +0200431 goto error_free;
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100432 }
Willy Tarreauc8368452012-12-21 00:09:23 +0100433 node->type = LOG_FMT_EXPR;
434 node->expr = expr;
435 node->options = options;
436
437 if (arg_len) {
438 node->arg = my_strndup(arg, arg_len);
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100439 if (!parse_logformat_var_args(node->arg, node, err))
Dragan Dosen61302da2019-04-30 00:40:02 +0200440 goto error_free;
Willy Tarreauc8368452012-12-21 00:09:23 +0100441 }
Willy Tarreau434c57c2013-01-08 01:10:24 +0100442 if (expr->fetch->val & cap & SMP_VAL_REQUEST)
Willy Tarreauc8368452012-12-21 00:09:23 +0100443 node->options |= LOG_OPT_REQ_CAP; /* fetch method is request-compatible */
444
Willy Tarreau434c57c2013-01-08 01:10:24 +0100445 if (expr->fetch->val & cap & SMP_VAL_RESPONSE)
Willy Tarreauc8368452012-12-21 00:09:23 +0100446 node->options |= LOG_OPT_RES_CAP; /* fetch method is response-compatible */
447
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100448 if (!(expr->fetch->val & cap)) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100449 memprintf(err, "sample fetch <%s> may not be reliably used here because it needs '%s' which is not available here",
450 text, sample_src_names(expr->fetch->use));
Dragan Dosen61302da2019-04-30 00:40:02 +0200451 goto error_free;
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100452 }
Willy Tarreau434c57c2013-01-08 01:10:24 +0100453
Christopher Faulet581db2b2021-03-26 10:02:46 +0100454 if ((options & LOG_OPT_HTTP) && (expr->fetch->use & (SMP_USE_L6REQ|SMP_USE_L6RES))) {
455 ha_warning("parsing [%s:%d] : L6 sample fetch <%s> ignored in HTTP log-format string.\n",
456 curpx->conf.args.file, curpx->conf.args.line, text);
457 }
458
Christopher Faulet711ed6a2019-07-16 14:16:10 +0200459 /* check if we need to allocate an http_txn struct for HTTP parsing */
Willy Tarreauc8368452012-12-21 00:09:23 +0100460 /* Note, we may also need to set curpx->to_log with certain fetches */
Willy Tarreau25320b22013-03-24 07:22:08 +0100461 curpx->http_needed |= !!(expr->fetch->use & SMP_USE_HTTP_ANY);
Willy Tarreauc8368452012-12-21 00:09:23 +0100462
William Lallemand65ad6e12014-01-31 15:08:02 +0100463 /* FIXME: temporary workaround for missing LW_XPRT and LW_REQ flags
464 * needed with some sample fetches (eg: ssl*). We always set it for
465 * now on, but this will leave with sample capabilities soon.
Willy Tarreau1f31c732013-01-10 16:22:27 +0100466 */
467 curpx->to_log |= LW_XPRT;
Christopher Fauletd2236cd2020-04-06 18:29:14 +0200468 if (curpx->http_needed)
469 curpx->to_log |= LW_REQ;
Willy Tarreau2b718102021-04-21 07:32:39 +0200470 LIST_APPEND(list_format, &node->list);
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100471 return 1;
Dragan Dosen61302da2019-04-30 00:40:02 +0200472
473 error_free:
474 release_sample_expr(expr);
475 if (node) {
476 free(node->arg);
477 free(node);
478 }
479 return 0;
Willy Tarreauc8368452012-12-21 00:09:23 +0100480}
481
482/*
William Lallemand723b73a2012-02-08 16:37:49 +0100483 * Parse the log_format string and fill a linked list.
484 * Variable name are preceded by % and composed by characters [a-zA-Z0-9]* : %varname
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200485 * You can set arguments using { } : %{many arguments}varname.
486 * The curproxy->conf.args.ctx must be set by the caller.
William Lallemand1d705562012-03-12 12:46:41 +0100487 *
Ilya Shipitsinae40dbc2020-04-04 12:59:53 +0500488 * fmt: the string to parse
William Lallemand1d705562012-03-12 12:46:41 +0100489 * curproxy: the proxy affected
490 * list_format: the destination list
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +0100491 * options: LOG_OPT_* to force on every node
Willy Tarreau434c57c2013-01-08 01:10:24 +0100492 * cap: all SMP_VAL_* flags supported by the consumer
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100493 *
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100494 * The function returns 1 in success case, otherwise, it returns 0 and err is filled.
William Lallemand723b73a2012-02-08 16:37:49 +0100495 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100496int parse_logformat_string(const char *fmt, struct proxy *curproxy, struct list *list_format, int options, int cap, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100497{
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100498 char *sp, *str, *backfmt; /* start pointer for text parts */
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100499 char *arg = NULL; /* start pointer for args */
500 char *var = NULL; /* start pointer for vars */
501 int arg_len = 0;
502 int var_len = 0;
503 int cformat; /* current token format */
504 int pformat; /* previous token format */
William Lallemand723b73a2012-02-08 16:37:49 +0100505 struct logformat_node *tmplf, *back;
506
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100507 sp = str = backfmt = strdup(fmt);
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100508 if (!str) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100509 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100510 return 0;
511 }
William Lallemand1dc00ef2012-08-09 16:41:35 +0200512 curproxy->to_log |= LW_INIT;
William Lallemand5e19a282012-04-02 16:22:10 +0200513
William Lallemand723b73a2012-02-08 16:37:49 +0100514 /* flush the list first. */
William Lallemand1d705562012-03-12 12:46:41 +0100515 list_for_each_entry_safe(tmplf, back, list_format, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200516 LIST_DELETE(&tmplf->list);
Dragan Dosen61302da2019-04-30 00:40:02 +0200517 release_sample_expr(tmplf->expr);
518 free(tmplf->arg);
William Lallemand723b73a2012-02-08 16:37:49 +0100519 free(tmplf);
520 }
521
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100522 for (cformat = LF_INIT; cformat != LF_END; str++) {
William Lallemand723b73a2012-02-08 16:37:49 +0100523 pformat = cformat;
524
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100525 if (!*str)
526 cformat = LF_END; // preset it to save all states from doing this
William Lallemand723b73a2012-02-08 16:37:49 +0100527
Joseph Herlant85b40592018-11-15 12:10:04 -0800528 /* The principle of the two-step state machine below is to first detect a change, and
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100529 * second have all common paths processed at one place. The common paths are the ones
530 * encountered in text areas (LF_INIT, LF_TEXT, LF_SEPARATOR) and at the end (LF_END).
531 * We use the common LF_INIT state to dispatch to the different final states.
532 */
533 switch (pformat) {
534 case LF_STARTVAR: // text immediately following a '%'
Willy Tarreauc8368452012-12-21 00:09:23 +0100535 arg = NULL; var = NULL;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100536 arg_len = var_len = 0;
537 if (*str == '{') { // optional argument
538 cformat = LF_STARG;
539 arg = str + 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100540 }
Willy Tarreauc8368452012-12-21 00:09:23 +0100541 else if (*str == '[') {
542 cformat = LF_STEXPR;
543 var = str + 1; // store expr in variable name
544 }
Willy Tarreau0f28f822013-12-16 01:38:33 +0100545 else if (isalpha((unsigned char)*str)) { // variable name
William Lallemand723b73a2012-02-08 16:37:49 +0100546 cformat = LF_VAR;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100547 var = str;
William Lallemand723b73a2012-02-08 16:37:49 +0100548 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100549 else if (*str == '%')
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500550 cformat = LF_TEXT; // convert this character to a literal (useful for '%')
Willy Tarreau0f28f822013-12-16 01:38:33 +0100551 else if (isdigit((unsigned char)*str) || *str == ' ' || *str == '\t') {
Willy Tarreau06d97f92013-12-02 17:45:48 +0100552 /* single '%' followed by blank or digit, send them both */
553 cformat = LF_TEXT;
554 pformat = LF_TEXT; /* finally we include the previous char as well */
555 sp = str - 1; /* send both the '%' and the current char */
Jim Freemana2278c82017-04-15 08:01:59 -0600556 memprintf(err, "unexpected variable name near '%c' at position %d line : '%s'. Maybe you want to write a single '%%', use the syntax '%%%%'",
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100557 *str, (int)(str - backfmt), fmt);
Willy Tarreau51013e82019-12-11 12:05:39 +0100558 goto fail;
Willy Tarreau06d97f92013-12-02 17:45:48 +0100559
560 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100561 else
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500562 cformat = LF_INIT; // handle other cases of literals
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100563 break;
564
565 case LF_STARG: // text immediately following '%{'
566 if (*str == '}') { // end of arg
William Lallemand723b73a2012-02-08 16:37:49 +0100567 cformat = LF_EDARG;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100568 arg_len = str - arg;
569 *str = 0; // used for reporting errors
William Lallemand723b73a2012-02-08 16:37:49 +0100570 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100571 break;
572
573 case LF_EDARG: // text immediately following '%{arg}'
Willy Tarreauc8368452012-12-21 00:09:23 +0100574 if (*str == '[') {
575 cformat = LF_STEXPR;
576 var = str + 1; // store expr in variable name
577 break;
578 }
Willy Tarreau0f28f822013-12-16 01:38:33 +0100579 else if (isalnum((unsigned char)*str)) { // variable name
William Lallemand723b73a2012-02-08 16:37:49 +0100580 cformat = LF_VAR;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100581 var = str;
582 break;
583 }
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100584 memprintf(err, "parse argument modifier without variable name near '%%{%s}'", arg);
Willy Tarreau51013e82019-12-11 12:05:39 +0100585 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100586
Willy Tarreauc8368452012-12-21 00:09:23 +0100587 case LF_STEXPR: // text immediately following '%['
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100588 /* the whole sample expression is parsed at once,
589 * returning the pointer to the first character not
590 * part of the expression, which MUST be the trailing
591 * angle bracket.
592 */
593 if (!add_sample_to_logformat_list(var, arg, arg_len, curproxy, list_format, options, cap, err, &str))
594 goto fail;
595
596 if (*str == ']') {
597 // end of arg, go on with next state
598 cformat = pformat = LF_EDEXPR;
599 sp = str;
600 }
601 else {
602 char c = *str;
603 *str = 0;
Willy Tarreau90807112020-02-25 08:16:33 +0100604 if (isprint((unsigned char)c))
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100605 memprintf(err, "expected ']' after '%s', but found '%c'", var, c);
606 else
607 memprintf(err, "missing ']' after '%s'", var);
Dragan Dosen2866acf2020-06-30 21:16:43 +0200608 goto fail;
Willy Tarreauc8368452012-12-21 00:09:23 +0100609 }
610 break;
611
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100612 case LF_VAR: // text part of a variable name
613 var_len = str - var;
Willy Tarreau0f28f822013-12-16 01:38:33 +0100614 if (!isalnum((unsigned char)*str))
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100615 cformat = LF_INIT; // not variable name anymore
616 break;
617
Willy Tarreauc8368452012-12-21 00:09:23 +0100618 default: // LF_INIT, LF_TEXT, LF_SEPARATOR, LF_END, LF_EDEXPR
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100619 cformat = LF_INIT;
620 }
621
622 if (cformat == LF_INIT) { /* resynchronize state to text/sep/startvar */
623 switch (*str) {
624 case '%': cformat = LF_STARTVAR; break;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100625 case 0 : cformat = LF_END; break;
Dragan Dosen1e3b16f2020-06-23 18:16:44 +0200626 case ' ':
627 if (options & LOG_OPT_MERGE_SPACES) {
628 cformat = LF_SEPARATOR;
629 break;
630 }
Willy Tarreau80f9a632022-11-14 07:22:57 +0100631 __fallthrough;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100632 default : cformat = LF_TEXT; break;
William Lallemand723b73a2012-02-08 16:37:49 +0100633 }
634 }
635
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100636 if (cformat != pformat || pformat == LF_SEPARATOR) {
637 switch (pformat) {
638 case LF_VAR:
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100639 if (!parse_logformat_var(arg, arg_len, var, var_len, curproxy, list_format, &options, err))
Willy Tarreau51013e82019-12-11 12:05:39 +0100640 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100641 break;
642 case LF_TEXT:
643 case LF_SEPARATOR:
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100644 if (!add_to_logformat_list(sp, str, pformat, list_format, err))
Willy Tarreau51013e82019-12-11 12:05:39 +0100645 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100646 break;
647 }
648 sp = str; /* new start of text at every state switch and at every separator */
William Lallemand723b73a2012-02-08 16:37:49 +0100649 }
650 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100651
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100652 if (pformat == LF_STARTVAR || pformat == LF_STARG || pformat == LF_STEXPR) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100653 memprintf(err, "truncated line after '%s'", var ? var : arg ? arg : "%");
Willy Tarreau51013e82019-12-11 12:05:39 +0100654 goto fail;
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100655 }
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100656 free(backfmt);
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100657
658 return 1;
Willy Tarreau51013e82019-12-11 12:05:39 +0100659 fail:
660 free(backfmt);
661 return 0;
William Lallemand723b73a2012-02-08 16:37:49 +0100662}
663
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200664/*
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500665 * Parse the first range of indexes from a string made of a list of comma separated
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200666 * ranges of indexes. Note that an index may be considered as a particular range
667 * with a high limit to the low limit.
668 */
669int get_logsrv_smp_range(unsigned int *low, unsigned int *high, char **arg, char **err)
670{
671 char *end, *p;
672
673 *low = *high = 0;
674
675 p = *arg;
676 end = strchr(p, ',');
677 if (!end)
678 end = p + strlen(p);
679
680 *high = *low = read_uint((const char **)&p, end);
681 if (!*low || (p != end && *p != '-'))
682 goto err;
683
684 if (p == end)
685 goto done;
686
687 p++;
688 *high = read_uint((const char **)&p, end);
689 if (!*high || *high <= *low || p != end)
690 goto err;
691
692 done:
693 if (*end == ',')
694 end++;
695 *arg = end;
696 return 1;
697
698 err:
699 memprintf(err, "wrong sample range '%s'", *arg);
700 return 0;
701}
702
703/*
704 * Returns 1 if the range defined by <low> and <high> overlaps
705 * one of them in <rgs> array of ranges with <sz> the size of this
706 * array, 0 if not.
707 */
708int smp_log_ranges_overlap(struct smp_log_range *rgs, size_t sz,
709 unsigned int low, unsigned int high, char **err)
710{
711 size_t i;
712
713 for (i = 0; i < sz; i++) {
714 if ((low >= rgs[i].low && low <= rgs[i].high) ||
715 (high >= rgs[i].low && high <= rgs[i].high)) {
716 memprintf(err, "ranges are overlapping");
717 return 1;
718 }
719 }
720
721 return 0;
722}
723
724int smp_log_range_cmp(const void *a, const void *b)
725{
726 const struct smp_log_range *rg_a = a;
727 const struct smp_log_range *rg_b = b;
728
729 if (rg_a->high < rg_b->low)
730 return -1;
731 else if (rg_a->low > rg_b->high)
732 return 1;
733
734 return 0;
735}
736
Willy Tarreau211ea252022-03-17 19:47:33 +0100737/* frees log server <logsrv> after freeing all of its allocated fields. The
738 * server must not belong to a list anymore. Logsrv may be NULL, which is
739 * silently ignored.
740 */
741void free_logsrv(struct logsrv *logsrv)
742{
743 if (!logsrv)
744 return;
745
746 BUG_ON(LIST_INLIST(&logsrv->list));
747 ha_free(&logsrv->conf.file);
748 ha_free(&logsrv->ring_name);
749 free(logsrv);
750}
751
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200752/*
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200753 * Parse "log" keyword and update <logsrvs> list accordingly.
754 *
755 * When <do_del> is set, it means the "no log" line was parsed, so all log
756 * servers in <logsrvs> are released.
757 *
758 * Otherwise, we try to parse the "log" line. First of all, when the list is not
759 * the global one, we look for the parameter "global". If we find it,
760 * global.logsrvs is copied. Else we parse each arguments.
761 *
762 * The function returns 1 in success case, otherwise, it returns 0 and err is
763 * filled.
764 */
Emeric Brun9533a702021-04-02 10:13:43 +0200765int parse_logsrv(char **args, struct list *logsrvs, int do_del, const char *file, int linenum, char **err)
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200766{
Willy Tarreauae32ac72020-10-27 09:51:37 +0100767 struct smp_log_range *smp_rgs = NULL;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200768 struct sockaddr_storage *sk;
Emeric Brun94aab062021-04-02 10:41:36 +0200769 struct protocol *proto;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200770 struct logsrv *logsrv = NULL;
771 int port1, port2;
772 int cur_arg;
Willy Tarreau89599262020-09-15 14:03:26 +0200773 int fd;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200774
775 /*
776 * "no log": delete previous herited or defined syslog
777 * servers.
778 */
779 if (do_del) {
780 struct logsrv *back;
781
782 if (*(args[1]) != 0) {
783 memprintf(err, "'no log' does not expect arguments");
784 goto error;
785 }
786
787 list_for_each_entry_safe(logsrv, back, logsrvs, list) {
Willy Tarreau211ea252022-03-17 19:47:33 +0100788 LIST_DEL_INIT(&logsrv->list);
789 free_logsrv(logsrv);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200790 }
791 return 1;
792 }
793
794 /*
795 * "log global": copy global.logrsvs linked list to the end of logsrvs
796 * list. But first, we check (logsrvs != global.logsrvs).
797 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100798 if (*(args[1]) && *(args[2]) == 0 && strcmp(args[1], "global") == 0) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200799 if (logsrvs == &global.logsrvs) {
800 memprintf(err, "'global' is not supported for a global syslog server");
801 goto error;
802 }
803 list_for_each_entry(logsrv, &global.logsrvs, list) {
Christopher Faulet28ac0992018-03-26 16:09:19 +0200804 struct logsrv *node;
805
806 list_for_each_entry(node, logsrvs, list) {
807 if (node->ref == logsrv)
808 goto skip_logsrv;
809 }
810
811 node = malloc(sizeof(*node));
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200812 memcpy(node, logsrv, sizeof(struct logsrv));
Christopher Faulet28ac0992018-03-26 16:09:19 +0200813 node->ref = logsrv;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200814 LIST_INIT(&node->list);
Willy Tarreau2b718102021-04-21 07:32:39 +0200815 LIST_APPEND(logsrvs, &node->list);
Willy Tarreau211ea252022-03-17 19:47:33 +0100816 node->ring_name = logsrv->ring_name ? strdup(logsrv->ring_name) : NULL;
Emeric Brun9533a702021-04-02 10:13:43 +0200817 node->conf.file = strdup(file);
818 node->conf.line = linenum;
Christopher Faulet28ac0992018-03-26 16:09:19 +0200819
820 skip_logsrv:
821 continue;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200822 }
823 return 1;
824 }
825
826 /*
827 * "log <address> ...: parse a syslog server line
828 */
829 if (*(args[1]) == 0 || *(args[2]) == 0) {
830 memprintf(err, "expects <address> and <facility> %s as arguments",
831 ((logsrvs == &global.logsrvs) ? "" : "or global"));
832 goto error;
833 }
834
Willy Tarreau5a32ecc2018-11-12 07:34:59 +0100835 /* take care of "stdout" and "stderr" as regular aliases for fd@1 / fd@2 */
836 if (strcmp(args[1], "stdout") == 0)
837 args[1] = "fd@1";
838 else if (strcmp(args[1], "stderr") == 0)
839 args[1] = "fd@2";
840
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200841 logsrv = calloc(1, sizeof(*logsrv));
842 if (!logsrv) {
843 memprintf(err, "out of memory");
844 goto error;
845 }
Christopher Fauletb4f96ed2022-03-29 14:17:09 +0200846 LIST_INIT(&logsrv->list);
Emeric Brun9533a702021-04-02 10:13:43 +0200847 logsrv->conf.file = strdup(file);
848 logsrv->conf.line = linenum;
849
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200850 /* skip address for now, it will be parsed at the end */
851 cur_arg = 2;
852
853 /* just after the address, a length may be specified */
854 logsrv->maxlen = MAX_SYSLOG_LEN;
855 if (strcmp(args[cur_arg], "len") == 0) {
856 int len = atoi(args[cur_arg+1]);
857 if (len < 80 || len > 65535) {
858 memprintf(err, "invalid log length '%s', must be between 80 and 65535",
859 args[cur_arg+1]);
860 goto error;
861 }
862 logsrv->maxlen = len;
863 cur_arg += 2;
864 }
865 if (logsrv->maxlen > global.max_syslog_len)
866 global.max_syslog_len = logsrv->maxlen;
867
868 /* after the length, a format may be specified */
869 if (strcmp(args[cur_arg], "format") == 0) {
870 logsrv->format = get_log_format(args[cur_arg+1]);
Emeric Brun54648852020-07-06 15:54:06 +0200871 if (logsrv->format == LOG_FORMAT_UNSPEC) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200872 memprintf(err, "unknown log format '%s'", args[cur_arg+1]);
873 goto error;
874 }
875 cur_arg += 2;
876 }
877
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200878 if (strcmp(args[cur_arg], "sample") == 0) {
879 unsigned low, high;
880 char *p, *beg, *end, *smp_sz_str;
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200881 size_t smp_rgs_sz = 0, smp_sz = 0, new_smp_sz;
882
883 p = args[cur_arg+1];
884 smp_sz_str = strchr(p, ':');
885 if (!smp_sz_str) {
886 memprintf(err, "Missing sample size");
887 goto error;
888 }
889
890 *smp_sz_str++ = '\0';
891
892 end = p + strlen(p);
893
894 while (p != end) {
895 if (!get_logsrv_smp_range(&low, &high, &p, err))
896 goto error;
897
898 if (smp_rgs && smp_log_ranges_overlap(smp_rgs, smp_rgs_sz, low, high, err))
899 goto error;
900
901 smp_rgs = my_realloc2(smp_rgs, (smp_rgs_sz + 1) * sizeof *smp_rgs);
902 if (!smp_rgs) {
903 memprintf(err, "out of memory error");
904 goto error;
905 }
906
907 smp_rgs[smp_rgs_sz].low = low;
908 smp_rgs[smp_rgs_sz].high = high;
909 smp_rgs[smp_rgs_sz].sz = high - low + 1;
910 smp_rgs[smp_rgs_sz].curr_idx = 0;
911 if (smp_rgs[smp_rgs_sz].high > smp_sz)
912 smp_sz = smp_rgs[smp_rgs_sz].high;
913 smp_rgs_sz++;
914 }
915
Tim Duesterhus21648002019-06-23 22:10:10 +0200916 if (smp_rgs == NULL) {
917 memprintf(err, "no sampling ranges given");
918 goto error;
919 }
920
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200921 beg = smp_sz_str;
922 end = beg + strlen(beg);
923 new_smp_sz = read_uint((const char **)&beg, end);
924 if (!new_smp_sz || beg != end) {
925 memprintf(err, "wrong sample size '%s' for sample range '%s'",
926 smp_sz_str, args[cur_arg+1]);
927 goto error;
928 }
929
930 if (new_smp_sz < smp_sz) {
931 memprintf(err, "sample size %zu should be greater or equal to "
932 "%zu the maximum of the high ranges limits",
933 new_smp_sz, smp_sz);
934 goto error;
935 }
936 smp_sz = new_smp_sz;
937
938 /* Let's order <smp_rgs> array. */
939 qsort(smp_rgs, smp_rgs_sz, sizeof(struct smp_log_range), smp_log_range_cmp);
940
941 logsrv->lb.smp_rgs = smp_rgs;
942 logsrv->lb.smp_rgs_sz = smp_rgs_sz;
943 logsrv->lb.smp_sz = smp_sz;
944
945 cur_arg += 2;
946 }
Frédéric Lécailled803e472019-04-25 07:42:09 +0200947 HA_SPIN_INIT(&logsrv->lock);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200948 /* parse the facility */
949 logsrv->facility = get_log_facility(args[cur_arg]);
950 if (logsrv->facility < 0) {
951 memprintf(err, "unknown log facility '%s'", args[cur_arg]);
952 goto error;
953 }
954 cur_arg++;
955
956 /* parse the max syslog level (default: debug) */
957 logsrv->level = 7;
958 if (*(args[cur_arg])) {
959 logsrv->level = get_log_level(args[cur_arg]);
960 if (logsrv->level < 0) {
961 memprintf(err, "unknown optional log level '%s'", args[cur_arg]);
962 goto error;
963 }
964 cur_arg++;
965 }
966
967 /* parse the limit syslog level (default: emerg) */
968 logsrv->minlvl = 0;
969 if (*(args[cur_arg])) {
970 logsrv->minlvl = get_log_level(args[cur_arg]);
971 if (logsrv->minlvl < 0) {
972 memprintf(err, "unknown optional minimum log level '%s'", args[cur_arg]);
973 goto error;
974 }
975 cur_arg++;
976 }
977
978 /* Too many args */
979 if (*(args[cur_arg])) {
980 memprintf(err, "cannot handle unexpected argument '%s'", args[cur_arg]);
981 goto error;
982 }
983
984 /* now, back to the address */
Willy Tarreauf3dc30f2019-08-30 14:18:44 +0200985 logsrv->type = LOG_TARGET_DGRAM;
Willy Tarreauc046d162019-08-30 15:24:59 +0200986 if (strncmp(args[1], "ring@", 5) == 0) {
Willy Tarreauc046d162019-08-30 15:24:59 +0200987 logsrv->addr.ss_family = AF_UNSPEC;
988 logsrv->type = LOG_TARGET_BUFFER;
Emeric Brun99c453d2020-05-25 15:01:04 +0200989 logsrv->sink = NULL;
990 logsrv->ring_name = strdup(args[1] + 5);
Willy Tarreauc046d162019-08-30 15:24:59 +0200991 goto done;
992 }
993
Emeric Brun94aab062021-04-02 10:41:36 +0200994 sk = str2sa_range(args[1], NULL, &port1, &port2, &fd, &proto,
995 err, NULL, NULL,
996 PA_O_RESOLVE | PA_O_PORT_OK | PA_O_RAW_FD | PA_O_DGRAM | PA_O_STREAM | PA_O_DEFAULT_DGRAM);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200997 if (!sk)
998 goto error;
Willy Tarreau89599262020-09-15 14:03:26 +0200999
1000 if (fd != -1)
1001 logsrv->type = LOG_TARGET_FD;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001002 logsrv->addr = *sk;
1003
1004 if (sk->ss_family == AF_INET || sk->ss_family == AF_INET6) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001005 if (!port1)
1006 set_host_port(&logsrv->addr, SYSLOG_PORT);
1007 }
Emeric Brun9533a702021-04-02 10:13:43 +02001008
Willy Tarreau91b47262022-05-20 16:36:46 +02001009 if (proto && proto->xprt_type == PROTO_TYPE_STREAM) {
Emeric Brun94aab062021-04-02 10:41:36 +02001010 static unsigned long ring_ids;
1011
1012 /* Implicit sink buffer will be
1013 * initialized in post_check
1014 */
1015 logsrv->type = LOG_TARGET_BUFFER;
1016 logsrv->sink = NULL;
1017 /* compute uniq name for the ring */
1018 memprintf(&logsrv->ring_name, "ring#%lu", ++ring_ids);
1019 }
1020
Willy Tarreauc046d162019-08-30 15:24:59 +02001021 done:
Willy Tarreau2b718102021-04-21 07:32:39 +02001022 LIST_APPEND(logsrvs, &logsrv->list);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001023 return 1;
1024
1025 error:
Willy Tarreauae32ac72020-10-27 09:51:37 +01001026 free(smp_rgs);
Willy Tarreau211ea252022-03-17 19:47:33 +01001027 free_logsrv(logsrv);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001028 return 0;
1029}
1030
Amaury Denoyelle7b01a8d2021-03-29 10:29:07 +02001031
1032/*
Emeric Brun54648852020-07-06 15:54:06 +02001033 * returns log format, LOG_FORMAT_UNSPEC is return if not found.
Dragan Dosen1322d092015-09-22 16:05:32 +02001034 */
Emeric Brun54648852020-07-06 15:54:06 +02001035enum log_fmt get_log_format(const char *fmt)
Dragan Dosen1322d092015-09-22 16:05:32 +02001036{
Emeric Brun54648852020-07-06 15:54:06 +02001037 enum log_fmt format;
Dragan Dosen1322d092015-09-22 16:05:32 +02001038
1039 format = LOG_FORMATS - 1;
Emeric Brun54648852020-07-06 15:54:06 +02001040 while (format > 0 && log_formats[format].name
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001041 && strcmp(log_formats[format].name, fmt) != 0)
Dragan Dosen1322d092015-09-22 16:05:32 +02001042 format--;
1043
Emeric Brun54648852020-07-06 15:54:06 +02001044 /* Note: 0 is LOG_FORMAT_UNSPEC */
Dragan Dosen1322d092015-09-22 16:05:32 +02001045 return format;
1046}
1047
1048/*
Willy Tarreaubaaee002006-06-26 02:48:02 +02001049 * returns log level for <lev> or -1 if not found.
1050 */
1051int get_log_level(const char *lev)
1052{
1053 int level;
1054
1055 level = NB_LOG_LEVELS - 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001056 while (level >= 0 && strcmp(log_levels[level], lev) != 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001057 level--;
1058
1059 return level;
1060}
1061
Willy Tarreaubaaee002006-06-26 02:48:02 +02001062/*
1063 * returns log facility for <fac> or -1 if not found.
1064 */
1065int get_log_facility(const char *fac)
1066{
1067 int facility;
1068
1069 facility = NB_LOG_FACILITIES - 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001070 while (facility >= 0 && strcmp(log_facilities[facility], fac) != 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001071 facility--;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001072
Willy Tarreaubaaee002006-06-26 02:48:02 +02001073 return facility;
1074}
1075
William Lallemanda1cc3812012-02-08 16:38:44 +01001076/*
Dragan Dosen835b9212016-02-12 13:23:03 +01001077 * Encode the string.
1078 *
1079 * When using the +E log format option, it will try to escape '"\]'
1080 * characters with '\' as prefix. The same prefix should not be used as
1081 * <escape>.
1082 */
1083static char *lf_encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001084 const char escape, const long *map,
Dragan Dosen835b9212016-02-12 13:23:03 +01001085 const char *string,
1086 struct logformat_node *node)
1087{
1088 if (node->options & LOG_OPT_ESC) {
1089 if (start < stop) {
1090 stop--; /* reserve one byte for the final '\0' */
1091 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001092 if (!ha_bit_test((unsigned char)(*string), map)) {
1093 if (!ha_bit_test((unsigned char)(*string), rfc5424_escape_map))
Dragan Dosen835b9212016-02-12 13:23:03 +01001094 *start++ = *string;
1095 else {
1096 if (start + 2 >= stop)
1097 break;
1098 *start++ = '\\';
1099 *start++ = *string;
1100 }
1101 }
1102 else {
1103 if (start + 3 >= stop)
1104 break;
1105 *start++ = escape;
1106 *start++ = hextab[(*string >> 4) & 15];
1107 *start++ = hextab[*string & 15];
1108 }
1109 string++;
1110 }
1111 *start = '\0';
1112 }
1113 }
1114 else {
1115 return encode_string(start, stop, escape, map, string);
1116 }
1117
1118 return start;
1119}
1120
1121/*
1122 * Encode the chunk.
1123 *
1124 * When using the +E log format option, it will try to escape '"\]'
1125 * characters with '\' as prefix. The same prefix should not be used as
1126 * <escape>.
1127 */
1128static char *lf_encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001129 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001130 const struct buffer *chunk,
Dragan Dosen835b9212016-02-12 13:23:03 +01001131 struct logformat_node *node)
1132{
1133 char *str, *end;
1134
1135 if (node->options & LOG_OPT_ESC) {
1136 if (start < stop) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001137 str = chunk->area;
1138 end = chunk->area + chunk->data;
Dragan Dosen835b9212016-02-12 13:23:03 +01001139
1140 stop--; /* reserve one byte for the final '\0' */
1141 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001142 if (!ha_bit_test((unsigned char)(*str), map)) {
1143 if (!ha_bit_test((unsigned char)(*str), rfc5424_escape_map))
Dragan Dosen835b9212016-02-12 13:23:03 +01001144 *start++ = *str;
1145 else {
1146 if (start + 2 >= stop)
1147 break;
1148 *start++ = '\\';
1149 *start++ = *str;
1150 }
1151 }
1152 else {
1153 if (start + 3 >= stop)
1154 break;
1155 *start++ = escape;
1156 *start++ = hextab[(*str >> 4) & 15];
1157 *start++ = hextab[*str & 15];
1158 }
1159 str++;
1160 }
1161 *start = '\0';
1162 }
1163 }
1164 else {
1165 return encode_chunk(start, stop, escape, map, chunk);
1166 }
1167
1168 return start;
1169}
1170
1171/*
William Lallemanda1cc3812012-02-08 16:38:44 +01001172 * Write a string in the log string
Dragan Dosen835b9212016-02-12 13:23:03 +01001173 * Take cares of quote and escape options
William Lallemanda1cc3812012-02-08 16:38:44 +01001174 *
Joseph Herlant85b40592018-11-15 12:10:04 -08001175 * Return the address of the \0 character, or NULL on error
William Lallemanda1cc3812012-02-08 16:38:44 +01001176 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001177char *lf_text_len(char *dst, const char *src, size_t len, size_t size, const struct logformat_node *node)
William Lallemanda1cc3812012-02-08 16:38:44 +01001178{
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001179 if (size < 2)
1180 return NULL;
William Lallemanda1cc3812012-02-08 16:38:44 +01001181
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001182 if (node->options & LOG_OPT_QUOTE) {
1183 *(dst++) = '"';
1184 size--;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001185 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001186
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001187 if (src && len) {
Aurelien DARRAGONc5bff8e2022-09-20 14:33:18 +02001188 /* escape_string and strlcpy2 will both try to add terminating NULL-byte
1189 * to dst, so we need to make sure that extra byte will fit into dst
1190 * before calling them
1191 */
Dragan Dosen835b9212016-02-12 13:23:03 +01001192 if (node->options & LOG_OPT_ESC) {
Dragan Dosen835b9212016-02-12 13:23:03 +01001193 char *ret;
1194
Aurelien DARRAGONc5bff8e2022-09-20 14:33:18 +02001195 ret = escape_string(dst, (dst + size - 1), '\\', rfc5424_escape_map, src, src + len);
Dragan Dosen835b9212016-02-12 13:23:03 +01001196 if (ret == NULL || *ret != '\0')
1197 return NULL;
1198 len = ret - dst;
1199 }
1200 else {
Aurelien DARRAGONc5bff8e2022-09-20 14:33:18 +02001201 if (++len > size)
1202 len = size;
Dragan Dosen835b9212016-02-12 13:23:03 +01001203 len = strlcpy2(dst, src, len);
1204 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001205
1206 size -= len;
1207 dst += len;
1208 }
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001209 else if ((node->options & (LOG_OPT_QUOTE|LOG_OPT_MANDATORY)) == LOG_OPT_MANDATORY) {
1210 if (size < 2)
1211 return NULL;
1212 *(dst++) = '-';
Aurelien DARRAGONc5bff8e2022-09-20 14:33:18 +02001213 size -= 1;
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001214 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001215
1216 if (node->options & LOG_OPT_QUOTE) {
1217 if (size < 2)
1218 return NULL;
1219 *(dst++) = '"';
1220 }
1221
1222 *dst = '\0';
William Lallemandbddd4fd2012-02-27 11:23:10 +01001223 return dst;
William Lallemanda1cc3812012-02-08 16:38:44 +01001224}
1225
Willy Tarreau26ffa852018-09-05 15:23:10 +02001226static inline char *lf_text(char *dst, const char *src, size_t size, const struct logformat_node *node)
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001227{
1228 return lf_text_len(dst, src, size, size, node);
1229}
1230
William Lallemand5f232402012-04-05 18:02:55 +02001231/*
Joseph Herlant85b40592018-11-15 12:10:04 -08001232 * Write a IP address to the log string
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001233 * +X option write in hexadecimal notation, most significant byte on the left
William Lallemand5f232402012-04-05 18:02:55 +02001234 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001235char *lf_ip(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node)
William Lallemand5f232402012-04-05 18:02:55 +02001236{
1237 char *ret = dst;
1238 int iret;
1239 char pn[INET6_ADDRSTRLEN];
1240
1241 if (node->options & LOG_OPT_HEXA) {
Radek Zajic594c4562019-03-22 10:21:54 +00001242 unsigned char *addr = NULL;
1243 switch (sockaddr->sa_family) {
1244 case AF_INET:
1245 addr = (unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_addr.s_addr;
1246 iret = snprintf(dst, size, "%02X%02X%02X%02X", addr[0], addr[1], addr[2], addr[3]);
1247 break;
1248 case AF_INET6:
1249 addr = (unsigned char *)&((struct sockaddr_in6 *)sockaddr)->sin6_addr.s6_addr;
1250 iret = snprintf(dst, size, "%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X",
1251 addr[0], addr[1], addr[2], addr[3], addr[4], addr[5], addr[6], addr[7],
1252 addr[8], addr[9], addr[10], addr[11], addr[12], addr[13], addr[14], addr[15]);
1253 break;
1254 default:
1255 return NULL;
1256 }
William Lallemand5f232402012-04-05 18:02:55 +02001257 if (iret < 0 || iret > size)
1258 return NULL;
1259 ret += iret;
1260 } else {
1261 addr_to_str((struct sockaddr_storage *)sockaddr, pn, sizeof(pn));
1262 ret = lf_text(dst, pn, size, node);
1263 if (ret == NULL)
1264 return NULL;
1265 }
1266 return ret;
1267}
1268
1269/*
1270 * Write a port to the log
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001271 * +X option write in hexadecimal notation, most significant byte on the left
William Lallemand5f232402012-04-05 18:02:55 +02001272 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001273char *lf_port(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node)
William Lallemand5f232402012-04-05 18:02:55 +02001274{
1275 char *ret = dst;
1276 int iret;
1277
1278 if (node->options & LOG_OPT_HEXA) {
1279 const unsigned char *port = (const unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_port;
1280 iret = snprintf(dst, size, "%02X%02X", port[0], port[1]);
1281 if (iret < 0 || iret > size)
1282 return NULL;
1283 ret += iret;
1284 } else {
1285 ret = ltoa_o(get_host_port((struct sockaddr_storage *)sockaddr), dst, size);
1286 if (ret == NULL)
1287 return NULL;
1288 }
1289 return ret;
1290}
1291
Emeric Brun54648852020-07-06 15:54:06 +02001292
1293/*
1294 * This function sends the syslog message using a printf format string. It
1295 * expects an LF-terminated message.
Willy Tarreaub1a2faf2012-03-19 16:51:53 +01001296 */
Emeric Brun54648852020-07-06 15:54:06 +02001297void send_log(struct proxy *p, int level, const char *format, ...)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001298{
Emeric Brun54648852020-07-06 15:54:06 +02001299 va_list argp;
1300 int data_len;
1301
1302 if (level < 0 || format == NULL || logline == NULL)
1303 return;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001304
Emeric Brun54648852020-07-06 15:54:06 +02001305 va_start(argp, format);
1306 data_len = vsnprintf(logline, global.max_syslog_len, format, argp);
1307 if (data_len < 0 || data_len > global.max_syslog_len)
1308 data_len = global.max_syslog_len;
1309 va_end(argp);
Willy Tarreaufe944602007-10-25 10:34:16 +02001310
Emeric Brun54648852020-07-06 15:54:06 +02001311 __send_log((p ? &p->logsrvs : NULL), (p ? &p->log_tag : NULL), level,
1312 logline, data_len, default_rfc5424_sd_log_format, 2);
1313}
1314/*
1315 * This function builds a log header of given format using given
1316 * metadata, if format is set to LOF_FORMAT_UNSPEC, it tries
1317 * to determine format based on given metadas. It is useful
1318 * for log-forwarding to be able to forward any format without
1319 * settings.
1320 * This function returns a struct ist array of elements of the header
1321 * nbelem is set to the number of available elements.
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001322 * This function returns currently a maximum of NB_LOG_HDR_IST_ELEMENTS
Emeric Brun54648852020-07-06 15:54:06 +02001323 * elements.
1324 */
1325struct ist *build_log_header(enum log_fmt format, int level, int facility,
1326 struct ist *metadata, size_t *nbelem)
1327{
1328 static THREAD_LOCAL struct {
1329 struct ist ist_vector[NB_LOG_HDR_MAX_ELEMENTS];
1330 char timestamp_buffer[LOG_LEGACYTIME_LEN+1+1];
1331 time_t cur_legacy_time;
1332 char priority_buffer[6];
1333 } hdr_ctx = { .priority_buffer = "<<<<>" };
Willy Tarreaubaaee002006-06-26 02:48:02 +02001334
Emeric Brun54648852020-07-06 15:54:06 +02001335 struct tm logtime;
1336 int len;
1337 int fac_level = 0;
1338 time_t time = date.tv_sec;
Dragan Dosen43885c72015-10-01 13:18:13 +02001339
Emeric Brun54648852020-07-06 15:54:06 +02001340 *nbelem = 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001341
Emeric Brun54648852020-07-06 15:54:06 +02001342
1343 if (format == LOG_FORMAT_UNSPEC) {
1344 format = LOG_FORMAT_RAW;
1345 if (metadata) {
1346 /* If a hostname is set, it appears we want to perform syslog
1347 * because only rfc5427 or rfc3164 support an hostname.
1348 */
1349 if (metadata[LOG_META_HOST].len) {
1350 /* If a rfc5424 compliant timestamp is used we consider
1351 * that output format is rfc5424, else legacy format
1352 * is used as specified default for local logs
1353 * in documentation.
1354 */
1355 if ((metadata[LOG_META_TIME].len == 1 && metadata[LOG_META_TIME].ptr[0] == '-')
1356 || (metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN))
1357 format = LOG_FORMAT_RFC5424;
1358 else
1359 format = LOG_FORMAT_RFC3164;
1360 }
Emeric Brun0237c4e2020-11-27 16:24:34 +01001361 else if (metadata[LOG_META_TAG].len) {
1362 /* Tag is present but no hostname, we should
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05001363 * consider we try to emit a local log
Emeric Brun0237c4e2020-11-27 16:24:34 +01001364 * in legacy format (analog to RFC3164 but
1365 * with stripped hostname).
1366 */
1367 format = LOG_FORMAT_LOCAL;
1368 }
Emeric Brun54648852020-07-06 15:54:06 +02001369 else if (metadata[LOG_META_PRIO].len) {
1370 /* the source seems a parsed message
1371 * offering a valid level/prio prefix
1372 * so we consider this format.
1373 */
1374 format = LOG_FORMAT_PRIO;
1375 }
1376 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001377 }
1378
Emeric Brun54648852020-07-06 15:54:06 +02001379 /* prepare priority, stored into 1 single elem */
1380 switch (format) {
Emeric Brun0237c4e2020-11-27 16:24:34 +01001381 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001382 case LOG_FORMAT_RFC3164:
1383 case LOG_FORMAT_RFC5424:
1384 case LOG_FORMAT_PRIO:
1385 fac_level = facility << 3;
1386 /* further format ignore the facility */
Willy Tarreau80f9a632022-11-14 07:22:57 +01001387 __fallthrough;
Emeric Brun54648852020-07-06 15:54:06 +02001388 case LOG_FORMAT_TIMED:
1389 case LOG_FORMAT_SHORT:
1390 fac_level += level;
1391 hdr_ctx.ist_vector[*nbelem].ptr = &hdr_ctx.priority_buffer[3]; /* last digit of the log level */
1392 do {
1393 *hdr_ctx.ist_vector[*nbelem].ptr = '0' + fac_level % 10;
1394 fac_level /= 10;
1395 hdr_ctx.ist_vector[*nbelem].ptr--;
1396 } while (fac_level && hdr_ctx.ist_vector[*nbelem].ptr > &hdr_ctx.priority_buffer[0]);
1397 *hdr_ctx.ist_vector[*nbelem].ptr = '<';
1398 hdr_ctx.ist_vector[(*nbelem)++].len = &hdr_ctx.priority_buffer[5] - hdr_ctx.ist_vector[0].ptr;
1399 break;
1400 case LOG_FORMAT_ISO:
1401 case LOG_FORMAT_RAW:
1402 break;
1403 case LOG_FORMAT_UNSPEC:
1404 case LOG_FORMATS:
1405 ABORT_NOW();
1406 }
Willy Tarreau094af4e2015-01-07 15:03:42 +01001407
William Lallemand2a4a44f2012-02-06 16:00:33 +01001408
Emeric Brun54648852020-07-06 15:54:06 +02001409 /* prepare timestamp, stored into a max of 4 elems */
1410 switch (format) {
Emeric Brun0237c4e2020-11-27 16:24:34 +01001411 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001412 case LOG_FORMAT_RFC3164:
1413 /* rfc3164 ex: 'Jan 1 00:00:00 ' */
1414 if (metadata && metadata[LOG_META_TIME].len == LOG_LEGACYTIME_LEN) {
1415 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1416 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001417 /* time is set, break immediately */
Emeric Brun54648852020-07-06 15:54:06 +02001418 break;
1419 }
1420 else if (metadata && metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN) {
1421 int month;
1422 char *timestamp = metadata[LOG_META_TIME].ptr;
Dragan Dosen1322d092015-09-22 16:05:32 +02001423
Emeric Brun54648852020-07-06 15:54:06 +02001424 /* iso time always begins like this: '1970-01-01T00:00:00' */
Dragan Dosen1322d092015-09-22 16:05:32 +02001425
Emeric Brun54648852020-07-06 15:54:06 +02001426 /* compute month */
1427 month = 10*(timestamp[5] - '0') + (timestamp[6] - '0');
1428 if (month)
1429 month--;
1430 if (month <= 11) {
1431 /* builds log prefix ex: 'Jan 1 ' */
1432 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1433 "%s %c%c ", monthname[month],
1434 timestamp[8] != '0' ? timestamp[8] : ' ',
1435 timestamp[9]);
1436 /* we reused the timestamp_buffer, signal that it does not
1437 * contain local time anymore
1438 */
1439 hdr_ctx.cur_legacy_time = 0;
1440 if (len == 7) {
1441 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], len);
1442 /* adds 'HH:MM:SS' from iso time */
1443 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&timestamp[11], 8);
1444 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1445 /* we successfully reuse iso time, we can break */
1446 break;
1447 }
1448 }
1449 /* Failed to reuse isotime time, fallback to local legacy time */
1450 }
Dragan Dosen1322d092015-09-22 16:05:32 +02001451
Emeric Brun54648852020-07-06 15:54:06 +02001452 if (unlikely(time != hdr_ctx.cur_legacy_time)) {
1453 /* re-builds timestamp from the current local time */
1454 get_localtime(time, &logtime);
1455
1456 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1457 "%s %2d %02d:%02d:%02d ",
1458 monthname[logtime.tm_mon],
1459 logtime.tm_mday, logtime.tm_hour, logtime.tm_min, logtime.tm_sec);
1460 if (len != LOG_LEGACYTIME_LEN+1)
1461 hdr_ctx.cur_legacy_time = 0;
1462 else
1463 hdr_ctx.cur_legacy_time = time;
1464 }
1465 if (likely(hdr_ctx.cur_legacy_time))
1466 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], LOG_LEGACYTIME_LEN+1);
1467 else
1468 hdr_ctx.ist_vector[(*nbelem)++] = ist2("Jan 1 00:00:00 ", LOG_LEGACYTIME_LEN+1);
1469 break;
1470 case LOG_FORMAT_RFC5424:
1471 /* adds rfc5425 version prefix */
1472 hdr_ctx.ist_vector[(*nbelem)++] = ist2("1 ", 2);
1473 if (metadata && metadata[LOG_META_TIME].len == 1 && metadata[LOG_META_TIME].ptr[0] == '-') {
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001474 /* submitted len is NILVALUE, it is a valid timestamp for rfc5425 */
Emeric Brun54648852020-07-06 15:54:06 +02001475 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1476 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1477 break;
1478 }
1479 /* let continue as 'timed' and 'iso' format for usual timestamp */
Willy Tarreau80f9a632022-11-14 07:22:57 +01001480 __fallthrough;
Emeric Brun54648852020-07-06 15:54:06 +02001481 case LOG_FORMAT_TIMED:
1482 case LOG_FORMAT_ISO:
1483 /* ISO format ex: '1900:01:01T12:00:00.123456Z'
1484 * '1900:01:01T14:00:00+02:00'
1485 * '1900:01:01T10:00:00.123456-02:00'
1486 */
1487 if (metadata && metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN) {
1488 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1489 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001490 /* time is set, break immediately */
Emeric Brun54648852020-07-06 15:54:06 +02001491 break;
1492 }
1493 else if (metadata && metadata[LOG_META_TIME].len == LOG_LEGACYTIME_LEN) {
1494 int month;
1495 char *timestamp = metadata[LOG_META_TIME].ptr;
1496
1497 for (month = 0; month < 12; month++)
1498 if (!memcmp(monthname[month], timestamp, 3))
1499 break;
Dragan Dosen1322d092015-09-22 16:05:32 +02001500
Emeric Brun54648852020-07-06 15:54:06 +02001501 if (month < 12) {
1502
1503 /* get local time to retrieve year */
1504 get_localtime(time, &logtime);
1505
1506 /* year seems changed since log */
1507 if (logtime.tm_mon < month)
1508 logtime.tm_year--;
1509
1510 /* builds rfc5424 prefix ex: '1900-01-01T' */
1511 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1512 "%4d-%02d-%c%cT",
1513 logtime.tm_year+1900, month+1,
1514 timestamp[4] != ' ' ? timestamp[4] : '0',
1515 timestamp[5]);
1516
1517 /* we reused the timestamp_buffer, signal that it does not
1518 * contain local time anymore
1519 */
1520 hdr_ctx.cur_legacy_time = 0;
1521 if (len == 11) {
1522 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], len);
1523 /* adds HH:MM:SS from legacy timestamp */
1524 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&timestamp[7], 8);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001525 /* skip secfraq because it is optional */
Emeric Brun54648852020-07-06 15:54:06 +02001526 /* according to rfc: -00:00 means we don't know the timezone */
1527 hdr_ctx.ist_vector[(*nbelem)++] = ist2("-00:00 ", 7);
1528 /* we successfully reuse legacy time, we can break */
1529 break;
1530 }
1531 }
1532 /* Failed to reuse legacy time, fallback to local iso time */
1533 }
1534 hdr_ctx.ist_vector[(*nbelem)++] = ist2(timeofday_as_iso_us(1), LOG_ISOTIME_MAXLEN + 1);
1535 break;
1536 case LOG_FORMAT_PRIO:
1537 case LOG_FORMAT_SHORT:
1538 case LOG_FORMAT_RAW:
1539 break;
1540 case LOG_FORMAT_UNSPEC:
1541 case LOG_FORMATS:
1542 ABORT_NOW();
Dragan Dosen1322d092015-09-22 16:05:32 +02001543 }
1544
Emeric Brun54648852020-07-06 15:54:06 +02001545 /* prepare other meta data, stored into a max of 10 elems */
1546 switch (format) {
1547 case LOG_FORMAT_RFC3164:
1548 if (metadata && metadata[LOG_META_HOST].len) {
1549 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_HOST];
1550 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1551 }
Emeric Brun0237c4e2020-11-27 16:24:34 +01001552 else /* the caller MUST fill the hostname, this field is mandatory */
Emeric Brun54648852020-07-06 15:54:06 +02001553 hdr_ctx.ist_vector[(*nbelem)++] = ist2("localhost ", 10);
Willy Tarreau80f9a632022-11-14 07:22:57 +01001554 __fallthrough;
Emeric Brun0237c4e2020-11-27 16:24:34 +01001555 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001556 if (!metadata || !metadata[LOG_META_TAG].len)
1557 break;
Dragan Dosen1322d092015-09-22 16:05:32 +02001558
Emeric Brun54648852020-07-06 15:54:06 +02001559 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TAG];
1560 if (metadata[LOG_META_PID].len) {
1561 hdr_ctx.ist_vector[(*nbelem)++] = ist2("[", 1);
1562 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_PID];
1563 hdr_ctx.ist_vector[(*nbelem)++] = ist2("]", 1);
1564 }
1565 hdr_ctx.ist_vector[(*nbelem)++] = ist2(": ", 2);
1566 break;
1567 case LOG_FORMAT_RFC5424:
1568 if (metadata && metadata[LOG_META_HOST].len) {
1569 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_HOST];
1570 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1571 }
1572 else
1573 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
Dragan Dosen1322d092015-09-22 16:05:32 +02001574
Emeric Brun54648852020-07-06 15:54:06 +02001575 if (metadata && metadata[LOG_META_TAG].len) {
1576 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TAG];
1577 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1578 }
1579 else
1580 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001581
Emeric Brun54648852020-07-06 15:54:06 +02001582 if (metadata && metadata[LOG_META_PID].len) {
1583 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_PID];
1584 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1585 }
1586 else
1587 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001588
Emeric Brun54648852020-07-06 15:54:06 +02001589 if (metadata && metadata[LOG_META_MSGID].len) {
1590 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_MSGID];
1591 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1592 }
1593 else
1594 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001595
Emeric Brun54648852020-07-06 15:54:06 +02001596 if (metadata && metadata[LOG_META_STDATA].len) {
1597 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_STDATA];
1598 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1599 }
1600 else
1601 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
1602 break;
1603 case LOG_FORMAT_PRIO:
1604 case LOG_FORMAT_SHORT:
1605 case LOG_FORMAT_TIMED:
1606 case LOG_FORMAT_ISO:
1607 case LOG_FORMAT_RAW:
1608 break;
1609 case LOG_FORMAT_UNSPEC:
1610 case LOG_FORMATS:
1611 ABORT_NOW();
1612 }
1613
1614 return hdr_ctx.ist_vector;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001615}
1616
1617/*
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001618 * This function sends a syslog message to <logsrv>.
Emeric Brun54648852020-07-06 15:54:06 +02001619 * The argument <metadata> MUST be an array of size
1620 * LOG_META_FIELDS*sizeof(struct ist) containing data to build the header.
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001621 * It overrides the last byte of the message vector with an LF character.
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001622 * Does not return any error,
William Lallemand2a4a44f2012-02-06 16:00:33 +01001623 */
Emeric Brun54648852020-07-06 15:54:06 +02001624static inline void __do_send_log(struct logsrv *logsrv, int nblogger, int level, int facility, struct ist *metadata, char *message, size_t size)
William Lallemand2a4a44f2012-02-06 16:00:33 +01001625{
Emeric Brun54648852020-07-06 15:54:06 +02001626 static THREAD_LOCAL struct iovec iovec[NB_LOG_HDR_MAX_ELEMENTS+1+1] = { }; /* header elements + message + LF */
Christopher Fauletf8188c62017-06-02 16:20:16 +02001627 static THREAD_LOCAL struct msghdr msghdr = {
1628 //.msg_iov = iovec,
Emeric Brun54648852020-07-06 15:54:06 +02001629 .msg_iovlen = NB_LOG_HDR_MAX_ELEMENTS+2
Dragan Dosen609ac2a2015-09-16 18:25:42 +02001630 };
Christopher Fauletf8188c62017-06-02 16:20:16 +02001631 static THREAD_LOCAL int logfdunix = -1; /* syslog to AF_UNIX socket */
1632 static THREAD_LOCAL int logfdinet = -1; /* syslog to AF_INET socket */
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001633 int *plogfd;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001634 int sent;
Emeric Brun54648852020-07-06 15:54:06 +02001635 size_t nbelem;
1636 struct ist *msg_header = NULL;
Christopher Fauletf8188c62017-06-02 16:20:16 +02001637
1638 msghdr.msg_iov = iovec;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001639
Emeric Brunfa9d7802020-05-28 14:21:33 +02001640 /* historically some messages used to already contain the trailing LF
1641 * or Zero. Let's remove all trailing LF or Zero
1642 */
Emeric Brun54648852020-07-06 15:54:06 +02001643 while (size && (message[size-1] == '\n' || (message[size-1] == 0)))
Emeric Brun9e8ea0a2020-05-12 19:33:15 +02001644 size--;
1645
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001646 if (logsrv->type == LOG_TARGET_BUFFER) {
Willy Tarreauc046d162019-08-30 15:24:59 +02001647 plogfd = NULL;
Emeric Brune709e1e2020-05-06 17:23:59 +02001648 goto send;
Willy Tarreauc046d162019-08-30 15:24:59 +02001649 }
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001650 else if (logsrv->addr.ss_family == AF_CUST_EXISTING_FD) {
1651 /* the socket's address is a file descriptor */
1652 plogfd = (int *)&((struct sockaddr_in *)&logsrv->addr)->sin_addr.s_addr;
1653 }
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001654 else if (logsrv->addr.ss_family == AF_UNIX)
1655 plogfd = &logfdunix;
1656 else
1657 plogfd = &logfdinet;
Robert Tsai81ae1952007-12-05 10:47:29 +01001658
Willy Tarreauc046d162019-08-30 15:24:59 +02001659 if (plogfd && unlikely(*plogfd < 0)) {
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001660 /* socket not successfully initialized yet */
1661 if ((*plogfd = socket(logsrv->addr.ss_family, SOCK_DGRAM,
1662 (logsrv->addr.ss_family == AF_UNIX) ? 0 : IPPROTO_UDP)) < 0) {
1663 static char once;
William Lallemand0f99e342011-10-12 17:50:54 +02001664
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001665 if (!once) {
1666 once = 1; /* note: no need for atomic ops here */
1667 ha_alert("socket() failed in logger #%d: %s (errno=%d)\n",
1668 nblogger, strerror(errno), errno);
1669 }
1670 return;
1671 } else {
1672 /* we don't want to receive anything on this socket */
1673 setsockopt(*plogfd, SOL_SOCKET, SO_RCVBUF, &zero, sizeof(zero));
1674 /* does nothing under Linux, maybe needed for others */
1675 shutdown(*plogfd, SHUT_RD);
Willy Tarreau38247432022-04-26 10:24:14 +02001676 fd_set_cloexec(*plogfd);
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001677 }
Dragan Dosen43885c72015-10-01 13:18:13 +02001678 }
1679
Emeric Brun54648852020-07-06 15:54:06 +02001680 msg_header = build_log_header(logsrv->format, level, facility, metadata, &nbelem);
1681 send:
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001682 if (logsrv->type == LOG_TARGET_BUFFER) {
Emeric Brun54648852020-07-06 15:54:06 +02001683 struct ist msg;
1684
1685 msg = ist2(message, size);
Tim Duesterhus2471f5c2021-11-08 09:05:01 +01001686 msg = isttrim(msg, logsrv->maxlen);
Willy Tarreaud52a7f82019-08-30 14:05:35 +02001687
Christopher Fauletcc640e82022-10-19 08:16:48 +02001688 sent = sink_write(logsrv->sink, &msg, 1, level, facility, metadata);
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001689 }
1690 else if (logsrv->addr.ss_family == AF_CUST_EXISTING_FD) {
1691 struct ist msg;
1692
1693 msg = ist2(message, size);
Tim Duesterhus2471f5c2021-11-08 09:05:01 +01001694 msg = isttrim(msg, logsrv->maxlen);
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001695
1696 sent = fd_write_frag_line(*plogfd, logsrv->maxlen, msg_header, nbelem, &msg, 1, 1);
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001697 }
1698 else {
Emeric Brun54648852020-07-06 15:54:06 +02001699 int i = 0;
1700 int totlen = logsrv->maxlen;
1701
1702 for (i = 0 ; i < nbelem ; i++ ) {
1703 iovec[i].iov_base = msg_header[i].ptr;
1704 iovec[i].iov_len = msg_header[i].len;
1705 if (totlen <= iovec[i].iov_len) {
1706 iovec[i].iov_len = totlen;
1707 totlen = 0;
1708 break;
1709 }
1710 totlen -= iovec[i].iov_len;
1711 }
1712 if (totlen) {
1713 iovec[i].iov_base = message;
1714 iovec[i].iov_len = size;
1715 if (totlen <= iovec[i].iov_len)
1716 iovec[i].iov_len = totlen;
1717 i++;
1718 }
1719 iovec[i].iov_base = "\n"; /* insert a \n at the end of the message */
1720 iovec[i].iov_len = 1;
1721 i++;
Willy Tarreaud52a7f82019-08-30 14:05:35 +02001722
Emeric Brun54648852020-07-06 15:54:06 +02001723 msghdr.msg_iovlen = i;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001724 msghdr.msg_name = (struct sockaddr *)&logsrv->addr;
1725 msghdr.msg_namelen = get_addr_len(&logsrv->addr);
Dragan Dosen43885c72015-10-01 13:18:13 +02001726
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001727 sent = sendmsg(*plogfd, &msghdr, MSG_DONTWAIT | MSG_NOSIGNAL);
1728 }
Dragan Dosen43885c72015-10-01 13:18:13 +02001729
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001730 if (sent < 0) {
1731 static char once;
Dragan Dosen43885c72015-10-01 13:18:13 +02001732
Willy Tarreauacef5e22022-04-25 20:32:15 +02001733 if (errno == EAGAIN || errno == EWOULDBLOCK)
Willy Tarreau4781b152021-04-06 13:53:36 +02001734 _HA_ATOMIC_INC(&dropped_logs);
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001735 else if (!once) {
1736 once = 1; /* note: no need for atomic ops here */
1737 ha_alert("sendmsg()/writev() failed in logger #%d: %s (errno=%d)\n",
1738 nblogger, strerror(errno), errno);
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001739 }
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001740 }
1741}
Dragan Dosen59cee972015-09-19 22:09:02 +02001742
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001743/*
1744 * This function sends a syslog message.
1745 * It doesn't care about errors nor does it report them.
Emeric Brun54648852020-07-06 15:54:06 +02001746 * The argument <metadata> MUST be an array of size
1747 * LOG_META_FIELDS*sizeof(struct ist) containing
1748 * data to build the header.
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001749 */
Emeric Brun54648852020-07-06 15:54:06 +02001750void process_send_log(struct list *logsrvs, int level, int facility,
1751 struct ist *metadata, char *message, size_t size)
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001752{
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001753 struct logsrv *logsrv;
1754 int nblogger;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001755
1756 /* Send log messages to syslog server. */
1757 nblogger = 0;
1758 list_for_each_entry(logsrv, logsrvs, list) {
Emeric Brun2f4cc282020-07-10 15:47:11 +02001759 int in_range = 1;
Frédéric Lécailled803e472019-04-25 07:42:09 +02001760
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001761 /* we can filter the level of the messages that are sent to each logger */
1762 if (level > logsrv->level)
1763 continue;
1764
Frédéric Lécailled803e472019-04-25 07:42:09 +02001765 if (logsrv->lb.smp_rgs) {
1766 struct smp_log_range *curr_rg;
1767
1768 HA_SPIN_LOCK(LOGSRV_LOCK, &logsrv->lock);
1769 curr_rg = &logsrv->lb.smp_rgs[logsrv->lb.curr_rg];
1770 in_range = in_smp_log_range(curr_rg, logsrv->lb.curr_idx);
1771 if (in_range) {
1772 /* Let's consume this range. */
1773 curr_rg->curr_idx = (curr_rg->curr_idx + 1) % curr_rg->sz;
1774 if (!curr_rg->curr_idx) {
1775 /* If consumed, let's select the next range. */
1776 logsrv->lb.curr_rg = (logsrv->lb.curr_rg + 1) % logsrv->lb.smp_rgs_sz;
1777 }
1778 }
1779 logsrv->lb.curr_idx = (logsrv->lb.curr_idx + 1) % logsrv->lb.smp_sz;
1780 HA_SPIN_UNLOCK(LOGSRV_LOCK, &logsrv->lock);
1781 }
1782 if (in_range)
Emeric Brun54648852020-07-06 15:54:06 +02001783 __do_send_log(logsrv, ++nblogger, MAX(level, logsrv->minlvl),
1784 (facility == -1) ? logsrv->facility : facility,
1785 metadata, message, size);
Willy Tarreaubaaee002006-06-26 02:48:02 +02001786 }
1787}
1788
Emeric Brun54648852020-07-06 15:54:06 +02001789/*
1790 * This function sends a syslog message.
1791 * It doesn't care about errors nor does it report them.
1792 * The arguments <sd> and <sd_size> are used for the structured-data part
1793 * in RFC5424 formatted syslog messages.
1794 */
1795void __send_log(struct list *logsrvs, struct buffer *tagb, int level,
1796 char *message, size_t size, char *sd, size_t sd_size)
1797{
1798 static THREAD_LOCAL pid_t curr_pid;
1799 static THREAD_LOCAL char pidstr[16];
1800 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
1801
1802 if (logsrvs == NULL) {
1803 if (!LIST_ISEMPTY(&global.logsrvs)) {
1804 logsrvs = &global.logsrvs;
1805 }
1806 }
1807 if (!logsrvs || LIST_ISEMPTY(logsrvs))
1808 return;
1809
1810 if (!metadata[LOG_META_HOST].len) {
1811 if (global.log_send_hostname)
Tim Duesterhus77508502022-03-15 13:11:06 +01001812 metadata[LOG_META_HOST] = ist(global.log_send_hostname);
Emeric Brun54648852020-07-06 15:54:06 +02001813 }
1814
1815 if (!tagb || !tagb->area)
1816 tagb = &global.log_tag;
1817
1818 if (tagb)
1819 metadata[LOG_META_TAG] = ist2(tagb->area, tagb->data);
1820
1821 if (unlikely(curr_pid != getpid()))
1822 metadata[LOG_META_PID].len = 0;
1823
1824 if (!metadata[LOG_META_PID].len) {
1825 curr_pid = getpid();
1826 ltoa_o(curr_pid, pidstr, sizeof(pidstr));
1827 metadata[LOG_META_PID] = ist2(pidstr, strlen(pidstr));
1828 }
1829
1830 metadata[LOG_META_STDATA] = ist2(sd, sd_size);
1831
1832 /* Remove trailing space of structured data */
1833 while (metadata[LOG_META_STDATA].len && metadata[LOG_META_STDATA].ptr[metadata[LOG_META_STDATA].len-1] == ' ')
1834 metadata[LOG_META_STDATA].len--;
1835
1836 return process_send_log(logsrvs, level, -1, metadata, message, size);
1837}
Willy Tarreaubaaee002006-06-26 02:48:02 +02001838
Willy Tarreauc89ccb62012-04-05 21:18:22 +02001839const char sess_cookie[8] = "NIDVEOU7"; /* No cookie, Invalid cookie, cookie for a Down server, Valid cookie, Expired cookie, Old cookie, Unused, unknown */
William Lallemandbddd4fd2012-02-27 11:23:10 +01001840const char sess_set_cookie[8] = "NPDIRU67"; /* No set-cookie, Set-cookie found and left unchanged (passive),
1841 Set-cookie Deleted, Set-Cookie Inserted, Set-cookie Rewritten,
1842 Set-cookie Updated, unknown, unknown */
1843
William Lallemand1d705562012-03-12 12:46:41 +01001844/*
1845 * try to write a character if there is enough space, or goto out
1846 */
William Lallemandbddd4fd2012-02-27 11:23:10 +01001847#define LOGCHAR(x) do { \
William Lallemand1d705562012-03-12 12:46:41 +01001848 if (tmplog < dst + maxsize - 1) { \
William Lallemandbddd4fd2012-02-27 11:23:10 +01001849 *(tmplog++) = (x); \
1850 } else { \
1851 goto out; \
1852 } \
1853 } while(0)
1854
Dragan Dosen835b9212016-02-12 13:23:03 +01001855
Willy Tarreaub6b3df32018-11-26 16:31:20 +01001856/* Initializes some log data at boot */
1857static void init_log()
Dragan Dosen835b9212016-02-12 13:23:03 +01001858{
1859 char *tmp;
Willy Tarreaue10cd482018-09-10 18:16:53 +02001860 int i;
Dragan Dosen835b9212016-02-12 13:23:03 +01001861
1862 /* Initialize the escape map for the RFC5424 structured-data : '"\]'
1863 * inside PARAM-VALUE should be escaped with '\' as prefix.
1864 * See https://tools.ietf.org/html/rfc5424#section-6.3.3 for more
1865 * details.
1866 */
1867 memset(rfc5424_escape_map, 0, sizeof(rfc5424_escape_map));
1868
1869 tmp = "\"\\]";
1870 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001871 ha_bit_set(*tmp, rfc5424_escape_map);
Dragan Dosen835b9212016-02-12 13:23:03 +01001872 tmp++;
1873 }
Willy Tarreaue10cd482018-09-10 18:16:53 +02001874
1875 /* initialize the log header encoding map : '{|}"#' should be encoded with
1876 * '#' as prefix, as well as non-printable characters ( <32 or >= 127 ).
1877 * URL encoding only requires '"', '#' to be encoded as well as non-
1878 * printable characters above.
1879 */
1880 memset(hdr_encode_map, 0, sizeof(hdr_encode_map));
1881 memset(url_encode_map, 0, sizeof(url_encode_map));
1882 for (i = 0; i < 32; i++) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001883 ha_bit_set(i, hdr_encode_map);
1884 ha_bit_set(i, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001885 }
1886 for (i = 127; i < 256; i++) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001887 ha_bit_set(i, hdr_encode_map);
1888 ha_bit_set(i, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001889 }
1890
1891 tmp = "\"#{|}";
1892 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001893 ha_bit_set(*tmp, hdr_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001894 tmp++;
1895 }
1896
1897 tmp = "\"#";
1898 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001899 ha_bit_set(*tmp, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001900 tmp++;
1901 }
1902
1903 /* initialize the http header encoding map. The draft httpbis define the
1904 * header content as:
1905 *
1906 * HTTP-message = start-line
1907 * *( header-field CRLF )
1908 * CRLF
1909 * [ message-body ]
1910 * header-field = field-name ":" OWS field-value OWS
1911 * field-value = *( field-content / obs-fold )
1912 * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
1913 * obs-fold = CRLF 1*( SP / HTAB )
1914 * field-vchar = VCHAR / obs-text
1915 * VCHAR = %x21-7E
1916 * obs-text = %x80-FF
1917 *
1918 * All the chars are encoded except "VCHAR", "obs-text", SP and HTAB.
1919 * The encoded chars are form 0x00 to 0x08, 0x0a to 0x1f and 0x7f. The
Joseph Herlant85b40592018-11-15 12:10:04 -08001920 * "obs-fold" is voluntarily forgotten because haproxy remove this.
Willy Tarreaue10cd482018-09-10 18:16:53 +02001921 */
1922 memset(http_encode_map, 0, sizeof(http_encode_map));
1923 for (i = 0x00; i <= 0x08; i++)
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001924 ha_bit_set(i, http_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001925 for (i = 0x0a; i <= 0x1f; i++)
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001926 ha_bit_set(i, http_encode_map);
1927 ha_bit_set(0x7f, http_encode_map);
Dragan Dosen835b9212016-02-12 13:23:03 +01001928}
William Lallemand1d705562012-03-12 12:46:41 +01001929
Willy Tarreaub6b3df32018-11-26 16:31:20 +01001930INITCALL0(STG_PREPARE, init_log);
1931
Christopher Faulet0132d062017-07-26 15:33:35 +02001932/* Initialize log buffers used for syslog messages */
1933int init_log_buffers()
1934{
Christopher Faulet0132d062017-07-26 15:33:35 +02001935 logline = my_realloc2(logline, global.max_syslog_len + 1);
1936 logline_rfc5424 = my_realloc2(logline_rfc5424, global.max_syslog_len + 1);
Emeric Brun54648852020-07-06 15:54:06 +02001937 if (!logline || !logline_rfc5424)
Christopher Faulet0132d062017-07-26 15:33:35 +02001938 return 0;
1939 return 1;
1940}
1941
1942/* Deinitialize log buffers used for syslog messages */
1943void deinit_log_buffers()
1944{
Christopher Faulet0132d062017-07-26 15:33:35 +02001945 free(logline);
1946 free(logline_rfc5424);
Christopher Faulet0132d062017-07-26 15:33:35 +02001947 logline = NULL;
1948 logline_rfc5424 = NULL;
1949}
1950
Willy Tarreaudf974472012-12-28 02:44:01 +01001951/* Builds a log line in <dst> based on <list_format>, and stops before reaching
1952 * <maxsize> characters. Returns the size of the output string in characters,
1953 * not counting the trailing zero which is always added if the resulting size
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001954 * is not zero. It requires a valid session and optionally a stream. If the
1955 * stream is NULL, default values will be assumed for the stream part.
Willy Tarreaudf974472012-12-28 02:44:01 +01001956 */
Willy Tarreau43c538e2018-09-05 14:58:15 +02001957int sess_build_logline(struct session *sess, struct stream *s, char *dst, size_t maxsize, struct list *list_format)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001958{
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02001959 struct proxy *fe = sess->fe;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001960 struct proxy *be;
1961 struct http_txn *txn;
1962 const struct strm_logs *logs;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02001963 struct connection *fe_conn, *be_conn;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001964 unsigned int s_flags;
1965 unsigned int uniq_id;
Willy Tarreau83061a82018-07-13 11:56:34 +02001966 struct buffer chunk;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001967 char *uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00001968 char *spc;
Andrew Hayworthe63ac872015-07-31 16:14:16 +00001969 char *qmark;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00001970 char *end;
Willy Tarreaufe944602007-10-25 10:34:16 +02001971 struct tm tm;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001972 int t_request;
1973 int hdr;
1974 int last_isspace = 1;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00001975 int nspaces = 0;
Willy Tarreaub1a2faf2012-03-19 16:51:53 +01001976 char *tmplog;
William Lallemand1d705562012-03-12 12:46:41 +01001977 char *ret;
1978 int iret;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02001979 int status;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001980 struct logformat_node *tmp;
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02001981 struct timeval tv;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001982 struct strm_logs tmp_strm_log;
Maciej Zdebfcdfd852020-11-30 18:27:47 +00001983 struct ist path;
Amaury Denoyellec453f952021-07-06 11:40:12 +02001984 struct http_uri_parser parser;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001985
William Lallemandbddd4fd2012-02-27 11:23:10 +01001986 /* FIXME: let's limit ourselves to frontend logging for now. */
Willy Tarreaubaaee002006-06-26 02:48:02 +02001987
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001988 if (likely(s)) {
1989 be = s->be;
1990 txn = s->txn;
Willy Tarreaufd9417b2022-05-18 16:23:22 +02001991 be_conn = sc_conn(s->scb);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02001992 status = (txn ? txn->status : 0);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001993 s_flags = s->flags;
1994 uniq_id = s->uniq_id;
1995 logs = &s->logs;
1996 } else {
1997 /* we have no stream so we first need to initialize a few
1998 * things that are needed later. We do increment the request
1999 * ID so that it's uniquely assigned to this request just as
2000 * if the request had reached the point of being processed.
2001 * A request error is reported as it's the only element we have
2002 * here and which justifies emitting such a log.
2003 */
Christopher Fauletfd818482021-04-14 14:01:41 +02002004 be = ((obj_type(sess->origin) == OBJ_TYPE_CHECK) ? __objt_check(sess->origin)->proxy : fe);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002005 txn = NULL;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002006 fe_conn = objt_conn(sess->origin);
Willy Tarreaubde14ad2022-05-27 10:04:04 +02002007 be_conn = ((obj_type(sess->origin) == OBJ_TYPE_CHECK) ? sc_conn(__objt_check(sess->origin)->sc) : NULL);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002008 status = 0;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002009 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
Willy Tarreau18515722021-04-06 11:57:41 +02002010 uniq_id = _HA_ATOMIC_FETCH_ADD(&global.req_count, 1);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002011
2012 /* prepare a valid log structure */
2013 tmp_strm_log.tv_accept = sess->tv_accept;
2014 tmp_strm_log.accept_date = sess->accept_date;
2015 tmp_strm_log.t_handshake = sess->t_handshake;
Christopher Fauletdd789212020-09-30 15:10:07 +02002016 tmp_strm_log.t_idle = (sess->t_idle >= 0 ? sess->t_idle : 0);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002017 tv_zero(&tmp_strm_log.tv_request);
2018 tmp_strm_log.t_queue = -1;
2019 tmp_strm_log.t_connect = -1;
2020 tmp_strm_log.t_data = -1;
2021 tmp_strm_log.t_close = tv_ms_elapsed(&sess->tv_accept, &now);
2022 tmp_strm_log.bytes_in = 0;
2023 tmp_strm_log.bytes_out = 0;
2024 tmp_strm_log.prx_queue_pos = 0;
2025 tmp_strm_log.srv_queue_pos = 0;
2026
2027 logs = &tmp_strm_log;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002028
2029 if ((fe->mode == PR_MODE_HTTP) && fe_conn && fe_conn->mux && fe_conn->mux->ctl) {
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002030 enum mux_exit_status es = fe_conn->mux->ctl(fe_conn, MUX_EXIT_STATUS, &status);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002031
2032 switch (es) {
2033 case MUX_ES_SUCCESS:
2034 break;
2035 case MUX_ES_INVALID_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002036 status = (status ? status : 400);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002037 if ((fe_conn->flags & CO_FL_ERROR) || conn_xprt_read0_pending(fe_conn))
2038 s_flags = SF_ERR_CLICL | SF_FINST_R;
2039 else
2040 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
2041 break;
2042 case MUX_ES_TOUT_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002043 status = (status ? status : 408);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002044 s_flags = SF_ERR_CLITO | SF_FINST_R;
2045 break;
Christopher Faulet142dd332020-12-07 11:24:37 +01002046 case MUX_ES_NOTIMPL_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002047 status = (status ? status : 501);
Christopher Faulet142dd332020-12-07 11:24:37 +01002048 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
2049 break;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002050 case MUX_ES_INTERNAL_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002051 status = (status ? status : 500);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002052 s_flags = SF_ERR_INTERNAL | SF_FINST_R;
2053 break;
2054 default:
2055 break;
2056 }
2057 }
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002058 }
2059
William Lallemandbddd4fd2012-02-27 11:23:10 +01002060 t_request = -1;
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002061 if (tv_isge(&logs->tv_request, &logs->tv_accept))
2062 t_request = tv_ms_elapsed(&logs->tv_accept, &logs->tv_request);
William Lallemandbddd4fd2012-02-27 11:23:10 +01002063
William Lallemand1d705562012-03-12 12:46:41 +01002064 tmplog = dst;
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +02002065
William Lallemandbddd4fd2012-02-27 11:23:10 +01002066 /* fill logbuffer */
William Lallemand1d705562012-03-12 12:46:41 +01002067 if (LIST_ISEMPTY(list_format))
2068 return 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002069
William Lallemand1d705562012-03-12 12:46:41 +01002070 list_for_each_entry(tmp, list_format, list) {
Christopher Faulet52b28d22021-10-27 11:58:05 +02002071#ifdef USE_OPENSSL
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002072 struct connection *conn;
Christopher Faulet52b28d22021-10-27 11:58:05 +02002073#endif
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002074 const struct sockaddr_storage *addr;
Willy Tarreau4f653562012-10-12 19:48:16 +02002075 const char *src = NULL;
Willy Tarreauc8368452012-12-21 00:09:23 +01002076 struct sample *key;
Willy Tarreau83061a82018-07-13 11:56:34 +02002077 const struct buffer empty = { };
William Lallemandbddd4fd2012-02-27 11:23:10 +01002078
Willy Tarreauc8368452012-12-21 00:09:23 +01002079 switch (tmp->type) {
William Lallemand1d705562012-03-12 12:46:41 +01002080 case LOG_FMT_SEPARATOR:
William Lallemandbddd4fd2012-02-27 11:23:10 +01002081 if (!last_isspace) {
2082 LOGCHAR(' ');
2083 last_isspace = 1;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002084 }
2085 break;
2086
William Lallemand1d705562012-03-12 12:46:41 +01002087 case LOG_FMT_TEXT: // text
William Lallemandbddd4fd2012-02-27 11:23:10 +01002088 src = tmp->arg;
William Lallemand5f232402012-04-05 18:02:55 +02002089 iret = strlcpy2(tmplog, src, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002090 if (iret == 0)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002091 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002092 tmplog += iret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002093 last_isspace = 0;
2094 break;
2095
Willy Tarreauc8368452012-12-21 00:09:23 +01002096 case LOG_FMT_EXPR: // sample expression, may be request or response
2097 key = NULL;
Christopher Faulet5f940702020-04-06 10:40:02 +02002098 if (tmp->options & LOG_OPT_REQ_CAP)
Adis Nezirovic79beb242015-07-06 15:41:02 +02002099 key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_REQ|SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
Willy Tarreau20b7a0f2021-09-03 08:53:29 +02002100
Christopher Faulet5f940702020-04-06 10:40:02 +02002101 if (!key && (tmp->options & LOG_OPT_RES_CAP))
Adis Nezirovic79beb242015-07-06 15:41:02 +02002102 key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_RES|SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
Willy Tarreau20b7a0f2021-09-03 08:53:29 +02002103
2104 if (!key && !(tmp->options & (LOG_OPT_REQ_CAP|LOG_OPT_RES_CAP))) // cfg, cli
2105 key = sample_fetch_as_type(be, sess, s, SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
2106
Thierry FOURNIERd048d8b2014-03-13 16:46:18 +01002107 if (tmp->options & LOG_OPT_HTTP)
Dragan Dosen835b9212016-02-12 13:23:03 +01002108 ret = lf_encode_chunk(tmplog, dst + maxsize,
2109 '%', http_encode_map, key ? &key->data.u.str : &empty, tmp);
Thierry FOURNIERd048d8b2014-03-13 16:46:18 +01002110 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002111 ret = lf_text_len(tmplog,
2112 key ? key->data.u.str.area : NULL,
2113 key ? key->data.u.str.data : 0,
2114 dst + maxsize - tmplog,
2115 tmp);
Willy Tarreauc8368452012-12-21 00:09:23 +01002116 if (ret == 0)
2117 goto out;
2118 tmplog = ret;
2119 last_isspace = 0;
2120 break;
2121
Willy Tarreau2beef582012-12-20 17:22:52 +01002122 case LOG_FMT_CLIENTIP: // %ci
Willy Tarreaud68ff012022-05-27 08:57:21 +02002123 addr = (s ? sc_src(s->scf) : sess_src(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002124 if (addr)
2125 ret = lf_ip(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002126 else
2127 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002128
William Lallemand1d705562012-03-12 12:46:41 +01002129 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002130 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002131 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002132 last_isspace = 0;
2133 break;
2134
Willy Tarreau2beef582012-12-20 17:22:52 +01002135 case LOG_FMT_CLIENTPORT: // %cp
Willy Tarreaud68ff012022-05-27 08:57:21 +02002136 addr = (s ? sc_src(s->scf) : sess_src(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002137 if (addr) {
Christopher Faulet1ccbe122021-11-15 11:31:08 +01002138 /* sess->listener is always defined when the session's owner is an inbound connections */
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002139 if (addr->ss_family == AF_UNIX)
Willy Tarreaufb0afa72015-04-03 14:46:27 +02002140 ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog);
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002141 else
2142 ret = lf_port(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
William Lallemand5f232402012-04-05 18:02:55 +02002143 }
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002144 else
2145 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2146
William Lallemand5f232402012-04-05 18:02:55 +02002147 if (ret == NULL)
2148 goto out;
2149 tmplog = ret;
2150 last_isspace = 0;
2151 break;
2152
Willy Tarreau2beef582012-12-20 17:22:52 +01002153 case LOG_FMT_FRONTENDIP: // %fi
Willy Tarreaud68ff012022-05-27 08:57:21 +02002154 addr = (s ? sc_dst(s->scf) : sess_dst(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002155 if (addr)
2156 ret = lf_ip(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002157 else
2158 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2159
William Lallemand1d705562012-03-12 12:46:41 +01002160 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002161 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002162 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002163 last_isspace = 0;
2164 break;
2165
Willy Tarreau2beef582012-12-20 17:22:52 +01002166 case LOG_FMT_FRONTENDPORT: // %fp
Willy Tarreaud68ff012022-05-27 08:57:21 +02002167 addr = (s ? sc_dst(s->scf) : sess_dst(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002168 if (addr) {
Christopher Faulet1ccbe122021-11-15 11:31:08 +01002169 /* sess->listener is always defined when the session's owner is an inbound connections */
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002170 if (addr->ss_family == AF_UNIX)
Willy Tarreaufb0afa72015-04-03 14:46:27 +02002171 ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002172 else
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002173 ret = lf_port(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
William Lallemand5f232402012-04-05 18:02:55 +02002174 }
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002175 else
2176 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2177
William Lallemand5f232402012-04-05 18:02:55 +02002178 if (ret == NULL)
2179 goto out;
2180 tmplog = ret;
2181 last_isspace = 0;
2182 break;
2183
Willy Tarreau2beef582012-12-20 17:22:52 +01002184 case LOG_FMT_BACKENDIP: // %bi
Willy Tarreau8fa99842019-07-17 11:47:11 +02002185 if (be_conn && conn_get_src(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002186 ret = lf_ip(tmplog, (const struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002187 else
2188 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2189
William Lallemand1d705562012-03-12 12:46:41 +01002190 if (ret == NULL)
William Lallemandb7ff6a32012-03-02 14:35:21 +01002191 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002192 tmplog = ret;
William Lallemandb7ff6a32012-03-02 14:35:21 +01002193 last_isspace = 0;
2194 break;
2195
Willy Tarreau2beef582012-12-20 17:22:52 +01002196 case LOG_FMT_BACKENDPORT: // %bp
Willy Tarreau8fa99842019-07-17 11:47:11 +02002197 if (be_conn && conn_get_src(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002198 ret = lf_port(tmplog, (struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002199 else
2200 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2201
William Lallemand5f232402012-04-05 18:02:55 +02002202 if (ret == NULL)
2203 goto out;
2204 tmplog = ret;
2205 last_isspace = 0;
2206 break;
2207
Willy Tarreau2beef582012-12-20 17:22:52 +01002208 case LOG_FMT_SERVERIP: // %si
Willy Tarreau8fa99842019-07-17 11:47:11 +02002209 if (be_conn && conn_get_dst(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002210 ret = lf_ip(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002211 else
2212 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2213
William Lallemand5f232402012-04-05 18:02:55 +02002214 if (ret == NULL)
2215 goto out;
2216 tmplog = ret;
2217 last_isspace = 0;
2218 break;
2219
Willy Tarreau2beef582012-12-20 17:22:52 +01002220 case LOG_FMT_SERVERPORT: // %sp
Willy Tarreau8fa99842019-07-17 11:47:11 +02002221 if (be_conn && conn_get_dst(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002222 ret = lf_port(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002223 else
2224 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2225
William Lallemand1d705562012-03-12 12:46:41 +01002226 if (ret == NULL)
William Lallemandb7ff6a32012-03-02 14:35:21 +01002227 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002228 tmplog = ret;
William Lallemandb7ff6a32012-03-02 14:35:21 +01002229 last_isspace = 0;
2230 break;
2231
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002232 case LOG_FMT_DATE: // %t = accept date
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002233 get_localtime(logs->accept_date.tv_sec, &tm);
2234 ret = date2str_log(tmplog, &tm, &logs->accept_date, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002235 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002236 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002237 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002238 last_isspace = 0;
2239 break;
2240
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002241 case LOG_FMT_tr: // %tr = start of request date
2242 /* Note that the timers are valid if we get here */
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002243 tv_ms_add(&tv, &logs->accept_date, logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002244 get_localtime(tv.tv_sec, &tm);
2245 ret = date2str_log(tmplog, &tm, &tv, dst + maxsize - tmplog);
2246 if (ret == NULL)
2247 goto out;
2248 tmplog = ret;
2249 last_isspace = 0;
2250 break;
2251
2252 case LOG_FMT_DATEGMT: // %T = accept date, GMT
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002253 get_gmtime(logs->accept_date.tv_sec, &tm);
William Lallemand5f232402012-04-05 18:02:55 +02002254 ret = gmt2str_log(tmplog, &tm, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002255 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002256 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002257 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002258 last_isspace = 0;
2259 break;
2260
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002261 case LOG_FMT_trg: // %trg = start of request date, GMT
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002262 tv_ms_add(&tv, &logs->accept_date, logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002263 get_gmtime(tv.tv_sec, &tm);
2264 ret = gmt2str_log(tmplog, &tm, dst + maxsize - tmplog);
2265 if (ret == NULL)
2266 goto out;
2267 tmplog = ret;
2268 last_isspace = 0;
2269 break;
2270
2271 case LOG_FMT_DATELOCAL: // %Tl = accept date, local
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002272 get_localtime(logs->accept_date.tv_sec, &tm);
2273 ret = localdate2str_log(tmplog, logs->accept_date.tv_sec, &tm, dst + maxsize - tmplog);
Yuxans Yao4e25b012012-10-19 10:36:09 +08002274 if (ret == NULL)
2275 goto out;
2276 tmplog = ret;
2277 last_isspace = 0;
2278 break;
2279
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002280 case LOG_FMT_trl: // %trl = start of request date, local
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002281 tv_ms_add(&tv, &logs->accept_date, logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002282 get_localtime(tv.tv_sec, &tm);
2283 ret = localdate2str_log(tmplog, tv.tv_sec, &tm, dst + maxsize - tmplog);
2284 if (ret == NULL)
2285 goto out;
2286 tmplog = ret;
2287 last_isspace = 0;
2288 break;
2289
William Lallemand5f232402012-04-05 18:02:55 +02002290 case LOG_FMT_TS: // %Ts
William Lallemand5f232402012-04-05 18:02:55 +02002291 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002292 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", (unsigned int)logs->accept_date.tv_sec);
William Lallemand5f232402012-04-05 18:02:55 +02002293 if (iret < 0 || iret > dst + maxsize - tmplog)
2294 goto out;
2295 last_isspace = 0;
2296 tmplog += iret;
2297 } else {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002298 ret = ltoa_o(logs->accept_date.tv_sec, tmplog, dst + maxsize - tmplog);
William Lallemand5f232402012-04-05 18:02:55 +02002299 if (ret == NULL)
2300 goto out;
2301 tmplog = ret;
2302 last_isspace = 0;
2303 }
2304 break;
2305
William Lallemand1d705562012-03-12 12:46:41 +01002306 case LOG_FMT_MS: // %ms
William Lallemand5f232402012-04-05 18:02:55 +02002307 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002308 iret = snprintf(tmplog, dst + maxsize - tmplog, "%02X",(unsigned int)logs->accept_date.tv_usec/1000);
William Lallemand5f232402012-04-05 18:02:55 +02002309 if (iret < 0 || iret > dst + maxsize - tmplog)
2310 goto out;
2311 last_isspace = 0;
2312 tmplog += iret;
2313 } else {
2314 if ((dst + maxsize - tmplog) < 4)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002315 goto out;
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002316 ret = utoa_pad((unsigned int)logs->accept_date.tv_usec/1000,
Willy Tarreau9e60cd82013-01-24 01:18:16 +01002317 tmplog, 4);
2318 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002319 goto out;
Willy Tarreau9e60cd82013-01-24 01:18:16 +01002320 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002321 last_isspace = 0;
William Lallemand5f232402012-04-05 18:02:55 +02002322 }
2323 break;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002324
William Lallemand1d705562012-03-12 12:46:41 +01002325 case LOG_FMT_FRONTEND: // %f
William Lallemandbddd4fd2012-02-27 11:23:10 +01002326 src = fe->id;
William Lallemand5f232402012-04-05 18:02:55 +02002327 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002328 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002329 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002330 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002331 last_isspace = 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002332 break;
2333
Willy Tarreau773d65f2012-10-12 14:56:11 +02002334 case LOG_FMT_FRONTEND_XPRT: // %ft
2335 src = fe->id;
2336 if (tmp->options & LOG_OPT_QUOTE)
2337 LOGCHAR('"');
2338 iret = strlcpy2(tmplog, src, dst + maxsize - tmplog);
2339 if (iret == 0)
2340 goto out;
2341 tmplog += iret;
Christopher Faulet1ccbe122021-11-15 11:31:08 +01002342
2343 /* sess->listener may be undefined if the session's owner is a health-check */
Willy Tarreau807a3a52022-04-12 08:08:33 +02002344 if (sess->listener && sess->listener->bind_conf->xprt->get_ssl_sock_ctx)
Willy Tarreau773d65f2012-10-12 14:56:11 +02002345 LOGCHAR('~');
Willy Tarreau773d65f2012-10-12 14:56:11 +02002346 if (tmp->options & LOG_OPT_QUOTE)
2347 LOGCHAR('"');
2348 last_isspace = 0;
2349 break;
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002350#ifdef USE_OPENSSL
2351 case LOG_FMT_SSL_CIPHER: // %sslc
2352 src = NULL;
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002353 conn = objt_conn(sess->origin);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002354 if (conn) {
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02002355 src = ssl_sock_get_cipher_name(conn);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002356 }
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002357 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
2358 if (ret == NULL)
2359 goto out;
2360 tmplog = ret;
2361 last_isspace = 0;
2362 break;
Willy Tarreau773d65f2012-10-12 14:56:11 +02002363
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002364 case LOG_FMT_SSL_VERSION: // %sslv
2365 src = NULL;
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002366 conn = objt_conn(sess->origin);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002367 if (conn) {
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02002368 src = ssl_sock_get_proto_version(conn);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002369 }
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002370 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
2371 if (ret == NULL)
2372 goto out;
2373 tmplog = ret;
2374 last_isspace = 0;
2375 break;
2376#endif
William Lallemand1d705562012-03-12 12:46:41 +01002377 case LOG_FMT_BACKEND: // %b
William Lallemandbddd4fd2012-02-27 11:23:10 +01002378 src = be->id;
William Lallemand5f232402012-04-05 18:02:55 +02002379 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002380 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002381 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002382 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002383 last_isspace = 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002384 break;
2385
William Lallemand1d705562012-03-12 12:46:41 +01002386 case LOG_FMT_SERVER: // %s
Christopher Fauletfd818482021-04-14 14:01:41 +02002387 switch (obj_type(s ? s->target : sess->origin)) {
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002388 case OBJ_TYPE_SERVER:
Willy Tarreau1aaf3242018-09-20 11:13:58 +02002389 src = __objt_server(s->target)->id;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002390 break;
2391 case OBJ_TYPE_APPLET:
Willy Tarreau1aaf3242018-09-20 11:13:58 +02002392 src = __objt_applet(s->target)->name;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002393 break;
Christopher Fauletfd818482021-04-14 14:01:41 +02002394 case OBJ_TYPE_CHECK:
2395 src = (__objt_check(sess->origin)->server
2396 ? __objt_check(sess->origin)->server->id
2397 : "<NOSRV>");
2398 break;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002399 default:
2400 src = "<NOSRV>";
2401 break;
2402 }
William Lallemand5f232402012-04-05 18:02:55 +02002403 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002404 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002405 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002406 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002407 last_isspace = 0;
2408 break;
2409
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002410 case LOG_FMT_Th: // %Th = handshake time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002411 ret = ltoa_o(logs->t_handshake, tmplog, dst + maxsize - tmplog);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002412 if (ret == NULL)
2413 goto out;
2414 tmplog = ret;
2415 last_isspace = 0;
2416 break;
2417
2418 case LOG_FMT_Ti: // %Ti = HTTP idle time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002419 ret = ltoa_o(logs->t_idle, tmplog, dst + maxsize - tmplog);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002420 if (ret == NULL)
2421 goto out;
2422 tmplog = ret;
2423 last_isspace = 0;
2424 break;
2425
2426 case LOG_FMT_TR: // %TR = HTTP request time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002427 ret = ltoa_o((t_request >= 0) ? t_request - logs->t_idle - logs->t_handshake : -1,
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002428 tmplog, dst + maxsize - tmplog);
2429 if (ret == NULL)
2430 goto out;
2431 tmplog = ret;
2432 last_isspace = 0;
2433 break;
2434
2435 case LOG_FMT_TQ: // %Tq = Th + Ti + TR
William Lallemand5f232402012-04-05 18:02:55 +02002436 ret = ltoa_o(t_request, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002437 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002438 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002439 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002440 last_isspace = 0;
2441 break;
2442
William Lallemand1d705562012-03-12 12:46:41 +01002443 case LOG_FMT_TW: // %Tw
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002444 ret = ltoa_o((logs->t_queue >= 0) ? logs->t_queue - t_request : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002445 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002446 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002447 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002448 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002449 last_isspace = 0;
2450 break;
2451
William Lallemand1d705562012-03-12 12:46:41 +01002452 case LOG_FMT_TC: // %Tc
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002453 ret = ltoa_o((logs->t_connect >= 0) ? logs->t_connect - logs->t_queue : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002454 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002455 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002456 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002457 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002458 last_isspace = 0;
2459 break;
2460
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002461 case LOG_FMT_Tr: // %Tr
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002462 ret = ltoa_o((logs->t_data >= 0) ? logs->t_data - logs->t_connect : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002463 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002464 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002465 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002466 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002467 last_isspace = 0;
2468 break;
2469
Willy Tarreau27b639d2016-05-17 17:55:27 +02002470 case LOG_FMT_TD: // %Td
Willy Tarreaua21c0e62018-09-05 15:07:15 +02002471 if (be->mode == PR_MODE_HTTP)
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002472 ret = ltoa_o((logs->t_data >= 0) ? logs->t_close - logs->t_data : -1,
Willy Tarreau27b639d2016-05-17 17:55:27 +02002473 tmplog, dst + maxsize - tmplog);
2474 else
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002475 ret = ltoa_o((logs->t_connect >= 0) ? logs->t_close - logs->t_connect : -1,
Willy Tarreau27b639d2016-05-17 17:55:27 +02002476 tmplog, dst + maxsize - tmplog);
2477 if (ret == NULL)
2478 goto out;
2479 tmplog = ret;
2480 last_isspace = 0;
2481 break;
2482
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002483 case LOG_FMT_Ta: // %Ta = active time = Tt - Th - Ti
2484 if (!(fe->to_log & LW_BYTES))
2485 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002486 ret = ltoa_o(logs->t_close - (logs->t_idle >= 0 ? logs->t_idle + logs->t_handshake : 0),
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002487 tmplog, dst + maxsize - tmplog);
2488 if (ret == NULL)
2489 goto out;
2490 tmplog = ret;
2491 last_isspace = 0;
2492 break;
2493
2494 case LOG_FMT_TT: // %Tt = total time
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002495 if (!(fe->to_log & LW_BYTES))
William Lallemand1d705562012-03-12 12:46:41 +01002496 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002497 ret = ltoa_o(logs->t_close, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002498 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002499 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002500 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002501 last_isspace = 0;
2502 break;
2503
Damien Claisse57c8eb92020-04-28 12:09:19 +00002504 case LOG_FMT_TU: // %Tu = total time seen by user = Tt - Ti
2505 if (!(fe->to_log & LW_BYTES))
2506 LOGCHAR('+');
2507 ret = ltoa_o(logs->t_close - (logs->t_idle >= 0 ? logs->t_idle : 0),
2508 tmplog, dst + maxsize - tmplog);
2509 if (ret == NULL)
2510 goto out;
2511 tmplog = ret;
2512 last_isspace = 0;
2513 break;
2514
Willy Tarreau2beef582012-12-20 17:22:52 +01002515 case LOG_FMT_STATUS: // %ST
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002516 ret = ltoa_o(status, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002517 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002518 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002519 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002520 last_isspace = 0;
2521 break;
2522
William Lallemand1d705562012-03-12 12:46:41 +01002523 case LOG_FMT_BYTES: // %B
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002524 if (!(fe->to_log & LW_BYTES))
William Lallemand1d705562012-03-12 12:46:41 +01002525 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002526 ret = lltoa(logs->bytes_out, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002527 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002528 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002529 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002530 last_isspace = 0;
2531 break;
2532
Willy Tarreauc5259fd2012-12-20 15:38:04 +01002533 case LOG_FMT_BYTES_UP: // %U
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002534 ret = lltoa(logs->bytes_in, tmplog, dst + maxsize - tmplog);
Willy Tarreauc5259fd2012-12-20 15:38:04 +01002535 if (ret == NULL)
2536 goto out;
2537 tmplog = ret;
2538 last_isspace = 0;
2539 break;
2540
Willy Tarreau2beef582012-12-20 17:22:52 +01002541 case LOG_FMT_CCLIENT: // %CC
Willy Tarreau57bc8912016-04-25 17:09:40 +02002542 src = txn ? txn->cli_cookie : NULL;
William Lallemand5f232402012-04-05 18:02:55 +02002543 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002544 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002545 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002546 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002547 last_isspace = 0;
2548 break;
2549
Willy Tarreau2beef582012-12-20 17:22:52 +01002550 case LOG_FMT_CSERVER: // %CS
Willy Tarreau57bc8912016-04-25 17:09:40 +02002551 src = txn ? txn->srv_cookie : NULL;
William Lallemand5f232402012-04-05 18:02:55 +02002552 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002553 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002554 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002555 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002556 last_isspace = 0;
2557 break;
2558
William Lallemand1d705562012-03-12 12:46:41 +01002559 case LOG_FMT_TERMSTATE: // %ts
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002560 LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]);
2561 LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]);
Willy Tarreau6580c062012-03-12 15:09:42 +01002562 *tmplog = '\0';
2563 last_isspace = 0;
2564 break;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002565
William Lallemand1d705562012-03-12 12:46:41 +01002566 case LOG_FMT_TERMSTATE_CK: // %tsc, same as TS with cookie state (for mode HTTP)
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002567 LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]);
2568 LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]);
Willy Tarreau57bc8912016-04-25 17:09:40 +02002569 LOGCHAR((txn && (be->ck_opts & PR_CK_ANY)) ? sess_cookie[(txn->flags & TX_CK_MASK) >> TX_CK_SHIFT] : '-');
2570 LOGCHAR((txn && (be->ck_opts & PR_CK_ANY)) ? sess_set_cookie[(txn->flags & TX_SCK_MASK) >> TX_SCK_SHIFT] : '-');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002571 last_isspace = 0;
2572 break;
2573
William Lallemand1d705562012-03-12 12:46:41 +01002574 case LOG_FMT_ACTCONN: // %ac
William Lallemand5f232402012-04-05 18:02:55 +02002575 ret = ltoa_o(actconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002576 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002577 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002578 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002579 last_isspace = 0;
2580 break;
2581
William Lallemand1d705562012-03-12 12:46:41 +01002582 case LOG_FMT_FECONN: // %fc
William Lallemand5f232402012-04-05 18:02:55 +02002583 ret = ltoa_o(fe->feconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002584 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002585 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002586 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002587 last_isspace = 0;
2588 break;
2589
William Lallemand1d705562012-03-12 12:46:41 +01002590 case LOG_FMT_BECONN: // %bc
William Lallemand5f232402012-04-05 18:02:55 +02002591 ret = ltoa_o(be->beconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002592 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002593 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002594 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002595 last_isspace = 0;
2596 break;
2597
William Lallemand1d705562012-03-12 12:46:41 +01002598 case LOG_FMT_SRVCONN: // %sc
Christopher Fauletfd818482021-04-14 14:01:41 +02002599 switch (obj_type(s ? s->target : sess->origin)) {
2600 case OBJ_TYPE_SERVER:
2601 ret = ultoa_o(__objt_server(s->target)->cur_sess,
2602 tmplog, dst + maxsize - tmplog);
2603 break;
2604 case OBJ_TYPE_CHECK:
2605 ret = ultoa_o(__objt_check(sess->origin)->server
2606 ? __objt_check(sess->origin)->server->cur_sess
2607 : 0, tmplog, dst + maxsize - tmplog);
2608 break;
2609 default:
2610 ret = ultoa_o(0, tmplog, dst + maxsize - tmplog);
2611 break;
2612 }
2613
William Lallemand1d705562012-03-12 12:46:41 +01002614 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002615 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002616 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002617 last_isspace = 0;
2618 break;
2619
William Lallemand1d705562012-03-12 12:46:41 +01002620 case LOG_FMT_RETRIES: // %rq
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002621 if (s_flags & SF_REDISP)
William Lallemand1d705562012-03-12 12:46:41 +01002622 LOGCHAR('+');
Christopher Faulet731c8e62022-03-29 16:08:44 +02002623 ret = ltoa_o((s ? s->conn_retries : 0), tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002624 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002625 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002626 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002627 last_isspace = 0;
2628 break;
2629
William Lallemand1d705562012-03-12 12:46:41 +01002630 case LOG_FMT_SRVQUEUE: // %sq
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002631 ret = ltoa_o(logs->srv_queue_pos, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002632 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002633 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002634 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002635 last_isspace = 0;
2636 break;
2637
William Lallemand1d705562012-03-12 12:46:41 +01002638 case LOG_FMT_BCKQUEUE: // %bq
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002639 ret = ltoa_o(logs->prx_queue_pos, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002640 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002641 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002642 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002643 last_isspace = 0;
2644 break;
2645
William Lallemand1d705562012-03-12 12:46:41 +01002646 case LOG_FMT_HDRREQUEST: // %hr
William Lallemandbddd4fd2012-02-27 11:23:10 +01002647 /* request header */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002648 if (fe->nb_req_cap && s && s->req_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002649 if (tmp->options & LOG_OPT_QUOTE)
2650 LOGCHAR('"');
2651 LOGCHAR('{');
2652 for (hdr = 0; hdr < fe->nb_req_cap; hdr++) {
2653 if (hdr)
2654 LOGCHAR('|');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002655 if (s->req_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002656 ret = lf_encode_string(tmplog, dst + maxsize,
2657 '#', hdr_encode_map, s->req_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002658 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002659 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002660 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002661 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002662 }
2663 LOGCHAR('}');
William Lallemand51b5dca2012-03-26 17:52:55 +02002664 if (tmp->options & LOG_OPT_QUOTE)
2665 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002666 last_isspace = 0;
2667 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002668 break;
2669
William Lallemand1d705562012-03-12 12:46:41 +01002670 case LOG_FMT_HDRREQUESTLIST: // %hrl
William Lallemandbddd4fd2012-02-27 11:23:10 +01002671 /* request header list */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002672 if (fe->nb_req_cap && s && s->req_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002673 for (hdr = 0; hdr < fe->nb_req_cap; hdr++) {
2674 if (hdr > 0)
2675 LOGCHAR(' ');
2676 if (tmp->options & LOG_OPT_QUOTE)
2677 LOGCHAR('"');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002678 if (s->req_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002679 ret = lf_encode_string(tmplog, dst + maxsize,
2680 '#', hdr_encode_map, s->req_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002681 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002682 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002683 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002684 } else if (!(tmp->options & LOG_OPT_QUOTE))
2685 LOGCHAR('-');
2686 if (tmp->options & LOG_OPT_QUOTE)
2687 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002688 last_isspace = 0;
2689 }
2690 }
2691 break;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002692
William Lallemand1d705562012-03-12 12:46:41 +01002693
2694 case LOG_FMT_HDRRESPONS: // %hs
William Lallemandbddd4fd2012-02-27 11:23:10 +01002695 /* response header */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002696 if (fe->nb_rsp_cap && s && s->res_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002697 if (tmp->options & LOG_OPT_QUOTE)
2698 LOGCHAR('"');
2699 LOGCHAR('{');
2700 for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) {
2701 if (hdr)
2702 LOGCHAR('|');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002703 if (s->res_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002704 ret = lf_encode_string(tmplog, dst + maxsize,
2705 '#', hdr_encode_map, s->res_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002706 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002707 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002708 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002709 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002710 }
2711 LOGCHAR('}');
2712 last_isspace = 0;
2713 if (tmp->options & LOG_OPT_QUOTE)
2714 LOGCHAR('"');
2715 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002716 break;
2717
William Lallemand1d705562012-03-12 12:46:41 +01002718 case LOG_FMT_HDRRESPONSLIST: // %hsl
William Lallemandbddd4fd2012-02-27 11:23:10 +01002719 /* response header list */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002720 if (fe->nb_rsp_cap && s && s->res_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002721 for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) {
2722 if (hdr > 0)
2723 LOGCHAR(' ');
2724 if (tmp->options & LOG_OPT_QUOTE)
2725 LOGCHAR('"');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002726 if (s->res_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002727 ret = lf_encode_string(tmplog, dst + maxsize,
2728 '#', hdr_encode_map, s->res_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002729 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002730 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002731 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002732 } else if (!(tmp->options & LOG_OPT_QUOTE))
2733 LOGCHAR('-');
2734 if (tmp->options & LOG_OPT_QUOTE)
2735 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002736 last_isspace = 0;
2737 }
2738 }
2739 break;
2740
William Lallemand1d705562012-03-12 12:46:41 +01002741 case LOG_FMT_REQ: // %r
William Lallemandbddd4fd2012-02-27 11:23:10 +01002742 /* Request */
2743 if (tmp->options & LOG_OPT_QUOTE)
2744 LOGCHAR('"');
Willy Tarreau57bc8912016-04-25 17:09:40 +02002745 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Dragan Dosen835b9212016-02-12 13:23:03 +01002746 ret = lf_encode_string(tmplog, dst + maxsize,
2747 '#', url_encode_map, uri, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002748 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002749 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002750 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002751 if (tmp->options & LOG_OPT_QUOTE)
2752 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002753 last_isspace = 0;
2754 break;
William Lallemand5f232402012-04-05 18:02:55 +02002755
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002756 case LOG_FMT_HTTP_PATH: // %HP
Willy Tarreau57bc8912016-04-25 17:09:40 +02002757 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002758
Willy Tarreaub7636d12015-06-17 19:58:02 +02002759 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002760 LOGCHAR('"');
2761
2762 end = uri + strlen(uri);
2763 // look for the first whitespace character
2764 while (uri < end && !HTTP_IS_SPHT(*uri))
2765 uri++;
2766
2767 // keep advancing past multiple spaces
2768 while (uri < end && HTTP_IS_SPHT(*uri)) {
2769 uri++; nspaces++;
2770 }
2771
2772 // look for first space or question mark after url
2773 spc = uri;
2774 while (spc < end && *spc != '?' && !HTTP_IS_SPHT(*spc))
2775 spc++;
2776
Nenad Merdanovic54e439f2016-04-26 01:39:02 +02002777 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002778 chunk.area = "<BADREQ>";
2779 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002780 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002781 chunk.area = uri;
2782 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002783 }
2784
Dragan Dosen835b9212016-02-12 13:23:03 +01002785 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002786 if (ret == NULL || *ret != '\0')
2787 goto out;
2788
2789 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002790 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002791 LOGCHAR('"');
2792
2793 last_isspace = 0;
2794 break;
2795
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002796 case LOG_FMT_HTTP_PATH_ONLY: // %HPO
2797 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
2798
2799 if (tmp->options & LOG_OPT_QUOTE)
2800 LOGCHAR('"');
2801
2802 end = uri + strlen(uri);
2803
2804 // look for the first whitespace character
2805 while (uri < end && !HTTP_IS_SPHT(*uri))
2806 uri++;
2807
2808 // keep advancing past multiple spaces
2809 while (uri < end && HTTP_IS_SPHT(*uri)) {
2810 uri++; nspaces++;
2811 }
2812
2813 // look for first space after url
2814 spc = uri;
2815 while (spc < end && !HTTP_IS_SPHT(*spc))
2816 spc++;
2817
Tim Duesterhus92c696e2021-02-28 16:11:36 +01002818 path = ist2(uri, spc - uri);
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002819
2820 // extract relative path without query params from url
Amaury Denoyellec453f952021-07-06 11:40:12 +02002821 parser = http_uri_parser_init(path);
2822 path = iststop(http_parse_path(&parser), '?');
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002823 if (!txn || !txn->uri || nspaces == 0) {
2824 chunk.area = "<BADREQ>";
2825 chunk.data = strlen("<BADREQ>");
2826 } else {
2827 chunk.area = path.ptr;
2828 chunk.data = path.len;
2829 }
2830
2831 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
2832 if (ret == NULL || *ret != '\0')
2833 goto out;
2834
2835 tmplog = ret;
2836 if (tmp->options & LOG_OPT_QUOTE)
2837 LOGCHAR('"');
2838
2839 last_isspace = 0;
2840 break;
2841
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002842 case LOG_FMT_HTTP_QUERY: // %HQ
2843 if (tmp->options & LOG_OPT_QUOTE)
2844 LOGCHAR('"');
2845
Willy Tarreau57bc8912016-04-25 17:09:40 +02002846 if (!txn || !txn->uri) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002847 chunk.area = "<BADREQ>";
2848 chunk.data = strlen("<BADREQ>");
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002849 } else {
2850 uri = txn->uri;
2851 end = uri + strlen(uri);
2852 // look for the first question mark
2853 while (uri < end && *uri != '?')
2854 uri++;
2855
2856 qmark = uri;
2857 // look for first space or question mark after url
2858 while (uri < end && !HTTP_IS_SPHT(*uri))
2859 uri++;
2860
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002861 chunk.area = qmark;
2862 chunk.data = uri - qmark;
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002863 }
2864
Dragan Dosen835b9212016-02-12 13:23:03 +01002865 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002866 if (ret == NULL || *ret != '\0')
2867 goto out;
2868
2869 tmplog = ret;
2870 if (tmp->options & LOG_OPT_QUOTE)
2871 LOGCHAR('"');
2872
2873 last_isspace = 0;
2874 break;
2875
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002876 case LOG_FMT_HTTP_URI: // %HU
Willy Tarreau57bc8912016-04-25 17:09:40 +02002877 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002878
Willy Tarreaub7636d12015-06-17 19:58:02 +02002879 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002880 LOGCHAR('"');
2881
2882 end = uri + strlen(uri);
2883 // look for the first whitespace character
2884 while (uri < end && !HTTP_IS_SPHT(*uri))
2885 uri++;
2886
2887 // keep advancing past multiple spaces
2888 while (uri < end && HTTP_IS_SPHT(*uri)) {
2889 uri++; nspaces++;
2890 }
2891
2892 // look for first space after url
2893 spc = uri;
2894 while (spc < end && !HTTP_IS_SPHT(*spc))
2895 spc++;
2896
Willy Tarreau57bc8912016-04-25 17:09:40 +02002897 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002898 chunk.area = "<BADREQ>";
2899 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002900 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002901 chunk.area = uri;
2902 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002903 }
2904
Dragan Dosen835b9212016-02-12 13:23:03 +01002905 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002906 if (ret == NULL || *ret != '\0')
2907 goto out;
2908
2909 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002910 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002911 LOGCHAR('"');
2912
2913 last_isspace = 0;
2914 break;
2915
2916 case LOG_FMT_HTTP_METHOD: // %HM
Willy Tarreau57bc8912016-04-25 17:09:40 +02002917 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Willy Tarreaub7636d12015-06-17 19:58:02 +02002918 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002919 LOGCHAR('"');
2920
2921 end = uri + strlen(uri);
2922 // look for the first whitespace character
2923 spc = uri;
2924 while (spc < end && !HTTP_IS_SPHT(*spc))
2925 spc++;
2926
2927 if (spc == end) { // odd case, we have txn->uri, but we only got a verb
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002928 chunk.area = "<BADREQ>";
2929 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002930 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002931 chunk.area = uri;
2932 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002933 }
2934
Dragan Dosen835b9212016-02-12 13:23:03 +01002935 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002936 if (ret == NULL || *ret != '\0')
2937 goto out;
2938
2939 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002940 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002941 LOGCHAR('"');
2942
2943 last_isspace = 0;
2944 break;
2945
2946 case LOG_FMT_HTTP_VERSION: // %HV
Willy Tarreau57bc8912016-04-25 17:09:40 +02002947 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Willy Tarreaub7636d12015-06-17 19:58:02 +02002948 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002949 LOGCHAR('"');
2950
2951 end = uri + strlen(uri);
2952 // look for the first whitespace character
2953 while (uri < end && !HTTP_IS_SPHT(*uri))
2954 uri++;
2955
2956 // keep advancing past multiple spaces
2957 while (uri < end && HTTP_IS_SPHT(*uri)) {
2958 uri++; nspaces++;
2959 }
2960
2961 // look for the next whitespace character
2962 while (uri < end && !HTTP_IS_SPHT(*uri))
2963 uri++;
2964
2965 // keep advancing past multiple spaces
2966 while (uri < end && HTTP_IS_SPHT(*uri))
2967 uri++;
2968
Willy Tarreau57bc8912016-04-25 17:09:40 +02002969 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002970 chunk.area = "<BADREQ>";
2971 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002972 } else if (uri == end) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002973 chunk.area = "HTTP/0.9";
2974 chunk.data = strlen("HTTP/0.9");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002975 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002976 chunk.area = uri;
2977 chunk.data = end - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002978 }
2979
Dragan Dosen835b9212016-02-12 13:23:03 +01002980 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002981 if (ret == NULL || *ret != '\0')
2982 goto out;
2983
2984 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002985 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002986 LOGCHAR('"');
2987
2988 last_isspace = 0;
2989 break;
2990
William Lallemand5f232402012-04-05 18:02:55 +02002991 case LOG_FMT_COUNTER: // %rt
2992 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau5cacab62018-09-05 15:52:59 +02002993 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", uniq_id);
William Lallemand5f232402012-04-05 18:02:55 +02002994 if (iret < 0 || iret > dst + maxsize - tmplog)
2995 goto out;
2996 last_isspace = 0;
2997 tmplog += iret;
2998 } else {
Willy Tarreau5cacab62018-09-05 15:52:59 +02002999 ret = ltoa_o(uniq_id, tmplog, dst + maxsize - tmplog);
William Lallemand5f232402012-04-05 18:02:55 +02003000 if (ret == NULL)
3001 goto out;
3002 tmplog = ret;
3003 last_isspace = 0;
3004 }
3005 break;
3006
Willy Tarreau7346acb2014-08-28 15:03:15 +02003007 case LOG_FMT_LOGCNT: // %lc
3008 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003009 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", fe->log_count);
Willy Tarreau7346acb2014-08-28 15:03:15 +02003010 if (iret < 0 || iret > dst + maxsize - tmplog)
3011 goto out;
3012 last_isspace = 0;
3013 tmplog += iret;
3014 } else {
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003015 ret = ultoa_o(fe->log_count, tmplog, dst + maxsize - tmplog);
Willy Tarreau7346acb2014-08-28 15:03:15 +02003016 if (ret == NULL)
3017 goto out;
3018 tmplog = ret;
3019 last_isspace = 0;
3020 }
3021 break;
3022
William Lallemand5f232402012-04-05 18:02:55 +02003023 case LOG_FMT_HOSTNAME: // %H
3024 src = hostname;
3025 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
3026 if (ret == NULL)
3027 goto out;
3028 tmplog = ret;
3029 last_isspace = 0;
3030 break;
3031
3032 case LOG_FMT_PID: // %pid
3033 if (tmp->options & LOG_OPT_HEXA) {
3034 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", pid);
3035 if (iret < 0 || iret > dst + maxsize - tmplog)
3036 goto out;
3037 last_isspace = 0;
3038 tmplog += iret;
3039 } else {
3040 ret = ltoa_o(pid, tmplog, dst + maxsize - tmplog);
3041 if (ret == NULL)
3042 goto out;
3043 tmplog = ret;
3044 last_isspace = 0;
3045 }
3046 break;
William Lallemanda73203e2012-03-12 12:48:57 +01003047
3048 case LOG_FMT_UNIQUEID: // %ID
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003049 ret = NULL;
Tim Duesterhusa17e6622020-03-05 20:19:02 +01003050 if (s)
3051 ret = lf_text_len(tmplog, s->unique_id.ptr, s->unique_id.len, maxsize - (tmplog - dst), tmp);
3052 else
3053 ret = lf_text_len(tmplog, NULL, 0, maxsize - (tmplog - dst), tmp);
William Lallemanda73203e2012-03-12 12:48:57 +01003054 if (ret == NULL)
3055 goto out;
3056 tmplog = ret;
3057 last_isspace = 0;
3058 break;
3059
William Lallemandbddd4fd2012-02-27 11:23:10 +01003060 }
3061 }
3062
3063out:
William Lallemand1d705562012-03-12 12:46:41 +01003064 /* *tmplog is a unused character */
3065 *tmplog = '\0';
Willy Tarreaudf974472012-12-28 02:44:01 +01003066 return tmplog - dst;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003067
Willy Tarreaubaaee002006-06-26 02:48:02 +02003068}
3069
William Lallemand1d705562012-03-12 12:46:41 +01003070/*
Willy Tarreau87b09662015-04-03 00:22:06 +02003071 * send a log for the stream when we have enough info about it.
William Lallemand1d705562012-03-12 12:46:41 +01003072 * Will not log if the frontend has no log defined.
3073 */
Willy Tarreau87b09662015-04-03 00:22:06 +02003074void strm_log(struct stream *s)
William Lallemand1d705562012-03-12 12:46:41 +01003075{
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003076 struct session *sess = s->sess;
William Lallemand1d705562012-03-12 12:46:41 +01003077 int size, err, level;
Dragan Dosen0b85ece2015-09-25 19:17:44 +02003078 int sd_size = 0;
William Lallemand1d705562012-03-12 12:46:41 +01003079
3080 /* if we don't want to log normal traffic, return now */
Willy Tarreaue7dff022015-04-03 01:14:29 +02003081 err = (s->flags & SF_REDISP) ||
3082 ((s->flags & SF_ERR_MASK) > SF_ERR_LOCAL) ||
Christopher Fauleta892b7f2022-06-17 14:53:20 +02003083 (((s->flags & SF_ERR_MASK) == SF_ERR_NONE) && s->conn_retries) ||
Willy Tarreaueee5b512015-04-03 23:46:31 +02003084 ((sess->fe->mode == PR_MODE_HTTP) && s->txn && s->txn->status >= 500);
Willy Tarreaubaaee002006-06-26 02:48:02 +02003085
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003086 if (!err && (sess->fe->options2 & PR_O2_NOLOGNORM))
William Lallemand1d705562012-03-12 12:46:41 +01003087 return;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003088
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003089 if (LIST_ISEMPTY(&sess->fe->logsrvs))
William Lallemand1d705562012-03-12 12:46:41 +01003090 return;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003091
Willy Tarreauabcd5142013-06-11 17:18:02 +02003092 if (s->logs.level) { /* loglevel was overridden */
3093 if (s->logs.level == -1) {
3094 s->logs.logwait = 0; /* logs disabled */
3095 return;
3096 }
3097 level = s->logs.level - 1;
3098 }
3099 else {
3100 level = LOG_INFO;
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003101 if (err && (sess->fe->options2 & PR_O2_LOGERRORS))
Willy Tarreauabcd5142013-06-11 17:18:02 +02003102 level = LOG_ERR;
3103 }
William Lallemand1d705562012-03-12 12:46:41 +01003104
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003105 /* if unique-id was not generated */
Tim Duesterhusa17e6622020-03-05 20:19:02 +01003106 if (!isttest(s->unique_id) && !LIST_ISEMPTY(&sess->fe->format_unique_id)) {
Tim Duesterhus2825b4b2020-02-28 15:13:34 +01003107 stream_generate_unique_id(s, &sess->fe->format_unique_id);
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003108 }
3109
Dragan Dosen0b85ece2015-09-25 19:17:44 +02003110 if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) {
3111 sd_size = build_logline(s, logline_rfc5424, global.max_syslog_len,
3112 &sess->fe->logformat_sd);
3113 }
3114
Dragan Dosen59cee972015-09-19 22:09:02 +02003115 size = build_logline(s, logline, global.max_syslog_len, &sess->fe->logformat);
William Lallemand1d705562012-03-12 12:46:41 +01003116 if (size > 0) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003117 _HA_ATOMIC_INC(&sess->fe->log_count);
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003118 __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level,
3119 logline, size + 1, logline_rfc5424, sd_size);
William Lallemand1d705562012-03-12 12:46:41 +01003120 s->logs.logwait = 0;
3121 }
3122}
William Lallemandbddd4fd2012-02-27 11:23:10 +01003123
Willy Tarreau53839352018-09-05 19:51:10 +02003124/*
3125 * send a minimalist log for the session. Will not log if the frontend has no
3126 * log defined. It is assumed that this is only used to report anomalies that
3127 * cannot lead to the creation of a regular stream. Because of this the log
3128 * level is LOG_INFO or LOG_ERR depending on the "log-separate-error" setting
3129 * in the frontend. The caller must simply know that it should not call this
Willy Tarreau9fa267d2018-10-05 10:22:27 +02003130 * function to report unimportant events. It is safe to call this function with
3131 * sess==NULL (will not do anything).
Willy Tarreau53839352018-09-05 19:51:10 +02003132 */
3133void sess_log(struct session *sess)
3134{
3135 int size, level;
3136 int sd_size = 0;
3137
Willy Tarreau9fa267d2018-10-05 10:22:27 +02003138 if (!sess)
3139 return;
3140
Willy Tarreau53839352018-09-05 19:51:10 +02003141 if (LIST_ISEMPTY(&sess->fe->logsrvs))
3142 return;
3143
3144 level = LOG_INFO;
3145 if (sess->fe->options2 & PR_O2_LOGERRORS)
3146 level = LOG_ERR;
3147
3148 if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) {
3149 sd_size = sess_build_logline(sess, NULL,
3150 logline_rfc5424, global.max_syslog_len,
3151 &sess->fe->logformat_sd);
3152 }
3153
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02003154 if (!LIST_ISEMPTY(&sess->fe->logformat_error))
3155 size = sess_build_logline(sess, NULL, logline, global.max_syslog_len, &sess->fe->logformat_error);
3156 else
3157 size = sess_build_logline(sess, NULL, logline, global.max_syslog_len, &sess->fe->logformat);
Willy Tarreau53839352018-09-05 19:51:10 +02003158 if (size > 0) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003159 _HA_ATOMIC_INC(&sess->fe->log_count);
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003160 __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level,
3161 logline, size + 1, logline_rfc5424, sd_size);
Willy Tarreau53839352018-09-05 19:51:10 +02003162 }
3163}
3164
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003165void app_log(struct list *logsrvs, struct buffer *tag, int level, const char *format, ...)
3166{
3167 va_list argp;
3168 int data_len;
3169
3170 if (level < 0 || format == NULL || logline == NULL)
3171 return;
3172
3173 va_start(argp, format);
3174 data_len = vsnprintf(logline, global.max_syslog_len, format, argp);
3175 if (data_len < 0 || data_len > global.max_syslog_len)
3176 data_len = global.max_syslog_len;
3177 va_end(argp);
3178
3179 __send_log(logsrvs, tag, level, logline, data_len, default_rfc5424_sd_log_format, 2);
3180}
Emeric Brun54932b42020-07-07 09:43:24 +02003181/*
3182 * This function parse a received log message <buf>, of size <buflen>
3183 * it fills <level>, <facility> and <metadata> depending of the detected
3184 * header format and message will point on remaining payload of <size>
3185 *
3186 * <metadata> must point on a preallocated array of LOG_META_FIELDS*sizeof(struct ist)
3187 * struct ist len will be set to 0 if field is not found
3188 * <level> and <facility> will be set to -1 if not found.
3189 */
3190void parse_log_message(char *buf, size_t buflen, int *level, int *facility,
3191 struct ist *metadata, char **message, size_t *size)
3192{
3193
3194 char *p;
3195 int fac_level = 0;
3196
3197 *level = *facility = -1;
3198
3199 *message = buf;
3200 *size = buflen;
3201
3202 memset(metadata, 0, LOG_META_FIELDS*sizeof(struct ist));
3203
3204 p = buf;
3205 if (*size < 2 || *p != '<')
3206 return;
3207
3208 p++;
3209 while (*p != '>') {
3210 if (*p > '9' || *p < '0')
3211 return;
3212 fac_level = 10*fac_level + (*p - '0');
3213 p++;
3214 if ((p - buf) > buflen)
3215 return;
3216 }
3217
3218 *facility = fac_level >> 3;
3219 *level = fac_level & 0x7;
3220 p++;
3221
3222 metadata[LOG_META_PRIO] = ist2(buf, p - buf);
3223
3224 buflen -= p - buf;
3225 buf = p;
3226
3227 *size = buflen;
3228 *message = buf;
3229
3230 /* for rfc5424, prio is always followed by '1' and ' ' */
3231 if ((*size > 2) && (p[0] == '1') && (p[1] == ' ')) {
3232 /* format is always '1 TIMESTAMP HOSTNAME TAG PID MSGID STDATA '
3233 * followed by message.
3234 * Each header field can present NILVALUE: '-'
3235 */
3236
3237 p += 2;
Aurelien DARRAGONab9efc22022-11-22 11:17:11 +01003238 *size -= 2;
Emeric Brun54932b42020-07-07 09:43:24 +02003239 /* timestamp is NILVALUE '-' */
3240 if (*size > 2 && (p[0] == '-') && p[1] == ' ') {
3241 metadata[LOG_META_TIME] = ist2(p, 1);
3242 p++;
3243 }
3244 else if (*size > LOG_ISOTIME_MINLEN) {
3245 metadata[LOG_META_TIME].ptr = p;
3246
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05003247 /* check if optional secfrac is present
Emeric Brun54932b42020-07-07 09:43:24 +02003248 * in timestamp.
3249 * possible format are:
3250 * ex: '1970-01-01T00:00:00.000000Z'
3251 * '1970-01-01T00:00:00.000000+00:00'
3252 * '1970-01-01T00:00:00.000000-00:00'
3253 * '1970-01-01T00:00:00Z'
3254 * '1970-01-01T00:00:00+00:00'
3255 * '1970-01-01T00:00:00-00:00'
3256 */
3257 p += 19;
3258 if (*p == '.') {
3259 p++;
3260 if ((p - buf) >= buflen)
3261 goto bad_format;
3262 while (*p != 'Z' && *p != '+' && *p != '-') {
3263 if ((unsigned char)(*p - '0') > 9)
3264 goto bad_format;
3265
3266 p++;
3267 if ((p - buf) >= buflen)
3268 goto bad_format;
3269 }
3270 }
3271
3272 if (*p == 'Z')
3273 p++;
3274 else
3275 p += 6; /* case of '+00:00 or '-00:00' */
3276
3277 if ((p - buf) >= buflen || *p != ' ')
3278 goto bad_format;
3279 metadata[LOG_META_TIME].len = p - metadata[LOG_META_TIME].ptr;
3280 }
3281 else
3282 goto bad_format;
3283
3284
3285 p++;
3286 if ((p - buf) >= buflen || *p == ' ')
3287 goto bad_format;
3288
3289 metadata[LOG_META_HOST].ptr = p;
3290 while (*p != ' ') {
3291 p++;
3292 if ((p - buf) >= buflen)
3293 goto bad_format;
3294 }
3295 metadata[LOG_META_HOST].len = p - metadata[LOG_META_HOST].ptr;
3296 if (metadata[LOG_META_HOST].len == 1 && metadata[LOG_META_HOST].ptr[0] == '-')
3297 metadata[LOG_META_HOST].len = 0;
3298
3299 p++;
3300 if ((p - buf) >= buflen || *p == ' ')
3301 goto bad_format;
3302
3303 metadata[LOG_META_TAG].ptr = p;
3304 while (*p != ' ') {
3305 p++;
3306 if ((p - buf) >= buflen)
3307 goto bad_format;
3308 }
3309 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3310 if (metadata[LOG_META_TAG].len == 1 && metadata[LOG_META_TAG].ptr[0] == '-')
3311 metadata[LOG_META_TAG].len = 0;
3312
3313 p++;
3314 if ((p - buf) >= buflen || *p == ' ')
3315 goto bad_format;
3316
3317 metadata[LOG_META_PID].ptr = p;
3318 while (*p != ' ') {
3319 p++;
3320 if ((p - buf) >= buflen)
3321 goto bad_format;
3322 }
3323 metadata[LOG_META_PID].len = p - metadata[LOG_META_PID].ptr;
3324 if (metadata[LOG_META_PID].len == 1 && metadata[LOG_META_PID].ptr[0] == '-')
3325 metadata[LOG_META_PID].len = 0;
3326
3327 p++;
3328 if ((p - buf) >= buflen || *p == ' ')
3329 goto bad_format;
3330
3331 metadata[LOG_META_MSGID].ptr = p;
3332 while (*p != ' ') {
3333 p++;
3334 if ((p - buf) >= buflen)
3335 goto bad_format;
3336 }
3337 metadata[LOG_META_MSGID].len = p - metadata[LOG_META_MSGID].ptr;
3338 if (metadata[LOG_META_MSGID].len == 1 && metadata[LOG_META_MSGID].ptr[0] == '-')
3339 metadata[LOG_META_MSGID].len = 0;
3340
3341 p++;
3342 if ((p - buf) >= buflen || *p == ' ')
3343 goto bad_format;
3344
3345 /* structured data format is:
3346 * ex:
3347 * '[key1=value1 key2=value2][key3=value3]'
3348 *
3349 * space is invalid outside [] because
3350 * considered as the end of structured data field
3351 */
3352 metadata[LOG_META_STDATA].ptr = p;
3353 if (*p == '[') {
3354 int elem = 0;
3355
3356 while (1) {
3357 if (elem) {
3358 /* according to rfc this char is escaped in param values */
3359 if (*p == ']' && *(p-1) != '\\')
3360 elem = 0;
3361 }
3362 else {
3363 if (*p == '[')
3364 elem = 1;
3365 else if (*p == ' ')
3366 break;
3367 else
3368 goto bad_format;
3369 }
3370 p++;
3371 if ((p - buf) >= buflen)
3372 goto bad_format;
3373 }
3374 }
3375 else if (*p == '-') {
3376 /* case of NILVALUE */
3377 p++;
3378 if ((p - buf) >= buflen || *p != ' ')
3379 goto bad_format;
3380 }
3381 else
3382 goto bad_format;
3383
3384 metadata[LOG_META_STDATA].len = p - metadata[LOG_META_STDATA].ptr;
3385 if (metadata[LOG_META_STDATA].len == 1 && metadata[LOG_META_STDATA].ptr[0] == '-')
3386 metadata[LOG_META_STDATA].len = 0;
3387
3388 p++;
3389
3390 buflen -= p - buf;
3391 buf = p;
3392
3393 *size = buflen;
3394 *message = p;
3395 }
3396 else if (*size > LOG_LEGACYTIME_LEN) {
3397 int m;
3398
3399 /* supported header format according to rfc3164.
3400 * ex:
3401 * 'Jan 1 00:00:00 HOSTNAME TAG[PID]: '
3402 * or 'Jan 1 00:00:00 HOSTNAME TAG: '
3403 * or 'Jan 1 00:00:00 HOSTNAME '
3404 * Note: HOSTNAME is mandatory, and day
3405 * of month uses a single space prefix if
3406 * less than 10 to ensure hour offset is
3407 * always the same.
3408 */
3409
3410 /* Check month to see if it correspond to a rfc3164
3411 * header ex 'Jan 1 00:00:00' */
3412 for (m = 0; m < 12; m++)
3413 if (!memcmp(monthname[m], p, 3))
3414 break;
3415 /* Month not found */
3416 if (m == 12)
3417 goto bad_format;
3418
3419 metadata[LOG_META_TIME] = ist2(p, LOG_LEGACYTIME_LEN);
3420
3421 p += LOG_LEGACYTIME_LEN;
3422 if ((p - buf) >= buflen || *p != ' ')
3423 goto bad_format;
3424
3425 p++;
3426 if ((p - buf) >= buflen || *p == ' ')
3427 goto bad_format;
3428
3429 metadata[LOG_META_HOST].ptr = p;
3430 while (*p != ' ') {
3431 p++;
3432 if ((p - buf) >= buflen)
3433 goto bad_format;
3434 }
3435 metadata[LOG_META_HOST].len = p - metadata[LOG_META_HOST].ptr;
3436
3437 /* TAG seems to no be mandatory */
3438 p++;
3439
3440 buflen -= p - buf;
3441 buf = p;
3442
3443 *size = buflen;
3444 *message = buf;
3445
3446 if (!buflen)
3447 return;
3448
3449 while (((p - buf) < buflen) && *p != ' ' && *p != ':')
3450 p++;
3451
3452 /* a tag must present a trailing ':' */
3453 if (((p - buf) >= buflen) || *p != ':')
3454 return;
3455 p++;
3456 /* followed by a space */
3457 if (((p - buf) >= buflen) || *p != ' ')
3458 return;
3459
3460 /* rewind to parse tag and pid */
3461 p = buf;
3462 metadata[LOG_META_TAG].ptr = p;
3463 /* we have the guarantee that ':' will be reach before size limit */
3464 while (*p != ':') {
3465 if (*p == '[') {
3466 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3467 metadata[LOG_META_PID].ptr = p + 1;
3468 }
Tim Duesterhus7b5777d2021-03-02 18:57:28 +01003469 else if (*p == ']' && isttest(metadata[LOG_META_PID])) {
Emeric Brun54932b42020-07-07 09:43:24 +02003470 if (p[1] != ':')
3471 return;
3472 metadata[LOG_META_PID].len = p - metadata[LOG_META_PID].ptr;
3473 }
3474 p++;
3475 }
3476 if (!metadata[LOG_META_TAG].len)
3477 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3478
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05003479 /* let pass ':' and ' ', we still have warranty size is large enough */
Emeric Brun54932b42020-07-07 09:43:24 +02003480 p += 2;
3481
3482 buflen -= p - buf;
3483 buf = p;
3484
3485 *size = buflen;
3486 *message = buf;
3487 }
3488
3489 return;
3490
3491bad_format:
3492 /* bad syslog format, we reset all parsed syslog fields
3493 * but priority is kept because we are able to re-build
3494 * this message using LOF_FORMAT_PRIO.
3495 */
3496 metadata[LOG_META_TIME].len = 0;
3497 metadata[LOG_META_HOST].len = 0;
3498 metadata[LOG_META_TAG].len = 0;
3499 metadata[LOG_META_PID].len = 0;
3500 metadata[LOG_META_MSGID].len = 0;
3501 metadata[LOG_META_STDATA].len = 0;
3502
3503 return;
3504}
3505
3506/*
3507 * UDP syslog fd handler
3508 */
3509void syslog_fd_handler(int fd)
3510{
3511 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
3512 ssize_t ret = 0;
3513 struct buffer *buf = get_trash_chunk();
3514 size_t size;
3515 char *message;
3516 int level;
3517 int facility;
3518 struct listener *l = objt_listener(fdtab[fd].owner);
3519 int max_accept;
3520
Tim Duesterhus16554242021-09-15 13:58:49 +02003521 BUG_ON(!l);
Emeric Brun54932b42020-07-07 09:43:24 +02003522
Willy Tarreauf5090652021-04-06 17:23:40 +02003523 if (fdtab[fd].state & FD_POLL_IN) {
Emeric Brun54932b42020-07-07 09:43:24 +02003524
3525 if (!fd_recv_ready(fd))
3526 return;
3527
Willy Tarreau882f2482023-01-12 18:52:23 +01003528 max_accept = l->bind_conf->maxaccept ? l->bind_conf->maxaccept : 1;
Emeric Brun54932b42020-07-07 09:43:24 +02003529
3530 do {
3531 /* Source address */
3532 struct sockaddr_storage saddr = {0};
3533 socklen_t saddrlen;
3534
3535 saddrlen = sizeof(saddr);
3536
3537 ret = recvfrom(fd, buf->area, buf->size, 0, (struct sockaddr *)&saddr, &saddrlen);
3538 if (ret < 0) {
3539 if (errno == EINTR)
3540 continue;
Willy Tarreauacef5e22022-04-25 20:32:15 +02003541 if (errno == EAGAIN || errno == EWOULDBLOCK)
Emeric Brun54932b42020-07-07 09:43:24 +02003542 fd_cant_recv(fd);
3543 goto out;
3544 }
3545 buf->data = ret;
3546
Emeric Brun45c457a2020-07-09 23:23:34 +02003547 /* update counters */
Willy Tarreau4781b152021-04-06 13:53:36 +02003548 _HA_ATOMIC_INC(&cum_log_messages);
Frédéric Lécaille9969adb2023-01-18 11:52:21 +01003549 proxy_inc_fe_req_ctr(l, l->bind_conf->frontend, 0);
Emeric Brun45c457a2020-07-09 23:23:34 +02003550
Emeric Brun54932b42020-07-07 09:43:24 +02003551 parse_log_message(buf->area, buf->data, &level, &facility, metadata, &message, &size);
3552
3553 process_send_log(&l->bind_conf->frontend->logsrvs, level, facility, metadata, message, size);
3554
3555 } while (--max_accept);
3556 }
3557
3558out:
3559 return;
3560}
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003561
Emeric Brun12941c82020-07-07 14:19:42 +02003562/*
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003563 * IO Handler to handle message exchange with a syslog tcp client
3564 */
3565static void syslog_io_handler(struct appctx *appctx)
3566{
3567 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
Willy Tarreauc12b3212022-05-27 11:08:15 +02003568 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau270a4572022-05-27 10:36:36 +02003569 struct stream *s = __sc_strm(sc);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003570 struct proxy *frontend = strm_fe(s);
3571 struct listener *l = strm_li(s);
3572 struct buffer *buf = get_trash_chunk();
3573 int max_accept;
3574 int to_skip;
3575 int facility;
3576 int level;
3577 char *message;
3578 size_t size;
3579
Willy Tarreau882f2482023-01-12 18:52:23 +01003580 max_accept = l->bind_conf->maxaccept ? l->bind_conf->maxaccept : 1;
Willy Tarreau270a4572022-05-27 10:36:36 +02003581 while (co_data(sc_oc(sc))) {
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003582 char c;
3583
3584 if (max_accept <= 0)
3585 goto missing_budget;
3586 max_accept--;
3587
Willy Tarreau270a4572022-05-27 10:36:36 +02003588 to_skip = co_getchar(sc_oc(sc), &c);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003589 if (!to_skip)
3590 goto missing_data;
3591 else if (to_skip < 0)
3592 goto cli_abort;
3593
3594 if (c == '<') {
3595 /* rfc-6587, Non-Transparent-Framing: messages separated by
3596 * a trailing LF or CR LF
3597 */
Willy Tarreau270a4572022-05-27 10:36:36 +02003598 to_skip = co_getline(sc_oc(sc), buf->area, buf->size);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003599 if (!to_skip)
3600 goto missing_data;
3601 else if (to_skip < 0)
3602 goto cli_abort;
3603
3604 if (buf->area[to_skip - 1] != '\n')
3605 goto parse_error;
3606
3607 buf->data = to_skip - 1;
3608
3609 /* according to rfc-6587, some devices adds CR before LF */
3610 if (buf->data && buf->area[buf->data - 1] == '\r')
3611 buf->data--;
3612
3613 }
3614 else if ((unsigned char)(c - '1') <= 8) {
3615 /* rfc-6587, Octet-Counting: message length in ASCII
3616 * (first digit can not be ZERO), followed by a space
3617 * and message length
3618 */
3619 char *p = NULL;
3620 int msglen;
3621
Willy Tarreau270a4572022-05-27 10:36:36 +02003622 to_skip = co_getword(sc_oc(sc), buf->area, buf->size, ' ');
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003623 if (!to_skip)
3624 goto missing_data;
3625 else if (to_skip < 0)
3626 goto cli_abort;
3627
3628 if (buf->area[to_skip - 1] != ' ')
3629 goto parse_error;
3630
Aurelien DARRAGON7faffdc2022-10-26 23:40:08 +02003631 msglen = strtol(buf->area, &p, 10);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003632 if (!msglen || p != &buf->area[to_skip - 1])
3633 goto parse_error;
3634
3635 /* message seems too large */
3636 if (msglen > buf->size)
3637 goto parse_error;
3638
Willy Tarreau270a4572022-05-27 10:36:36 +02003639 msglen = co_getblk(sc_oc(sc), buf->area, msglen, to_skip);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003640 if (!msglen)
3641 goto missing_data;
3642 else if (msglen < 0)
3643 goto cli_abort;
3644
3645
3646 buf->data = msglen;
3647 to_skip += msglen;
3648 }
3649 else
3650 goto parse_error;
3651
Willy Tarreau270a4572022-05-27 10:36:36 +02003652 co_skip(sc_oc(sc), to_skip);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003653
3654 /* update counters */
Willy Tarreau4781b152021-04-06 13:53:36 +02003655 _HA_ATOMIC_INC(&cum_log_messages);
Frédéric Lécaille9969adb2023-01-18 11:52:21 +01003656 proxy_inc_fe_req_ctr(l, frontend, 0);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003657
3658 parse_log_message(buf->area, buf->data, &level, &facility, metadata, &message, &size);
3659
3660 process_send_log(&frontend->logsrvs, level, facility, metadata, message, size);
3661
3662 }
3663
3664missing_data:
3665 /* we need more data to read */
Willy Tarreau270a4572022-05-27 10:36:36 +02003666 sc_oc(sc)->flags |= CF_READ_DONTWAIT;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003667
3668 return;
3669
3670missing_budget:
3671 /* it may remain some stuff to do, let's retry later */
3672 appctx_wakeup(appctx);
3673
3674 return;
3675
3676parse_error:
3677 if (l->counters)
Willy Tarreau4781b152021-04-06 13:53:36 +02003678 _HA_ATOMIC_INC(&l->counters->failed_req);
3679 _HA_ATOMIC_INC(&frontend->fe_counters.failed_req);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003680
3681 goto close;
3682
3683cli_abort:
3684 if (l->counters)
Willy Tarreau4781b152021-04-06 13:53:36 +02003685 _HA_ATOMIC_INC(&l->counters->cli_aborts);
3686 _HA_ATOMIC_INC(&frontend->fe_counters.cli_aborts);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003687
3688close:
Willy Tarreau270a4572022-05-27 10:36:36 +02003689 sc_shutw(sc);
3690 sc_shutr(sc);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003691
Christopher Faulet6e1bbc42022-12-12 08:08:15 +01003692 sc_ic(sc)->flags |= CF_READ_EVENT;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003693
3694 return;
3695}
3696
3697static struct applet syslog_applet = {
3698 .obj_type = OBJ_TYPE_APPLET,
3699 .name = "<SYSLOG>", /* used for logging */
3700 .fct = syslog_io_handler,
3701 .release = NULL,
3702};
3703
3704/*
Emeric Brun12941c82020-07-07 14:19:42 +02003705 * Parse "log-forward" section and create corresponding sink buffer.
3706 *
3707 * The function returns 0 in success case, otherwise, it returns error
3708 * flags.
3709 */
3710int cfg_parse_log_forward(const char *file, int linenum, char **args, int kwm)
3711{
3712 int err_code = 0;
3713 struct proxy *px;
3714 char *errmsg = NULL;
3715 const char *err = NULL;
3716
3717 if (strcmp(args[0], "log-forward") == 0) {
3718 if (!*args[1]) {
3719 ha_alert("parsing [%s:%d] : missing name for ip-forward section.\n", file, linenum);
3720 err_code |= ERR_ALERT | ERR_ABORT;
3721 goto out;
3722 }
3723
3724 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3725 goto out;
3726
3727 err = invalid_char(args[1]);
3728 if (err) {
3729 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
3730 file, linenum, *err, args[0], args[1]);
3731 err_code |= ERR_ALERT | ERR_ABORT;
3732 goto out;
3733 }
3734
Emeric Brunb0c331f2020-10-07 17:05:59 +02003735 px = log_forward_by_name(args[1]);
3736 if (px) {
3737 ha_alert("Parsing [%s:%d]: log-forward section '%s' has the same name as another log-forward section declared at %s:%d.\n",
3738 file, linenum, args[1], px->conf.file, px->conf.line);
3739 err_code |= ERR_ALERT | ERR_FATAL;
3740 }
3741
3742 px = proxy_find_by_name(args[1], 0, 0);
3743 if (px) {
3744 ha_alert("Parsing [%s:%d]: log forward section '%s' has the same name as %s '%s' declared at %s:%d.\n",
3745 file, linenum, args[1], proxy_type_str(px),
3746 px->id, px->conf.file, px->conf.line);
3747 err_code |= ERR_ALERT | ERR_FATAL;
Emeric Brun12941c82020-07-07 14:19:42 +02003748 }
3749
3750 px = calloc(1, sizeof *px);
3751 if (!px) {
3752 err_code |= ERR_ALERT | ERR_FATAL;
3753 goto out;
3754 }
3755
Emeric Brun2ad2b1c2021-12-01 12:08:42 +01003756 init_new_proxy(px);
Emeric Brun12941c82020-07-07 14:19:42 +02003757 px->next = cfg_log_forward;
3758 cfg_log_forward = px;
Emeric Brun12941c82020-07-07 14:19:42 +02003759 px->conf.file = strdup(file);
3760 px->conf.line = linenum;
3761 px->mode = PR_MODE_SYSLOG;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003762 px->last_change = now.tv_sec;
3763 px->cap = PR_CAP_FE;
3764 px->maxconn = 10;
3765 px->timeout.client = TICK_ETERNITY;
3766 px->accept = frontend_accept;
3767 px->default_target = &syslog_applet.obj_type;
Emeric Brun12941c82020-07-07 14:19:42 +02003768 px->id = strdup(args[1]);
3769
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003770 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003771 else if (strcmp(args[0], "maxconn") == 0) { /* maxconn */
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003772 if (warnifnotcap(cfg_log_forward, PR_CAP_FE, file, linenum, args[0], " Maybe you want 'fullconn' instead ?"))
3773 err_code |= ERR_WARN;
3774
3775 if (*(args[1]) == 0) {
3776 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", file, linenum, args[0]);
3777 err_code |= ERR_ALERT | ERR_FATAL;
3778 goto out;
3779 }
3780 cfg_log_forward->maxconn = atol(args[1]);
3781 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3782 goto out;
3783 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003784 else if (strcmp(args[0], "backlog") == 0) { /* backlog */
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003785 if (warnifnotcap(cfg_log_forward, PR_CAP_FE, file, linenum, args[0], NULL))
3786 err_code |= ERR_WARN;
3787
3788 if (*(args[1]) == 0) {
3789 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", file, linenum, args[0]);
3790 err_code |= ERR_ALERT | ERR_FATAL;
3791 goto out;
3792 }
3793 cfg_log_forward->backlog = atol(args[1]);
3794 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3795 goto out;
3796 }
3797 else if (strcmp(args[0], "bind") == 0) {
3798 int cur_arg;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003799 struct bind_conf *bind_conf;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003800 struct listener *l;
Emeric Bruna8942cd2022-08-19 15:16:26 +02003801 int ret;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003802
3803 cur_arg = 1;
3804
3805 bind_conf = bind_conf_alloc(cfg_log_forward, file, linenum,
3806 NULL, xprt_get(XPRT_RAW));
3807 if (!bind_conf) {
3808 ha_alert("parsing [%s:%d] : out of memory error.", file, linenum);
3809 err_code |= ERR_ALERT | ERR_FATAL;
3810 goto out;
3811 }
3812
Willy Tarreau882f2482023-01-12 18:52:23 +01003813 bind_conf->maxaccept = global.tune.maxaccept ? global.tune.maxaccept : MAX_ACCEPT;
3814
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003815 if (!str2listener(args[1], cfg_log_forward, bind_conf, file, linenum, &errmsg)) {
3816 if (errmsg && *errmsg) {
3817 indent_msg(&errmsg, 2);
3818 ha_alert("parsing [%s:%d] : '%s %s' : %s\n", file, linenum, args[0], args[1], errmsg);
3819 }
3820 else {
3821 ha_alert("parsing [%s:%d] : '%s %s' : error encountered while parsing listening address %s.\n",
3822 file, linenum, args[0], args[1], args[2]);
3823 err_code |= ERR_ALERT | ERR_FATAL;
3824 goto out;
3825 }
3826 }
3827 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003828 l->accept = session_accept_fd;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003829 l->default_target = cfg_log_forward->default_target;
3830 global.maxsock++;
3831 }
3832 cur_arg++;
3833
Emeric Bruna8942cd2022-08-19 15:16:26 +02003834 ret = bind_parse_args_list(bind_conf, args, cur_arg, cursection, file, linenum);
3835 err_code |= ret;
3836 if (ret != 0) {
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003837 err_code |= ERR_ALERT | ERR_FATAL;
3838 goto out;
3839 }
Emeric Brun12941c82020-07-07 14:19:42 +02003840 }
Willy Tarreau76aaa7f2020-09-16 15:07:22 +02003841 else if (strcmp(args[0], "dgram-bind") == 0) {
Emeric Brun12941c82020-07-07 14:19:42 +02003842 int cur_arg;
Emeric Brun12941c82020-07-07 14:19:42 +02003843 struct bind_conf *bind_conf;
3844 struct bind_kw *kw;
3845 struct listener *l;
3846
3847 cur_arg = 1;
3848
3849 bind_conf = bind_conf_alloc(cfg_log_forward, file, linenum,
3850 NULL, xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +02003851 if (!bind_conf) {
3852 ha_alert("parsing [%s:%d] : out of memory error.", file, linenum);
3853 err_code |= ERR_ALERT | ERR_FATAL;
3854 goto out;
3855 }
Emeric Brun12941c82020-07-07 14:19:42 +02003856
Willy Tarreau882f2482023-01-12 18:52:23 +01003857 bind_conf->maxaccept = global.tune.maxaccept ? global.tune.maxaccept : MAX_ACCEPT;
3858
Willy Tarreau26ff5da2020-09-16 15:22:19 +02003859 if (!str2receiver(args[1], cfg_log_forward, bind_conf, file, linenum, &errmsg)) {
Emeric Brun12941c82020-07-07 14:19:42 +02003860 if (errmsg && *errmsg) {
3861 indent_msg(&errmsg, 2);
3862 ha_alert("parsing [%s:%d] : '%s %s' : %s\n", file, linenum, args[0], args[1], errmsg);
3863 }
3864 else {
3865 ha_alert("parsing [%s:%d] : '%s %s' : error encountered while parsing listening address %s.\n",
3866 file, linenum, args[0], args[1], args[2]);
Emeric Brun12941c82020-07-07 14:19:42 +02003867 }
Willy Tarreau3b139e52020-09-16 16:24:14 +02003868 err_code |= ERR_ALERT | ERR_FATAL;
3869 goto out;
Emeric Brun12941c82020-07-07 14:19:42 +02003870 }
3871 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau26ff5da2020-09-16 15:22:19 +02003872 /* the fact that the sockets are of type dgram is guaranteed by str2receiver() */
Willy Tarreaue140a692020-10-15 21:25:32 +02003873 l->rx.iocb = syslog_fd_handler;
Emeric Brun12941c82020-07-07 14:19:42 +02003874 global.maxsock++;
3875 }
3876 cur_arg++;
3877
3878 while (*args[cur_arg] && (kw = bind_find_kw(args[cur_arg]))) {
3879 int ret;
3880
3881 ret = kw->parse(args, cur_arg, cfg_log_forward, bind_conf, &errmsg);
3882 err_code |= ret;
3883 if (ret) {
3884 if (errmsg && *errmsg) {
3885 indent_msg(&errmsg, 2);
3886 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
3887 }
3888 else
3889 ha_alert("parsing [%s:%d]: error encountered while processing '%s'\n",
3890 file, linenum, args[cur_arg]);
3891 if (ret & ERR_FATAL)
3892 goto out;
3893 }
3894 cur_arg += 1 + kw->skip;
3895 }
3896 if (*args[cur_arg] != 0) {
Willy Tarreau433b05f2021-03-12 10:14:07 +01003897 const char *best = bind_find_best_kw(args[cur_arg]);
3898 if (best)
3899 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section; did you mean '%s' maybe ?\n",
3900 file, linenum, args[cur_arg], cursection, best);
3901 else
3902 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section.\n",
3903 file, linenum, args[cur_arg], cursection);
Emeric Brun12941c82020-07-07 14:19:42 +02003904 err_code |= ERR_ALERT | ERR_FATAL;
3905 goto out;
3906 }
3907 }
3908 else if (strcmp(args[0], "log") == 0) {
Emeric Brun9533a702021-04-02 10:13:43 +02003909 if (!parse_logsrv(args, &cfg_log_forward->logsrvs, (kwm == KWM_NO), file, linenum, &errmsg)) {
Emeric Brun12941c82020-07-07 14:19:42 +02003910 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
3911 err_code |= ERR_ALERT | ERR_FATAL;
3912 goto out;
3913 }
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003914 }
3915 else if (strcmp(args[0], "timeout") == 0) {
3916 const char *res;
3917 unsigned timeout;
3918
3919 if (strcmp(args[1], "client") != 0) {
3920 ha_alert("parsing [%s:%d] : unknown keyword '%s %s' in log-forward section.\n", file, linenum, args[0], args[1]);
3921 err_code |= ERR_ALERT | ERR_FATAL;
3922 goto out;
3923 }
3924
3925 if (*args[2] == 0) {
3926 ha_alert("parsing [%s:%d] : missing timeout client value.\n", file, linenum);
3927 err_code |= ERR_ALERT | ERR_FATAL;
3928 goto out;
3929 }
3930 res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
3931 if (res == PARSE_TIME_OVER) {
3932 memprintf(&errmsg, "timer overflow in argument '%s' to 'timeout client' (maximum value is 2147483647 ms or ~24.8 days)", args[2]);
3933 }
3934 else if (res == PARSE_TIME_UNDER) {
3935 memprintf(&errmsg, "timer underflow in argument '%s' to 'timeout client' (minimum non-null value is 1 ms)", args[2]);
3936 }
3937 else if (res) {
3938 memprintf(&errmsg, "unexpected character '%c' in 'timeout client'", *res);
3939 return -1;
3940 }
3941
3942 if (res) {
3943 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
3944 err_code |= ERR_ALERT | ERR_FATAL;
3945 goto out;
3946 }
3947 cfg_log_forward->timeout.client = MS_TO_TICKS(timeout);
Emeric Brun12941c82020-07-07 14:19:42 +02003948 }
Willy Tarreauf9feec22020-09-16 15:04:33 +02003949 else {
3950 ha_alert("parsing [%s:%d] : unknown keyword '%s' in log-forward section.\n", file, linenum, args[0]);
3951 err_code |= ERR_ALERT | ERR_ABORT;
3952 goto out;
3953 }
Emeric Brun12941c82020-07-07 14:19:42 +02003954out:
3955 return err_code;
3956}
3957
Willy Tarreau0108d902018-11-25 19:14:37 +01003958
Emeric Brun12941c82020-07-07 14:19:42 +02003959/* config parsers for this section */
3960REGISTER_CONFIG_SECTION("log-forward", cfg_parse_log_forward, NULL);
3961
Willy Tarreau082b6282019-05-22 14:42:12 +02003962REGISTER_PER_THREAD_ALLOC(init_log_buffers);
3963REGISTER_PER_THREAD_FREE(deinit_log_buffers);
Willy Tarreau172f5ce2018-11-26 11:21:50 +01003964
Willy Tarreaubaaee002006-06-26 02:48:02 +02003965/*
3966 * Local variables:
3967 * c-indent-level: 8
3968 * c-basic-offset: 8
3969 * End:
3970 */