blob: c112a49bc0640287027c1843c7cdd1e08902db27 [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 Tarreauc8f24f82007-11-30 18:38:35 +010014#include <fcntl.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020015#include <stdarg.h>
16#include <stdio.h>
17#include <stdlib.h>
18#include <string.h>
19#include <syslog.h>
20#include <time.h>
21#include <unistd.h>
Robert Tsai81ae1952007-12-05 10:47:29 +010022#include <errno.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020023
24#include <sys/time.h>
Willy Tarreau077edcb2016-08-10 18:30:56 +020025#include <sys/uio.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020026
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020027#include <haproxy/api.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020028#include <haproxy/applet-t.h>
Emeric Brun12941c82020-07-07 14:19:42 +020029#include <haproxy/cfgparse.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020030#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/fd.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020032#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/global.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020034#include <haproxy/http.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/ring.h>
39#include <haproxy/sample.h>
40#include <haproxy/sink.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020041#include <haproxy/ssl_sock.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020042#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020043#include <haproxy/stream_interface.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 Tarreaud6788052020-05-27 15:59:00 +020046#include <haproxy/version.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020047
Emeric Brun45c457a2020-07-09 23:23:34 +020048/* global recv logs counter */
49int cum_log_messages;
Willy Tarreaubaaee002006-06-26 02:48:02 +020050
Emeric Brun12941c82020-07-07 14:19:42 +020051/* log forward proxy list */
52struct proxy *cfg_log_forward;
53
Emeric Brun54648852020-07-06 15:54:06 +020054struct log_fmt_st {
Dragan Dosen43885c72015-10-01 13:18:13 +020055 char *name;
Dragan Dosen43885c72015-10-01 13:18:13 +020056};
57
Emeric Brun54648852020-07-06 15:54:06 +020058static const struct log_fmt_st log_formats[LOG_FORMATS] = {
Emeric Brun0237c4e2020-11-27 16:24:34 +010059 [LOG_FORMAT_LOCAL] = {
60 .name = "local",
61 },
Dragan Dosen43885c72015-10-01 13:18:13 +020062 [LOG_FORMAT_RFC3164] = {
63 .name = "rfc3164",
Dragan Dosen43885c72015-10-01 13:18:13 +020064 },
65 [LOG_FORMAT_RFC5424] = {
66 .name = "rfc5424",
Emeric Brun54648852020-07-06 15:54:06 +020067 },
68 [LOG_FORMAT_PRIO] = {
69 .name = "priority",
Willy Tarreaue8746a02018-11-12 08:45:00 +010070 },
71 [LOG_FORMAT_SHORT] = {
72 .name = "short",
Emeric Brun54648852020-07-06 15:54:06 +020073 },
74 [LOG_FORMAT_TIMED] = {
75 .name = "timed",
76 },
77 [LOG_FORMAT_ISO] = {
78 .name = "iso",
Willy Tarreaue8746a02018-11-12 08:45:00 +010079 },
Willy Tarreauc1b06452018-11-12 11:57:56 +010080 [LOG_FORMAT_RAW] = {
81 .name = "raw",
Willy Tarreauc1b06452018-11-12 11:57:56 +010082 },
Dragan Dosen1322d092015-09-22 16:05:32 +020083};
84
Dragan Dosen835b9212016-02-12 13:23:03 +010085/*
86 * This map is used with all the FD_* macros to check whether a particular bit
Willy Tarreau1bfd6022019-06-07 11:10:07 +020087 * is set or not. Each bit represents an ACSII code. ha_bit_set() sets those
88 * bytes which should be escaped. When ha_bit_test() returns non-zero, it means
89 * that the byte should be escaped. Be careful to always pass bytes from 0 to
90 * 255 exclusively to the macros.
Dragan Dosen835b9212016-02-12 13:23:03 +010091 */
Willy Tarreau1bfd6022019-06-07 11:10:07 +020092long rfc5424_escape_map[(256/8) / sizeof(long)];
93long hdr_encode_map[(256/8) / sizeof(long)];
94long url_encode_map[(256/8) / sizeof(long)];
95long http_encode_map[(256/8) / sizeof(long)];
Dragan Dosen835b9212016-02-12 13:23:03 +010096
Dragan Dosen835b9212016-02-12 13:23:03 +010097
Willy Tarreaubaaee002006-06-26 02:48:02 +020098const char *log_facilities[NB_LOG_FACILITIES] = {
99 "kern", "user", "mail", "daemon",
100 "auth", "syslog", "lpr", "news",
101 "uucp", "cron", "auth2", "ftp",
102 "ntp", "audit", "alert", "cron2",
103 "local0", "local1", "local2", "local3",
104 "local4", "local5", "local6", "local7"
105};
106
Willy Tarreaubaaee002006-06-26 02:48:02 +0200107const char *log_levels[NB_LOG_LEVELS] = {
108 "emerg", "alert", "crit", "err",
109 "warning", "notice", "info", "debug"
110};
111
Willy Tarreau570f2212013-06-10 16:42:09 +0200112const 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 +0200113const char sess_fin_state[8] = "-RCHDLQT"; /* cliRequest, srvConnect, srvHeader, Data, Last, Queue, Tarpit */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200114
William Lallemand723b73a2012-02-08 16:37:49 +0100115
116/* log_format */
117struct logformat_type {
118 char *name;
119 int type;
William Lallemandbddd4fd2012-02-27 11:23:10 +0100120 int mode;
William Lallemand5e19a282012-04-02 16:22:10 +0200121 int lw; /* logwait bitsfield */
William Lallemandb7ff6a32012-03-02 14:35:21 +0100122 int (*config_callback)(struct logformat_node *node, struct proxy *curproxy);
Willy Tarreau2beef582012-12-20 17:22:52 +0100123 const char *replace_by; /* new option to use instead of old one */
William Lallemand723b73a2012-02-08 16:37:49 +0100124};
125
William Lallemandb7ff6a32012-03-02 14:35:21 +0100126int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy);
127
William Lallemand723b73a2012-02-08 16:37:49 +0100128/* log_format variable names */
129static const struct logformat_type logformat_keywords[] = {
William Lallemand5e19a282012-04-02 16:22:10 +0200130 { "o", LOG_FMT_GLOBAL, PR_MODE_TCP, 0, NULL }, /* global option */
Willy Tarreau2beef582012-12-20 17:22:52 +0100131
132 /* please keep these lines sorted ! */
133 { "B", LOG_FMT_BYTES, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from server to client */
134 { "CC", LOG_FMT_CCLIENT, PR_MODE_HTTP, LW_REQHDR, NULL }, /* client cookie */
135 { "CS", LOG_FMT_CSERVER, PR_MODE_HTTP, LW_RSPHDR, NULL }, /* server cookie */
136 { "H", LOG_FMT_HOSTNAME, PR_MODE_TCP, LW_INIT, NULL }, /* Hostname */
Tim Duesterhuscf6e0c82020-03-13 12:34:24 +0100137 { "ID", LOG_FMT_UNIQUEID, PR_MODE_TCP, LW_BYTES, NULL }, /* Unique ID */
Willy Tarreau4bf99632014-06-13 12:21:40 +0200138 { "ST", LOG_FMT_STATUS, PR_MODE_TCP, LW_RESP, NULL }, /* status code */
William Lallemand5e19a282012-04-02 16:22:10 +0200139 { "T", LOG_FMT_DATEGMT, PR_MODE_TCP, LW_INIT, NULL }, /* date GMT */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200140 { "Ta", LOG_FMT_Ta, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time active (tr to end) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100141 { "Tc", LOG_FMT_TC, PR_MODE_TCP, LW_BYTES, NULL }, /* Tc */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200142 { "Th", LOG_FMT_Th, PR_MODE_TCP, LW_BYTES, NULL }, /* Time handshake */
143 { "Ti", LOG_FMT_Ti, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time idle */
144 { "Tl", LOG_FMT_DATELOCAL, PR_MODE_TCP, LW_INIT, NULL }, /* date local timezone */
145 { "Tq", LOG_FMT_TQ, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tq=Th+Ti+TR */
146 { "Tr", LOG_FMT_Tr, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tr */
147 { "TR", LOG_FMT_TR, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time to receive a valid request */
Willy Tarreau27b639d2016-05-17 17:55:27 +0200148 { "Td", LOG_FMT_TD, PR_MODE_TCP, LW_BYTES, NULL }, /* Td = Tt - (Tq + Tw + Tc + Tr) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100149 { "Ts", LOG_FMT_TS, PR_MODE_TCP, LW_INIT, NULL }, /* timestamp GMT */
William Lallemand5e19a282012-04-02 16:22:10 +0200150 { "Tt", LOG_FMT_TT, PR_MODE_TCP, LW_BYTES, NULL }, /* Tt */
Damien Claisse57c8eb92020-04-28 12:09:19 +0000151 { "Tu", LOG_FMT_TU, PR_MODE_TCP, LW_BYTES, NULL }, /* Tu = Tt -Ti */
Willy Tarreau2beef582012-12-20 17:22:52 +0100152 { "Tw", LOG_FMT_TW, PR_MODE_TCP, LW_BYTES, NULL }, /* Tw */
153 { "U", LOG_FMT_BYTES_UP, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from client to server */
William Lallemand5e19a282012-04-02 16:22:10 +0200154 { "ac", LOG_FMT_ACTCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* actconn */
Willy Tarreau2beef582012-12-20 17:22:52 +0100155 { "b", LOG_FMT_BACKEND, PR_MODE_TCP, LW_INIT, NULL }, /* backend */
William Lallemand5e19a282012-04-02 16:22:10 +0200156 { "bc", LOG_FMT_BECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* beconn */
Willy Tarreau2beef582012-12-20 17:22:52 +0100157 { "bi", LOG_FMT_BACKENDIP, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source ip */
158 { "bp", LOG_FMT_BACKENDPORT, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source port */
William Lallemand5e19a282012-04-02 16:22:10 +0200159 { "bq", LOG_FMT_BCKQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* backend_queue */
Willy Tarreaud02286d2017-06-23 11:23:43 +0200160 { "ci", LOG_FMT_CLIENTIP, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client ip */
161 { "cp", LOG_FMT_CLIENTPORT, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client port */
Willy Tarreau2beef582012-12-20 17:22:52 +0100162 { "f", LOG_FMT_FRONTEND, PR_MODE_TCP, LW_INIT, NULL }, /* frontend */
163 { "fc", LOG_FMT_FECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* feconn */
Willy Tarreaud02286d2017-06-23 11:23:43 +0200164 { "fi", LOG_FMT_FRONTENDIP, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend ip */
165 { "fp", LOG_FMT_FRONTENDPORT, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend port */
Willy Tarreau2beef582012-12-20 17:22:52 +0100166 { "ft", LOG_FMT_FRONTEND_XPRT, PR_MODE_TCP, LW_INIT, NULL }, /* frontend with transport mode */
Willy Tarreaud9ed3d22014-06-13 12:23:06 +0200167 { "hr", LOG_FMT_HDRREQUEST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request */
168 { "hrl", LOG_FMT_HDRREQUESTLIST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request list */
169 { "hs", LOG_FMT_HDRRESPONS, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response */
170 { "hsl", LOG_FMT_HDRRESPONSLIST, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response list */
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +0000171 { "HM", LOG_FMT_HTTP_METHOD, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP method */
Maciej Zdebfcdfd852020-11-30 18:27:47 +0000172 { "HP", LOG_FMT_HTTP_PATH, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP relative or absolute path */
173 { "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 +0000174 { "HQ", LOG_FMT_HTTP_QUERY, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP query */
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +0000175 { "HU", LOG_FMT_HTTP_URI, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP full URI */
176 { "HV", LOG_FMT_HTTP_VERSION, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP version */
Willy Tarreau7346acb2014-08-28 15:03:15 +0200177 { "lc", LOG_FMT_LOGCNT, PR_MODE_TCP, LW_INIT, NULL }, /* log counter */
Willy Tarreau2beef582012-12-20 17:22:52 +0100178 { "ms", LOG_FMT_MS, PR_MODE_TCP, LW_INIT, NULL }, /* accept date millisecond */
William Lallemand5e19a282012-04-02 16:22:10 +0200179 { "pid", LOG_FMT_PID, PR_MODE_TCP, LW_INIT, NULL }, /* log pid */
Willy Tarreau2beef582012-12-20 17:22:52 +0100180 { "r", LOG_FMT_REQ, PR_MODE_HTTP, LW_REQ, NULL }, /* request */
181 { "rc", LOG_FMT_RETRIES, PR_MODE_TCP, LW_BYTES, NULL }, /* retries */
Willy Tarreau1f0da242014-01-25 11:01:50 +0100182 { "rt", LOG_FMT_COUNTER, PR_MODE_TCP, LW_REQ, NULL }, /* request counter (HTTP or TCP session) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100183 { "s", LOG_FMT_SERVER, PR_MODE_TCP, LW_SVID, NULL }, /* server */
184 { "sc", LOG_FMT_SRVCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_conn */
185 { "si", LOG_FMT_SERVERIP, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination ip */
186 { "sp", LOG_FMT_SERVERPORT, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination port */
187 { "sq", LOG_FMT_SRVQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_queue */
Willy Tarreauffc3fcd2012-10-12 20:17:54 +0200188 { "sslc", LOG_FMT_SSL_CIPHER, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL ciphers */
189 { "sslv", LOG_FMT_SSL_VERSION, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL protocol version */
Willy Tarreau2beef582012-12-20 17:22:52 +0100190 { "t", LOG_FMT_DATE, PR_MODE_TCP, LW_INIT, NULL }, /* date */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200191 { "tr", LOG_FMT_tr, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request */
192 { "trg",LOG_FMT_trg, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, GMT */
193 { "trl",LOG_FMT_trl, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, local */
Willy Tarreau2beef582012-12-20 17:22:52 +0100194 { "ts", LOG_FMT_TERMSTATE, PR_MODE_TCP, LW_BYTES, NULL },/* termination state */
195 { "tsc", LOG_FMT_TERMSTATE_CK, PR_MODE_TCP, LW_INIT, NULL },/* termination state */
196
197 /* The following tags are deprecated and will be removed soon */
198 { "Bi", LOG_FMT_BACKENDIP, PR_MODE_TCP, LW_BCKIP, prepare_addrsource, "bi" }, /* backend source ip */
199 { "Bp", LOG_FMT_BACKENDPORT, PR_MODE_TCP, LW_BCKIP, prepare_addrsource, "bp" }, /* backend source port */
Willy Tarreaud02286d2017-06-23 11:23:43 +0200200 { "Ci", LOG_FMT_CLIENTIP, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL, "ci" }, /* client ip */
201 { "Cp", LOG_FMT_CLIENTPORT, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL, "cp" }, /* client port */
202 { "Fi", LOG_FMT_FRONTENDIP, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL, "fi" }, /* frontend ip */
203 { "Fp", LOG_FMT_FRONTENDPORT, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL, "fp" }, /* frontend port */
Willy Tarreau2beef582012-12-20 17:22:52 +0100204 { "Si", LOG_FMT_SERVERIP, PR_MODE_TCP, LW_SVIP, NULL, "si" }, /* server destination ip */
205 { "Sp", LOG_FMT_SERVERPORT, PR_MODE_TCP, LW_SVIP, NULL, "sp" }, /* server destination port */
206 { "cc", LOG_FMT_CCLIENT, PR_MODE_HTTP, LW_REQHDR, NULL, "CC" }, /* client cookie */
207 { "cs", LOG_FMT_CSERVER, PR_MODE_HTTP, LW_RSPHDR, NULL, "CS" }, /* server cookie */
208 { "st", LOG_FMT_STATUS, PR_MODE_HTTP, LW_RESP, NULL, "ST" }, /* status code */
William Lallemand5e19a282012-04-02 16:22:10 +0200209 { 0, 0, 0, 0, NULL }
William Lallemand723b73a2012-02-08 16:37:49 +0100210};
211
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200212char 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
213char 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 +0100214char 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 +0100215char *log_format = NULL;
216
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200217/* Default string used for structured-data part in RFC5424 formatted
218 * syslog messages.
219 */
220char default_rfc5424_sd_log_format[] = "- ";
Dragan Dosen1322d092015-09-22 16:05:32 +0200221
Willy Tarreau13ef7732018-11-12 07:25:28 +0100222/* total number of dropped logs */
223unsigned int dropped_logs = 0;
224
Dragan Dosen59cee972015-09-19 22:09:02 +0200225/* This is a global syslog message buffer, common to all outgoing
226 * messages. It contains only the data part.
Willy Tarreaub1a2faf2012-03-19 16:51:53 +0100227 */
Christopher Fauletf8188c62017-06-02 16:20:16 +0200228THREAD_LOCAL char *logline = NULL;
Willy Tarreaub1a2faf2012-03-19 16:51:53 +0100229
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200230/* A global syslog message buffer, common to all RFC5424 syslog messages.
231 * Currently, it is used for generating the structured-data part.
232 */
Christopher Fauletf8188c62017-06-02 16:20:16 +0200233THREAD_LOCAL char *logline_rfc5424 = NULL;
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200234
Christopher Fauletd4696382017-10-24 11:44:05 +0200235/* A global buffer used to store all startup alerts/warnings. It will then be
236 * retrieve on the CLI. */
Willy Tarreau869efd52019-11-15 15:16:57 +0100237static struct ring *startup_logs = NULL;
Christopher Fauletd4696382017-10-24 11:44:05 +0200238
William Lallemand723b73a2012-02-08 16:37:49 +0100239struct logformat_var_args {
240 char *name;
241 int mask;
242};
243
244struct logformat_var_args var_args_list[] = {
245// global
246 { "M", LOG_OPT_MANDATORY },
247 { "Q", LOG_OPT_QUOTE },
William Lallemand5f232402012-04-05 18:02:55 +0200248 { "X", LOG_OPT_HEXA },
Dragan Dosen835b9212016-02-12 13:23:03 +0100249 { "E", LOG_OPT_ESC },
William Lallemand723b73a2012-02-08 16:37:49 +0100250 { 0, 0 }
251};
252
Willy Tarreaub1f3af22013-04-12 18:30:32 +0200253/* return the name of the directive used in the current proxy for which we're
254 * currently parsing a header, when it is known.
255 */
256static inline const char *fmt_directive(const struct proxy *curproxy)
257{
Willy Tarreaubf0addb2013-12-02 12:24:54 +0100258 switch (curproxy->conf.args.ctx) {
Willy Tarreau53e1a6d2015-07-09 11:20:00 +0200259 case ARGC_ACL:
260 return "acl";
261 case ARGC_STK:
262 return "stick";
263 case ARGC_TRK:
264 return "track-sc";
265 case ARGC_LOG:
266 return "log-format";
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200267 case ARGC_LOGSD:
268 return "log-format-sd";
Willy Tarreaubf0addb2013-12-02 12:24:54 +0100269 case ARGC_HRQ:
Thierry FOURNIER1c0054f2013-11-20 15:09:52 +0100270 return "http-request";
Willy Tarreaubf0addb2013-12-02 12:24:54 +0100271 case ARGC_HRS:
Thierry FOURNIER1c0054f2013-11-20 15:09:52 +0100272 return "http-response";
Willy Tarreau53e1a6d2015-07-09 11:20:00 +0200273 case ARGC_UIF:
274 return "unique-id-format";
Thierry FOURNIERd18cd0f2013-11-29 12:15:45 +0100275 case ARGC_RDR:
Willy Tarreau53e1a6d2015-07-09 11:20:00 +0200276 return "redirect";
277 case ARGC_CAP:
278 return "capture";
Willy Tarreau28d976d2015-07-09 11:39:33 +0200279 case ARGC_SRV:
280 return "server";
Christopher Fauletf7e4e7e2016-10-27 22:29:49 +0200281 case ARGC_SPOE:
282 return "spoe-message";
Thierry FOURNIER / OZON.IO4ed1c952016-11-24 23:57:54 +0100283 case ARGC_UBK:
284 return "use_backend";
Christopher Faulet3b967c12020-05-15 15:47:44 +0200285 case ARGC_HERR:
286 return "http-error";
Miroslav Zagorac7f8314c2020-12-09 16:31:48 +0100287 case ARGC_OT:
288 return "ot-scope";
Willy Tarreaubf0addb2013-12-02 12:24:54 +0100289 default:
Willy Tarreau53e1a6d2015-07-09 11:20:00 +0200290 return "undefined(please report this bug)"; /* must never happen */
Willy Tarreaubf0addb2013-12-02 12:24:54 +0100291 }
Willy Tarreaub1f3af22013-04-12 18:30:32 +0200292}
293
William Lallemand723b73a2012-02-08 16:37:49 +0100294/*
William Lallemandb7ff6a32012-03-02 14:35:21 +0100295 * callback used to configure addr source retrieval
296 */
297int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy)
298{
299 curproxy->options2 |= PR_O2_SRC_ADDR;
300
301 return 0;
302}
303
304
305/*
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100306 * Parse args in a logformat_var. Returns 0 in error
307 * case, otherwise, it returns 1.
William Lallemand723b73a2012-02-08 16:37:49 +0100308 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100309int parse_logformat_var_args(char *args, struct logformat_node *node, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100310{
311 int i = 0;
312 int end = 0;
313 int flags = 0; // 1 = + 2 = -
314 char *sp = NULL; // start pointer
315
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100316 if (args == NULL) {
317 memprintf(err, "internal error: parse_logformat_var_args() expects non null 'args'");
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100318 return 0;
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100319 }
William Lallemand723b73a2012-02-08 16:37:49 +0100320
321 while (1) {
322 if (*args == '\0')
323 end = 1;
324
325 if (*args == '+') {
326 // add flag
327 sp = args + 1;
328 flags = 1;
329 }
330 if (*args == '-') {
331 // delete flag
332 sp = args + 1;
333 flags = 2;
334 }
335
336 if (*args == '\0' || *args == ',') {
337 *args = '\0';
Willy Tarreau254d44c2012-12-20 18:19:26 +0100338 for (i = 0; sp && var_args_list[i].name; i++) {
William Lallemand723b73a2012-02-08 16:37:49 +0100339 if (strcmp(sp, var_args_list[i].name) == 0) {
340 if (flags == 1) {
341 node->options |= var_args_list[i].mask;
342 break;
343 } else if (flags == 2) {
344 node->options &= ~var_args_list[i].mask;
345 break;
346 }
347 }
348 }
349 sp = NULL;
350 if (end)
351 break;
352 }
Willy Tarreau254d44c2012-12-20 18:19:26 +0100353 args++;
William Lallemand723b73a2012-02-08 16:37:49 +0100354 }
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100355 return 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100356}
357
358/*
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100359 * Parse a variable '%varname' or '%{args}varname' in log-format. The caller
360 * must pass the args part in the <arg> pointer with its length in <arg_len>,
361 * and varname with its length in <var> and <var_len> respectively. <arg> is
362 * ignored when arg_len is 0. Neither <var> nor <var_len> may be null.
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100363 * Returns false in error case and err is filled, otherwise returns true.
William Lallemand723b73a2012-02-08 16:37:49 +0100364 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100365int 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 +0100366{
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100367 int j;
Dragan Dosen61302da2019-04-30 00:40:02 +0200368 struct logformat_node *node = NULL;
William Lallemand723b73a2012-02-08 16:37:49 +0100369
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100370 for (j = 0; logformat_keywords[j].name; j++) { // search a log type
371 if (strlen(logformat_keywords[j].name) == var_len &&
372 strncmp(var, logformat_keywords[j].name, var_len) == 0) {
373 if (logformat_keywords[j].mode != PR_MODE_HTTP || curproxy->mode == PR_MODE_HTTP) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200374 node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100375 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100376 memprintf(err, "out of memory error");
Dragan Dosen61302da2019-04-30 00:40:02 +0200377 goto error_free;
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100378 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100379 node->type = logformat_keywords[j].type;
380 node->options = *defoptions;
381 if (arg_len) {
382 node->arg = my_strndup(arg, arg_len);
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100383 if (!parse_logformat_var_args(node->arg, node, err))
Dragan Dosen61302da2019-04-30 00:40:02 +0200384 goto error_free;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100385 }
386 if (node->type == LOG_FMT_GLOBAL) {
387 *defoptions = node->options;
388 free(node->arg);
389 free(node);
390 } else {
391 if (logformat_keywords[j].config_callback &&
392 logformat_keywords[j].config_callback(node, curproxy) != 0) {
Dragan Dosen61302da2019-04-30 00:40:02 +0200393 goto error_free;
William Lallemand723b73a2012-02-08 16:37:49 +0100394 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100395 curproxy->to_log |= logformat_keywords[j].lw;
Willy Tarreau2b718102021-04-21 07:32:39 +0200396 LIST_APPEND(list_format, &node->list);
William Lallemand723b73a2012-02-08 16:37:49 +0100397 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100398 if (logformat_keywords[j].replace_by)
Christopher Faulet767a84b2017-11-24 16:50:31 +0100399 ha_warning("parsing [%s:%d] : deprecated variable '%s' in '%s', please replace it with '%s'.\n",
400 curproxy->conf.args.file, curproxy->conf.args.line,
401 logformat_keywords[j].name, fmt_directive(curproxy), logformat_keywords[j].replace_by);
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100402 return 1;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100403 } else {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100404 memprintf(err, "format variable '%s' is reserved for HTTP mode",
405 logformat_keywords[j].name);
Dragan Dosen61302da2019-04-30 00:40:02 +0200406 goto error_free;
William Lallemand723b73a2012-02-08 16:37:49 +0100407 }
William Lallemand723b73a2012-02-08 16:37:49 +0100408 }
409 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100410
411 j = var[var_len];
412 var[var_len] = 0;
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100413 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 +0100414 var[var_len] = j;
Dragan Dosen61302da2019-04-30 00:40:02 +0200415
416 error_free:
417 if (node) {
418 free(node->arg);
419 free(node);
420 }
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100421 return 0;
William Lallemand723b73a2012-02-08 16:37:49 +0100422}
423
424/*
425 * push to the logformat linked list
426 *
427 * start: start pointer
428 * end: end text pointer
429 * type: string type
William Lallemand1d705562012-03-12 12:46:41 +0100430 * list_format: destination list
William Lallemand723b73a2012-02-08 16:37:49 +0100431 *
432 * LOG_TEXT: copy chars from start to end excluding end.
433 *
434*/
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100435int add_to_logformat_list(char *start, char *end, int type, struct list *list_format, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100436{
437 char *str;
438
Willy Tarreaua3571662012-12-20 21:59:12 +0100439 if (type == LF_TEXT) { /* type text */
Vincent Bernat02779b62016-04-03 13:48:43 +0200440 struct logformat_node *node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100441 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100442 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100443 return 0;
444 }
Vincent Bernat02779b62016-04-03 13:48:43 +0200445 str = calloc(1, end - start + 1);
William Lallemand723b73a2012-02-08 16:37:49 +0100446 strncpy(str, start, end - start);
William Lallemand723b73a2012-02-08 16:37:49 +0100447 str[end - start] = '\0';
448 node->arg = str;
William Lallemand1d705562012-03-12 12:46:41 +0100449 node->type = LOG_FMT_TEXT; // type string
Willy Tarreau2b718102021-04-21 07:32:39 +0200450 LIST_APPEND(list_format, &node->list);
Willy Tarreaua3571662012-12-20 21:59:12 +0100451 } else if (type == LF_SEPARATOR) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200452 struct logformat_node *node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100453 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100454 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100455 return 0;
456 }
William Lallemand1d705562012-03-12 12:46:41 +0100457 node->type = LOG_FMT_SEPARATOR;
Willy Tarreau2b718102021-04-21 07:32:39 +0200458 LIST_APPEND(list_format, &node->list);
William Lallemand723b73a2012-02-08 16:37:49 +0100459 }
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100460 return 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100461}
462
463/*
Willy Tarreauc8368452012-12-21 00:09:23 +0100464 * Parse the sample fetch expression <text> and add a node to <list_format> upon
465 * success. At the moment, sample converters are not yet supported but fetch arguments
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100466 * should work. The curpx->conf.args.ctx must be set by the caller. If an end pointer
467 * is passed in <endptr>, it will be updated with the pointer to the first character
468 * not part of the sample expression.
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100469 *
470 * In error case, the function returns 0, otherwise it returns 1.
Willy Tarreauc8368452012-12-21 00:09:23 +0100471 */
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100472int 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 +0100473{
474 char *cmd[2];
Dragan Dosen61302da2019-04-30 00:40:02 +0200475 struct sample_expr *expr = NULL;
476 struct logformat_node *node = NULL;
Willy Tarreauc8368452012-12-21 00:09:23 +0100477 int cmd_arg;
478
479 cmd[0] = text;
480 cmd[1] = "";
481 cmd_arg = 0;
482
Christopher Faulet8551c342021-09-30 16:22:51 +0200483 expr = sample_parse_expr(cmd, &cmd_arg, curpx->conf.args.file, curpx->conf.args.line, err,
484 (curpx->cap & PR_CAP_DEF) ? NULL: &curpx->conf.args, endptr);
Willy Tarreauc8368452012-12-21 00:09:23 +0100485 if (!expr) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100486 memprintf(err, "failed to parse sample expression <%s> : %s", text, *err);
Dragan Dosen61302da2019-04-30 00:40:02 +0200487 goto error_free;
Willy Tarreauc8368452012-12-21 00:09:23 +0100488 }
489
Vincent Bernat02779b62016-04-03 13:48:43 +0200490 node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100491 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100492 memprintf(err, "out of memory error");
Dragan Dosen61302da2019-04-30 00:40:02 +0200493 goto error_free;
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100494 }
Willy Tarreauc8368452012-12-21 00:09:23 +0100495 node->type = LOG_FMT_EXPR;
496 node->expr = expr;
497 node->options = options;
498
499 if (arg_len) {
500 node->arg = my_strndup(arg, arg_len);
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100501 if (!parse_logformat_var_args(node->arg, node, err))
Dragan Dosen61302da2019-04-30 00:40:02 +0200502 goto error_free;
Willy Tarreauc8368452012-12-21 00:09:23 +0100503 }
Willy Tarreau434c57c2013-01-08 01:10:24 +0100504 if (expr->fetch->val & cap & SMP_VAL_REQUEST)
Willy Tarreauc8368452012-12-21 00:09:23 +0100505 node->options |= LOG_OPT_REQ_CAP; /* fetch method is request-compatible */
506
Willy Tarreau434c57c2013-01-08 01:10:24 +0100507 if (expr->fetch->val & cap & SMP_VAL_RESPONSE)
Willy Tarreauc8368452012-12-21 00:09:23 +0100508 node->options |= LOG_OPT_RES_CAP; /* fetch method is response-compatible */
509
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100510 if (!(expr->fetch->val & cap)) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100511 memprintf(err, "sample fetch <%s> may not be reliably used here because it needs '%s' which is not available here",
512 text, sample_src_names(expr->fetch->use));
Dragan Dosen61302da2019-04-30 00:40:02 +0200513 goto error_free;
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100514 }
Willy Tarreau434c57c2013-01-08 01:10:24 +0100515
Christopher Faulet581db2b2021-03-26 10:02:46 +0100516 if ((options & LOG_OPT_HTTP) && (expr->fetch->use & (SMP_USE_L6REQ|SMP_USE_L6RES))) {
517 ha_warning("parsing [%s:%d] : L6 sample fetch <%s> ignored in HTTP log-format string.\n",
518 curpx->conf.args.file, curpx->conf.args.line, text);
519 }
520
Christopher Faulet711ed6a2019-07-16 14:16:10 +0200521 /* check if we need to allocate an http_txn struct for HTTP parsing */
Willy Tarreauc8368452012-12-21 00:09:23 +0100522 /* Note, we may also need to set curpx->to_log with certain fetches */
Willy Tarreau25320b22013-03-24 07:22:08 +0100523 curpx->http_needed |= !!(expr->fetch->use & SMP_USE_HTTP_ANY);
Willy Tarreauc8368452012-12-21 00:09:23 +0100524
William Lallemand65ad6e12014-01-31 15:08:02 +0100525 /* FIXME: temporary workaround for missing LW_XPRT and LW_REQ flags
526 * needed with some sample fetches (eg: ssl*). We always set it for
527 * now on, but this will leave with sample capabilities soon.
Willy Tarreau1f31c732013-01-10 16:22:27 +0100528 */
529 curpx->to_log |= LW_XPRT;
Christopher Fauletd2236cd2020-04-06 18:29:14 +0200530 if (curpx->http_needed)
531 curpx->to_log |= LW_REQ;
Willy Tarreau2b718102021-04-21 07:32:39 +0200532 LIST_APPEND(list_format, &node->list);
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100533 return 1;
Dragan Dosen61302da2019-04-30 00:40:02 +0200534
535 error_free:
536 release_sample_expr(expr);
537 if (node) {
538 free(node->arg);
539 free(node);
540 }
541 return 0;
Willy Tarreauc8368452012-12-21 00:09:23 +0100542}
543
544/*
William Lallemand723b73a2012-02-08 16:37:49 +0100545 * Parse the log_format string and fill a linked list.
546 * Variable name are preceded by % and composed by characters [a-zA-Z0-9]* : %varname
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200547 * You can set arguments using { } : %{many arguments}varname.
548 * The curproxy->conf.args.ctx must be set by the caller.
William Lallemand1d705562012-03-12 12:46:41 +0100549 *
Ilya Shipitsinae40dbc2020-04-04 12:59:53 +0500550 * fmt: the string to parse
William Lallemand1d705562012-03-12 12:46:41 +0100551 * curproxy: the proxy affected
552 * list_format: the destination list
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +0100553 * options: LOG_OPT_* to force on every node
Willy Tarreau434c57c2013-01-08 01:10:24 +0100554 * cap: all SMP_VAL_* flags supported by the consumer
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100555 *
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100556 * The function returns 1 in success case, otherwise, it returns 0 and err is filled.
William Lallemand723b73a2012-02-08 16:37:49 +0100557 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100558int 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 +0100559{
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100560 char *sp, *str, *backfmt; /* start pointer for text parts */
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100561 char *arg = NULL; /* start pointer for args */
562 char *var = NULL; /* start pointer for vars */
563 int arg_len = 0;
564 int var_len = 0;
565 int cformat; /* current token format */
566 int pformat; /* previous token format */
William Lallemand723b73a2012-02-08 16:37:49 +0100567 struct logformat_node *tmplf, *back;
568
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100569 sp = str = backfmt = strdup(fmt);
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100570 if (!str) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100571 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100572 return 0;
573 }
William Lallemand1dc00ef2012-08-09 16:41:35 +0200574 curproxy->to_log |= LW_INIT;
William Lallemand5e19a282012-04-02 16:22:10 +0200575
William Lallemand723b73a2012-02-08 16:37:49 +0100576 /* flush the list first. */
William Lallemand1d705562012-03-12 12:46:41 +0100577 list_for_each_entry_safe(tmplf, back, list_format, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200578 LIST_DELETE(&tmplf->list);
Dragan Dosen61302da2019-04-30 00:40:02 +0200579 release_sample_expr(tmplf->expr);
580 free(tmplf->arg);
William Lallemand723b73a2012-02-08 16:37:49 +0100581 free(tmplf);
582 }
583
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100584 for (cformat = LF_INIT; cformat != LF_END; str++) {
William Lallemand723b73a2012-02-08 16:37:49 +0100585 pformat = cformat;
586
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100587 if (!*str)
588 cformat = LF_END; // preset it to save all states from doing this
William Lallemand723b73a2012-02-08 16:37:49 +0100589
Joseph Herlant85b40592018-11-15 12:10:04 -0800590 /* The principle of the two-step state machine below is to first detect a change, and
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100591 * second have all common paths processed at one place. The common paths are the ones
592 * encountered in text areas (LF_INIT, LF_TEXT, LF_SEPARATOR) and at the end (LF_END).
593 * We use the common LF_INIT state to dispatch to the different final states.
594 */
595 switch (pformat) {
596 case LF_STARTVAR: // text immediately following a '%'
Willy Tarreauc8368452012-12-21 00:09:23 +0100597 arg = NULL; var = NULL;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100598 arg_len = var_len = 0;
599 if (*str == '{') { // optional argument
600 cformat = LF_STARG;
601 arg = str + 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100602 }
Willy Tarreauc8368452012-12-21 00:09:23 +0100603 else if (*str == '[') {
604 cformat = LF_STEXPR;
605 var = str + 1; // store expr in variable name
606 }
Willy Tarreau0f28f822013-12-16 01:38:33 +0100607 else if (isalpha((unsigned char)*str)) { // variable name
William Lallemand723b73a2012-02-08 16:37:49 +0100608 cformat = LF_VAR;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100609 var = str;
William Lallemand723b73a2012-02-08 16:37:49 +0100610 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100611 else if (*str == '%')
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500612 cformat = LF_TEXT; // convert this character to a literal (useful for '%')
Willy Tarreau0f28f822013-12-16 01:38:33 +0100613 else if (isdigit((unsigned char)*str) || *str == ' ' || *str == '\t') {
Willy Tarreau06d97f92013-12-02 17:45:48 +0100614 /* single '%' followed by blank or digit, send them both */
615 cformat = LF_TEXT;
616 pformat = LF_TEXT; /* finally we include the previous char as well */
617 sp = str - 1; /* send both the '%' and the current char */
Jim Freemana2278c82017-04-15 08:01:59 -0600618 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 +0100619 *str, (int)(str - backfmt), fmt);
Willy Tarreau51013e82019-12-11 12:05:39 +0100620 goto fail;
Willy Tarreau06d97f92013-12-02 17:45:48 +0100621
622 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100623 else
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500624 cformat = LF_INIT; // handle other cases of literals
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100625 break;
626
627 case LF_STARG: // text immediately following '%{'
628 if (*str == '}') { // end of arg
William Lallemand723b73a2012-02-08 16:37:49 +0100629 cformat = LF_EDARG;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100630 arg_len = str - arg;
631 *str = 0; // used for reporting errors
William Lallemand723b73a2012-02-08 16:37:49 +0100632 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100633 break;
634
635 case LF_EDARG: // text immediately following '%{arg}'
Willy Tarreauc8368452012-12-21 00:09:23 +0100636 if (*str == '[') {
637 cformat = LF_STEXPR;
638 var = str + 1; // store expr in variable name
639 break;
640 }
Willy Tarreau0f28f822013-12-16 01:38:33 +0100641 else if (isalnum((unsigned char)*str)) { // variable name
William Lallemand723b73a2012-02-08 16:37:49 +0100642 cformat = LF_VAR;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100643 var = str;
644 break;
645 }
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100646 memprintf(err, "parse argument modifier without variable name near '%%{%s}'", arg);
Willy Tarreau51013e82019-12-11 12:05:39 +0100647 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100648
Willy Tarreauc8368452012-12-21 00:09:23 +0100649 case LF_STEXPR: // text immediately following '%['
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100650 /* the whole sample expression is parsed at once,
651 * returning the pointer to the first character not
652 * part of the expression, which MUST be the trailing
653 * angle bracket.
654 */
655 if (!add_sample_to_logformat_list(var, arg, arg_len, curproxy, list_format, options, cap, err, &str))
656 goto fail;
657
658 if (*str == ']') {
659 // end of arg, go on with next state
660 cformat = pformat = LF_EDEXPR;
661 sp = str;
662 }
663 else {
664 char c = *str;
665 *str = 0;
Willy Tarreau90807112020-02-25 08:16:33 +0100666 if (isprint((unsigned char)c))
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100667 memprintf(err, "expected ']' after '%s', but found '%c'", var, c);
668 else
669 memprintf(err, "missing ']' after '%s'", var);
Dragan Dosen2866acf2020-06-30 21:16:43 +0200670 goto fail;
Willy Tarreauc8368452012-12-21 00:09:23 +0100671 }
672 break;
673
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100674 case LF_VAR: // text part of a variable name
675 var_len = str - var;
Willy Tarreau0f28f822013-12-16 01:38:33 +0100676 if (!isalnum((unsigned char)*str))
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100677 cformat = LF_INIT; // not variable name anymore
678 break;
679
Willy Tarreauc8368452012-12-21 00:09:23 +0100680 default: // LF_INIT, LF_TEXT, LF_SEPARATOR, LF_END, LF_EDEXPR
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100681 cformat = LF_INIT;
682 }
683
684 if (cformat == LF_INIT) { /* resynchronize state to text/sep/startvar */
685 switch (*str) {
686 case '%': cformat = LF_STARTVAR; break;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100687 case 0 : cformat = LF_END; break;
Dragan Dosen1e3b16f2020-06-23 18:16:44 +0200688 case ' ':
689 if (options & LOG_OPT_MERGE_SPACES) {
690 cformat = LF_SEPARATOR;
691 break;
692 }
693 /* fall through */
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100694 default : cformat = LF_TEXT; break;
William Lallemand723b73a2012-02-08 16:37:49 +0100695 }
696 }
697
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100698 if (cformat != pformat || pformat == LF_SEPARATOR) {
699 switch (pformat) {
700 case LF_VAR:
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100701 if (!parse_logformat_var(arg, arg_len, var, var_len, curproxy, list_format, &options, err))
Willy Tarreau51013e82019-12-11 12:05:39 +0100702 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100703 break;
704 case LF_TEXT:
705 case LF_SEPARATOR:
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100706 if (!add_to_logformat_list(sp, str, pformat, list_format, err))
Willy Tarreau51013e82019-12-11 12:05:39 +0100707 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100708 break;
709 }
710 sp = str; /* new start of text at every state switch and at every separator */
William Lallemand723b73a2012-02-08 16:37:49 +0100711 }
712 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100713
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100714 if (pformat == LF_STARTVAR || pformat == LF_STARG || pformat == LF_STEXPR) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100715 memprintf(err, "truncated line after '%s'", var ? var : arg ? arg : "%");
Willy Tarreau51013e82019-12-11 12:05:39 +0100716 goto fail;
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100717 }
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100718 free(backfmt);
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100719
720 return 1;
Willy Tarreau51013e82019-12-11 12:05:39 +0100721 fail:
722 free(backfmt);
723 return 0;
William Lallemand723b73a2012-02-08 16:37:49 +0100724}
725
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200726/*
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500727 * 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 +0200728 * ranges of indexes. Note that an index may be considered as a particular range
729 * with a high limit to the low limit.
730 */
731int get_logsrv_smp_range(unsigned int *low, unsigned int *high, char **arg, char **err)
732{
733 char *end, *p;
734
735 *low = *high = 0;
736
737 p = *arg;
738 end = strchr(p, ',');
739 if (!end)
740 end = p + strlen(p);
741
742 *high = *low = read_uint((const char **)&p, end);
743 if (!*low || (p != end && *p != '-'))
744 goto err;
745
746 if (p == end)
747 goto done;
748
749 p++;
750 *high = read_uint((const char **)&p, end);
751 if (!*high || *high <= *low || p != end)
752 goto err;
753
754 done:
755 if (*end == ',')
756 end++;
757 *arg = end;
758 return 1;
759
760 err:
761 memprintf(err, "wrong sample range '%s'", *arg);
762 return 0;
763}
764
765/*
766 * Returns 1 if the range defined by <low> and <high> overlaps
767 * one of them in <rgs> array of ranges with <sz> the size of this
768 * array, 0 if not.
769 */
770int smp_log_ranges_overlap(struct smp_log_range *rgs, size_t sz,
771 unsigned int low, unsigned int high, char **err)
772{
773 size_t i;
774
775 for (i = 0; i < sz; i++) {
776 if ((low >= rgs[i].low && low <= rgs[i].high) ||
777 (high >= rgs[i].low && high <= rgs[i].high)) {
778 memprintf(err, "ranges are overlapping");
779 return 1;
780 }
781 }
782
783 return 0;
784}
785
786int smp_log_range_cmp(const void *a, const void *b)
787{
788 const struct smp_log_range *rg_a = a;
789 const struct smp_log_range *rg_b = b;
790
791 if (rg_a->high < rg_b->low)
792 return -1;
793 else if (rg_a->low > rg_b->high)
794 return 1;
795
796 return 0;
797}
798
799/*
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200800 * Parse "log" keyword and update <logsrvs> list accordingly.
801 *
802 * When <do_del> is set, it means the "no log" line was parsed, so all log
803 * servers in <logsrvs> are released.
804 *
805 * Otherwise, we try to parse the "log" line. First of all, when the list is not
806 * the global one, we look for the parameter "global". If we find it,
807 * global.logsrvs is copied. Else we parse each arguments.
808 *
809 * The function returns 1 in success case, otherwise, it returns 0 and err is
810 * filled.
811 */
Emeric Brun9533a702021-04-02 10:13:43 +0200812int parse_logsrv(char **args, struct list *logsrvs, int do_del, const char *file, int linenum, char **err)
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200813{
Willy Tarreauae32ac72020-10-27 09:51:37 +0100814 struct smp_log_range *smp_rgs = NULL;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200815 struct sockaddr_storage *sk;
Emeric Brun94aab062021-04-02 10:41:36 +0200816 struct protocol *proto;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200817 struct logsrv *logsrv = NULL;
818 int port1, port2;
819 int cur_arg;
Willy Tarreau89599262020-09-15 14:03:26 +0200820 int fd;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200821
822 /*
823 * "no log": delete previous herited or defined syslog
824 * servers.
825 */
826 if (do_del) {
827 struct logsrv *back;
828
829 if (*(args[1]) != 0) {
830 memprintf(err, "'no log' does not expect arguments");
831 goto error;
832 }
833
834 list_for_each_entry_safe(logsrv, back, logsrvs, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200835 LIST_DELETE(&logsrv->list);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200836 free(logsrv);
837 }
838 return 1;
839 }
840
841 /*
842 * "log global": copy global.logrsvs linked list to the end of logsrvs
843 * list. But first, we check (logsrvs != global.logsrvs).
844 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100845 if (*(args[1]) && *(args[2]) == 0 && strcmp(args[1], "global") == 0) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200846 if (logsrvs == &global.logsrvs) {
847 memprintf(err, "'global' is not supported for a global syslog server");
848 goto error;
849 }
850 list_for_each_entry(logsrv, &global.logsrvs, list) {
Christopher Faulet28ac0992018-03-26 16:09:19 +0200851 struct logsrv *node;
852
853 list_for_each_entry(node, logsrvs, list) {
854 if (node->ref == logsrv)
855 goto skip_logsrv;
856 }
857
858 node = malloc(sizeof(*node));
Aurelien DARRAGON4ba4a212023-05-11 18:57:23 +0200859 if (!node) {
860 memprintf(err, "out of memory error");
861 goto error;
862 }
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200863 memcpy(node, logsrv, sizeof(struct logsrv));
Christopher Faulet28ac0992018-03-26 16:09:19 +0200864 node->ref = logsrv;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200865 LIST_INIT(&node->list);
Willy Tarreau2b718102021-04-21 07:32:39 +0200866 LIST_APPEND(logsrvs, &node->list);
Emeric Brun9533a702021-04-02 10:13:43 +0200867 node->conf.file = strdup(file);
868 node->conf.line = linenum;
Christopher Faulet28ac0992018-03-26 16:09:19 +0200869
870 skip_logsrv:
871 continue;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200872 }
873 return 1;
874 }
875
876 /*
877 * "log <address> ...: parse a syslog server line
878 */
879 if (*(args[1]) == 0 || *(args[2]) == 0) {
880 memprintf(err, "expects <address> and <facility> %s as arguments",
881 ((logsrvs == &global.logsrvs) ? "" : "or global"));
882 goto error;
883 }
884
Willy Tarreau5a32ecc2018-11-12 07:34:59 +0100885 /* take care of "stdout" and "stderr" as regular aliases for fd@1 / fd@2 */
886 if (strcmp(args[1], "stdout") == 0)
887 args[1] = "fd@1";
888 else if (strcmp(args[1], "stderr") == 0)
889 args[1] = "fd@2";
890
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200891 logsrv = calloc(1, sizeof(*logsrv));
892 if (!logsrv) {
893 memprintf(err, "out of memory");
894 goto error;
895 }
896
Emeric Brun9533a702021-04-02 10:13:43 +0200897 logsrv->conf.file = strdup(file);
898 logsrv->conf.line = linenum;
899
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200900 /* skip address for now, it will be parsed at the end */
901 cur_arg = 2;
902
903 /* just after the address, a length may be specified */
904 logsrv->maxlen = MAX_SYSLOG_LEN;
905 if (strcmp(args[cur_arg], "len") == 0) {
906 int len = atoi(args[cur_arg+1]);
907 if (len < 80 || len > 65535) {
908 memprintf(err, "invalid log length '%s', must be between 80 and 65535",
909 args[cur_arg+1]);
910 goto error;
911 }
912 logsrv->maxlen = len;
913 cur_arg += 2;
914 }
915 if (logsrv->maxlen > global.max_syslog_len)
916 global.max_syslog_len = logsrv->maxlen;
917
918 /* after the length, a format may be specified */
919 if (strcmp(args[cur_arg], "format") == 0) {
920 logsrv->format = get_log_format(args[cur_arg+1]);
Emeric Brun54648852020-07-06 15:54:06 +0200921 if (logsrv->format == LOG_FORMAT_UNSPEC) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200922 memprintf(err, "unknown log format '%s'", args[cur_arg+1]);
923 goto error;
924 }
925 cur_arg += 2;
926 }
927
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200928 if (strcmp(args[cur_arg], "sample") == 0) {
929 unsigned low, high;
930 char *p, *beg, *end, *smp_sz_str;
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200931 size_t smp_rgs_sz = 0, smp_sz = 0, new_smp_sz;
932
933 p = args[cur_arg+1];
934 smp_sz_str = strchr(p, ':');
935 if (!smp_sz_str) {
936 memprintf(err, "Missing sample size");
937 goto error;
938 }
939
940 *smp_sz_str++ = '\0';
941
942 end = p + strlen(p);
943
944 while (p != end) {
945 if (!get_logsrv_smp_range(&low, &high, &p, err))
946 goto error;
947
948 if (smp_rgs && smp_log_ranges_overlap(smp_rgs, smp_rgs_sz, low, high, err))
949 goto error;
950
951 smp_rgs = my_realloc2(smp_rgs, (smp_rgs_sz + 1) * sizeof *smp_rgs);
952 if (!smp_rgs) {
953 memprintf(err, "out of memory error");
954 goto error;
955 }
956
957 smp_rgs[smp_rgs_sz].low = low;
958 smp_rgs[smp_rgs_sz].high = high;
959 smp_rgs[smp_rgs_sz].sz = high - low + 1;
960 smp_rgs[smp_rgs_sz].curr_idx = 0;
961 if (smp_rgs[smp_rgs_sz].high > smp_sz)
962 smp_sz = smp_rgs[smp_rgs_sz].high;
963 smp_rgs_sz++;
964 }
965
Tim Duesterhus21648002019-06-23 22:10:10 +0200966 if (smp_rgs == NULL) {
967 memprintf(err, "no sampling ranges given");
968 goto error;
969 }
970
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200971 beg = smp_sz_str;
972 end = beg + strlen(beg);
973 new_smp_sz = read_uint((const char **)&beg, end);
974 if (!new_smp_sz || beg != end) {
975 memprintf(err, "wrong sample size '%s' for sample range '%s'",
976 smp_sz_str, args[cur_arg+1]);
977 goto error;
978 }
979
980 if (new_smp_sz < smp_sz) {
981 memprintf(err, "sample size %zu should be greater or equal to "
982 "%zu the maximum of the high ranges limits",
983 new_smp_sz, smp_sz);
984 goto error;
985 }
986 smp_sz = new_smp_sz;
987
988 /* Let's order <smp_rgs> array. */
989 qsort(smp_rgs, smp_rgs_sz, sizeof(struct smp_log_range), smp_log_range_cmp);
990
991 logsrv->lb.smp_rgs = smp_rgs;
992 logsrv->lb.smp_rgs_sz = smp_rgs_sz;
993 logsrv->lb.smp_sz = smp_sz;
994
995 cur_arg += 2;
996 }
Frédéric Lécailled803e472019-04-25 07:42:09 +0200997 HA_SPIN_INIT(&logsrv->lock);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200998 /* parse the facility */
999 logsrv->facility = get_log_facility(args[cur_arg]);
1000 if (logsrv->facility < 0) {
1001 memprintf(err, "unknown log facility '%s'", args[cur_arg]);
1002 goto error;
1003 }
1004 cur_arg++;
1005
1006 /* parse the max syslog level (default: debug) */
1007 logsrv->level = 7;
1008 if (*(args[cur_arg])) {
1009 logsrv->level = get_log_level(args[cur_arg]);
1010 if (logsrv->level < 0) {
1011 memprintf(err, "unknown optional log level '%s'", args[cur_arg]);
1012 goto error;
1013 }
1014 cur_arg++;
1015 }
1016
1017 /* parse the limit syslog level (default: emerg) */
1018 logsrv->minlvl = 0;
1019 if (*(args[cur_arg])) {
1020 logsrv->minlvl = get_log_level(args[cur_arg]);
1021 if (logsrv->minlvl < 0) {
1022 memprintf(err, "unknown optional minimum log level '%s'", args[cur_arg]);
1023 goto error;
1024 }
1025 cur_arg++;
1026 }
1027
1028 /* Too many args */
1029 if (*(args[cur_arg])) {
1030 memprintf(err, "cannot handle unexpected argument '%s'", args[cur_arg]);
1031 goto error;
1032 }
1033
1034 /* now, back to the address */
Willy Tarreauf3dc30f2019-08-30 14:18:44 +02001035 logsrv->type = LOG_TARGET_DGRAM;
Willy Tarreauc046d162019-08-30 15:24:59 +02001036 if (strncmp(args[1], "ring@", 5) == 0) {
Willy Tarreauc046d162019-08-30 15:24:59 +02001037 logsrv->addr.ss_family = AF_UNSPEC;
1038 logsrv->type = LOG_TARGET_BUFFER;
Emeric Brun99c453d2020-05-25 15:01:04 +02001039 logsrv->sink = NULL;
1040 logsrv->ring_name = strdup(args[1] + 5);
Willy Tarreauc046d162019-08-30 15:24:59 +02001041 goto done;
1042 }
1043
Emeric Brun94aab062021-04-02 10:41:36 +02001044 sk = str2sa_range(args[1], NULL, &port1, &port2, &fd, &proto,
1045 err, NULL, NULL,
1046 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 +02001047 if (!sk)
1048 goto error;
Willy Tarreau89599262020-09-15 14:03:26 +02001049
1050 if (fd != -1)
1051 logsrv->type = LOG_TARGET_FD;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001052 logsrv->addr = *sk;
1053
1054 if (sk->ss_family == AF_INET || sk->ss_family == AF_INET6) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001055 if (!port1)
1056 set_host_port(&logsrv->addr, SYSLOG_PORT);
1057 }
Emeric Brun9533a702021-04-02 10:13:43 +02001058
Emeric Brun26754902021-04-07 14:26:44 +02001059 if (proto && proto->ctrl_type == SOCK_STREAM) {
Emeric Brun94aab062021-04-02 10:41:36 +02001060 static unsigned long ring_ids;
1061
1062 /* Implicit sink buffer will be
1063 * initialized in post_check
1064 */
1065 logsrv->type = LOG_TARGET_BUFFER;
1066 logsrv->sink = NULL;
1067 /* compute uniq name for the ring */
1068 memprintf(&logsrv->ring_name, "ring#%lu", ++ring_ids);
1069 }
1070
Willy Tarreauc046d162019-08-30 15:24:59 +02001071 done:
Willy Tarreau2b718102021-04-21 07:32:39 +02001072 LIST_APPEND(logsrvs, &logsrv->list);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001073 return 1;
1074
1075 error:
Willy Tarreauae32ac72020-10-27 09:51:37 +01001076 free(smp_rgs);
Emeric Brun9533a702021-04-02 10:13:43 +02001077 if (logsrv) {
1078 free(logsrv->conf.file);
Willy Tarreaua0133fc2020-10-27 10:35:32 +01001079 free(logsrv->ring_name);
Emeric Brun9533a702021-04-02 10:13:43 +02001080 }
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001081 free(logsrv);
1082 return 0;
1083}
1084
1085
Christopher Fauletd4696382017-10-24 11:44:05 +02001086/* Generic function to display messages prefixed by a label */
1087static void print_message(const char *label, const char *fmt, va_list argp)
1088{
Christopher Fauletd4696382017-10-24 11:44:05 +02001089 char *head, *msg;
Willy Tarreau9f903af2021-05-07 08:42:39 +02001090 char prefix[11]; // '[' + 8 chars + ']' + 0.
Christopher Fauletd4696382017-10-24 11:44:05 +02001091
Willy Tarreau9f903af2021-05-07 08:42:39 +02001092 *prefix = '[';
1093 strncpy(prefix + 1, label, sizeof(prefix) - 2);
1094 msg = prefix + strlen(prefix);
1095 *msg++ = ']';
1096 while (msg < prefix + sizeof(prefix) - 1)
1097 *msg++ = ' ';
1098 *msg = 0;
Christopher Fauletd4696382017-10-24 11:44:05 +02001099
Willy Tarreau9f903af2021-05-07 08:42:39 +02001100 head = msg = NULL;
1101 memprintf(&head, "%s (%u) : ", prefix, (uint)getpid());
Christopher Fauletd4696382017-10-24 11:44:05 +02001102 memvprintf(&msg, fmt, argp);
1103
Willy Tarreau869efd52019-11-15 15:16:57 +01001104 if (global.mode & MODE_STARTING) {
1105 if (unlikely(!startup_logs))
1106 startup_logs = ring_new(STARTUP_LOG_SIZE);
1107
1108 if (likely(startup_logs)) {
1109 struct ist m[2];
1110
1111 m[0] = ist(head);
1112 m[1] = ist(msg);
1113 /* trim the trailing '\n' */
1114 if (m[1].len > 0 && m[1].ptr[m[1].len - 1] == '\n')
1115 m[1].len--;
1116 ring_write(startup_logs, ~0, 0, 0, m, 2);
1117 }
1118 }
Christopher Fauletd4696382017-10-24 11:44:05 +02001119
1120 fprintf(stderr, "%s%s", head, msg);
1121 fflush(stderr);
1122
1123 free(head);
1124 free(msg);
1125}
1126
Willy Tarreaubaaee002006-06-26 02:48:02 +02001127/*
1128 * Displays the message on stderr with the date and pid. Overrides the quiet
1129 * mode during startup.
1130 */
Christopher Faulet767a84b2017-11-24 16:50:31 +01001131void ha_alert(const char *fmt, ...)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001132{
1133 va_list argp;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001134
1135 if (!(global.mode & MODE_QUIET) || (global.mode & (MODE_VERBOSE | MODE_STARTING))) {
Willy Tarreaubb869862020-04-16 10:52:41 +02001136 if (!(warned & WARN_EXEC_PATH)) {
1137 const char *path = get_exec_path();
1138
1139 warned |= WARN_EXEC_PATH;
1140 ha_notice("haproxy version is %s\n", haproxy_version);
1141 if (path)
1142 ha_notice("path to executable is %s\n", path);
1143 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001144 va_start(argp, fmt);
Christopher Fauletd4696382017-10-24 11:44:05 +02001145 print_message("ALERT", fmt, argp);
Willy Tarreaubaaee002006-06-26 02:48:02 +02001146 va_end(argp);
1147 }
1148}
1149
1150
1151/*
1152 * Displays the message on stderr with the date and pid.
1153 */
Christopher Faulet767a84b2017-11-24 16:50:31 +01001154void ha_warning(const char *fmt, ...)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001155{
1156 va_list argp;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001157
Willy Tarreaubebd2122020-04-15 16:06:11 +02001158 warned |= WARN_ANY;
1159
Willy Tarreaubaaee002006-06-26 02:48:02 +02001160 if (!(global.mode & MODE_QUIET) || (global.mode & MODE_VERBOSE)) {
1161 va_start(argp, fmt);
Christopher Fauletd4696382017-10-24 11:44:05 +02001162 print_message("WARNING", fmt, argp);
Willy Tarreaubaaee002006-06-26 02:48:02 +02001163 va_end(argp);
1164 }
1165}
1166
1167/*
Amaury Denoyelle7b01a8d2021-03-29 10:29:07 +02001168 * Variant of _ha_diag_warning with va_list.
1169 * Use it only if MODE_DIAG has been previously checked.
1170 */
1171void _ha_vdiag_warning(const char *fmt, va_list argp)
1172{
Willy Tarreau9f903af2021-05-07 08:42:39 +02001173 print_message("DIAG", fmt, argp);
Amaury Denoyelle7b01a8d2021-03-29 10:29:07 +02001174}
1175
1176/*
1177 * Output a diagnostic warning.
1178 * Use it only if MODE_DIAG has been previously checked.
1179 */
1180void _ha_diag_warning(const char *fmt, ...)
1181{
1182 va_list argp;
1183
1184 va_start(argp, fmt);
1185 _ha_vdiag_warning(fmt, argp);
1186 va_end(argp);
1187}
1188
1189/*
1190 * Output a diagnostic warning. Do nothing of MODE_DIAG is not on.
1191 */
1192void ha_diag_warning(const char *fmt, ...)
1193{
1194 va_list argp;
1195
1196 if (global.mode & MODE_DIAG) {
1197 va_start(argp, fmt);
1198 _ha_vdiag_warning(fmt, argp);
1199 va_end(argp);
1200 }
1201}
1202
1203/*
William Lallemand9c56a222018-11-21 18:04:52 +01001204 * Displays the message on stderr with the date and pid.
1205 */
1206void ha_notice(const char *fmt, ...)
1207{
1208 va_list argp;
1209
1210 if (!(global.mode & MODE_QUIET) || (global.mode & MODE_VERBOSE)) {
1211 va_start(argp, fmt);
1212 print_message("NOTICE", fmt, argp);
1213 va_end(argp);
1214 }
1215}
1216
1217/*
Willy Tarreaubaaee002006-06-26 02:48:02 +02001218 * Displays the message on <out> only if quiet mode is not set.
1219 */
Willy Tarreaub17916e2006-10-15 15:17:57 +02001220void qfprintf(FILE *out, const char *fmt, ...)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001221{
1222 va_list argp;
1223
1224 if (!(global.mode & MODE_QUIET) || (global.mode & MODE_VERBOSE)) {
1225 va_start(argp, fmt);
1226 vfprintf(out, fmt, argp);
1227 fflush(out);
1228 va_end(argp);
1229 }
1230}
1231
1232/*
Emeric Brun54648852020-07-06 15:54:06 +02001233 * returns log format, LOG_FORMAT_UNSPEC is return if not found.
Dragan Dosen1322d092015-09-22 16:05:32 +02001234 */
Emeric Brun54648852020-07-06 15:54:06 +02001235enum log_fmt get_log_format(const char *fmt)
Dragan Dosen1322d092015-09-22 16:05:32 +02001236{
Emeric Brun54648852020-07-06 15:54:06 +02001237 enum log_fmt format;
Dragan Dosen1322d092015-09-22 16:05:32 +02001238
1239 format = LOG_FORMATS - 1;
Emeric Brun54648852020-07-06 15:54:06 +02001240 while (format > 0 && log_formats[format].name
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001241 && strcmp(log_formats[format].name, fmt) != 0)
Dragan Dosen1322d092015-09-22 16:05:32 +02001242 format--;
1243
Emeric Brun54648852020-07-06 15:54:06 +02001244 /* Note: 0 is LOG_FORMAT_UNSPEC */
Dragan Dosen1322d092015-09-22 16:05:32 +02001245 return format;
1246}
1247
1248/*
Willy Tarreaubaaee002006-06-26 02:48:02 +02001249 * returns log level for <lev> or -1 if not found.
1250 */
1251int get_log_level(const char *lev)
1252{
1253 int level;
1254
1255 level = NB_LOG_LEVELS - 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001256 while (level >= 0 && strcmp(log_levels[level], lev) != 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001257 level--;
1258
1259 return level;
1260}
1261
Willy Tarreaubaaee002006-06-26 02:48:02 +02001262/*
1263 * returns log facility for <fac> or -1 if not found.
1264 */
1265int get_log_facility(const char *fac)
1266{
1267 int facility;
1268
1269 facility = NB_LOG_FACILITIES - 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001270 while (facility >= 0 && strcmp(log_facilities[facility], fac) != 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001271 facility--;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001272
Willy Tarreaubaaee002006-06-26 02:48:02 +02001273 return facility;
1274}
1275
William Lallemanda1cc3812012-02-08 16:38:44 +01001276/*
Dragan Dosen835b9212016-02-12 13:23:03 +01001277 * Encode the string.
1278 *
1279 * When using the +E log format option, it will try to escape '"\]'
1280 * characters with '\' as prefix. The same prefix should not be used as
1281 * <escape>.
1282 */
1283static char *lf_encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001284 const char escape, const long *map,
Dragan Dosen835b9212016-02-12 13:23:03 +01001285 const char *string,
1286 struct logformat_node *node)
1287{
1288 if (node->options & LOG_OPT_ESC) {
1289 if (start < stop) {
1290 stop--; /* reserve one byte for the final '\0' */
1291 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001292 if (!ha_bit_test((unsigned char)(*string), map)) {
1293 if (!ha_bit_test((unsigned char)(*string), rfc5424_escape_map))
Dragan Dosen835b9212016-02-12 13:23:03 +01001294 *start++ = *string;
1295 else {
1296 if (start + 2 >= stop)
1297 break;
1298 *start++ = '\\';
1299 *start++ = *string;
1300 }
1301 }
1302 else {
1303 if (start + 3 >= stop)
1304 break;
1305 *start++ = escape;
1306 *start++ = hextab[(*string >> 4) & 15];
1307 *start++ = hextab[*string & 15];
1308 }
1309 string++;
1310 }
1311 *start = '\0';
1312 }
1313 }
1314 else {
1315 return encode_string(start, stop, escape, map, string);
1316 }
1317
1318 return start;
1319}
1320
1321/*
1322 * Encode the chunk.
1323 *
1324 * When using the +E log format option, it will try to escape '"\]'
1325 * characters with '\' as prefix. The same prefix should not be used as
1326 * <escape>.
1327 */
1328static char *lf_encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001329 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001330 const struct buffer *chunk,
Dragan Dosen835b9212016-02-12 13:23:03 +01001331 struct logformat_node *node)
1332{
1333 char *str, *end;
1334
1335 if (node->options & LOG_OPT_ESC) {
1336 if (start < stop) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001337 str = chunk->area;
1338 end = chunk->area + chunk->data;
Dragan Dosen835b9212016-02-12 13:23:03 +01001339
1340 stop--; /* reserve one byte for the final '\0' */
1341 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001342 if (!ha_bit_test((unsigned char)(*str), map)) {
1343 if (!ha_bit_test((unsigned char)(*str), rfc5424_escape_map))
Dragan Dosen835b9212016-02-12 13:23:03 +01001344 *start++ = *str;
1345 else {
1346 if (start + 2 >= stop)
1347 break;
1348 *start++ = '\\';
1349 *start++ = *str;
1350 }
1351 }
1352 else {
1353 if (start + 3 >= stop)
1354 break;
1355 *start++ = escape;
1356 *start++ = hextab[(*str >> 4) & 15];
1357 *start++ = hextab[*str & 15];
1358 }
1359 str++;
1360 }
1361 *start = '\0';
1362 }
1363 }
1364 else {
1365 return encode_chunk(start, stop, escape, map, chunk);
1366 }
1367
1368 return start;
1369}
1370
1371/*
William Lallemanda1cc3812012-02-08 16:38:44 +01001372 * Write a string in the log string
Dragan Dosen835b9212016-02-12 13:23:03 +01001373 * Take cares of quote and escape options
William Lallemanda1cc3812012-02-08 16:38:44 +01001374 *
Joseph Herlant85b40592018-11-15 12:10:04 -08001375 * Return the address of the \0 character, or NULL on error
William Lallemanda1cc3812012-02-08 16:38:44 +01001376 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001377char *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 +01001378{
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001379 if (size < 2)
1380 return NULL;
William Lallemanda1cc3812012-02-08 16:38:44 +01001381
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001382 if (node->options & LOG_OPT_QUOTE) {
1383 *(dst++) = '"';
1384 size--;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001385 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001386
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001387 if (src && len) {
Aurelien DARRAGONa5c621a2022-09-20 14:33:18 +02001388 /* escape_string and strlcpy2 will both try to add terminating NULL-byte
1389 * to dst, so we need to make sure that extra byte will fit into dst
1390 * before calling them
1391 */
Dragan Dosen835b9212016-02-12 13:23:03 +01001392 if (node->options & LOG_OPT_ESC) {
Dragan Dosen835b9212016-02-12 13:23:03 +01001393 char *ret;
1394
Aurelien DARRAGONa5c621a2022-09-20 14:33:18 +02001395 ret = escape_string(dst, (dst + size - 1), '\\', rfc5424_escape_map, src, src + len);
Dragan Dosen835b9212016-02-12 13:23:03 +01001396 if (ret == NULL || *ret != '\0')
1397 return NULL;
1398 len = ret - dst;
1399 }
1400 else {
Aurelien DARRAGONa5c621a2022-09-20 14:33:18 +02001401 if (++len > size)
1402 len = size;
Dragan Dosen835b9212016-02-12 13:23:03 +01001403 len = strlcpy2(dst, src, len);
1404 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001405
1406 size -= len;
1407 dst += len;
1408 }
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001409 else if ((node->options & (LOG_OPT_QUOTE|LOG_OPT_MANDATORY)) == LOG_OPT_MANDATORY) {
1410 if (size < 2)
1411 return NULL;
1412 *(dst++) = '-';
Aurelien DARRAGONa5c621a2022-09-20 14:33:18 +02001413 size -= 1;
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001414 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001415
1416 if (node->options & LOG_OPT_QUOTE) {
1417 if (size < 2)
1418 return NULL;
1419 *(dst++) = '"';
1420 }
1421
1422 *dst = '\0';
William Lallemandbddd4fd2012-02-27 11:23:10 +01001423 return dst;
William Lallemanda1cc3812012-02-08 16:38:44 +01001424}
1425
Willy Tarreau26ffa852018-09-05 15:23:10 +02001426static inline char *lf_text(char *dst, const char *src, size_t size, const struct logformat_node *node)
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001427{
1428 return lf_text_len(dst, src, size, size, node);
1429}
1430
William Lallemand5f232402012-04-05 18:02:55 +02001431/*
Joseph Herlant85b40592018-11-15 12:10:04 -08001432 * Write a IP address to the log string
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001433 * +X option write in hexadecimal notation, most significant byte on the left
William Lallemand5f232402012-04-05 18:02:55 +02001434 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001435char *lf_ip(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node)
William Lallemand5f232402012-04-05 18:02:55 +02001436{
1437 char *ret = dst;
1438 int iret;
1439 char pn[INET6_ADDRSTRLEN];
1440
1441 if (node->options & LOG_OPT_HEXA) {
Radek Zajic594c4562019-03-22 10:21:54 +00001442 unsigned char *addr = NULL;
1443 switch (sockaddr->sa_family) {
1444 case AF_INET:
1445 addr = (unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_addr.s_addr;
1446 iret = snprintf(dst, size, "%02X%02X%02X%02X", addr[0], addr[1], addr[2], addr[3]);
1447 break;
1448 case AF_INET6:
1449 addr = (unsigned char *)&((struct sockaddr_in6 *)sockaddr)->sin6_addr.s6_addr;
1450 iret = snprintf(dst, size, "%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X",
1451 addr[0], addr[1], addr[2], addr[3], addr[4], addr[5], addr[6], addr[7],
1452 addr[8], addr[9], addr[10], addr[11], addr[12], addr[13], addr[14], addr[15]);
1453 break;
1454 default:
1455 return NULL;
1456 }
William Lallemand5f232402012-04-05 18:02:55 +02001457 if (iret < 0 || iret > size)
1458 return NULL;
1459 ret += iret;
1460 } else {
1461 addr_to_str((struct sockaddr_storage *)sockaddr, pn, sizeof(pn));
1462 ret = lf_text(dst, pn, size, node);
1463 if (ret == NULL)
1464 return NULL;
1465 }
1466 return ret;
1467}
1468
1469/*
1470 * Write a port to the log
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001471 * +X option write in hexadecimal notation, most significant byte on the left
William Lallemand5f232402012-04-05 18:02:55 +02001472 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001473char *lf_port(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node)
William Lallemand5f232402012-04-05 18:02:55 +02001474{
1475 char *ret = dst;
1476 int iret;
1477
1478 if (node->options & LOG_OPT_HEXA) {
1479 const unsigned char *port = (const unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_port;
1480 iret = snprintf(dst, size, "%02X%02X", port[0], port[1]);
1481 if (iret < 0 || iret > size)
1482 return NULL;
1483 ret += iret;
1484 } else {
1485 ret = ltoa_o(get_host_port((struct sockaddr_storage *)sockaddr), dst, size);
1486 if (ret == NULL)
1487 return NULL;
1488 }
1489 return ret;
1490}
1491
Emeric Brun54648852020-07-06 15:54:06 +02001492
1493/*
1494 * This function sends the syslog message using a printf format string. It
1495 * expects an LF-terminated message.
Willy Tarreaub1a2faf2012-03-19 16:51:53 +01001496 */
Emeric Brun54648852020-07-06 15:54:06 +02001497void send_log(struct proxy *p, int level, const char *format, ...)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001498{
Emeric Brun54648852020-07-06 15:54:06 +02001499 va_list argp;
1500 int data_len;
1501
1502 if (level < 0 || format == NULL || logline == NULL)
1503 return;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001504
Emeric Brun54648852020-07-06 15:54:06 +02001505 va_start(argp, format);
1506 data_len = vsnprintf(logline, global.max_syslog_len, format, argp);
1507 if (data_len < 0 || data_len > global.max_syslog_len)
1508 data_len = global.max_syslog_len;
1509 va_end(argp);
Willy Tarreaufe944602007-10-25 10:34:16 +02001510
Emeric Brun54648852020-07-06 15:54:06 +02001511 __send_log((p ? &p->logsrvs : NULL), (p ? &p->log_tag : NULL), level,
1512 logline, data_len, default_rfc5424_sd_log_format, 2);
1513}
1514/*
1515 * This function builds a log header of given format using given
1516 * metadata, if format is set to LOF_FORMAT_UNSPEC, it tries
1517 * to determine format based on given metadas. It is useful
1518 * for log-forwarding to be able to forward any format without
1519 * settings.
1520 * This function returns a struct ist array of elements of the header
1521 * nbelem is set to the number of available elements.
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001522 * This function returns currently a maximum of NB_LOG_HDR_IST_ELEMENTS
Emeric Brun54648852020-07-06 15:54:06 +02001523 * elements.
1524 */
1525struct ist *build_log_header(enum log_fmt format, int level, int facility,
1526 struct ist *metadata, size_t *nbelem)
1527{
1528 static THREAD_LOCAL struct {
1529 struct ist ist_vector[NB_LOG_HDR_MAX_ELEMENTS];
1530 char timestamp_buffer[LOG_LEGACYTIME_LEN+1+1];
1531 time_t cur_legacy_time;
1532 char priority_buffer[6];
1533 } hdr_ctx = { .priority_buffer = "<<<<>" };
Willy Tarreaubaaee002006-06-26 02:48:02 +02001534
Emeric Brun54648852020-07-06 15:54:06 +02001535 struct tm logtime;
1536 int len;
1537 int fac_level = 0;
1538 time_t time = date.tv_sec;
Dragan Dosen43885c72015-10-01 13:18:13 +02001539
Emeric Brun54648852020-07-06 15:54:06 +02001540 *nbelem = 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001541
Emeric Brun54648852020-07-06 15:54:06 +02001542
1543 if (format == LOG_FORMAT_UNSPEC) {
1544 format = LOG_FORMAT_RAW;
1545 if (metadata) {
1546 /* If a hostname is set, it appears we want to perform syslog
1547 * because only rfc5427 or rfc3164 support an hostname.
1548 */
1549 if (metadata[LOG_META_HOST].len) {
1550 /* If a rfc5424 compliant timestamp is used we consider
1551 * that output format is rfc5424, else legacy format
1552 * is used as specified default for local logs
1553 * in documentation.
1554 */
1555 if ((metadata[LOG_META_TIME].len == 1 && metadata[LOG_META_TIME].ptr[0] == '-')
1556 || (metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN))
1557 format = LOG_FORMAT_RFC5424;
1558 else
1559 format = LOG_FORMAT_RFC3164;
1560 }
Emeric Brun0237c4e2020-11-27 16:24:34 +01001561 else if (metadata[LOG_META_TAG].len) {
1562 /* Tag is present but no hostname, we should
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05001563 * consider we try to emit a local log
Emeric Brun0237c4e2020-11-27 16:24:34 +01001564 * in legacy format (analog to RFC3164 but
1565 * with stripped hostname).
1566 */
1567 format = LOG_FORMAT_LOCAL;
1568 }
Emeric Brun54648852020-07-06 15:54:06 +02001569 else if (metadata[LOG_META_PRIO].len) {
1570 /* the source seems a parsed message
1571 * offering a valid level/prio prefix
1572 * so we consider this format.
1573 */
1574 format = LOG_FORMAT_PRIO;
1575 }
1576 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001577 }
1578
Emeric Brun54648852020-07-06 15:54:06 +02001579 /* prepare priority, stored into 1 single elem */
1580 switch (format) {
Emeric Brun0237c4e2020-11-27 16:24:34 +01001581 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001582 case LOG_FORMAT_RFC3164:
1583 case LOG_FORMAT_RFC5424:
1584 case LOG_FORMAT_PRIO:
1585 fac_level = facility << 3;
1586 /* further format ignore the facility */
1587 /* fall through */
1588 case LOG_FORMAT_TIMED:
1589 case LOG_FORMAT_SHORT:
1590 fac_level += level;
1591 hdr_ctx.ist_vector[*nbelem].ptr = &hdr_ctx.priority_buffer[3]; /* last digit of the log level */
1592 do {
1593 *hdr_ctx.ist_vector[*nbelem].ptr = '0' + fac_level % 10;
1594 fac_level /= 10;
1595 hdr_ctx.ist_vector[*nbelem].ptr--;
1596 } while (fac_level && hdr_ctx.ist_vector[*nbelem].ptr > &hdr_ctx.priority_buffer[0]);
1597 *hdr_ctx.ist_vector[*nbelem].ptr = '<';
1598 hdr_ctx.ist_vector[(*nbelem)++].len = &hdr_ctx.priority_buffer[5] - hdr_ctx.ist_vector[0].ptr;
1599 break;
1600 case LOG_FORMAT_ISO:
1601 case LOG_FORMAT_RAW:
1602 break;
1603 case LOG_FORMAT_UNSPEC:
1604 case LOG_FORMATS:
1605 ABORT_NOW();
1606 }
Willy Tarreau094af4e2015-01-07 15:03:42 +01001607
William Lallemand2a4a44f2012-02-06 16:00:33 +01001608
Emeric Brun54648852020-07-06 15:54:06 +02001609 /* prepare timestamp, stored into a max of 4 elems */
1610 switch (format) {
Emeric Brun0237c4e2020-11-27 16:24:34 +01001611 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001612 case LOG_FORMAT_RFC3164:
1613 /* rfc3164 ex: 'Jan 1 00:00:00 ' */
1614 if (metadata && metadata[LOG_META_TIME].len == LOG_LEGACYTIME_LEN) {
1615 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1616 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001617 /* time is set, break immediately */
Emeric Brun54648852020-07-06 15:54:06 +02001618 break;
1619 }
1620 else if (metadata && metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN) {
1621 int month;
1622 char *timestamp = metadata[LOG_META_TIME].ptr;
Dragan Dosen1322d092015-09-22 16:05:32 +02001623
Emeric Brun54648852020-07-06 15:54:06 +02001624 /* iso time always begins like this: '1970-01-01T00:00:00' */
Dragan Dosen1322d092015-09-22 16:05:32 +02001625
Emeric Brun54648852020-07-06 15:54:06 +02001626 /* compute month */
1627 month = 10*(timestamp[5] - '0') + (timestamp[6] - '0');
1628 if (month)
1629 month--;
1630 if (month <= 11) {
1631 /* builds log prefix ex: 'Jan 1 ' */
1632 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1633 "%s %c%c ", monthname[month],
1634 timestamp[8] != '0' ? timestamp[8] : ' ',
1635 timestamp[9]);
1636 /* we reused the timestamp_buffer, signal that it does not
1637 * contain local time anymore
1638 */
1639 hdr_ctx.cur_legacy_time = 0;
1640 if (len == 7) {
1641 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], len);
1642 /* adds 'HH:MM:SS' from iso time */
1643 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&timestamp[11], 8);
1644 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1645 /* we successfully reuse iso time, we can break */
1646 break;
1647 }
1648 }
1649 /* Failed to reuse isotime time, fallback to local legacy time */
1650 }
Dragan Dosen1322d092015-09-22 16:05:32 +02001651
Emeric Brun54648852020-07-06 15:54:06 +02001652 if (unlikely(time != hdr_ctx.cur_legacy_time)) {
1653 /* re-builds timestamp from the current local time */
1654 get_localtime(time, &logtime);
1655
1656 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1657 "%s %2d %02d:%02d:%02d ",
1658 monthname[logtime.tm_mon],
1659 logtime.tm_mday, logtime.tm_hour, logtime.tm_min, logtime.tm_sec);
1660 if (len != LOG_LEGACYTIME_LEN+1)
1661 hdr_ctx.cur_legacy_time = 0;
1662 else
1663 hdr_ctx.cur_legacy_time = time;
1664 }
1665 if (likely(hdr_ctx.cur_legacy_time))
1666 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], LOG_LEGACYTIME_LEN+1);
1667 else
1668 hdr_ctx.ist_vector[(*nbelem)++] = ist2("Jan 1 00:00:00 ", LOG_LEGACYTIME_LEN+1);
1669 break;
1670 case LOG_FORMAT_RFC5424:
1671 /* adds rfc5425 version prefix */
1672 hdr_ctx.ist_vector[(*nbelem)++] = ist2("1 ", 2);
1673 if (metadata && metadata[LOG_META_TIME].len == 1 && metadata[LOG_META_TIME].ptr[0] == '-') {
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001674 /* submitted len is NILVALUE, it is a valid timestamp for rfc5425 */
Emeric Brun54648852020-07-06 15:54:06 +02001675 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1676 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1677 break;
1678 }
1679 /* let continue as 'timed' and 'iso' format for usual timestamp */
1680 /* fall through */
1681 case LOG_FORMAT_TIMED:
1682 case LOG_FORMAT_ISO:
1683 /* ISO format ex: '1900:01:01T12:00:00.123456Z'
1684 * '1900:01:01T14:00:00+02:00'
1685 * '1900:01:01T10:00:00.123456-02:00'
1686 */
1687 if (metadata && metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN) {
1688 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1689 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001690 /* time is set, break immediately */
Emeric Brun54648852020-07-06 15:54:06 +02001691 break;
1692 }
1693 else if (metadata && metadata[LOG_META_TIME].len == LOG_LEGACYTIME_LEN) {
1694 int month;
1695 char *timestamp = metadata[LOG_META_TIME].ptr;
1696
1697 for (month = 0; month < 12; month++)
1698 if (!memcmp(monthname[month], timestamp, 3))
1699 break;
Dragan Dosen1322d092015-09-22 16:05:32 +02001700
Emeric Brun54648852020-07-06 15:54:06 +02001701 if (month < 12) {
1702
1703 /* get local time to retrieve year */
1704 get_localtime(time, &logtime);
1705
1706 /* year seems changed since log */
1707 if (logtime.tm_mon < month)
1708 logtime.tm_year--;
1709
1710 /* builds rfc5424 prefix ex: '1900-01-01T' */
1711 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1712 "%4d-%02d-%c%cT",
1713 logtime.tm_year+1900, month+1,
1714 timestamp[4] != ' ' ? timestamp[4] : '0',
1715 timestamp[5]);
1716
1717 /* we reused the timestamp_buffer, signal that it does not
1718 * contain local time anymore
1719 */
1720 hdr_ctx.cur_legacy_time = 0;
1721 if (len == 11) {
1722 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], len);
1723 /* adds HH:MM:SS from legacy timestamp */
1724 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&timestamp[7], 8);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001725 /* skip secfraq because it is optional */
Emeric Brun54648852020-07-06 15:54:06 +02001726 /* according to rfc: -00:00 means we don't know the timezone */
1727 hdr_ctx.ist_vector[(*nbelem)++] = ist2("-00:00 ", 7);
1728 /* we successfully reuse legacy time, we can break */
1729 break;
1730 }
1731 }
1732 /* Failed to reuse legacy time, fallback to local iso time */
1733 }
1734 hdr_ctx.ist_vector[(*nbelem)++] = ist2(timeofday_as_iso_us(1), LOG_ISOTIME_MAXLEN + 1);
1735 break;
1736 case LOG_FORMAT_PRIO:
1737 case LOG_FORMAT_SHORT:
1738 case LOG_FORMAT_RAW:
1739 break;
1740 case LOG_FORMAT_UNSPEC:
1741 case LOG_FORMATS:
1742 ABORT_NOW();
Dragan Dosen1322d092015-09-22 16:05:32 +02001743 }
1744
Emeric Brun54648852020-07-06 15:54:06 +02001745 /* prepare other meta data, stored into a max of 10 elems */
1746 switch (format) {
1747 case LOG_FORMAT_RFC3164:
1748 if (metadata && metadata[LOG_META_HOST].len) {
1749 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_HOST];
1750 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1751 }
Emeric Brun0237c4e2020-11-27 16:24:34 +01001752 else /* the caller MUST fill the hostname, this field is mandatory */
Emeric Brun54648852020-07-06 15:54:06 +02001753 hdr_ctx.ist_vector[(*nbelem)++] = ist2("localhost ", 10);
Emeric Brun0237c4e2020-11-27 16:24:34 +01001754 /* fall through */
1755 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001756 if (!metadata || !metadata[LOG_META_TAG].len)
1757 break;
Dragan Dosen1322d092015-09-22 16:05:32 +02001758
Emeric Brun54648852020-07-06 15:54:06 +02001759 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TAG];
1760 if (metadata[LOG_META_PID].len) {
1761 hdr_ctx.ist_vector[(*nbelem)++] = ist2("[", 1);
1762 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_PID];
1763 hdr_ctx.ist_vector[(*nbelem)++] = ist2("]", 1);
1764 }
1765 hdr_ctx.ist_vector[(*nbelem)++] = ist2(": ", 2);
1766 break;
1767 case LOG_FORMAT_RFC5424:
1768 if (metadata && metadata[LOG_META_HOST].len) {
1769 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_HOST];
1770 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1771 }
1772 else
1773 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
Dragan Dosen1322d092015-09-22 16:05:32 +02001774
Emeric Brun54648852020-07-06 15:54:06 +02001775 if (metadata && metadata[LOG_META_TAG].len) {
1776 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TAG];
1777 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1778 }
1779 else
1780 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001781
Emeric Brun54648852020-07-06 15:54:06 +02001782 if (metadata && metadata[LOG_META_PID].len) {
1783 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_PID];
1784 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1785 }
1786 else
1787 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001788
Emeric Brun54648852020-07-06 15:54:06 +02001789 if (metadata && metadata[LOG_META_MSGID].len) {
1790 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_MSGID];
1791 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1792 }
1793 else
1794 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001795
Emeric Brun54648852020-07-06 15:54:06 +02001796 if (metadata && metadata[LOG_META_STDATA].len) {
1797 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_STDATA];
1798 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1799 }
1800 else
1801 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
1802 break;
1803 case LOG_FORMAT_PRIO:
1804 case LOG_FORMAT_SHORT:
1805 case LOG_FORMAT_TIMED:
1806 case LOG_FORMAT_ISO:
1807 case LOG_FORMAT_RAW:
1808 break;
1809 case LOG_FORMAT_UNSPEC:
1810 case LOG_FORMATS:
1811 ABORT_NOW();
1812 }
1813
1814 return hdr_ctx.ist_vector;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001815}
1816
1817/*
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001818 * This function sends a syslog message to <logsrv>.
Emeric Brun54648852020-07-06 15:54:06 +02001819 * The argument <metadata> MUST be an array of size
1820 * LOG_META_FIELDS*sizeof(struct ist) containing data to build the header.
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001821 * It overrides the last byte of the message vector with an LF character.
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001822 * Does not return any error,
William Lallemand2a4a44f2012-02-06 16:00:33 +01001823 */
Emeric Brun54648852020-07-06 15:54:06 +02001824static 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 +01001825{
Emeric Brun54648852020-07-06 15:54:06 +02001826 static THREAD_LOCAL struct iovec iovec[NB_LOG_HDR_MAX_ELEMENTS+1+1] = { }; /* header elements + message + LF */
Christopher Fauletf8188c62017-06-02 16:20:16 +02001827 static THREAD_LOCAL struct msghdr msghdr = {
1828 //.msg_iov = iovec,
Emeric Brun54648852020-07-06 15:54:06 +02001829 .msg_iovlen = NB_LOG_HDR_MAX_ELEMENTS+2
Dragan Dosen609ac2a2015-09-16 18:25:42 +02001830 };
Christopher Fauletf8188c62017-06-02 16:20:16 +02001831 static THREAD_LOCAL int logfdunix = -1; /* syslog to AF_UNIX socket */
1832 static THREAD_LOCAL int logfdinet = -1; /* syslog to AF_INET socket */
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001833 int *plogfd;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001834 int sent;
Emeric Brun54648852020-07-06 15:54:06 +02001835 size_t nbelem;
1836 struct ist *msg_header = NULL;
Christopher Fauletf8188c62017-06-02 16:20:16 +02001837
1838 msghdr.msg_iov = iovec;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001839
Emeric Brunfa9d7802020-05-28 14:21:33 +02001840 /* historically some messages used to already contain the trailing LF
1841 * or Zero. Let's remove all trailing LF or Zero
1842 */
Emeric Brun54648852020-07-06 15:54:06 +02001843 while (size && (message[size-1] == '\n' || (message[size-1] == 0)))
Emeric Brun9e8ea0a2020-05-12 19:33:15 +02001844 size--;
1845
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001846 if (logsrv->type == LOG_TARGET_BUFFER) {
Willy Tarreauc046d162019-08-30 15:24:59 +02001847 plogfd = NULL;
Emeric Brune709e1e2020-05-06 17:23:59 +02001848 goto send;
Willy Tarreauc046d162019-08-30 15:24:59 +02001849 }
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001850 else if (logsrv->addr.ss_family == AF_CUST_EXISTING_FD) {
1851 /* the socket's address is a file descriptor */
1852 plogfd = (int *)&((struct sockaddr_in *)&logsrv->addr)->sin_addr.s_addr;
1853 }
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001854 else if (logsrv->addr.ss_family == AF_UNIX)
1855 plogfd = &logfdunix;
1856 else
1857 plogfd = &logfdinet;
Robert Tsai81ae1952007-12-05 10:47:29 +01001858
Willy Tarreauc046d162019-08-30 15:24:59 +02001859 if (plogfd && unlikely(*plogfd < 0)) {
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001860 /* socket not successfully initialized yet */
1861 if ((*plogfd = socket(logsrv->addr.ss_family, SOCK_DGRAM,
1862 (logsrv->addr.ss_family == AF_UNIX) ? 0 : IPPROTO_UDP)) < 0) {
1863 static char once;
William Lallemand0f99e342011-10-12 17:50:54 +02001864
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001865 if (!once) {
1866 once = 1; /* note: no need for atomic ops here */
1867 ha_alert("socket() failed in logger #%d: %s (errno=%d)\n",
1868 nblogger, strerror(errno), errno);
1869 }
1870 return;
1871 } else {
1872 /* we don't want to receive anything on this socket */
1873 setsockopt(*plogfd, SOL_SOCKET, SO_RCVBUF, &zero, sizeof(zero));
1874 /* does nothing under Linux, maybe needed for others */
1875 shutdown(*plogfd, SHUT_RD);
1876 fcntl(*plogfd, F_SETFD, fcntl(*plogfd, F_GETFD, FD_CLOEXEC) | FD_CLOEXEC);
1877 }
Dragan Dosen43885c72015-10-01 13:18:13 +02001878 }
1879
Emeric Brun54648852020-07-06 15:54:06 +02001880 msg_header = build_log_header(logsrv->format, level, facility, metadata, &nbelem);
1881 send:
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001882 if (logsrv->type == LOG_TARGET_BUFFER) {
Emeric Brun54648852020-07-06 15:54:06 +02001883 struct ist msg;
Aurelien DARRAGON55446a42023-06-26 17:15:48 +02001884 size_t maxlen = logsrv->maxlen;
Emeric Brun54648852020-07-06 15:54:06 +02001885
1886 msg = ist2(message, size);
1887 if (msg.len > logsrv->maxlen)
1888 msg.len = logsrv->maxlen;
Willy Tarreaud52a7f82019-08-30 14:05:35 +02001889
Aurelien DARRAGON55446a42023-06-26 17:15:48 +02001890 /* make room for the final '\n' which may be forcefully inserted
1891 * by tcp forwarder applet (sink_forward_io_handler)
1892 */
1893 maxlen -= 1;
1894
1895 sent = sink_write(logsrv->sink, maxlen, &msg, 1, level, facility, metadata);
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001896 }
1897 else if (logsrv->addr.ss_family == AF_CUST_EXISTING_FD) {
1898 struct ist msg;
1899
1900 msg = ist2(message, size);
1901 if (msg.len > logsrv->maxlen)
1902 msg.len = logsrv->maxlen;
1903
1904 sent = fd_write_frag_line(*plogfd, logsrv->maxlen, msg_header, nbelem, &msg, 1, 1);
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001905 }
1906 else {
Emeric Brun54648852020-07-06 15:54:06 +02001907 int i = 0;
Aurelien DARRAGONa92de3f2023-06-27 11:32:06 +02001908 int totlen = logsrv->maxlen - 1; /* save space for the final '\n' */
Emeric Brun54648852020-07-06 15:54:06 +02001909
1910 for (i = 0 ; i < nbelem ; i++ ) {
1911 iovec[i].iov_base = msg_header[i].ptr;
1912 iovec[i].iov_len = msg_header[i].len;
1913 if (totlen <= iovec[i].iov_len) {
1914 iovec[i].iov_len = totlen;
1915 totlen = 0;
1916 break;
1917 }
1918 totlen -= iovec[i].iov_len;
1919 }
1920 if (totlen) {
1921 iovec[i].iov_base = message;
1922 iovec[i].iov_len = size;
1923 if (totlen <= iovec[i].iov_len)
1924 iovec[i].iov_len = totlen;
1925 i++;
1926 }
1927 iovec[i].iov_base = "\n"; /* insert a \n at the end of the message */
1928 iovec[i].iov_len = 1;
1929 i++;
Willy Tarreaud52a7f82019-08-30 14:05:35 +02001930
Emeric Brun54648852020-07-06 15:54:06 +02001931 msghdr.msg_iovlen = i;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001932 msghdr.msg_name = (struct sockaddr *)&logsrv->addr;
1933 msghdr.msg_namelen = get_addr_len(&logsrv->addr);
Dragan Dosen43885c72015-10-01 13:18:13 +02001934
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001935 sent = sendmsg(*plogfd, &msghdr, MSG_DONTWAIT | MSG_NOSIGNAL);
1936 }
Dragan Dosen43885c72015-10-01 13:18:13 +02001937
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001938 if (sent < 0) {
1939 static char once;
Dragan Dosen43885c72015-10-01 13:18:13 +02001940
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001941 if (errno == EAGAIN)
Willy Tarreau4781b152021-04-06 13:53:36 +02001942 _HA_ATOMIC_INC(&dropped_logs);
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001943 else if (!once) {
1944 once = 1; /* note: no need for atomic ops here */
1945 ha_alert("sendmsg()/writev() failed in logger #%d: %s (errno=%d)\n",
1946 nblogger, strerror(errno), errno);
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001947 }
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001948 }
1949}
Dragan Dosen59cee972015-09-19 22:09:02 +02001950
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001951/*
1952 * This function sends a syslog message.
1953 * It doesn't care about errors nor does it report them.
Emeric Brun54648852020-07-06 15:54:06 +02001954 * The argument <metadata> MUST be an array of size
1955 * LOG_META_FIELDS*sizeof(struct ist) containing
1956 * data to build the header.
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001957 */
Emeric Brun54648852020-07-06 15:54:06 +02001958void process_send_log(struct list *logsrvs, int level, int facility,
1959 struct ist *metadata, char *message, size_t size)
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001960{
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001961 struct logsrv *logsrv;
1962 int nblogger;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001963
1964 /* Send log messages to syslog server. */
1965 nblogger = 0;
1966 list_for_each_entry(logsrv, logsrvs, list) {
Emeric Brun2f4cc282020-07-10 15:47:11 +02001967 int in_range = 1;
Frédéric Lécailled803e472019-04-25 07:42:09 +02001968
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001969 /* we can filter the level of the messages that are sent to each logger */
1970 if (level > logsrv->level)
1971 continue;
1972
Frédéric Lécailled803e472019-04-25 07:42:09 +02001973 if (logsrv->lb.smp_rgs) {
1974 struct smp_log_range *curr_rg;
1975
1976 HA_SPIN_LOCK(LOGSRV_LOCK, &logsrv->lock);
1977 curr_rg = &logsrv->lb.smp_rgs[logsrv->lb.curr_rg];
1978 in_range = in_smp_log_range(curr_rg, logsrv->lb.curr_idx);
1979 if (in_range) {
1980 /* Let's consume this range. */
1981 curr_rg->curr_idx = (curr_rg->curr_idx + 1) % curr_rg->sz;
1982 if (!curr_rg->curr_idx) {
1983 /* If consumed, let's select the next range. */
1984 logsrv->lb.curr_rg = (logsrv->lb.curr_rg + 1) % logsrv->lb.smp_rgs_sz;
1985 }
1986 }
1987 logsrv->lb.curr_idx = (logsrv->lb.curr_idx + 1) % logsrv->lb.smp_sz;
1988 HA_SPIN_UNLOCK(LOGSRV_LOCK, &logsrv->lock);
1989 }
1990 if (in_range)
Emeric Brun54648852020-07-06 15:54:06 +02001991 __do_send_log(logsrv, ++nblogger, MAX(level, logsrv->minlvl),
1992 (facility == -1) ? logsrv->facility : facility,
1993 metadata, message, size);
Willy Tarreaubaaee002006-06-26 02:48:02 +02001994 }
1995}
1996
Emeric Brun54648852020-07-06 15:54:06 +02001997/*
1998 * This function sends a syslog message.
1999 * It doesn't care about errors nor does it report them.
2000 * The arguments <sd> and <sd_size> are used for the structured-data part
2001 * in RFC5424 formatted syslog messages.
2002 */
2003void __send_log(struct list *logsrvs, struct buffer *tagb, int level,
2004 char *message, size_t size, char *sd, size_t sd_size)
2005{
2006 static THREAD_LOCAL pid_t curr_pid;
2007 static THREAD_LOCAL char pidstr[16];
2008 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
2009
2010 if (logsrvs == NULL) {
2011 if (!LIST_ISEMPTY(&global.logsrvs)) {
2012 logsrvs = &global.logsrvs;
2013 }
2014 }
2015 if (!logsrvs || LIST_ISEMPTY(logsrvs))
2016 return;
2017
2018 if (!metadata[LOG_META_HOST].len) {
2019 if (global.log_send_hostname)
2020 metadata[LOG_META_HOST] = ist2(global.log_send_hostname, strlen(global.log_send_hostname));
Emeric Brun54648852020-07-06 15:54:06 +02002021 }
2022
2023 if (!tagb || !tagb->area)
2024 tagb = &global.log_tag;
2025
2026 if (tagb)
2027 metadata[LOG_META_TAG] = ist2(tagb->area, tagb->data);
2028
2029 if (unlikely(curr_pid != getpid()))
2030 metadata[LOG_META_PID].len = 0;
2031
2032 if (!metadata[LOG_META_PID].len) {
2033 curr_pid = getpid();
2034 ltoa_o(curr_pid, pidstr, sizeof(pidstr));
2035 metadata[LOG_META_PID] = ist2(pidstr, strlen(pidstr));
2036 }
2037
2038 metadata[LOG_META_STDATA] = ist2(sd, sd_size);
2039
2040 /* Remove trailing space of structured data */
2041 while (metadata[LOG_META_STDATA].len && metadata[LOG_META_STDATA].ptr[metadata[LOG_META_STDATA].len-1] == ' ')
2042 metadata[LOG_META_STDATA].len--;
2043
2044 return process_send_log(logsrvs, level, -1, metadata, message, size);
2045}
Willy Tarreaubaaee002006-06-26 02:48:02 +02002046
Willy Tarreauc89ccb62012-04-05 21:18:22 +02002047const 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 +01002048const char sess_set_cookie[8] = "NPDIRU67"; /* No set-cookie, Set-cookie found and left unchanged (passive),
2049 Set-cookie Deleted, Set-Cookie Inserted, Set-cookie Rewritten,
2050 Set-cookie Updated, unknown, unknown */
2051
William Lallemand1d705562012-03-12 12:46:41 +01002052/*
2053 * try to write a character if there is enough space, or goto out
2054 */
William Lallemandbddd4fd2012-02-27 11:23:10 +01002055#define LOGCHAR(x) do { \
William Lallemand1d705562012-03-12 12:46:41 +01002056 if (tmplog < dst + maxsize - 1) { \
William Lallemandbddd4fd2012-02-27 11:23:10 +01002057 *(tmplog++) = (x); \
2058 } else { \
2059 goto out; \
2060 } \
2061 } while(0)
2062
Dragan Dosen835b9212016-02-12 13:23:03 +01002063
Willy Tarreaub6b3df32018-11-26 16:31:20 +01002064/* Initializes some log data at boot */
2065static void init_log()
Dragan Dosen835b9212016-02-12 13:23:03 +01002066{
2067 char *tmp;
Willy Tarreaue10cd482018-09-10 18:16:53 +02002068 int i;
Dragan Dosen835b9212016-02-12 13:23:03 +01002069
2070 /* Initialize the escape map for the RFC5424 structured-data : '"\]'
2071 * inside PARAM-VALUE should be escaped with '\' as prefix.
2072 * See https://tools.ietf.org/html/rfc5424#section-6.3.3 for more
2073 * details.
2074 */
2075 memset(rfc5424_escape_map, 0, sizeof(rfc5424_escape_map));
2076
2077 tmp = "\"\\]";
2078 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002079 ha_bit_set(*tmp, rfc5424_escape_map);
Dragan Dosen835b9212016-02-12 13:23:03 +01002080 tmp++;
2081 }
Willy Tarreaue10cd482018-09-10 18:16:53 +02002082
2083 /* initialize the log header encoding map : '{|}"#' should be encoded with
2084 * '#' as prefix, as well as non-printable characters ( <32 or >= 127 ).
2085 * URL encoding only requires '"', '#' to be encoded as well as non-
2086 * printable characters above.
2087 */
2088 memset(hdr_encode_map, 0, sizeof(hdr_encode_map));
2089 memset(url_encode_map, 0, sizeof(url_encode_map));
2090 for (i = 0; i < 32; i++) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002091 ha_bit_set(i, hdr_encode_map);
2092 ha_bit_set(i, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02002093 }
2094 for (i = 127; i < 256; i++) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002095 ha_bit_set(i, hdr_encode_map);
2096 ha_bit_set(i, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02002097 }
2098
2099 tmp = "\"#{|}";
2100 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002101 ha_bit_set(*tmp, hdr_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02002102 tmp++;
2103 }
2104
2105 tmp = "\"#";
2106 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002107 ha_bit_set(*tmp, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02002108 tmp++;
2109 }
2110
2111 /* initialize the http header encoding map. The draft httpbis define the
2112 * header content as:
2113 *
2114 * HTTP-message = start-line
2115 * *( header-field CRLF )
2116 * CRLF
2117 * [ message-body ]
2118 * header-field = field-name ":" OWS field-value OWS
2119 * field-value = *( field-content / obs-fold )
2120 * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
2121 * obs-fold = CRLF 1*( SP / HTAB )
2122 * field-vchar = VCHAR / obs-text
2123 * VCHAR = %x21-7E
2124 * obs-text = %x80-FF
2125 *
2126 * All the chars are encoded except "VCHAR", "obs-text", SP and HTAB.
2127 * The encoded chars are form 0x00 to 0x08, 0x0a to 0x1f and 0x7f. The
Joseph Herlant85b40592018-11-15 12:10:04 -08002128 * "obs-fold" is voluntarily forgotten because haproxy remove this.
Willy Tarreaue10cd482018-09-10 18:16:53 +02002129 */
2130 memset(http_encode_map, 0, sizeof(http_encode_map));
2131 for (i = 0x00; i <= 0x08; i++)
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002132 ha_bit_set(i, http_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02002133 for (i = 0x0a; i <= 0x1f; i++)
Willy Tarreau1bfd6022019-06-07 11:10:07 +02002134 ha_bit_set(i, http_encode_map);
2135 ha_bit_set(0x7f, http_encode_map);
Dragan Dosen835b9212016-02-12 13:23:03 +01002136}
William Lallemand1d705562012-03-12 12:46:41 +01002137
Willy Tarreaub6b3df32018-11-26 16:31:20 +01002138INITCALL0(STG_PREPARE, init_log);
2139
Christopher Faulet0132d062017-07-26 15:33:35 +02002140/* Initialize log buffers used for syslog messages */
2141int init_log_buffers()
2142{
Christopher Faulet0132d062017-07-26 15:33:35 +02002143 logline = my_realloc2(logline, global.max_syslog_len + 1);
2144 logline_rfc5424 = my_realloc2(logline_rfc5424, global.max_syslog_len + 1);
Emeric Brun54648852020-07-06 15:54:06 +02002145 if (!logline || !logline_rfc5424)
Christopher Faulet0132d062017-07-26 15:33:35 +02002146 return 0;
2147 return 1;
2148}
2149
2150/* Deinitialize log buffers used for syslog messages */
2151void deinit_log_buffers()
2152{
Christopher Faulet0132d062017-07-26 15:33:35 +02002153 free(logline);
2154 free(logline_rfc5424);
Willy Tarreau869efd52019-11-15 15:16:57 +01002155 ring_free(_HA_ATOMIC_XCHG(&startup_logs, NULL));
Christopher Faulet0132d062017-07-26 15:33:35 +02002156 logline = NULL;
2157 logline_rfc5424 = NULL;
2158}
2159
Willy Tarreaudf974472012-12-28 02:44:01 +01002160/* Builds a log line in <dst> based on <list_format>, and stops before reaching
2161 * <maxsize> characters. Returns the size of the output string in characters,
2162 * not counting the trailing zero which is always added if the resulting size
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002163 * is not zero. It requires a valid session and optionally a stream. If the
2164 * stream is NULL, default values will be assumed for the stream part.
Willy Tarreaudf974472012-12-28 02:44:01 +01002165 */
Willy Tarreau43c538e2018-09-05 14:58:15 +02002166int 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 +02002167{
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02002168 struct proxy *fe = sess->fe;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002169 struct proxy *be;
2170 struct http_txn *txn;
2171 const struct strm_logs *logs;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002172 struct connection *fe_conn, *be_conn;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002173 unsigned int s_flags;
2174 unsigned int uniq_id;
Willy Tarreau83061a82018-07-13 11:56:34 +02002175 struct buffer chunk;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002176 char *uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002177 char *spc;
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002178 char *qmark;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002179 char *end;
Willy Tarreaufe944602007-10-25 10:34:16 +02002180 struct tm tm;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002181 int t_request;
2182 int hdr;
2183 int last_isspace = 1;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002184 int nspaces = 0;
Willy Tarreaub1a2faf2012-03-19 16:51:53 +01002185 char *tmplog;
William Lallemand1d705562012-03-12 12:46:41 +01002186 char *ret;
2187 int iret;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002188 int status;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002189 struct logformat_node *tmp;
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002190 struct timeval tv;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002191 struct strm_logs tmp_strm_log;
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002192 struct ist path;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002193
William Lallemandbddd4fd2012-02-27 11:23:10 +01002194 /* FIXME: let's limit ourselves to frontend logging for now. */
Willy Tarreaubaaee002006-06-26 02:48:02 +02002195
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002196 if (likely(s)) {
2197 be = s->be;
2198 txn = s->txn;
2199 be_conn = cs_conn(objt_cs(s->si[1].end));
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002200 status = (txn ? txn->status : 0);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002201 s_flags = s->flags;
2202 uniq_id = s->uniq_id;
2203 logs = &s->logs;
2204 } else {
2205 /* we have no stream so we first need to initialize a few
2206 * things that are needed later. We do increment the request
2207 * ID so that it's uniquely assigned to this request just as
2208 * if the request had reached the point of being processed.
2209 * A request error is reported as it's the only element we have
2210 * here and which justifies emitting such a log.
2211 */
Christopher Fauletfd818482021-04-14 14:01:41 +02002212 be = ((obj_type(sess->origin) == OBJ_TYPE_CHECK) ? __objt_check(sess->origin)->proxy : fe);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002213 txn = NULL;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002214 fe_conn = objt_conn(sess->origin);
Christopher Fauletfd818482021-04-14 14:01:41 +02002215 be_conn = ((obj_type(sess->origin) == OBJ_TYPE_CHECK) ? cs_conn(__objt_check(sess->origin)->cs) : NULL);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002216 status = 0;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002217 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
Willy Tarreau18515722021-04-06 11:57:41 +02002218 uniq_id = _HA_ATOMIC_FETCH_ADD(&global.req_count, 1);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002219
2220 /* prepare a valid log structure */
2221 tmp_strm_log.tv_accept = sess->tv_accept;
2222 tmp_strm_log.accept_date = sess->accept_date;
2223 tmp_strm_log.t_handshake = sess->t_handshake;
Christopher Fauletdd789212020-09-30 15:10:07 +02002224 tmp_strm_log.t_idle = (sess->t_idle >= 0 ? sess->t_idle : 0);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002225 tv_zero(&tmp_strm_log.tv_request);
2226 tmp_strm_log.t_queue = -1;
2227 tmp_strm_log.t_connect = -1;
2228 tmp_strm_log.t_data = -1;
2229 tmp_strm_log.t_close = tv_ms_elapsed(&sess->tv_accept, &now);
2230 tmp_strm_log.bytes_in = 0;
2231 tmp_strm_log.bytes_out = 0;
2232 tmp_strm_log.prx_queue_pos = 0;
2233 tmp_strm_log.srv_queue_pos = 0;
2234
2235 logs = &tmp_strm_log;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002236
2237 if ((fe->mode == PR_MODE_HTTP) && fe_conn && fe_conn->mux && fe_conn->mux->ctl) {
2238 enum mux_exit_status es = fe_conn->mux->ctl(fe_conn, MUX_EXIT_STATUS, NULL);
2239
2240 switch (es) {
2241 case MUX_ES_SUCCESS:
2242 break;
2243 case MUX_ES_INVALID_ERR:
2244 status = 400;
2245 if ((fe_conn->flags & CO_FL_ERROR) || conn_xprt_read0_pending(fe_conn))
2246 s_flags = SF_ERR_CLICL | SF_FINST_R;
2247 else
2248 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
2249 break;
2250 case MUX_ES_TOUT_ERR:
2251 status = 408;
2252 s_flags = SF_ERR_CLITO | SF_FINST_R;
2253 break;
Christopher Faulet142dd332020-12-07 11:24:37 +01002254 case MUX_ES_NOTIMPL_ERR:
2255 status = 501;
2256 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
2257 break;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002258 case MUX_ES_INTERNAL_ERR:
2259 status = 500;
2260 s_flags = SF_ERR_INTERNAL | SF_FINST_R;
2261 break;
2262 default:
2263 break;
2264 }
2265 }
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002266 }
2267
William Lallemandbddd4fd2012-02-27 11:23:10 +01002268 t_request = -1;
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002269 if (tv_isge(&logs->tv_request, &logs->tv_accept))
2270 t_request = tv_ms_elapsed(&logs->tv_accept, &logs->tv_request);
William Lallemandbddd4fd2012-02-27 11:23:10 +01002271
William Lallemand1d705562012-03-12 12:46:41 +01002272 tmplog = dst;
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +02002273
William Lallemandbddd4fd2012-02-27 11:23:10 +01002274 /* fill logbuffer */
William Lallemand1d705562012-03-12 12:46:41 +01002275 if (LIST_ISEMPTY(list_format))
2276 return 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002277
William Lallemand1d705562012-03-12 12:46:41 +01002278 list_for_each_entry(tmp, list_format, list) {
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002279 struct connection *conn;
Willy Tarreau4f653562012-10-12 19:48:16 +02002280 const char *src = NULL;
Willy Tarreauc8368452012-12-21 00:09:23 +01002281 struct sample *key;
Willy Tarreau83061a82018-07-13 11:56:34 +02002282 const struct buffer empty = { };
William Lallemandbddd4fd2012-02-27 11:23:10 +01002283
Willy Tarreauc8368452012-12-21 00:09:23 +01002284 switch (tmp->type) {
William Lallemand1d705562012-03-12 12:46:41 +01002285 case LOG_FMT_SEPARATOR:
William Lallemandbddd4fd2012-02-27 11:23:10 +01002286 if (!last_isspace) {
2287 LOGCHAR(' ');
2288 last_isspace = 1;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002289 }
2290 break;
2291
William Lallemand1d705562012-03-12 12:46:41 +01002292 case LOG_FMT_TEXT: // text
William Lallemandbddd4fd2012-02-27 11:23:10 +01002293 src = tmp->arg;
William Lallemand5f232402012-04-05 18:02:55 +02002294 iret = strlcpy2(tmplog, src, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002295 if (iret == 0)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002296 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002297 tmplog += iret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002298 last_isspace = 0;
2299 break;
2300
Willy Tarreauc8368452012-12-21 00:09:23 +01002301 case LOG_FMT_EXPR: // sample expression, may be request or response
2302 key = NULL;
Christopher Faulet5f940702020-04-06 10:40:02 +02002303 if (tmp->options & LOG_OPT_REQ_CAP)
Adis Nezirovic79beb242015-07-06 15:41:02 +02002304 key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_REQ|SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
Christopher Faulet5f940702020-04-06 10:40:02 +02002305 if (!key && (tmp->options & LOG_OPT_RES_CAP))
Adis Nezirovic79beb242015-07-06 15:41:02 +02002306 key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_RES|SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
Thierry FOURNIERd048d8b2014-03-13 16:46:18 +01002307 if (tmp->options & LOG_OPT_HTTP)
Dragan Dosen835b9212016-02-12 13:23:03 +01002308 ret = lf_encode_chunk(tmplog, dst + maxsize,
2309 '%', http_encode_map, key ? &key->data.u.str : &empty, tmp);
Thierry FOURNIERd048d8b2014-03-13 16:46:18 +01002310 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002311 ret = lf_text_len(tmplog,
2312 key ? key->data.u.str.area : NULL,
2313 key ? key->data.u.str.data : 0,
2314 dst + maxsize - tmplog,
2315 tmp);
Willy Tarreauc8368452012-12-21 00:09:23 +01002316 if (ret == 0)
2317 goto out;
2318 tmplog = ret;
2319 last_isspace = 0;
2320 break;
2321
Willy Tarreau2beef582012-12-20 17:22:52 +01002322 case LOG_FMT_CLIENTIP: // %ci
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002323 conn = objt_conn(sess->origin);
Willy Tarreau8fa99842019-07-17 11:47:11 +02002324 if (conn && conn_get_src(conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002325 ret = lf_ip(tmplog, (struct sockaddr *)conn->src, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002326 else
2327 ret = lf_text_len(tmplog, NULL, 0, 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 Lallemandbddd4fd2012-02-27 11:23:10 +01002331 last_isspace = 0;
2332 break;
2333
Willy Tarreau2beef582012-12-20 17:22:52 +01002334 case LOG_FMT_CLIENTPORT: // %cp
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002335 conn = objt_conn(sess->origin);
Willy Tarreau8fa99842019-07-17 11:47:11 +02002336 if (conn && conn_get_src(conn)) {
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002337 if (conn->src->ss_family == AF_UNIX) {
Willy Tarreaufb0afa72015-04-03 14:46:27 +02002338 ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002339 } else {
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002340 ret = lf_port(tmplog, (struct sockaddr *)conn->src,
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002341 dst + maxsize - tmplog, tmp);
2342 }
William Lallemand5f232402012-04-05 18:02:55 +02002343 }
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002344 else
2345 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2346
William Lallemand5f232402012-04-05 18:02:55 +02002347 if (ret == NULL)
2348 goto out;
2349 tmplog = ret;
2350 last_isspace = 0;
2351 break;
2352
Willy Tarreau2beef582012-12-20 17:22:52 +01002353 case LOG_FMT_FRONTENDIP: // %fi
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002354 conn = objt_conn(sess->origin);
Willy Tarreau8fa99842019-07-17 11:47:11 +02002355 if (conn && conn_get_dst(conn)) {
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002356 ret = lf_ip(tmplog, (struct sockaddr *)conn->dst, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002357 }
2358 else
2359 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2360
William Lallemand1d705562012-03-12 12:46:41 +01002361 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002362 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002363 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002364 last_isspace = 0;
2365 break;
2366
Willy Tarreau2beef582012-12-20 17:22:52 +01002367 case LOG_FMT_FRONTENDPORT: // %fp
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002368 conn = objt_conn(sess->origin);
Willy Tarreau8fa99842019-07-17 11:47:11 +02002369 if (conn && conn_get_dst(conn)) {
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002370 if (conn->dst->ss_family == AF_UNIX)
Willy Tarreaufb0afa72015-04-03 14:46:27 +02002371 ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002372 else
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002373 ret = lf_port(tmplog, (struct sockaddr *)conn->dst, dst + maxsize - tmplog, tmp);
William Lallemand5f232402012-04-05 18:02:55 +02002374 }
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002375 else
2376 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2377
William Lallemand5f232402012-04-05 18:02:55 +02002378 if (ret == NULL)
2379 goto out;
2380 tmplog = ret;
2381 last_isspace = 0;
2382 break;
2383
Willy Tarreau2beef582012-12-20 17:22:52 +01002384 case LOG_FMT_BACKENDIP: // %bi
Willy Tarreau8fa99842019-07-17 11:47:11 +02002385 if (be_conn && conn_get_src(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002386 ret = lf_ip(tmplog, (const struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002387 else
2388 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2389
William Lallemand1d705562012-03-12 12:46:41 +01002390 if (ret == NULL)
William Lallemandb7ff6a32012-03-02 14:35:21 +01002391 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002392 tmplog = ret;
William Lallemandb7ff6a32012-03-02 14:35:21 +01002393 last_isspace = 0;
2394 break;
2395
Willy Tarreau2beef582012-12-20 17:22:52 +01002396 case LOG_FMT_BACKENDPORT: // %bp
Willy Tarreau8fa99842019-07-17 11:47:11 +02002397 if (be_conn && conn_get_src(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002398 ret = lf_port(tmplog, (struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002399 else
2400 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2401
William Lallemand5f232402012-04-05 18:02:55 +02002402 if (ret == NULL)
2403 goto out;
2404 tmplog = ret;
2405 last_isspace = 0;
2406 break;
2407
Willy Tarreau2beef582012-12-20 17:22:52 +01002408 case LOG_FMT_SERVERIP: // %si
Willy Tarreau8fa99842019-07-17 11:47:11 +02002409 if (be_conn && conn_get_dst(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002410 ret = lf_ip(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002411 else
2412 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2413
William Lallemand5f232402012-04-05 18:02:55 +02002414 if (ret == NULL)
2415 goto out;
2416 tmplog = ret;
2417 last_isspace = 0;
2418 break;
2419
Willy Tarreau2beef582012-12-20 17:22:52 +01002420 case LOG_FMT_SERVERPORT: // %sp
Willy Tarreau8fa99842019-07-17 11:47:11 +02002421 if (be_conn && conn_get_dst(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002422 ret = lf_port(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002423 else
2424 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2425
William Lallemand1d705562012-03-12 12:46:41 +01002426 if (ret == NULL)
William Lallemandb7ff6a32012-03-02 14:35:21 +01002427 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002428 tmplog = ret;
William Lallemandb7ff6a32012-03-02 14:35:21 +01002429 last_isspace = 0;
2430 break;
2431
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002432 case LOG_FMT_DATE: // %t = accept date
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002433 get_localtime(logs->accept_date.tv_sec, &tm);
2434 ret = date2str_log(tmplog, &tm, &logs->accept_date, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002435 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002436 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002437 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002438 last_isspace = 0;
2439 break;
2440
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002441 case LOG_FMT_tr: // %tr = start of request date
2442 /* Note that the timers are valid if we get here */
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002443 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 +02002444 get_localtime(tv.tv_sec, &tm);
2445 ret = date2str_log(tmplog, &tm, &tv, dst + maxsize - tmplog);
2446 if (ret == NULL)
2447 goto out;
2448 tmplog = ret;
2449 last_isspace = 0;
2450 break;
2451
2452 case LOG_FMT_DATEGMT: // %T = accept date, GMT
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002453 get_gmtime(logs->accept_date.tv_sec, &tm);
William Lallemand5f232402012-04-05 18:02:55 +02002454 ret = gmt2str_log(tmplog, &tm, 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_trg: // %trg = start of request date, GMT
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002462 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 +02002463 get_gmtime(tv.tv_sec, &tm);
2464 ret = gmt2str_log(tmplog, &tm, dst + maxsize - tmplog);
2465 if (ret == NULL)
2466 goto out;
2467 tmplog = ret;
2468 last_isspace = 0;
2469 break;
2470
2471 case LOG_FMT_DATELOCAL: // %Tl = accept date, local
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002472 get_localtime(logs->accept_date.tv_sec, &tm);
2473 ret = localdate2str_log(tmplog, logs->accept_date.tv_sec, &tm, dst + maxsize - tmplog);
Yuxans Yao4e25b012012-10-19 10:36:09 +08002474 if (ret == NULL)
2475 goto out;
2476 tmplog = ret;
2477 last_isspace = 0;
2478 break;
2479
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002480 case LOG_FMT_trl: // %trl = start of request date, local
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002481 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 +02002482 get_localtime(tv.tv_sec, &tm);
2483 ret = localdate2str_log(tmplog, tv.tv_sec, &tm, dst + maxsize - tmplog);
2484 if (ret == NULL)
2485 goto out;
2486 tmplog = ret;
2487 last_isspace = 0;
2488 break;
2489
William Lallemand5f232402012-04-05 18:02:55 +02002490 case LOG_FMT_TS: // %Ts
William Lallemand5f232402012-04-05 18:02:55 +02002491 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002492 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", (unsigned int)logs->accept_date.tv_sec);
William Lallemand5f232402012-04-05 18:02:55 +02002493 if (iret < 0 || iret > dst + maxsize - tmplog)
2494 goto out;
2495 last_isspace = 0;
2496 tmplog += iret;
2497 } else {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002498 ret = ltoa_o(logs->accept_date.tv_sec, tmplog, dst + maxsize - tmplog);
William Lallemand5f232402012-04-05 18:02:55 +02002499 if (ret == NULL)
2500 goto out;
2501 tmplog = ret;
2502 last_isspace = 0;
2503 }
2504 break;
2505
William Lallemand1d705562012-03-12 12:46:41 +01002506 case LOG_FMT_MS: // %ms
William Lallemand5f232402012-04-05 18:02:55 +02002507 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002508 iret = snprintf(tmplog, dst + maxsize - tmplog, "%02X",(unsigned int)logs->accept_date.tv_usec/1000);
William Lallemand5f232402012-04-05 18:02:55 +02002509 if (iret < 0 || iret > dst + maxsize - tmplog)
2510 goto out;
2511 last_isspace = 0;
2512 tmplog += iret;
2513 } else {
2514 if ((dst + maxsize - tmplog) < 4)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002515 goto out;
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002516 ret = utoa_pad((unsigned int)logs->accept_date.tv_usec/1000,
Willy Tarreau9e60cd82013-01-24 01:18:16 +01002517 tmplog, 4);
2518 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002519 goto out;
Willy Tarreau9e60cd82013-01-24 01:18:16 +01002520 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002521 last_isspace = 0;
William Lallemand5f232402012-04-05 18:02:55 +02002522 }
2523 break;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002524
William Lallemand1d705562012-03-12 12:46:41 +01002525 case LOG_FMT_FRONTEND: // %f
William Lallemandbddd4fd2012-02-27 11:23:10 +01002526 src = fe->id;
William Lallemand5f232402012-04-05 18:02:55 +02002527 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002528 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002529 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002530 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002531 last_isspace = 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002532 break;
2533
Willy Tarreau773d65f2012-10-12 14:56:11 +02002534 case LOG_FMT_FRONTEND_XPRT: // %ft
2535 src = fe->id;
2536 if (tmp->options & LOG_OPT_QUOTE)
2537 LOGCHAR('"');
2538 iret = strlcpy2(tmplog, src, dst + maxsize - tmplog);
2539 if (iret == 0)
2540 goto out;
2541 tmplog += iret;
Christopher Fauletfd818482021-04-14 14:01:41 +02002542 if (sess->listener && sess->listener->bind_conf->xprt == xprt_get(XPRT_SSL))
Willy Tarreau773d65f2012-10-12 14:56:11 +02002543 LOGCHAR('~');
Willy Tarreau773d65f2012-10-12 14:56:11 +02002544 if (tmp->options & LOG_OPT_QUOTE)
2545 LOGCHAR('"');
2546 last_isspace = 0;
2547 break;
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002548#ifdef USE_OPENSSL
2549 case LOG_FMT_SSL_CIPHER: // %sslc
2550 src = NULL;
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002551 conn = objt_conn(sess->origin);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002552 if (conn) {
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02002553 src = ssl_sock_get_cipher_name(conn);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002554 }
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002555 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
2556 if (ret == NULL)
2557 goto out;
2558 tmplog = ret;
2559 last_isspace = 0;
2560 break;
Willy Tarreau773d65f2012-10-12 14:56:11 +02002561
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002562 case LOG_FMT_SSL_VERSION: // %sslv
2563 src = NULL;
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002564 conn = objt_conn(sess->origin);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002565 if (conn) {
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02002566 src = ssl_sock_get_proto_version(conn);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002567 }
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002568 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
2569 if (ret == NULL)
2570 goto out;
2571 tmplog = ret;
2572 last_isspace = 0;
2573 break;
2574#endif
William Lallemand1d705562012-03-12 12:46:41 +01002575 case LOG_FMT_BACKEND: // %b
William Lallemandbddd4fd2012-02-27 11:23:10 +01002576 src = be->id;
William Lallemand5f232402012-04-05 18:02:55 +02002577 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002578 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002579 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002580 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002581 last_isspace = 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002582 break;
2583
William Lallemand1d705562012-03-12 12:46:41 +01002584 case LOG_FMT_SERVER: // %s
Christopher Fauletfd818482021-04-14 14:01:41 +02002585 switch (obj_type(s ? s->target : sess->origin)) {
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002586 case OBJ_TYPE_SERVER:
Willy Tarreau1aaf3242018-09-20 11:13:58 +02002587 src = __objt_server(s->target)->id;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002588 break;
2589 case OBJ_TYPE_APPLET:
Willy Tarreau1aaf3242018-09-20 11:13:58 +02002590 src = __objt_applet(s->target)->name;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002591 break;
Christopher Fauletfd818482021-04-14 14:01:41 +02002592 case OBJ_TYPE_CHECK:
2593 src = (__objt_check(sess->origin)->server
2594 ? __objt_check(sess->origin)->server->id
2595 : "<NOSRV>");
2596 break;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002597 default:
2598 src = "<NOSRV>";
2599 break;
2600 }
William Lallemand5f232402012-04-05 18:02:55 +02002601 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002602 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002603 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002604 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002605 last_isspace = 0;
2606 break;
2607
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002608 case LOG_FMT_Th: // %Th = handshake time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002609 ret = ltoa_o(logs->t_handshake, tmplog, dst + maxsize - tmplog);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002610 if (ret == NULL)
2611 goto out;
2612 tmplog = ret;
2613 last_isspace = 0;
2614 break;
2615
2616 case LOG_FMT_Ti: // %Ti = HTTP idle time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002617 ret = ltoa_o(logs->t_idle, tmplog, dst + maxsize - tmplog);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002618 if (ret == NULL)
2619 goto out;
2620 tmplog = ret;
2621 last_isspace = 0;
2622 break;
2623
2624 case LOG_FMT_TR: // %TR = HTTP request time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002625 ret = ltoa_o((t_request >= 0) ? t_request - logs->t_idle - logs->t_handshake : -1,
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002626 tmplog, dst + maxsize - tmplog);
2627 if (ret == NULL)
2628 goto out;
2629 tmplog = ret;
2630 last_isspace = 0;
2631 break;
2632
2633 case LOG_FMT_TQ: // %Tq = Th + Ti + TR
William Lallemand5f232402012-04-05 18:02:55 +02002634 ret = ltoa_o(t_request, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002635 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002636 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002637 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002638 last_isspace = 0;
2639 break;
2640
William Lallemand1d705562012-03-12 12:46:41 +01002641 case LOG_FMT_TW: // %Tw
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002642 ret = ltoa_o((logs->t_queue >= 0) ? logs->t_queue - t_request : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002643 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002644 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002645 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002646 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002647 last_isspace = 0;
2648 break;
2649
William Lallemand1d705562012-03-12 12:46:41 +01002650 case LOG_FMT_TC: // %Tc
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002651 ret = ltoa_o((logs->t_connect >= 0) ? logs->t_connect - logs->t_queue : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002652 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002653 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002654 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002655 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002656 last_isspace = 0;
2657 break;
2658
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002659 case LOG_FMT_Tr: // %Tr
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002660 ret = ltoa_o((logs->t_data >= 0) ? logs->t_data - logs->t_connect : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002661 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002662 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002663 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002664 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002665 last_isspace = 0;
2666 break;
2667
Willy Tarreau27b639d2016-05-17 17:55:27 +02002668 case LOG_FMT_TD: // %Td
Willy Tarreaua21c0e62018-09-05 15:07:15 +02002669 if (be->mode == PR_MODE_HTTP)
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002670 ret = ltoa_o((logs->t_data >= 0) ? logs->t_close - logs->t_data : -1,
Willy Tarreau27b639d2016-05-17 17:55:27 +02002671 tmplog, dst + maxsize - tmplog);
2672 else
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002673 ret = ltoa_o((logs->t_connect >= 0) ? logs->t_close - logs->t_connect : -1,
Willy Tarreau27b639d2016-05-17 17:55:27 +02002674 tmplog, dst + maxsize - tmplog);
2675 if (ret == NULL)
2676 goto out;
2677 tmplog = ret;
2678 last_isspace = 0;
2679 break;
2680
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002681 case LOG_FMT_Ta: // %Ta = active time = Tt - Th - Ti
2682 if (!(fe->to_log & LW_BYTES))
2683 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002684 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 +02002685 tmplog, dst + maxsize - tmplog);
2686 if (ret == NULL)
2687 goto out;
2688 tmplog = ret;
2689 last_isspace = 0;
2690 break;
2691
2692 case LOG_FMT_TT: // %Tt = total time
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002693 if (!(fe->to_log & LW_BYTES))
William Lallemand1d705562012-03-12 12:46:41 +01002694 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002695 ret = ltoa_o(logs->t_close, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002696 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002697 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002698 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002699 last_isspace = 0;
2700 break;
2701
Damien Claisse57c8eb92020-04-28 12:09:19 +00002702 case LOG_FMT_TU: // %Tu = total time seen by user = Tt - Ti
2703 if (!(fe->to_log & LW_BYTES))
2704 LOGCHAR('+');
2705 ret = ltoa_o(logs->t_close - (logs->t_idle >= 0 ? logs->t_idle : 0),
2706 tmplog, dst + maxsize - tmplog);
2707 if (ret == NULL)
2708 goto out;
2709 tmplog = ret;
2710 last_isspace = 0;
2711 break;
2712
Willy Tarreau2beef582012-12-20 17:22:52 +01002713 case LOG_FMT_STATUS: // %ST
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002714 ret = ltoa_o(status, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002715 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002716 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002717 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002718 last_isspace = 0;
2719 break;
2720
William Lallemand1d705562012-03-12 12:46:41 +01002721 case LOG_FMT_BYTES: // %B
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002722 if (!(fe->to_log & LW_BYTES))
William Lallemand1d705562012-03-12 12:46:41 +01002723 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002724 ret = lltoa(logs->bytes_out, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002725 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002726 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002727 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002728 last_isspace = 0;
2729 break;
2730
Willy Tarreauc5259fd2012-12-20 15:38:04 +01002731 case LOG_FMT_BYTES_UP: // %U
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002732 ret = lltoa(logs->bytes_in, tmplog, dst + maxsize - tmplog);
Willy Tarreauc5259fd2012-12-20 15:38:04 +01002733 if (ret == NULL)
2734 goto out;
2735 tmplog = ret;
2736 last_isspace = 0;
2737 break;
2738
Willy Tarreau2beef582012-12-20 17:22:52 +01002739 case LOG_FMT_CCLIENT: // %CC
Willy Tarreau57bc8912016-04-25 17:09:40 +02002740 src = txn ? txn->cli_cookie : NULL;
William Lallemand5f232402012-04-05 18:02:55 +02002741 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002742 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002743 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002744 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002745 last_isspace = 0;
2746 break;
2747
Willy Tarreau2beef582012-12-20 17:22:52 +01002748 case LOG_FMT_CSERVER: // %CS
Willy Tarreau57bc8912016-04-25 17:09:40 +02002749 src = txn ? txn->srv_cookie : NULL;
William Lallemand5f232402012-04-05 18:02:55 +02002750 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002751 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002752 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002753 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002754 last_isspace = 0;
2755 break;
2756
William Lallemand1d705562012-03-12 12:46:41 +01002757 case LOG_FMT_TERMSTATE: // %ts
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002758 LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]);
2759 LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]);
Willy Tarreau6580c062012-03-12 15:09:42 +01002760 *tmplog = '\0';
2761 last_isspace = 0;
2762 break;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002763
William Lallemand1d705562012-03-12 12:46:41 +01002764 case LOG_FMT_TERMSTATE_CK: // %tsc, same as TS with cookie state (for mode HTTP)
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002765 LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]);
2766 LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]);
Willy Tarreau57bc8912016-04-25 17:09:40 +02002767 LOGCHAR((txn && (be->ck_opts & PR_CK_ANY)) ? sess_cookie[(txn->flags & TX_CK_MASK) >> TX_CK_SHIFT] : '-');
2768 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 +01002769 last_isspace = 0;
2770 break;
2771
William Lallemand1d705562012-03-12 12:46:41 +01002772 case LOG_FMT_ACTCONN: // %ac
William Lallemand5f232402012-04-05 18:02:55 +02002773 ret = ltoa_o(actconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002774 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002775 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002776 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002777 last_isspace = 0;
2778 break;
2779
William Lallemand1d705562012-03-12 12:46:41 +01002780 case LOG_FMT_FECONN: // %fc
William Lallemand5f232402012-04-05 18:02:55 +02002781 ret = ltoa_o(fe->feconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002782 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002783 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002784 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002785 last_isspace = 0;
2786 break;
2787
William Lallemand1d705562012-03-12 12:46:41 +01002788 case LOG_FMT_BECONN: // %bc
William Lallemand5f232402012-04-05 18:02:55 +02002789 ret = ltoa_o(be->beconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002790 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002791 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002792 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002793 last_isspace = 0;
2794 break;
2795
William Lallemand1d705562012-03-12 12:46:41 +01002796 case LOG_FMT_SRVCONN: // %sc
Christopher Fauletfd818482021-04-14 14:01:41 +02002797 switch (obj_type(s ? s->target : sess->origin)) {
2798 case OBJ_TYPE_SERVER:
2799 ret = ultoa_o(__objt_server(s->target)->cur_sess,
2800 tmplog, dst + maxsize - tmplog);
2801 break;
2802 case OBJ_TYPE_CHECK:
2803 ret = ultoa_o(__objt_check(sess->origin)->server
2804 ? __objt_check(sess->origin)->server->cur_sess
2805 : 0, tmplog, dst + maxsize - tmplog);
2806 break;
2807 default:
2808 ret = ultoa_o(0, tmplog, dst + maxsize - tmplog);
2809 break;
2810 }
2811
William Lallemand1d705562012-03-12 12:46:41 +01002812 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002813 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002814 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002815 last_isspace = 0;
2816 break;
2817
William Lallemand1d705562012-03-12 12:46:41 +01002818 case LOG_FMT_RETRIES: // %rq
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002819 if (s_flags & SF_REDISP)
William Lallemand1d705562012-03-12 12:46:41 +01002820 LOGCHAR('+');
Christopher Faulet1d26f222021-04-16 11:24:20 +02002821 ret = ltoa_o(((s && s->si[1].conn_retries > 0)
2822 ? (be->conn_retries - s->si[1].conn_retries)
2823 : ((s && s->si[1].state != SI_ST_INI) ? be->conn_retries : 0)),
2824 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002825 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002826 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002827 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002828 last_isspace = 0;
2829 break;
2830
William Lallemand1d705562012-03-12 12:46:41 +01002831 case LOG_FMT_SRVQUEUE: // %sq
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002832 ret = ltoa_o(logs->srv_queue_pos, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002833 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002834 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002835 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002836 last_isspace = 0;
2837 break;
2838
William Lallemand1d705562012-03-12 12:46:41 +01002839 case LOG_FMT_BCKQUEUE: // %bq
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002840 ret = ltoa_o(logs->prx_queue_pos, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002841 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002842 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002843 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002844 last_isspace = 0;
2845 break;
2846
William Lallemand1d705562012-03-12 12:46:41 +01002847 case LOG_FMT_HDRREQUEST: // %hr
William Lallemandbddd4fd2012-02-27 11:23:10 +01002848 /* request header */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002849 if (fe->nb_req_cap && s && s->req_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002850 if (tmp->options & LOG_OPT_QUOTE)
2851 LOGCHAR('"');
2852 LOGCHAR('{');
2853 for (hdr = 0; hdr < fe->nb_req_cap; hdr++) {
2854 if (hdr)
2855 LOGCHAR('|');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002856 if (s->req_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002857 ret = lf_encode_string(tmplog, dst + maxsize,
2858 '#', hdr_encode_map, s->req_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002859 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002860 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002861 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002862 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002863 }
2864 LOGCHAR('}');
William Lallemand51b5dca2012-03-26 17:52:55 +02002865 if (tmp->options & LOG_OPT_QUOTE)
2866 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002867 last_isspace = 0;
2868 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002869 break;
2870
William Lallemand1d705562012-03-12 12:46:41 +01002871 case LOG_FMT_HDRREQUESTLIST: // %hrl
William Lallemandbddd4fd2012-02-27 11:23:10 +01002872 /* request header list */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002873 if (fe->nb_req_cap && s && s->req_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002874 for (hdr = 0; hdr < fe->nb_req_cap; hdr++) {
2875 if (hdr > 0)
2876 LOGCHAR(' ');
2877 if (tmp->options & LOG_OPT_QUOTE)
2878 LOGCHAR('"');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002879 if (s->req_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002880 ret = lf_encode_string(tmplog, dst + maxsize,
2881 '#', hdr_encode_map, s->req_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002882 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002883 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002884 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002885 } else if (!(tmp->options & LOG_OPT_QUOTE))
2886 LOGCHAR('-');
2887 if (tmp->options & LOG_OPT_QUOTE)
2888 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002889 last_isspace = 0;
2890 }
2891 }
2892 break;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002893
William Lallemand1d705562012-03-12 12:46:41 +01002894
2895 case LOG_FMT_HDRRESPONS: // %hs
William Lallemandbddd4fd2012-02-27 11:23:10 +01002896 /* response header */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002897 if (fe->nb_rsp_cap && s && s->res_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002898 if (tmp->options & LOG_OPT_QUOTE)
2899 LOGCHAR('"');
2900 LOGCHAR('{');
2901 for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) {
2902 if (hdr)
2903 LOGCHAR('|');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002904 if (s->res_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002905 ret = lf_encode_string(tmplog, dst + maxsize,
2906 '#', hdr_encode_map, s->res_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002907 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002908 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002909 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002910 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002911 }
2912 LOGCHAR('}');
2913 last_isspace = 0;
2914 if (tmp->options & LOG_OPT_QUOTE)
2915 LOGCHAR('"');
2916 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002917 break;
2918
William Lallemand1d705562012-03-12 12:46:41 +01002919 case LOG_FMT_HDRRESPONSLIST: // %hsl
William Lallemandbddd4fd2012-02-27 11:23:10 +01002920 /* response header list */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002921 if (fe->nb_rsp_cap && s && s->res_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002922 for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) {
2923 if (hdr > 0)
2924 LOGCHAR(' ');
2925 if (tmp->options & LOG_OPT_QUOTE)
2926 LOGCHAR('"');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002927 if (s->res_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002928 ret = lf_encode_string(tmplog, dst + maxsize,
2929 '#', hdr_encode_map, s->res_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002930 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002931 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002932 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002933 } else if (!(tmp->options & LOG_OPT_QUOTE))
2934 LOGCHAR('-');
2935 if (tmp->options & LOG_OPT_QUOTE)
2936 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002937 last_isspace = 0;
2938 }
2939 }
2940 break;
2941
William Lallemand1d705562012-03-12 12:46:41 +01002942 case LOG_FMT_REQ: // %r
William Lallemandbddd4fd2012-02-27 11:23:10 +01002943 /* Request */
2944 if (tmp->options & LOG_OPT_QUOTE)
2945 LOGCHAR('"');
Willy Tarreau57bc8912016-04-25 17:09:40 +02002946 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Dragan Dosen835b9212016-02-12 13:23:03 +01002947 ret = lf_encode_string(tmplog, dst + maxsize,
2948 '#', url_encode_map, uri, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002949 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002950 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002951 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002952 if (tmp->options & LOG_OPT_QUOTE)
2953 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002954 last_isspace = 0;
2955 break;
William Lallemand5f232402012-04-05 18:02:55 +02002956
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002957 case LOG_FMT_HTTP_PATH: // %HP
Willy Tarreau57bc8912016-04-25 17:09:40 +02002958 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002959
Willy Tarreaub7636d12015-06-17 19:58:02 +02002960 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002961 LOGCHAR('"');
2962
2963 end = uri + strlen(uri);
2964 // look for the first whitespace character
2965 while (uri < end && !HTTP_IS_SPHT(*uri))
2966 uri++;
2967
2968 // keep advancing past multiple spaces
2969 while (uri < end && HTTP_IS_SPHT(*uri)) {
2970 uri++; nspaces++;
2971 }
2972
2973 // look for first space or question mark after url
2974 spc = uri;
2975 while (spc < end && *spc != '?' && !HTTP_IS_SPHT(*spc))
2976 spc++;
2977
Nenad Merdanovic54e439f2016-04-26 01:39:02 +02002978 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002979 chunk.area = "<BADREQ>";
2980 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002981 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002982 chunk.area = uri;
2983 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002984 }
2985
Dragan Dosen835b9212016-02-12 13:23:03 +01002986 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002987 if (ret == NULL || *ret != '\0')
2988 goto out;
2989
2990 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002991 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002992 LOGCHAR('"');
2993
2994 last_isspace = 0;
2995 break;
2996
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002997 case LOG_FMT_HTTP_PATH_ONLY: // %HPO
2998 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
2999
3000 if (tmp->options & LOG_OPT_QUOTE)
3001 LOGCHAR('"');
3002
3003 end = uri + strlen(uri);
3004
3005 // look for the first whitespace character
3006 while (uri < end && !HTTP_IS_SPHT(*uri))
3007 uri++;
3008
3009 // keep advancing past multiple spaces
3010 while (uri < end && HTTP_IS_SPHT(*uri)) {
3011 uri++; nspaces++;
3012 }
3013
3014 // look for first space after url
3015 spc = uri;
3016 while (spc < end && !HTTP_IS_SPHT(*spc))
3017 spc++;
3018
Tim Duesterhus92c696e2021-02-28 16:11:36 +01003019 path = ist2(uri, spc - uri);
Maciej Zdebfcdfd852020-11-30 18:27:47 +00003020
3021 // extract relative path without query params from url
3022 path = iststop(http_get_path(path), '?');
3023 if (!txn || !txn->uri || nspaces == 0) {
3024 chunk.area = "<BADREQ>";
3025 chunk.data = strlen("<BADREQ>");
3026 } else {
3027 chunk.area = path.ptr;
3028 chunk.data = path.len;
3029 }
3030
3031 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
3032 if (ret == NULL || *ret != '\0')
3033 goto out;
3034
3035 tmplog = ret;
3036 if (tmp->options & LOG_OPT_QUOTE)
3037 LOGCHAR('"');
3038
3039 last_isspace = 0;
3040 break;
3041
Andrew Hayworthe63ac872015-07-31 16:14:16 +00003042 case LOG_FMT_HTTP_QUERY: // %HQ
3043 if (tmp->options & LOG_OPT_QUOTE)
3044 LOGCHAR('"');
3045
Willy Tarreau57bc8912016-04-25 17:09:40 +02003046 if (!txn || !txn->uri) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003047 chunk.area = "<BADREQ>";
3048 chunk.data = strlen("<BADREQ>");
Andrew Hayworthe63ac872015-07-31 16:14:16 +00003049 } else {
3050 uri = txn->uri;
3051 end = uri + strlen(uri);
3052 // look for the first question mark
3053 while (uri < end && *uri != '?')
3054 uri++;
3055
3056 qmark = uri;
3057 // look for first space or question mark after url
3058 while (uri < end && !HTTP_IS_SPHT(*uri))
3059 uri++;
3060
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003061 chunk.area = qmark;
3062 chunk.data = uri - qmark;
Andrew Hayworthe63ac872015-07-31 16:14:16 +00003063 }
3064
Dragan Dosen835b9212016-02-12 13:23:03 +01003065 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworthe63ac872015-07-31 16:14:16 +00003066 if (ret == NULL || *ret != '\0')
3067 goto out;
3068
3069 tmplog = ret;
3070 if (tmp->options & LOG_OPT_QUOTE)
3071 LOGCHAR('"');
3072
3073 last_isspace = 0;
3074 break;
3075
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003076 case LOG_FMT_HTTP_URI: // %HU
Willy Tarreau57bc8912016-04-25 17:09:40 +02003077 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003078
Willy Tarreaub7636d12015-06-17 19:58:02 +02003079 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003080 LOGCHAR('"');
3081
3082 end = uri + strlen(uri);
3083 // look for the first whitespace character
3084 while (uri < end && !HTTP_IS_SPHT(*uri))
3085 uri++;
3086
3087 // keep advancing past multiple spaces
3088 while (uri < end && HTTP_IS_SPHT(*uri)) {
3089 uri++; nspaces++;
3090 }
3091
3092 // look for first space after url
3093 spc = uri;
3094 while (spc < end && !HTTP_IS_SPHT(*spc))
3095 spc++;
3096
Willy Tarreau57bc8912016-04-25 17:09:40 +02003097 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003098 chunk.area = "<BADREQ>";
3099 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003100 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003101 chunk.area = uri;
3102 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003103 }
3104
Dragan Dosen835b9212016-02-12 13:23:03 +01003105 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003106 if (ret == NULL || *ret != '\0')
3107 goto out;
3108
3109 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02003110 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003111 LOGCHAR('"');
3112
3113 last_isspace = 0;
3114 break;
3115
3116 case LOG_FMT_HTTP_METHOD: // %HM
Willy Tarreau57bc8912016-04-25 17:09:40 +02003117 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Willy Tarreaub7636d12015-06-17 19:58:02 +02003118 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003119 LOGCHAR('"');
3120
3121 end = uri + strlen(uri);
3122 // look for the first whitespace character
3123 spc = uri;
3124 while (spc < end && !HTTP_IS_SPHT(*spc))
3125 spc++;
3126
3127 if (spc == end) { // odd case, we have txn->uri, but we only got a verb
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003128 chunk.area = "<BADREQ>";
3129 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003130 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003131 chunk.area = uri;
3132 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003133 }
3134
Dragan Dosen835b9212016-02-12 13:23:03 +01003135 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003136 if (ret == NULL || *ret != '\0')
3137 goto out;
3138
3139 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02003140 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003141 LOGCHAR('"');
3142
3143 last_isspace = 0;
3144 break;
3145
3146 case LOG_FMT_HTTP_VERSION: // %HV
Willy Tarreau57bc8912016-04-25 17:09:40 +02003147 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Willy Tarreaub7636d12015-06-17 19:58:02 +02003148 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003149 LOGCHAR('"');
3150
3151 end = uri + strlen(uri);
3152 // look for the first whitespace character
3153 while (uri < end && !HTTP_IS_SPHT(*uri))
3154 uri++;
3155
3156 // keep advancing past multiple spaces
3157 while (uri < end && HTTP_IS_SPHT(*uri)) {
3158 uri++; nspaces++;
3159 }
3160
3161 // look for the next whitespace character
3162 while (uri < end && !HTTP_IS_SPHT(*uri))
3163 uri++;
3164
3165 // keep advancing past multiple spaces
3166 while (uri < end && HTTP_IS_SPHT(*uri))
3167 uri++;
3168
Willy Tarreau57bc8912016-04-25 17:09:40 +02003169 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003170 chunk.area = "<BADREQ>";
3171 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003172 } else if (uri == end) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003173 chunk.area = "HTTP/0.9";
3174 chunk.data = strlen("HTTP/0.9");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003175 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02003176 chunk.area = uri;
3177 chunk.data = end - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003178 }
3179
Dragan Dosen835b9212016-02-12 13:23:03 +01003180 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003181 if (ret == NULL || *ret != '\0')
3182 goto out;
3183
3184 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02003185 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00003186 LOGCHAR('"');
3187
3188 last_isspace = 0;
3189 break;
3190
William Lallemand5f232402012-04-05 18:02:55 +02003191 case LOG_FMT_COUNTER: // %rt
3192 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau5cacab62018-09-05 15:52:59 +02003193 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", uniq_id);
William Lallemand5f232402012-04-05 18:02:55 +02003194 if (iret < 0 || iret > dst + maxsize - tmplog)
3195 goto out;
3196 last_isspace = 0;
3197 tmplog += iret;
3198 } else {
Willy Tarreau5cacab62018-09-05 15:52:59 +02003199 ret = ltoa_o(uniq_id, tmplog, dst + maxsize - tmplog);
William Lallemand5f232402012-04-05 18:02:55 +02003200 if (ret == NULL)
3201 goto out;
3202 tmplog = ret;
3203 last_isspace = 0;
3204 }
3205 break;
3206
Willy Tarreau7346acb2014-08-28 15:03:15 +02003207 case LOG_FMT_LOGCNT: // %lc
3208 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003209 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", fe->log_count);
Willy Tarreau7346acb2014-08-28 15:03:15 +02003210 if (iret < 0 || iret > dst + maxsize - tmplog)
3211 goto out;
3212 last_isspace = 0;
3213 tmplog += iret;
3214 } else {
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003215 ret = ultoa_o(fe->log_count, tmplog, dst + maxsize - tmplog);
Willy Tarreau7346acb2014-08-28 15:03:15 +02003216 if (ret == NULL)
3217 goto out;
3218 tmplog = ret;
3219 last_isspace = 0;
3220 }
3221 break;
3222
William Lallemand5f232402012-04-05 18:02:55 +02003223 case LOG_FMT_HOSTNAME: // %H
3224 src = hostname;
3225 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
3226 if (ret == NULL)
3227 goto out;
3228 tmplog = ret;
3229 last_isspace = 0;
3230 break;
3231
3232 case LOG_FMT_PID: // %pid
3233 if (tmp->options & LOG_OPT_HEXA) {
3234 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", pid);
3235 if (iret < 0 || iret > dst + maxsize - tmplog)
3236 goto out;
3237 last_isspace = 0;
3238 tmplog += iret;
3239 } else {
3240 ret = ltoa_o(pid, tmplog, dst + maxsize - tmplog);
3241 if (ret == NULL)
3242 goto out;
3243 tmplog = ret;
3244 last_isspace = 0;
3245 }
3246 break;
William Lallemanda73203e2012-03-12 12:48:57 +01003247
3248 case LOG_FMT_UNIQUEID: // %ID
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003249 ret = NULL;
Tim Duesterhusa17e6622020-03-05 20:19:02 +01003250 if (s)
3251 ret = lf_text_len(tmplog, s->unique_id.ptr, s->unique_id.len, maxsize - (tmplog - dst), tmp);
3252 else
3253 ret = lf_text_len(tmplog, NULL, 0, maxsize - (tmplog - dst), tmp);
William Lallemanda73203e2012-03-12 12:48:57 +01003254 if (ret == NULL)
3255 goto out;
3256 tmplog = ret;
3257 last_isspace = 0;
3258 break;
3259
William Lallemandbddd4fd2012-02-27 11:23:10 +01003260 }
3261 }
3262
3263out:
William Lallemand1d705562012-03-12 12:46:41 +01003264 /* *tmplog is a unused character */
3265 *tmplog = '\0';
Willy Tarreaudf974472012-12-28 02:44:01 +01003266 return tmplog - dst;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003267
Willy Tarreaubaaee002006-06-26 02:48:02 +02003268}
3269
William Lallemand1d705562012-03-12 12:46:41 +01003270/*
Willy Tarreau87b09662015-04-03 00:22:06 +02003271 * send a log for the stream when we have enough info about it.
William Lallemand1d705562012-03-12 12:46:41 +01003272 * Will not log if the frontend has no log defined.
3273 */
Willy Tarreau87b09662015-04-03 00:22:06 +02003274void strm_log(struct stream *s)
William Lallemand1d705562012-03-12 12:46:41 +01003275{
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003276 struct session *sess = s->sess;
William Lallemand1d705562012-03-12 12:46:41 +01003277 int size, err, level;
Dragan Dosen0b85ece2015-09-25 19:17:44 +02003278 int sd_size = 0;
William Lallemand1d705562012-03-12 12:46:41 +01003279
3280 /* if we don't want to log normal traffic, return now */
Willy Tarreaue7dff022015-04-03 01:14:29 +02003281 err = (s->flags & SF_REDISP) ||
3282 ((s->flags & SF_ERR_MASK) > SF_ERR_LOCAL) ||
3283 (((s->flags & SF_ERR_MASK) == SF_ERR_NONE) &&
Willy Tarreau350f4872014-11-28 14:42:25 +01003284 (s->si[1].conn_retries != s->be->conn_retries)) ||
Willy Tarreaueee5b512015-04-03 23:46:31 +02003285 ((sess->fe->mode == PR_MODE_HTTP) && s->txn && s->txn->status >= 500);
Willy Tarreaubaaee002006-06-26 02:48:02 +02003286
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003287 if (!err && (sess->fe->options2 & PR_O2_NOLOGNORM))
William Lallemand1d705562012-03-12 12:46:41 +01003288 return;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003289
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003290 if (LIST_ISEMPTY(&sess->fe->logsrvs))
William Lallemand1d705562012-03-12 12:46:41 +01003291 return;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003292
Willy Tarreauabcd5142013-06-11 17:18:02 +02003293 if (s->logs.level) { /* loglevel was overridden */
3294 if (s->logs.level == -1) {
3295 s->logs.logwait = 0; /* logs disabled */
3296 return;
3297 }
3298 level = s->logs.level - 1;
3299 }
3300 else {
3301 level = LOG_INFO;
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003302 if (err && (sess->fe->options2 & PR_O2_LOGERRORS))
Willy Tarreauabcd5142013-06-11 17:18:02 +02003303 level = LOG_ERR;
3304 }
William Lallemand1d705562012-03-12 12:46:41 +01003305
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003306 /* if unique-id was not generated */
Tim Duesterhusa17e6622020-03-05 20:19:02 +01003307 if (!isttest(s->unique_id) && !LIST_ISEMPTY(&sess->fe->format_unique_id)) {
Tim Duesterhus2825b4b2020-02-28 15:13:34 +01003308 stream_generate_unique_id(s, &sess->fe->format_unique_id);
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003309 }
3310
Dragan Dosen0b85ece2015-09-25 19:17:44 +02003311 if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) {
3312 sd_size = build_logline(s, logline_rfc5424, global.max_syslog_len,
3313 &sess->fe->logformat_sd);
3314 }
3315
Dragan Dosen59cee972015-09-19 22:09:02 +02003316 size = build_logline(s, logline, global.max_syslog_len, &sess->fe->logformat);
William Lallemand1d705562012-03-12 12:46:41 +01003317 if (size > 0) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003318 _HA_ATOMIC_INC(&sess->fe->log_count);
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003319 __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level,
3320 logline, size + 1, logline_rfc5424, sd_size);
William Lallemand1d705562012-03-12 12:46:41 +01003321 s->logs.logwait = 0;
3322 }
3323}
William Lallemandbddd4fd2012-02-27 11:23:10 +01003324
Willy Tarreau53839352018-09-05 19:51:10 +02003325/*
3326 * send a minimalist log for the session. Will not log if the frontend has no
3327 * log defined. It is assumed that this is only used to report anomalies that
3328 * cannot lead to the creation of a regular stream. Because of this the log
3329 * level is LOG_INFO or LOG_ERR depending on the "log-separate-error" setting
3330 * in the frontend. The caller must simply know that it should not call this
Willy Tarreau9fa267d2018-10-05 10:22:27 +02003331 * function to report unimportant events. It is safe to call this function with
3332 * sess==NULL (will not do anything).
Willy Tarreau53839352018-09-05 19:51:10 +02003333 */
3334void sess_log(struct session *sess)
3335{
3336 int size, level;
3337 int sd_size = 0;
3338
Willy Tarreau9fa267d2018-10-05 10:22:27 +02003339 if (!sess)
3340 return;
3341
Willy Tarreau53839352018-09-05 19:51:10 +02003342 if (LIST_ISEMPTY(&sess->fe->logsrvs))
3343 return;
3344
3345 level = LOG_INFO;
3346 if (sess->fe->options2 & PR_O2_LOGERRORS)
3347 level = LOG_ERR;
3348
3349 if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) {
3350 sd_size = sess_build_logline(sess, NULL,
3351 logline_rfc5424, global.max_syslog_len,
3352 &sess->fe->logformat_sd);
3353 }
3354
3355 size = sess_build_logline(sess, NULL, logline, global.max_syslog_len, &sess->fe->logformat);
3356 if (size > 0) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003357 _HA_ATOMIC_INC(&sess->fe->log_count);
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003358 __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level,
3359 logline, size + 1, logline_rfc5424, sd_size);
Willy Tarreau53839352018-09-05 19:51:10 +02003360 }
3361}
3362
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003363void app_log(struct list *logsrvs, struct buffer *tag, int level, const char *format, ...)
3364{
3365 va_list argp;
3366 int data_len;
3367
3368 if (level < 0 || format == NULL || logline == NULL)
3369 return;
3370
3371 va_start(argp, format);
3372 data_len = vsnprintf(logline, global.max_syslog_len, format, argp);
3373 if (data_len < 0 || data_len > global.max_syslog_len)
3374 data_len = global.max_syslog_len;
3375 va_end(argp);
3376
3377 __send_log(logsrvs, tag, level, logline, data_len, default_rfc5424_sd_log_format, 2);
3378}
Emeric Brun54932b42020-07-07 09:43:24 +02003379/*
3380 * This function parse a received log message <buf>, of size <buflen>
3381 * it fills <level>, <facility> and <metadata> depending of the detected
3382 * header format and message will point on remaining payload of <size>
3383 *
3384 * <metadata> must point on a preallocated array of LOG_META_FIELDS*sizeof(struct ist)
3385 * struct ist len will be set to 0 if field is not found
3386 * <level> and <facility> will be set to -1 if not found.
3387 */
3388void parse_log_message(char *buf, size_t buflen, int *level, int *facility,
3389 struct ist *metadata, char **message, size_t *size)
3390{
3391
3392 char *p;
3393 int fac_level = 0;
3394
3395 *level = *facility = -1;
3396
3397 *message = buf;
3398 *size = buflen;
3399
3400 memset(metadata, 0, LOG_META_FIELDS*sizeof(struct ist));
3401
3402 p = buf;
3403 if (*size < 2 || *p != '<')
3404 return;
3405
3406 p++;
3407 while (*p != '>') {
3408 if (*p > '9' || *p < '0')
3409 return;
3410 fac_level = 10*fac_level + (*p - '0');
3411 p++;
3412 if ((p - buf) > buflen)
3413 return;
3414 }
3415
3416 *facility = fac_level >> 3;
3417 *level = fac_level & 0x7;
3418 p++;
3419
3420 metadata[LOG_META_PRIO] = ist2(buf, p - buf);
3421
3422 buflen -= p - buf;
3423 buf = p;
3424
3425 *size = buflen;
3426 *message = buf;
3427
3428 /* for rfc5424, prio is always followed by '1' and ' ' */
3429 if ((*size > 2) && (p[0] == '1') && (p[1] == ' ')) {
3430 /* format is always '1 TIMESTAMP HOSTNAME TAG PID MSGID STDATA '
3431 * followed by message.
3432 * Each header field can present NILVALUE: '-'
3433 */
3434
3435 p += 2;
Aurelien DARRAGON27272f22022-11-22 11:17:11 +01003436 *size -= 2;
Emeric Brun54932b42020-07-07 09:43:24 +02003437 /* timestamp is NILVALUE '-' */
3438 if (*size > 2 && (p[0] == '-') && p[1] == ' ') {
3439 metadata[LOG_META_TIME] = ist2(p, 1);
3440 p++;
3441 }
3442 else if (*size > LOG_ISOTIME_MINLEN) {
3443 metadata[LOG_META_TIME].ptr = p;
3444
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05003445 /* check if optional secfrac is present
Emeric Brun54932b42020-07-07 09:43:24 +02003446 * in timestamp.
3447 * possible format are:
3448 * ex: '1970-01-01T00:00:00.000000Z'
3449 * '1970-01-01T00:00:00.000000+00:00'
3450 * '1970-01-01T00:00:00.000000-00:00'
3451 * '1970-01-01T00:00:00Z'
3452 * '1970-01-01T00:00:00+00:00'
3453 * '1970-01-01T00:00:00-00:00'
3454 */
3455 p += 19;
3456 if (*p == '.') {
3457 p++;
3458 if ((p - buf) >= buflen)
3459 goto bad_format;
3460 while (*p != 'Z' && *p != '+' && *p != '-') {
3461 if ((unsigned char)(*p - '0') > 9)
3462 goto bad_format;
3463
3464 p++;
3465 if ((p - buf) >= buflen)
3466 goto bad_format;
3467 }
3468 }
3469
3470 if (*p == 'Z')
3471 p++;
3472 else
3473 p += 6; /* case of '+00:00 or '-00:00' */
3474
3475 if ((p - buf) >= buflen || *p != ' ')
3476 goto bad_format;
3477 metadata[LOG_META_TIME].len = p - metadata[LOG_META_TIME].ptr;
3478 }
3479 else
3480 goto bad_format;
3481
3482
3483 p++;
3484 if ((p - buf) >= buflen || *p == ' ')
3485 goto bad_format;
3486
3487 metadata[LOG_META_HOST].ptr = p;
3488 while (*p != ' ') {
3489 p++;
3490 if ((p - buf) >= buflen)
3491 goto bad_format;
3492 }
3493 metadata[LOG_META_HOST].len = p - metadata[LOG_META_HOST].ptr;
3494 if (metadata[LOG_META_HOST].len == 1 && metadata[LOG_META_HOST].ptr[0] == '-')
3495 metadata[LOG_META_HOST].len = 0;
3496
3497 p++;
3498 if ((p - buf) >= buflen || *p == ' ')
3499 goto bad_format;
3500
3501 metadata[LOG_META_TAG].ptr = p;
3502 while (*p != ' ') {
3503 p++;
3504 if ((p - buf) >= buflen)
3505 goto bad_format;
3506 }
3507 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3508 if (metadata[LOG_META_TAG].len == 1 && metadata[LOG_META_TAG].ptr[0] == '-')
3509 metadata[LOG_META_TAG].len = 0;
3510
3511 p++;
3512 if ((p - buf) >= buflen || *p == ' ')
3513 goto bad_format;
3514
3515 metadata[LOG_META_PID].ptr = p;
3516 while (*p != ' ') {
3517 p++;
3518 if ((p - buf) >= buflen)
3519 goto bad_format;
3520 }
3521 metadata[LOG_META_PID].len = p - metadata[LOG_META_PID].ptr;
3522 if (metadata[LOG_META_PID].len == 1 && metadata[LOG_META_PID].ptr[0] == '-')
3523 metadata[LOG_META_PID].len = 0;
3524
3525 p++;
3526 if ((p - buf) >= buflen || *p == ' ')
3527 goto bad_format;
3528
3529 metadata[LOG_META_MSGID].ptr = p;
3530 while (*p != ' ') {
3531 p++;
3532 if ((p - buf) >= buflen)
3533 goto bad_format;
3534 }
3535 metadata[LOG_META_MSGID].len = p - metadata[LOG_META_MSGID].ptr;
3536 if (metadata[LOG_META_MSGID].len == 1 && metadata[LOG_META_MSGID].ptr[0] == '-')
3537 metadata[LOG_META_MSGID].len = 0;
3538
3539 p++;
3540 if ((p - buf) >= buflen || *p == ' ')
3541 goto bad_format;
3542
3543 /* structured data format is:
3544 * ex:
3545 * '[key1=value1 key2=value2][key3=value3]'
3546 *
3547 * space is invalid outside [] because
3548 * considered as the end of structured data field
3549 */
3550 metadata[LOG_META_STDATA].ptr = p;
3551 if (*p == '[') {
3552 int elem = 0;
3553
3554 while (1) {
3555 if (elem) {
3556 /* according to rfc this char is escaped in param values */
3557 if (*p == ']' && *(p-1) != '\\')
3558 elem = 0;
3559 }
3560 else {
3561 if (*p == '[')
3562 elem = 1;
3563 else if (*p == ' ')
3564 break;
3565 else
3566 goto bad_format;
3567 }
3568 p++;
3569 if ((p - buf) >= buflen)
3570 goto bad_format;
3571 }
3572 }
3573 else if (*p == '-') {
3574 /* case of NILVALUE */
3575 p++;
3576 if ((p - buf) >= buflen || *p != ' ')
3577 goto bad_format;
3578 }
3579 else
3580 goto bad_format;
3581
3582 metadata[LOG_META_STDATA].len = p - metadata[LOG_META_STDATA].ptr;
3583 if (metadata[LOG_META_STDATA].len == 1 && metadata[LOG_META_STDATA].ptr[0] == '-')
3584 metadata[LOG_META_STDATA].len = 0;
3585
3586 p++;
3587
3588 buflen -= p - buf;
3589 buf = p;
3590
3591 *size = buflen;
3592 *message = p;
3593 }
3594 else if (*size > LOG_LEGACYTIME_LEN) {
3595 int m;
3596
3597 /* supported header format according to rfc3164.
3598 * ex:
3599 * 'Jan 1 00:00:00 HOSTNAME TAG[PID]: '
3600 * or 'Jan 1 00:00:00 HOSTNAME TAG: '
3601 * or 'Jan 1 00:00:00 HOSTNAME '
3602 * Note: HOSTNAME is mandatory, and day
3603 * of month uses a single space prefix if
3604 * less than 10 to ensure hour offset is
3605 * always the same.
3606 */
3607
3608 /* Check month to see if it correspond to a rfc3164
3609 * header ex 'Jan 1 00:00:00' */
3610 for (m = 0; m < 12; m++)
3611 if (!memcmp(monthname[m], p, 3))
3612 break;
3613 /* Month not found */
3614 if (m == 12)
3615 goto bad_format;
3616
3617 metadata[LOG_META_TIME] = ist2(p, LOG_LEGACYTIME_LEN);
3618
3619 p += LOG_LEGACYTIME_LEN;
3620 if ((p - buf) >= buflen || *p != ' ')
3621 goto bad_format;
3622
3623 p++;
3624 if ((p - buf) >= buflen || *p == ' ')
3625 goto bad_format;
3626
3627 metadata[LOG_META_HOST].ptr = p;
3628 while (*p != ' ') {
3629 p++;
3630 if ((p - buf) >= buflen)
3631 goto bad_format;
3632 }
3633 metadata[LOG_META_HOST].len = p - metadata[LOG_META_HOST].ptr;
3634
3635 /* TAG seems to no be mandatory */
3636 p++;
3637
3638 buflen -= p - buf;
3639 buf = p;
3640
3641 *size = buflen;
3642 *message = buf;
3643
3644 if (!buflen)
3645 return;
3646
3647 while (((p - buf) < buflen) && *p != ' ' && *p != ':')
3648 p++;
3649
3650 /* a tag must present a trailing ':' */
3651 if (((p - buf) >= buflen) || *p != ':')
3652 return;
3653 p++;
3654 /* followed by a space */
3655 if (((p - buf) >= buflen) || *p != ' ')
3656 return;
3657
3658 /* rewind to parse tag and pid */
3659 p = buf;
3660 metadata[LOG_META_TAG].ptr = p;
3661 /* we have the guarantee that ':' will be reach before size limit */
3662 while (*p != ':') {
3663 if (*p == '[') {
3664 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3665 metadata[LOG_META_PID].ptr = p + 1;
3666 }
Tim Duesterhus7b5777d2021-03-02 18:57:28 +01003667 else if (*p == ']' && isttest(metadata[LOG_META_PID])) {
Emeric Brun54932b42020-07-07 09:43:24 +02003668 if (p[1] != ':')
3669 return;
3670 metadata[LOG_META_PID].len = p - metadata[LOG_META_PID].ptr;
3671 }
3672 p++;
3673 }
3674 if (!metadata[LOG_META_TAG].len)
3675 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3676
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05003677 /* let pass ':' and ' ', we still have warranty size is large enough */
Emeric Brun54932b42020-07-07 09:43:24 +02003678 p += 2;
3679
3680 buflen -= p - buf;
3681 buf = p;
3682
3683 *size = buflen;
3684 *message = buf;
3685 }
3686
3687 return;
3688
3689bad_format:
3690 /* bad syslog format, we reset all parsed syslog fields
3691 * but priority is kept because we are able to re-build
3692 * this message using LOF_FORMAT_PRIO.
3693 */
3694 metadata[LOG_META_TIME].len = 0;
3695 metadata[LOG_META_HOST].len = 0;
3696 metadata[LOG_META_TAG].len = 0;
3697 metadata[LOG_META_PID].len = 0;
3698 metadata[LOG_META_MSGID].len = 0;
3699 metadata[LOG_META_STDATA].len = 0;
3700
3701 return;
3702}
3703
3704/*
3705 * UDP syslog fd handler
3706 */
3707void syslog_fd_handler(int fd)
3708{
3709 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
3710 ssize_t ret = 0;
3711 struct buffer *buf = get_trash_chunk();
3712 size_t size;
3713 char *message;
3714 int level;
3715 int facility;
3716 struct listener *l = objt_listener(fdtab[fd].owner);
3717 int max_accept;
3718
3719 if(!l)
3720 ABORT_NOW();
3721
Willy Tarreauf5090652021-04-06 17:23:40 +02003722 if (fdtab[fd].state & FD_POLL_IN) {
Emeric Brun54932b42020-07-07 09:43:24 +02003723
3724 if (!fd_recv_ready(fd))
3725 return;
3726
3727 max_accept = l->maxaccept ? l->maxaccept : 1;
3728
3729 do {
3730 /* Source address */
3731 struct sockaddr_storage saddr = {0};
3732 socklen_t saddrlen;
3733
3734 saddrlen = sizeof(saddr);
3735
3736 ret = recvfrom(fd, buf->area, buf->size, 0, (struct sockaddr *)&saddr, &saddrlen);
3737 if (ret < 0) {
3738 if (errno == EINTR)
3739 continue;
3740 if (errno == EAGAIN)
3741 fd_cant_recv(fd);
3742 goto out;
3743 }
3744 buf->data = ret;
3745
Emeric Brun45c457a2020-07-09 23:23:34 +02003746 /* update counters */
Willy Tarreau4781b152021-04-06 13:53:36 +02003747 _HA_ATOMIC_INC(&cum_log_messages);
Emeric Bruna39ecbd2020-10-05 14:33:12 +02003748 proxy_inc_fe_req_ctr(l, l->bind_conf->frontend);
Emeric Brun45c457a2020-07-09 23:23:34 +02003749
Emeric Brun54932b42020-07-07 09:43:24 +02003750 parse_log_message(buf->area, buf->data, &level, &facility, metadata, &message, &size);
3751
3752 process_send_log(&l->bind_conf->frontend->logsrvs, level, facility, metadata, message, size);
3753
3754 } while (--max_accept);
3755 }
3756
3757out:
3758 return;
3759}
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003760
Emeric Brun12941c82020-07-07 14:19:42 +02003761/*
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003762 * IO Handler to handle message exchange with a syslog tcp client
3763 */
3764static void syslog_io_handler(struct appctx *appctx)
3765{
3766 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
3767 struct stream_interface *si = appctx->owner;
3768 struct stream *s = si_strm(si);
3769 struct proxy *frontend = strm_fe(s);
3770 struct listener *l = strm_li(s);
3771 struct buffer *buf = get_trash_chunk();
3772 int max_accept;
3773 int to_skip;
3774 int facility;
3775 int level;
3776 char *message;
3777 size_t size;
3778
3779 max_accept = l->maxaccept ? l->maxaccept : 1;
Christopher Faulet1ce396c2023-04-17 16:34:29 +02003780 while (1) {
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003781 char c;
3782
3783 if (max_accept <= 0)
3784 goto missing_budget;
3785 max_accept--;
3786
3787 to_skip = co_getchar(si_oc(si), &c);
3788 if (!to_skip)
3789 goto missing_data;
3790 else if (to_skip < 0)
3791 goto cli_abort;
3792
3793 if (c == '<') {
3794 /* rfc-6587, Non-Transparent-Framing: messages separated by
3795 * a trailing LF or CR LF
3796 */
3797 to_skip = co_getline(si_oc(si), buf->area, buf->size);
3798 if (!to_skip)
3799 goto missing_data;
3800 else if (to_skip < 0)
3801 goto cli_abort;
3802
3803 if (buf->area[to_skip - 1] != '\n')
3804 goto parse_error;
3805
3806 buf->data = to_skip - 1;
3807
3808 /* according to rfc-6587, some devices adds CR before LF */
3809 if (buf->data && buf->area[buf->data - 1] == '\r')
3810 buf->data--;
3811
3812 }
3813 else if ((unsigned char)(c - '1') <= 8) {
3814 /* rfc-6587, Octet-Counting: message length in ASCII
3815 * (first digit can not be ZERO), followed by a space
3816 * and message length
3817 */
3818 char *p = NULL;
3819 int msglen;
3820
3821 to_skip = co_getword(si_oc(si), buf->area, buf->size, ' ');
3822 if (!to_skip)
3823 goto missing_data;
3824 else if (to_skip < 0)
3825 goto cli_abort;
3826
3827 if (buf->area[to_skip - 1] != ' ')
3828 goto parse_error;
3829
Aurelien DARRAGON5569aa92022-10-26 23:40:08 +02003830 msglen = strtol(buf->area, &p, 10);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003831 if (!msglen || p != &buf->area[to_skip - 1])
3832 goto parse_error;
3833
3834 /* message seems too large */
3835 if (msglen > buf->size)
3836 goto parse_error;
3837
3838 msglen = co_getblk(si_oc(si), buf->area, msglen, to_skip);
3839 if (!msglen)
3840 goto missing_data;
3841 else if (msglen < 0)
3842 goto cli_abort;
3843
3844
3845 buf->data = msglen;
3846 to_skip += msglen;
3847 }
3848 else
3849 goto parse_error;
3850
3851 co_skip(si_oc(si), to_skip);
3852
3853 /* update counters */
Willy Tarreau4781b152021-04-06 13:53:36 +02003854 _HA_ATOMIC_INC(&cum_log_messages);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003855 proxy_inc_fe_req_ctr(l, frontend);
3856
3857 parse_log_message(buf->area, buf->data, &level, &facility, metadata, &message, &size);
3858
3859 process_send_log(&frontend->logsrvs, level, facility, metadata, message, size);
3860
3861 }
3862
3863missing_data:
3864 /* we need more data to read */
3865 si_oc(si)->flags |= CF_READ_DONTWAIT;
3866
3867 return;
3868
3869missing_budget:
3870 /* it may remain some stuff to do, let's retry later */
3871 appctx_wakeup(appctx);
3872
3873 return;
3874
3875parse_error:
3876 if (l->counters)
Willy Tarreau4781b152021-04-06 13:53:36 +02003877 _HA_ATOMIC_INC(&l->counters->failed_req);
3878 _HA_ATOMIC_INC(&frontend->fe_counters.failed_req);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003879
3880 goto close;
3881
3882cli_abort:
3883 if (l->counters)
Willy Tarreau4781b152021-04-06 13:53:36 +02003884 _HA_ATOMIC_INC(&l->counters->cli_aborts);
3885 _HA_ATOMIC_INC(&frontend->fe_counters.cli_aborts);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003886
3887close:
3888 si_shutw(si);
3889 si_shutr(si);
3890
3891 si_ic(si)->flags |= CF_READ_NULL;
3892
3893 return;
3894}
3895
3896static struct applet syslog_applet = {
3897 .obj_type = OBJ_TYPE_APPLET,
3898 .name = "<SYSLOG>", /* used for logging */
3899 .fct = syslog_io_handler,
3900 .release = NULL,
3901};
3902
3903/*
Emeric Brun12941c82020-07-07 14:19:42 +02003904 * Parse "log-forward" section and create corresponding sink buffer.
3905 *
3906 * The function returns 0 in success case, otherwise, it returns error
3907 * flags.
3908 */
3909int cfg_parse_log_forward(const char *file, int linenum, char **args, int kwm)
3910{
Aurelien DARRAGON1a39bd22023-07-03 18:33:18 +02003911 int err_code = ERR_NONE;
Emeric Brun12941c82020-07-07 14:19:42 +02003912 struct proxy *px;
3913 char *errmsg = NULL;
3914 const char *err = NULL;
3915
3916 if (strcmp(args[0], "log-forward") == 0) {
3917 if (!*args[1]) {
Aurelien DARRAGONab89d8b2023-07-03 17:35:54 +02003918 ha_alert("parsing [%s:%d] : missing name for log-forward section.\n", file, linenum);
Emeric Brun12941c82020-07-07 14:19:42 +02003919 err_code |= ERR_ALERT | ERR_ABORT;
3920 goto out;
3921 }
3922
3923 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3924 goto out;
3925
3926 err = invalid_char(args[1]);
3927 if (err) {
3928 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
3929 file, linenum, *err, args[0], args[1]);
3930 err_code |= ERR_ALERT | ERR_ABORT;
3931 goto out;
3932 }
3933
Emeric Brunb0c331f2020-10-07 17:05:59 +02003934 px = log_forward_by_name(args[1]);
3935 if (px) {
3936 ha_alert("Parsing [%s:%d]: log-forward section '%s' has the same name as another log-forward section declared at %s:%d.\n",
3937 file, linenum, args[1], px->conf.file, px->conf.line);
3938 err_code |= ERR_ALERT | ERR_FATAL;
Aurelien DARRAGON1a39bd22023-07-03 18:33:18 +02003939 goto out;
Emeric Brunb0c331f2020-10-07 17:05:59 +02003940 }
3941
3942 px = proxy_find_by_name(args[1], 0, 0);
3943 if (px) {
3944 ha_alert("Parsing [%s:%d]: log forward section '%s' has the same name as %s '%s' declared at %s:%d.\n",
3945 file, linenum, args[1], proxy_type_str(px),
3946 px->id, px->conf.file, px->conf.line);
3947 err_code |= ERR_ALERT | ERR_FATAL;
Aurelien DARRAGON1a39bd22023-07-03 18:33:18 +02003948 goto out;
Emeric Brun12941c82020-07-07 14:19:42 +02003949 }
3950
3951 px = calloc(1, sizeof *px);
3952 if (!px) {
3953 err_code |= ERR_ALERT | ERR_FATAL;
3954 goto out;
3955 }
3956
Emeric Brun9ecb3bc2021-12-01 12:08:42 +01003957 init_new_proxy(px);
Emeric Brun12941c82020-07-07 14:19:42 +02003958 px->next = cfg_log_forward;
3959 cfg_log_forward = px;
Emeric Brun12941c82020-07-07 14:19:42 +02003960 px->conf.file = strdup(file);
3961 px->conf.line = linenum;
3962 px->mode = PR_MODE_SYSLOG;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003963 px->last_change = now.tv_sec;
3964 px->cap = PR_CAP_FE;
3965 px->maxconn = 10;
3966 px->timeout.client = TICK_ETERNITY;
3967 px->accept = frontend_accept;
3968 px->default_target = &syslog_applet.obj_type;
Emeric Brun12941c82020-07-07 14:19:42 +02003969 px->id = strdup(args[1]);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003970 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003971 else if (strcmp(args[0], "maxconn") == 0) { /* maxconn */
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003972 if (warnifnotcap(cfg_log_forward, PR_CAP_FE, file, linenum, args[0], " Maybe you want 'fullconn' instead ?"))
3973 err_code |= ERR_WARN;
3974
3975 if (*(args[1]) == 0) {
3976 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", file, linenum, args[0]);
3977 err_code |= ERR_ALERT | ERR_FATAL;
3978 goto out;
3979 }
3980 cfg_log_forward->maxconn = atol(args[1]);
3981 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3982 goto out;
3983 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003984 else if (strcmp(args[0], "backlog") == 0) { /* backlog */
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003985 if (warnifnotcap(cfg_log_forward, PR_CAP_FE, file, linenum, args[0], NULL))
3986 err_code |= ERR_WARN;
3987
3988 if (*(args[1]) == 0) {
3989 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", file, linenum, args[0]);
3990 err_code |= ERR_ALERT | ERR_FATAL;
3991 goto out;
3992 }
3993 cfg_log_forward->backlog = atol(args[1]);
3994 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3995 goto out;
3996 }
3997 else if (strcmp(args[0], "bind") == 0) {
3998 int cur_arg;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003999 struct bind_conf *bind_conf;
4000 struct bind_kw *kw;
4001 struct listener *l;
4002
4003 cur_arg = 1;
4004
4005 bind_conf = bind_conf_alloc(cfg_log_forward, file, linenum,
4006 NULL, xprt_get(XPRT_RAW));
4007 if (!bind_conf) {
4008 ha_alert("parsing [%s:%d] : out of memory error.", file, linenum);
4009 err_code |= ERR_ALERT | ERR_FATAL;
4010 goto out;
4011 }
4012
4013 if (!str2listener(args[1], cfg_log_forward, bind_conf, file, linenum, &errmsg)) {
4014 if (errmsg && *errmsg) {
4015 indent_msg(&errmsg, 2);
4016 ha_alert("parsing [%s:%d] : '%s %s' : %s\n", file, linenum, args[0], args[1], errmsg);
4017 }
4018 else {
4019 ha_alert("parsing [%s:%d] : '%s %s' : error encountered while parsing listening address %s.\n",
4020 file, linenum, args[0], args[1], args[2]);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02004021 }
Aurelien DARRAGON1a39bd22023-07-03 18:33:18 +02004022 err_code |= ERR_ALERT | ERR_FATAL;
4023 goto out;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02004024 }
4025 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau66161322021-02-19 15:50:27 +01004026 l->maxaccept = global.tune.maxaccept ? global.tune.maxaccept : MAX_ACCEPT;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02004027 l->accept = session_accept_fd;
4028 l->analysers |= cfg_log_forward->fe_req_ana;
4029 l->default_target = cfg_log_forward->default_target;
4030 global.maxsock++;
4031 }
4032 cur_arg++;
4033
4034 while (*args[cur_arg] && (kw = bind_find_kw(args[cur_arg]))) {
4035 int ret;
4036
4037 ret = kw->parse(args, cur_arg, cfg_log_forward, bind_conf, &errmsg);
4038 err_code |= ret;
4039 if (ret) {
4040 if (errmsg && *errmsg) {
4041 indent_msg(&errmsg, 2);
4042 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
4043 }
4044 else
4045 ha_alert("parsing [%s:%d]: error encountered while processing '%s'\n",
4046 file, linenum, args[cur_arg]);
4047 if (ret & ERR_FATAL)
4048 goto out;
4049 }
4050 cur_arg += 1 + kw->skip;
4051 }
4052 if (*args[cur_arg] != 0) {
Willy Tarreau433b05f2021-03-12 10:14:07 +01004053 const char *best = bind_find_best_kw(args[cur_arg]);
4054 if (best)
4055 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section; did you mean '%s' maybe ?\n",
4056 file, linenum, args[cur_arg], cursection, best);
4057 else
4058 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section.\n",
4059 file, linenum, args[cur_arg], cursection);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02004060 err_code |= ERR_ALERT | ERR_FATAL;
4061 goto out;
4062 }
Emeric Brun12941c82020-07-07 14:19:42 +02004063 }
Willy Tarreau76aaa7f2020-09-16 15:07:22 +02004064 else if (strcmp(args[0], "dgram-bind") == 0) {
Emeric Brun12941c82020-07-07 14:19:42 +02004065 int cur_arg;
Emeric Brun12941c82020-07-07 14:19:42 +02004066 struct bind_conf *bind_conf;
4067 struct bind_kw *kw;
4068 struct listener *l;
4069
4070 cur_arg = 1;
4071
4072 bind_conf = bind_conf_alloc(cfg_log_forward, file, linenum,
4073 NULL, xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +02004074 if (!bind_conf) {
4075 ha_alert("parsing [%s:%d] : out of memory error.", file, linenum);
4076 err_code |= ERR_ALERT | ERR_FATAL;
4077 goto out;
4078 }
Emeric Brun12941c82020-07-07 14:19:42 +02004079
Willy Tarreau26ff5da2020-09-16 15:22:19 +02004080 if (!str2receiver(args[1], cfg_log_forward, bind_conf, file, linenum, &errmsg)) {
Emeric Brun12941c82020-07-07 14:19:42 +02004081 if (errmsg && *errmsg) {
4082 indent_msg(&errmsg, 2);
4083 ha_alert("parsing [%s:%d] : '%s %s' : %s\n", file, linenum, args[0], args[1], errmsg);
4084 }
4085 else {
4086 ha_alert("parsing [%s:%d] : '%s %s' : error encountered while parsing listening address %s.\n",
4087 file, linenum, args[0], args[1], args[2]);
Emeric Brun12941c82020-07-07 14:19:42 +02004088 }
Willy Tarreau3b139e52020-09-16 16:24:14 +02004089 err_code |= ERR_ALERT | ERR_FATAL;
4090 goto out;
Emeric Brun12941c82020-07-07 14:19:42 +02004091 }
4092 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau26ff5da2020-09-16 15:22:19 +02004093 /* the fact that the sockets are of type dgram is guaranteed by str2receiver() */
Willy Tarreau66161322021-02-19 15:50:27 +01004094 l->maxaccept = global.tune.maxaccept ? global.tune.maxaccept : MAX_ACCEPT;
Willy Tarreaue140a692020-10-15 21:25:32 +02004095 l->rx.iocb = syslog_fd_handler;
Emeric Brun12941c82020-07-07 14:19:42 +02004096 global.maxsock++;
4097 }
4098 cur_arg++;
4099
4100 while (*args[cur_arg] && (kw = bind_find_kw(args[cur_arg]))) {
4101 int ret;
4102
4103 ret = kw->parse(args, cur_arg, cfg_log_forward, bind_conf, &errmsg);
4104 err_code |= ret;
4105 if (ret) {
4106 if (errmsg && *errmsg) {
4107 indent_msg(&errmsg, 2);
4108 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
4109 }
4110 else
4111 ha_alert("parsing [%s:%d]: error encountered while processing '%s'\n",
4112 file, linenum, args[cur_arg]);
4113 if (ret & ERR_FATAL)
4114 goto out;
4115 }
4116 cur_arg += 1 + kw->skip;
4117 }
4118 if (*args[cur_arg] != 0) {
Willy Tarreau433b05f2021-03-12 10:14:07 +01004119 const char *best = bind_find_best_kw(args[cur_arg]);
4120 if (best)
4121 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section; did you mean '%s' maybe ?\n",
4122 file, linenum, args[cur_arg], cursection, best);
4123 else
4124 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section.\n",
4125 file, linenum, args[cur_arg], cursection);
Emeric Brun12941c82020-07-07 14:19:42 +02004126 err_code |= ERR_ALERT | ERR_FATAL;
4127 goto out;
4128 }
4129 }
4130 else if (strcmp(args[0], "log") == 0) {
Emeric Brun9533a702021-04-02 10:13:43 +02004131 if (!parse_logsrv(args, &cfg_log_forward->logsrvs, (kwm == KWM_NO), file, linenum, &errmsg)) {
Emeric Brun12941c82020-07-07 14:19:42 +02004132 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
4133 err_code |= ERR_ALERT | ERR_FATAL;
4134 goto out;
4135 }
Emeric Bruncbb7bf72020-10-05 14:39:35 +02004136 }
4137 else if (strcmp(args[0], "timeout") == 0) {
4138 const char *res;
4139 unsigned timeout;
4140
4141 if (strcmp(args[1], "client") != 0) {
4142 ha_alert("parsing [%s:%d] : unknown keyword '%s %s' in log-forward section.\n", file, linenum, args[0], args[1]);
4143 err_code |= ERR_ALERT | ERR_FATAL;
4144 goto out;
4145 }
4146
4147 if (*args[2] == 0) {
4148 ha_alert("parsing [%s:%d] : missing timeout client value.\n", file, linenum);
4149 err_code |= ERR_ALERT | ERR_FATAL;
4150 goto out;
4151 }
4152 res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
4153 if (res == PARSE_TIME_OVER) {
4154 memprintf(&errmsg, "timer overflow in argument '%s' to 'timeout client' (maximum value is 2147483647 ms or ~24.8 days)", args[2]);
4155 }
4156 else if (res == PARSE_TIME_UNDER) {
4157 memprintf(&errmsg, "timer underflow in argument '%s' to 'timeout client' (minimum non-null value is 1 ms)", args[2]);
4158 }
4159 else if (res) {
4160 memprintf(&errmsg, "unexpected character '%c' in 'timeout client'", *res);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02004161 }
4162
4163 if (res) {
4164 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
4165 err_code |= ERR_ALERT | ERR_FATAL;
4166 goto out;
4167 }
4168 cfg_log_forward->timeout.client = MS_TO_TICKS(timeout);
Emeric Brun12941c82020-07-07 14:19:42 +02004169 }
Willy Tarreauf9feec22020-09-16 15:04:33 +02004170 else {
4171 ha_alert("parsing [%s:%d] : unknown keyword '%s' in log-forward section.\n", file, linenum, args[0]);
4172 err_code |= ERR_ALERT | ERR_ABORT;
4173 goto out;
4174 }
Emeric Brun12941c82020-07-07 14:19:42 +02004175out:
Aurelien DARRAGON91e28752023-07-04 15:36:45 +02004176 ha_free(&errmsg);
Emeric Brun12941c82020-07-07 14:19:42 +02004177 return err_code;
4178}
4179
4180
Willy Tarreau869efd52019-11-15 15:16:57 +01004181/* parse the "show startup-logs" command, returns 1 if a message is returned, otherwise zero */
4182static int cli_parse_show_startup_logs(char **args, char *payload, struct appctx *appctx, void *private)
Christopher Fauletc1b730a2017-10-24 12:00:51 +02004183{
Willy Tarreau869efd52019-11-15 15:16:57 +01004184 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
4185 return 1;
Christopher Fauletc1b730a2017-10-24 12:00:51 +02004186
Willy Tarreau869efd52019-11-15 15:16:57 +01004187 if (!startup_logs)
4188 return cli_msg(appctx, LOG_INFO, "\n"); // nothing to print
4189
4190 return ring_attach_cli(startup_logs, appctx);
Christopher Fauletc1b730a2017-10-24 12:00:51 +02004191}
4192
4193/* register cli keywords */
4194static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02004195 { { "show", "startup-logs", NULL }, "show startup-logs : report logs emitted during HAProxy startup", cli_parse_show_startup_logs, NULL, NULL },
Christopher Fauletc1b730a2017-10-24 12:00:51 +02004196 {{},}
4197}};
4198
Willy Tarreau0108d902018-11-25 19:14:37 +01004199INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
4200
Emeric Brun12941c82020-07-07 14:19:42 +02004201/* config parsers for this section */
4202REGISTER_CONFIG_SECTION("log-forward", cfg_parse_log_forward, NULL);
4203
Willy Tarreau082b6282019-05-22 14:42:12 +02004204REGISTER_PER_THREAD_ALLOC(init_log_buffers);
4205REGISTER_PER_THREAD_FREE(deinit_log_buffers);
Willy Tarreau172f5ce2018-11-26 11:21:50 +01004206
Willy Tarreaubaaee002006-06-26 02:48:02 +02004207/*
4208 * Local variables:
4209 * c-indent-level: 8
4210 * c-basic-offset: 8
4211 * End:
4212 */