blob: 36d6d36cabaa96d4ab6c477a83a5a7cc35867efe [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>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020028#include <haproxy/applet.h>
Emeric Brun12941c82020-07-07 14:19:42 +020029#include <haproxy/cfgparse.h>
Willy Tarreau55542642021-10-08 09:33:24 +020030#include <haproxy/clock.h>
Christopher Faulet908628c2022-03-25 16:43:49 +010031#include <haproxy/conn_stream.h>
32#include <haproxy/cs_utils.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/fd.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020034#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020035#include <haproxy/global.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020036#include <haproxy/http.h>
Willy Tarreaub7fc4c42021-10-06 18:56:42 +020037#include <haproxy/http_ana.h>
Emeric Brun12941c82020-07-07 14:19:42 +020038#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020039#include <haproxy/log.h>
Emeric Brun12941c82020-07-07 14:19:42 +020040#include <haproxy/proxy.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020041#include <haproxy/sample.h>
42#include <haproxy/sink.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020043#include <haproxy/ssl_sock.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020044#include <haproxy/stream.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020045#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020046#include <haproxy/tools.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);
William Lallemand723b73a2012-02-08 16:37:49 +0100123};
124
William Lallemandb7ff6a32012-03-02 14:35:21 +0100125int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy);
126
William Lallemand723b73a2012-02-08 16:37:49 +0100127/* log_format variable names */
128static const struct logformat_type logformat_keywords[] = {
William Lallemand5e19a282012-04-02 16:22:10 +0200129 { "o", LOG_FMT_GLOBAL, PR_MODE_TCP, 0, NULL }, /* global option */
Willy Tarreau2beef582012-12-20 17:22:52 +0100130
131 /* please keep these lines sorted ! */
132 { "B", LOG_FMT_BYTES, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from server to client */
133 { "CC", LOG_FMT_CCLIENT, PR_MODE_HTTP, LW_REQHDR, NULL }, /* client cookie */
134 { "CS", LOG_FMT_CSERVER, PR_MODE_HTTP, LW_RSPHDR, NULL }, /* server cookie */
135 { "H", LOG_FMT_HOSTNAME, PR_MODE_TCP, LW_INIT, NULL }, /* Hostname */
Tim Duesterhuscf6e0c82020-03-13 12:34:24 +0100136 { "ID", LOG_FMT_UNIQUEID, PR_MODE_TCP, LW_BYTES, NULL }, /* Unique ID */
Willy Tarreau4bf99632014-06-13 12:21:40 +0200137 { "ST", LOG_FMT_STATUS, PR_MODE_TCP, LW_RESP, NULL }, /* status code */
William Lallemand5e19a282012-04-02 16:22:10 +0200138 { "T", LOG_FMT_DATEGMT, PR_MODE_TCP, LW_INIT, NULL }, /* date GMT */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200139 { "Ta", LOG_FMT_Ta, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time active (tr to end) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100140 { "Tc", LOG_FMT_TC, PR_MODE_TCP, LW_BYTES, NULL }, /* Tc */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200141 { "Th", LOG_FMT_Th, PR_MODE_TCP, LW_BYTES, NULL }, /* Time handshake */
142 { "Ti", LOG_FMT_Ti, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time idle */
143 { "Tl", LOG_FMT_DATELOCAL, PR_MODE_TCP, LW_INIT, NULL }, /* date local timezone */
144 { "Tq", LOG_FMT_TQ, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tq=Th+Ti+TR */
145 { "Tr", LOG_FMT_Tr, PR_MODE_HTTP, LW_BYTES, NULL }, /* Tr */
146 { "TR", LOG_FMT_TR, PR_MODE_HTTP, LW_BYTES, NULL }, /* Time to receive a valid request */
Willy Tarreau27b639d2016-05-17 17:55:27 +0200147 { "Td", LOG_FMT_TD, PR_MODE_TCP, LW_BYTES, NULL }, /* Td = Tt - (Tq + Tw + Tc + Tr) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100148 { "Ts", LOG_FMT_TS, PR_MODE_TCP, LW_INIT, NULL }, /* timestamp GMT */
William Lallemand5e19a282012-04-02 16:22:10 +0200149 { "Tt", LOG_FMT_TT, PR_MODE_TCP, LW_BYTES, NULL }, /* Tt */
Damien Claisse57c8eb92020-04-28 12:09:19 +0000150 { "Tu", LOG_FMT_TU, PR_MODE_TCP, LW_BYTES, NULL }, /* Tu = Tt -Ti */
Willy Tarreau2beef582012-12-20 17:22:52 +0100151 { "Tw", LOG_FMT_TW, PR_MODE_TCP, LW_BYTES, NULL }, /* Tw */
152 { "U", LOG_FMT_BYTES_UP, PR_MODE_TCP, LW_BYTES, NULL }, /* bytes from client to server */
William Lallemand5e19a282012-04-02 16:22:10 +0200153 { "ac", LOG_FMT_ACTCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* actconn */
Willy Tarreau2beef582012-12-20 17:22:52 +0100154 { "b", LOG_FMT_BACKEND, PR_MODE_TCP, LW_INIT, NULL }, /* backend */
William Lallemand5e19a282012-04-02 16:22:10 +0200155 { "bc", LOG_FMT_BECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* beconn */
Willy Tarreau2beef582012-12-20 17:22:52 +0100156 { "bi", LOG_FMT_BACKENDIP, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source ip */
157 { "bp", LOG_FMT_BACKENDPORT, PR_MODE_TCP, LW_BCKIP, prepare_addrsource }, /* backend source port */
William Lallemand5e19a282012-04-02 16:22:10 +0200158 { "bq", LOG_FMT_BCKQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* backend_queue */
Willy Tarreaud02286d2017-06-23 11:23:43 +0200159 { "ci", LOG_FMT_CLIENTIP, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client ip */
160 { "cp", LOG_FMT_CLIENTPORT, PR_MODE_TCP, LW_CLIP | LW_XPRT, NULL }, /* client port */
Willy Tarreau2beef582012-12-20 17:22:52 +0100161 { "f", LOG_FMT_FRONTEND, PR_MODE_TCP, LW_INIT, NULL }, /* frontend */
162 { "fc", LOG_FMT_FECONN, PR_MODE_TCP, LW_BYTES, NULL }, /* feconn */
Willy Tarreaud02286d2017-06-23 11:23:43 +0200163 { "fi", LOG_FMT_FRONTENDIP, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend ip */
164 { "fp", LOG_FMT_FRONTENDPORT, PR_MODE_TCP, LW_FRTIP | LW_XPRT, NULL }, /* frontend port */
Willy Tarreau2beef582012-12-20 17:22:52 +0100165 { "ft", LOG_FMT_FRONTEND_XPRT, PR_MODE_TCP, LW_INIT, NULL }, /* frontend with transport mode */
Willy Tarreaud9ed3d22014-06-13 12:23:06 +0200166 { "hr", LOG_FMT_HDRREQUEST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request */
167 { "hrl", LOG_FMT_HDRREQUESTLIST, PR_MODE_TCP, LW_REQHDR, NULL }, /* header request list */
168 { "hs", LOG_FMT_HDRRESPONS, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response */
169 { "hsl", LOG_FMT_HDRRESPONSLIST, PR_MODE_TCP, LW_RSPHDR, NULL }, /* header response list */
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +0000170 { "HM", LOG_FMT_HTTP_METHOD, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP method */
Maciej Zdebfcdfd852020-11-30 18:27:47 +0000171 { "HP", LOG_FMT_HTTP_PATH, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP relative or absolute path */
172 { "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 +0000173 { "HQ", LOG_FMT_HTTP_QUERY, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP query */
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +0000174 { "HU", LOG_FMT_HTTP_URI, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP full URI */
175 { "HV", LOG_FMT_HTTP_VERSION, PR_MODE_HTTP, LW_REQ, NULL }, /* HTTP version */
Willy Tarreau7346acb2014-08-28 15:03:15 +0200176 { "lc", LOG_FMT_LOGCNT, PR_MODE_TCP, LW_INIT, NULL }, /* log counter */
Willy Tarreau2beef582012-12-20 17:22:52 +0100177 { "ms", LOG_FMT_MS, PR_MODE_TCP, LW_INIT, NULL }, /* accept date millisecond */
William Lallemand5e19a282012-04-02 16:22:10 +0200178 { "pid", LOG_FMT_PID, PR_MODE_TCP, LW_INIT, NULL }, /* log pid */
Willy Tarreau2beef582012-12-20 17:22:52 +0100179 { "r", LOG_FMT_REQ, PR_MODE_HTTP, LW_REQ, NULL }, /* request */
180 { "rc", LOG_FMT_RETRIES, PR_MODE_TCP, LW_BYTES, NULL }, /* retries */
Willy Tarreau1f0da242014-01-25 11:01:50 +0100181 { "rt", LOG_FMT_COUNTER, PR_MODE_TCP, LW_REQ, NULL }, /* request counter (HTTP or TCP session) */
Willy Tarreau2beef582012-12-20 17:22:52 +0100182 { "s", LOG_FMT_SERVER, PR_MODE_TCP, LW_SVID, NULL }, /* server */
183 { "sc", LOG_FMT_SRVCONN, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_conn */
184 { "si", LOG_FMT_SERVERIP, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination ip */
185 { "sp", LOG_FMT_SERVERPORT, PR_MODE_TCP, LW_SVIP, NULL }, /* server destination port */
186 { "sq", LOG_FMT_SRVQUEUE, PR_MODE_TCP, LW_BYTES, NULL }, /* srv_queue */
Willy Tarreauffc3fcd2012-10-12 20:17:54 +0200187 { "sslc", LOG_FMT_SSL_CIPHER, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL ciphers */
188 { "sslv", LOG_FMT_SSL_VERSION, PR_MODE_TCP, LW_XPRT, NULL }, /* client-side SSL protocol version */
Willy Tarreau2beef582012-12-20 17:22:52 +0100189 { "t", LOG_FMT_DATE, PR_MODE_TCP, LW_INIT, NULL }, /* date */
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200190 { "tr", LOG_FMT_tr, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request */
191 { "trg",LOG_FMT_trg, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, GMT */
192 { "trl",LOG_FMT_trl, PR_MODE_HTTP, LW_INIT, NULL }, /* date of start of request, local */
Willy Tarreau2beef582012-12-20 17:22:52 +0100193 { "ts", LOG_FMT_TERMSTATE, PR_MODE_TCP, LW_BYTES, NULL },/* termination state */
194 { "tsc", LOG_FMT_TERMSTATE_CK, PR_MODE_TCP, LW_INIT, NULL },/* termination state */
William Lallemand5e19a282012-04-02 16:22:10 +0200195 { 0, 0, 0, 0, NULL }
William Lallemand723b73a2012-02-08 16:37:49 +0100196};
197
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200198char default_http_log_format[] = "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r"; // default format
Willy Tarreau68574dd2021-11-05 19:14:55 +0100199char default_https_log_format[] = "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r %[fc_err]/%[ssl_fc_err,hex]/%[ssl_c_err]/%[ssl_c_ca_err]/%[ssl_fc_is_resumed] %[ssl_fc_sni]/%sslv/%sslc";
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +0200200char clf_http_log_format[] = "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl";
Willy Tarreau2beef582012-12-20 17:22:52 +0100201char default_tcp_log_format[] = "%ci:%cp [%t] %ft %b/%s %Tw/%Tc/%Tt %B %ts %ac/%fc/%bc/%sc/%rc %sq/%bq";
William Lallemand723b73a2012-02-08 16:37:49 +0100202char *log_format = NULL;
203
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200204/* Default string used for structured-data part in RFC5424 formatted
205 * syslog messages.
206 */
207char default_rfc5424_sd_log_format[] = "- ";
Dragan Dosen1322d092015-09-22 16:05:32 +0200208
Willy Tarreau13ef7732018-11-12 07:25:28 +0100209/* total number of dropped logs */
210unsigned int dropped_logs = 0;
211
Dragan Dosen59cee972015-09-19 22:09:02 +0200212/* This is a global syslog message buffer, common to all outgoing
213 * messages. It contains only the data part.
Willy Tarreaub1a2faf2012-03-19 16:51:53 +0100214 */
Christopher Fauletf8188c62017-06-02 16:20:16 +0200215THREAD_LOCAL char *logline = NULL;
Willy Tarreaub1a2faf2012-03-19 16:51:53 +0100216
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200217/* A global syslog message buffer, common to all RFC5424 syslog messages.
218 * Currently, it is used for generating the structured-data part.
219 */
Christopher Fauletf8188c62017-06-02 16:20:16 +0200220THREAD_LOCAL char *logline_rfc5424 = NULL;
Dragan Dosen0b85ece2015-09-25 19:17:44 +0200221
William Lallemand723b73a2012-02-08 16:37:49 +0100222struct logformat_var_args {
223 char *name;
224 int mask;
225};
226
227struct logformat_var_args var_args_list[] = {
228// global
229 { "M", LOG_OPT_MANDATORY },
230 { "Q", LOG_OPT_QUOTE },
William Lallemand5f232402012-04-05 18:02:55 +0200231 { "X", LOG_OPT_HEXA },
Dragan Dosen835b9212016-02-12 13:23:03 +0100232 { "E", LOG_OPT_ESC },
William Lallemand723b73a2012-02-08 16:37:49 +0100233 { 0, 0 }
234};
235
236/*
William Lallemandb7ff6a32012-03-02 14:35:21 +0100237 * callback used to configure addr source retrieval
238 */
239int prepare_addrsource(struct logformat_node *node, struct proxy *curproxy)
240{
241 curproxy->options2 |= PR_O2_SRC_ADDR;
242
243 return 0;
244}
245
246
247/*
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100248 * Parse args in a logformat_var. Returns 0 in error
249 * case, otherwise, it returns 1.
William Lallemand723b73a2012-02-08 16:37:49 +0100250 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100251int parse_logformat_var_args(char *args, struct logformat_node *node, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100252{
253 int i = 0;
254 int end = 0;
255 int flags = 0; // 1 = + 2 = -
256 char *sp = NULL; // start pointer
257
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100258 if (args == NULL) {
259 memprintf(err, "internal error: parse_logformat_var_args() expects non null 'args'");
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100260 return 0;
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100261 }
William Lallemand723b73a2012-02-08 16:37:49 +0100262
263 while (1) {
264 if (*args == '\0')
265 end = 1;
266
267 if (*args == '+') {
268 // add flag
269 sp = args + 1;
270 flags = 1;
271 }
272 if (*args == '-') {
273 // delete flag
274 sp = args + 1;
275 flags = 2;
276 }
277
278 if (*args == '\0' || *args == ',') {
279 *args = '\0';
Willy Tarreau254d44c2012-12-20 18:19:26 +0100280 for (i = 0; sp && var_args_list[i].name; i++) {
William Lallemand723b73a2012-02-08 16:37:49 +0100281 if (strcmp(sp, var_args_list[i].name) == 0) {
282 if (flags == 1) {
283 node->options |= var_args_list[i].mask;
284 break;
285 } else if (flags == 2) {
286 node->options &= ~var_args_list[i].mask;
287 break;
288 }
289 }
290 }
291 sp = NULL;
292 if (end)
293 break;
294 }
Willy Tarreau254d44c2012-12-20 18:19:26 +0100295 args++;
William Lallemand723b73a2012-02-08 16:37:49 +0100296 }
Thierry FOURNIER / OZON.IObca46f02016-11-22 23:13:04 +0100297 return 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100298}
299
300/*
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100301 * Parse a variable '%varname' or '%{args}varname' in log-format. The caller
302 * must pass the args part in the <arg> pointer with its length in <arg_len>,
303 * and varname with its length in <var> and <var_len> respectively. <arg> is
304 * ignored when arg_len is 0. Neither <var> nor <var_len> may be null.
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100305 * Returns false in error case and err is filled, otherwise returns true.
William Lallemand723b73a2012-02-08 16:37:49 +0100306 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100307int parse_logformat_var(char *arg, int arg_len, char *var, int var_len, struct proxy *curproxy, struct list *list_format, int *defoptions, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100308{
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100309 int j;
Dragan Dosen61302da2019-04-30 00:40:02 +0200310 struct logformat_node *node = NULL;
William Lallemand723b73a2012-02-08 16:37:49 +0100311
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100312 for (j = 0; logformat_keywords[j].name; j++) { // search a log type
313 if (strlen(logformat_keywords[j].name) == var_len &&
314 strncmp(var, logformat_keywords[j].name, var_len) == 0) {
315 if (logformat_keywords[j].mode != PR_MODE_HTTP || curproxy->mode == PR_MODE_HTTP) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200316 node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100317 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100318 memprintf(err, "out of memory error");
Dragan Dosen61302da2019-04-30 00:40:02 +0200319 goto error_free;
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100320 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100321 node->type = logformat_keywords[j].type;
322 node->options = *defoptions;
323 if (arg_len) {
324 node->arg = my_strndup(arg, arg_len);
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100325 if (!parse_logformat_var_args(node->arg, node, err))
Dragan Dosen61302da2019-04-30 00:40:02 +0200326 goto error_free;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100327 }
328 if (node->type == LOG_FMT_GLOBAL) {
329 *defoptions = node->options;
330 free(node->arg);
331 free(node);
332 } else {
333 if (logformat_keywords[j].config_callback &&
334 logformat_keywords[j].config_callback(node, curproxy) != 0) {
Dragan Dosen61302da2019-04-30 00:40:02 +0200335 goto error_free;
William Lallemand723b73a2012-02-08 16:37:49 +0100336 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100337 curproxy->to_log |= logformat_keywords[j].lw;
Willy Tarreau2b718102021-04-21 07:32:39 +0200338 LIST_APPEND(list_format, &node->list);
William Lallemand723b73a2012-02-08 16:37:49 +0100339 }
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100340 return 1;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100341 } else {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100342 memprintf(err, "format variable '%s' is reserved for HTTP mode",
343 logformat_keywords[j].name);
Dragan Dosen61302da2019-04-30 00:40:02 +0200344 goto error_free;
William Lallemand723b73a2012-02-08 16:37:49 +0100345 }
William Lallemand723b73a2012-02-08 16:37:49 +0100346 }
347 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100348
349 j = var[var_len];
350 var[var_len] = 0;
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100351 memprintf(err, "no such format variable '%s'. If you wanted to emit the '%%' character verbatim, you need to use '%%%%'", var);
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100352 var[var_len] = j;
Dragan Dosen61302da2019-04-30 00:40:02 +0200353
354 error_free:
355 if (node) {
356 free(node->arg);
357 free(node);
358 }
Thierry FOURNIER / OZON.IOeca4d952016-11-22 22:06:04 +0100359 return 0;
William Lallemand723b73a2012-02-08 16:37:49 +0100360}
361
362/*
363 * push to the logformat linked list
364 *
365 * start: start pointer
366 * end: end text pointer
367 * type: string type
William Lallemand1d705562012-03-12 12:46:41 +0100368 * list_format: destination list
William Lallemand723b73a2012-02-08 16:37:49 +0100369 *
370 * LOG_TEXT: copy chars from start to end excluding end.
371 *
372*/
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100373int add_to_logformat_list(char *start, char *end, int type, struct list *list_format, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100374{
375 char *str;
376
Willy Tarreaua3571662012-12-20 21:59:12 +0100377 if (type == LF_TEXT) { /* type text */
Vincent Bernat02779b62016-04-03 13:48:43 +0200378 struct logformat_node *node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100379 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100380 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100381 return 0;
382 }
Vincent Bernat02779b62016-04-03 13:48:43 +0200383 str = calloc(1, end - start + 1);
William Lallemand723b73a2012-02-08 16:37:49 +0100384 strncpy(str, start, end - start);
William Lallemand723b73a2012-02-08 16:37:49 +0100385 str[end - start] = '\0';
386 node->arg = str;
William Lallemand1d705562012-03-12 12:46:41 +0100387 node->type = LOG_FMT_TEXT; // type string
Willy Tarreau2b718102021-04-21 07:32:39 +0200388 LIST_APPEND(list_format, &node->list);
Willy Tarreaua3571662012-12-20 21:59:12 +0100389 } else if (type == LF_SEPARATOR) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200390 struct logformat_node *node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100391 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100392 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100393 return 0;
394 }
William Lallemand1d705562012-03-12 12:46:41 +0100395 node->type = LOG_FMT_SEPARATOR;
Willy Tarreau2b718102021-04-21 07:32:39 +0200396 LIST_APPEND(list_format, &node->list);
William Lallemand723b73a2012-02-08 16:37:49 +0100397 }
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100398 return 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100399}
400
401/*
Willy Tarreauc8368452012-12-21 00:09:23 +0100402 * Parse the sample fetch expression <text> and add a node to <list_format> upon
403 * success. At the moment, sample converters are not yet supported but fetch arguments
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100404 * should work. The curpx->conf.args.ctx must be set by the caller. If an end pointer
405 * is passed in <endptr>, it will be updated with the pointer to the first character
406 * not part of the sample expression.
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100407 *
408 * In error case, the function returns 0, otherwise it returns 1.
Willy Tarreauc8368452012-12-21 00:09:23 +0100409 */
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100410int add_sample_to_logformat_list(char *text, char *arg, int arg_len, struct proxy *curpx, struct list *list_format, int options, int cap, char **err, char **endptr)
Willy Tarreauc8368452012-12-21 00:09:23 +0100411{
412 char *cmd[2];
Dragan Dosen61302da2019-04-30 00:40:02 +0200413 struct sample_expr *expr = NULL;
414 struct logformat_node *node = NULL;
Willy Tarreauc8368452012-12-21 00:09:23 +0100415 int cmd_arg;
416
417 cmd[0] = text;
418 cmd[1] = "";
419 cmd_arg = 0;
420
Christopher Fauleteaba25d2021-09-30 16:22:51 +0200421 expr = sample_parse_expr(cmd, &cmd_arg, curpx->conf.args.file, curpx->conf.args.line, err,
Christopher Faulet6ff7de52021-10-13 15:18:36 +0200422 &curpx->conf.args, endptr);
Willy Tarreauc8368452012-12-21 00:09:23 +0100423 if (!expr) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100424 memprintf(err, "failed to parse sample expression <%s> : %s", text, *err);
Dragan Dosen61302da2019-04-30 00:40:02 +0200425 goto error_free;
Willy Tarreauc8368452012-12-21 00:09:23 +0100426 }
427
Vincent Bernat02779b62016-04-03 13:48:43 +0200428 node = calloc(1, sizeof(*node));
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100429 if (!node) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100430 memprintf(err, "out of memory error");
Dragan Dosen61302da2019-04-30 00:40:02 +0200431 goto error_free;
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100432 }
Willy Tarreauc8368452012-12-21 00:09:23 +0100433 node->type = LOG_FMT_EXPR;
434 node->expr = expr;
435 node->options = options;
436
437 if (arg_len) {
438 node->arg = my_strndup(arg, arg_len);
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100439 if (!parse_logformat_var_args(node->arg, node, err))
Dragan Dosen61302da2019-04-30 00:40:02 +0200440 goto error_free;
Willy Tarreauc8368452012-12-21 00:09:23 +0100441 }
Willy Tarreau434c57c2013-01-08 01:10:24 +0100442 if (expr->fetch->val & cap & SMP_VAL_REQUEST)
Willy Tarreauc8368452012-12-21 00:09:23 +0100443 node->options |= LOG_OPT_REQ_CAP; /* fetch method is request-compatible */
444
Willy Tarreau434c57c2013-01-08 01:10:24 +0100445 if (expr->fetch->val & cap & SMP_VAL_RESPONSE)
Willy Tarreauc8368452012-12-21 00:09:23 +0100446 node->options |= LOG_OPT_RES_CAP; /* fetch method is response-compatible */
447
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100448 if (!(expr->fetch->val & cap)) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100449 memprintf(err, "sample fetch <%s> may not be reliably used here because it needs '%s' which is not available here",
450 text, sample_src_names(expr->fetch->use));
Dragan Dosen61302da2019-04-30 00:40:02 +0200451 goto error_free;
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100452 }
Willy Tarreau434c57c2013-01-08 01:10:24 +0100453
Christopher Faulet581db2b2021-03-26 10:02:46 +0100454 if ((options & LOG_OPT_HTTP) && (expr->fetch->use & (SMP_USE_L6REQ|SMP_USE_L6RES))) {
455 ha_warning("parsing [%s:%d] : L6 sample fetch <%s> ignored in HTTP log-format string.\n",
456 curpx->conf.args.file, curpx->conf.args.line, text);
457 }
458
Christopher Faulet711ed6a2019-07-16 14:16:10 +0200459 /* check if we need to allocate an http_txn struct for HTTP parsing */
Willy Tarreauc8368452012-12-21 00:09:23 +0100460 /* Note, we may also need to set curpx->to_log with certain fetches */
Willy Tarreau25320b22013-03-24 07:22:08 +0100461 curpx->http_needed |= !!(expr->fetch->use & SMP_USE_HTTP_ANY);
Willy Tarreauc8368452012-12-21 00:09:23 +0100462
William Lallemand65ad6e12014-01-31 15:08:02 +0100463 /* FIXME: temporary workaround for missing LW_XPRT and LW_REQ flags
464 * needed with some sample fetches (eg: ssl*). We always set it for
465 * now on, but this will leave with sample capabilities soon.
Willy Tarreau1f31c732013-01-10 16:22:27 +0100466 */
467 curpx->to_log |= LW_XPRT;
Christopher Fauletd2236cd2020-04-06 18:29:14 +0200468 if (curpx->http_needed)
469 curpx->to_log |= LW_REQ;
Willy Tarreau2b718102021-04-21 07:32:39 +0200470 LIST_APPEND(list_format, &node->list);
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100471 return 1;
Dragan Dosen61302da2019-04-30 00:40:02 +0200472
473 error_free:
474 release_sample_expr(expr);
475 if (node) {
476 free(node->arg);
477 free(node);
478 }
479 return 0;
Willy Tarreauc8368452012-12-21 00:09:23 +0100480}
481
482/*
William Lallemand723b73a2012-02-08 16:37:49 +0100483 * Parse the log_format string and fill a linked list.
484 * Variable name are preceded by % and composed by characters [a-zA-Z0-9]* : %varname
Willy Tarreaua4312fa2013-04-02 16:34:32 +0200485 * You can set arguments using { } : %{many arguments}varname.
486 * The curproxy->conf.args.ctx must be set by the caller.
William Lallemand1d705562012-03-12 12:46:41 +0100487 *
Ilya Shipitsinae40dbc2020-04-04 12:59:53 +0500488 * fmt: the string to parse
William Lallemand1d705562012-03-12 12:46:41 +0100489 * curproxy: the proxy affected
490 * list_format: the destination list
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +0100491 * options: LOG_OPT_* to force on every node
Willy Tarreau434c57c2013-01-08 01:10:24 +0100492 * cap: all SMP_VAL_* flags supported by the consumer
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100493 *
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100494 * The function returns 1 in success case, otherwise, it returns 0 and err is filled.
William Lallemand723b73a2012-02-08 16:37:49 +0100495 */
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100496int parse_logformat_string(const char *fmt, struct proxy *curproxy, struct list *list_format, int options, int cap, char **err)
William Lallemand723b73a2012-02-08 16:37:49 +0100497{
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100498 char *sp, *str, *backfmt; /* start pointer for text parts */
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100499 char *arg = NULL; /* start pointer for args */
500 char *var = NULL; /* start pointer for vars */
501 int arg_len = 0;
502 int var_len = 0;
503 int cformat; /* current token format */
504 int pformat; /* previous token format */
William Lallemand723b73a2012-02-08 16:37:49 +0100505 struct logformat_node *tmplf, *back;
506
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100507 sp = str = backfmt = strdup(fmt);
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100508 if (!str) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100509 memprintf(err, "out of memory error");
Thierry FOURNIER / OZON.IO9cbfef22016-11-22 23:24:10 +0100510 return 0;
511 }
William Lallemand1dc00ef2012-08-09 16:41:35 +0200512 curproxy->to_log |= LW_INIT;
William Lallemand5e19a282012-04-02 16:22:10 +0200513
William Lallemand723b73a2012-02-08 16:37:49 +0100514 /* flush the list first. */
William Lallemand1d705562012-03-12 12:46:41 +0100515 list_for_each_entry_safe(tmplf, back, list_format, list) {
Willy Tarreau2b718102021-04-21 07:32:39 +0200516 LIST_DELETE(&tmplf->list);
Dragan Dosen61302da2019-04-30 00:40:02 +0200517 release_sample_expr(tmplf->expr);
518 free(tmplf->arg);
William Lallemand723b73a2012-02-08 16:37:49 +0100519 free(tmplf);
520 }
521
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100522 for (cformat = LF_INIT; cformat != LF_END; str++) {
William Lallemand723b73a2012-02-08 16:37:49 +0100523 pformat = cformat;
524
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100525 if (!*str)
526 cformat = LF_END; // preset it to save all states from doing this
William Lallemand723b73a2012-02-08 16:37:49 +0100527
Joseph Herlant85b40592018-11-15 12:10:04 -0800528 /* The principle of the two-step state machine below is to first detect a change, and
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100529 * second have all common paths processed at one place. The common paths are the ones
530 * encountered in text areas (LF_INIT, LF_TEXT, LF_SEPARATOR) and at the end (LF_END).
531 * We use the common LF_INIT state to dispatch to the different final states.
532 */
533 switch (pformat) {
534 case LF_STARTVAR: // text immediately following a '%'
Willy Tarreauc8368452012-12-21 00:09:23 +0100535 arg = NULL; var = NULL;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100536 arg_len = var_len = 0;
537 if (*str == '{') { // optional argument
538 cformat = LF_STARG;
539 arg = str + 1;
William Lallemand723b73a2012-02-08 16:37:49 +0100540 }
Willy Tarreauc8368452012-12-21 00:09:23 +0100541 else if (*str == '[') {
542 cformat = LF_STEXPR;
543 var = str + 1; // store expr in variable name
544 }
Willy Tarreau0f28f822013-12-16 01:38:33 +0100545 else if (isalpha((unsigned char)*str)) { // variable name
William Lallemand723b73a2012-02-08 16:37:49 +0100546 cformat = LF_VAR;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100547 var = str;
William Lallemand723b73a2012-02-08 16:37:49 +0100548 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100549 else if (*str == '%')
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500550 cformat = LF_TEXT; // convert this character to a literal (useful for '%')
Willy Tarreau0f28f822013-12-16 01:38:33 +0100551 else if (isdigit((unsigned char)*str) || *str == ' ' || *str == '\t') {
Willy Tarreau06d97f92013-12-02 17:45:48 +0100552 /* single '%' followed by blank or digit, send them both */
553 cformat = LF_TEXT;
554 pformat = LF_TEXT; /* finally we include the previous char as well */
555 sp = str - 1; /* send both the '%' and the current char */
Jim Freemana2278c82017-04-15 08:01:59 -0600556 memprintf(err, "unexpected variable name near '%c' at position %d line : '%s'. Maybe you want to write a single '%%', use the syntax '%%%%'",
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100557 *str, (int)(str - backfmt), fmt);
Willy Tarreau51013e82019-12-11 12:05:39 +0100558 goto fail;
Willy Tarreau06d97f92013-12-02 17:45:48 +0100559
560 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100561 else
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500562 cformat = LF_INIT; // handle other cases of literals
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100563 break;
564
565 case LF_STARG: // text immediately following '%{'
566 if (*str == '}') { // end of arg
William Lallemand723b73a2012-02-08 16:37:49 +0100567 cformat = LF_EDARG;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100568 arg_len = str - arg;
569 *str = 0; // used for reporting errors
William Lallemand723b73a2012-02-08 16:37:49 +0100570 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100571 break;
572
573 case LF_EDARG: // text immediately following '%{arg}'
Willy Tarreauc8368452012-12-21 00:09:23 +0100574 if (*str == '[') {
575 cformat = LF_STEXPR;
576 var = str + 1; // store expr in variable name
577 break;
578 }
Willy Tarreau0f28f822013-12-16 01:38:33 +0100579 else if (isalnum((unsigned char)*str)) { // variable name
William Lallemand723b73a2012-02-08 16:37:49 +0100580 cformat = LF_VAR;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100581 var = str;
582 break;
583 }
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100584 memprintf(err, "parse argument modifier without variable name near '%%{%s}'", arg);
Willy Tarreau51013e82019-12-11 12:05:39 +0100585 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100586
Willy Tarreauc8368452012-12-21 00:09:23 +0100587 case LF_STEXPR: // text immediately following '%['
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100588 /* the whole sample expression is parsed at once,
589 * returning the pointer to the first character not
590 * part of the expression, which MUST be the trailing
591 * angle bracket.
592 */
593 if (!add_sample_to_logformat_list(var, arg, arg_len, curproxy, list_format, options, cap, err, &str))
594 goto fail;
595
596 if (*str == ']') {
597 // end of arg, go on with next state
598 cformat = pformat = LF_EDEXPR;
599 sp = str;
600 }
601 else {
602 char c = *str;
603 *str = 0;
Willy Tarreau90807112020-02-25 08:16:33 +0100604 if (isprint((unsigned char)c))
Willy Tarreaucd0d2ed2020-02-14 17:33:06 +0100605 memprintf(err, "expected ']' after '%s', but found '%c'", var, c);
606 else
607 memprintf(err, "missing ']' after '%s'", var);
Dragan Dosen2866acf2020-06-30 21:16:43 +0200608 goto fail;
Willy Tarreauc8368452012-12-21 00:09:23 +0100609 }
610 break;
611
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100612 case LF_VAR: // text part of a variable name
613 var_len = str - var;
Willy Tarreau0f28f822013-12-16 01:38:33 +0100614 if (!isalnum((unsigned char)*str))
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100615 cformat = LF_INIT; // not variable name anymore
616 break;
617
Willy Tarreauc8368452012-12-21 00:09:23 +0100618 default: // LF_INIT, LF_TEXT, LF_SEPARATOR, LF_END, LF_EDEXPR
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100619 cformat = LF_INIT;
620 }
621
622 if (cformat == LF_INIT) { /* resynchronize state to text/sep/startvar */
623 switch (*str) {
624 case '%': cformat = LF_STARTVAR; break;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100625 case 0 : cformat = LF_END; break;
Dragan Dosen1e3b16f2020-06-23 18:16:44 +0200626 case ' ':
627 if (options & LOG_OPT_MERGE_SPACES) {
628 cformat = LF_SEPARATOR;
629 break;
630 }
631 /* fall through */
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100632 default : cformat = LF_TEXT; break;
William Lallemand723b73a2012-02-08 16:37:49 +0100633 }
634 }
635
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100636 if (cformat != pformat || pformat == LF_SEPARATOR) {
637 switch (pformat) {
638 case LF_VAR:
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100639 if (!parse_logformat_var(arg, arg_len, var, var_len, curproxy, list_format, &options, err))
Willy Tarreau51013e82019-12-11 12:05:39 +0100640 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100641 break;
642 case LF_TEXT:
643 case LF_SEPARATOR:
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100644 if (!add_to_logformat_list(sp, str, pformat, list_format, err))
Willy Tarreau51013e82019-12-11 12:05:39 +0100645 goto fail;
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100646 break;
647 }
648 sp = str; /* new start of text at every state switch and at every separator */
William Lallemand723b73a2012-02-08 16:37:49 +0100649 }
650 }
Willy Tarreau8a3f52f2012-12-20 21:23:42 +0100651
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100652 if (pformat == LF_STARTVAR || pformat == LF_STARG || pformat == LF_STEXPR) {
Thierry FOURNIER / OZON.IO8a4e4422016-11-23 00:41:28 +0100653 memprintf(err, "truncated line after '%s'", var ? var : arg ? arg : "%");
Willy Tarreau51013e82019-12-11 12:05:39 +0100654 goto fail;
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100655 }
Willy Tarreaub83bc1e2012-12-24 12:36:33 +0100656 free(backfmt);
Thierry FOURNIER / OZON.IOa2c38d72016-11-22 23:11:21 +0100657
658 return 1;
Willy Tarreau51013e82019-12-11 12:05:39 +0100659 fail:
660 free(backfmt);
661 return 0;
William Lallemand723b73a2012-02-08 16:37:49 +0100662}
663
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200664/*
Ilya Shipitsin856aabc2020-04-16 23:51:34 +0500665 * Parse the first range of indexes from a string made of a list of comma separated
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200666 * ranges of indexes. Note that an index may be considered as a particular range
667 * with a high limit to the low limit.
668 */
669int get_logsrv_smp_range(unsigned int *low, unsigned int *high, char **arg, char **err)
670{
671 char *end, *p;
672
673 *low = *high = 0;
674
675 p = *arg;
676 end = strchr(p, ',');
677 if (!end)
678 end = p + strlen(p);
679
680 *high = *low = read_uint((const char **)&p, end);
681 if (!*low || (p != end && *p != '-'))
682 goto err;
683
684 if (p == end)
685 goto done;
686
687 p++;
688 *high = read_uint((const char **)&p, end);
689 if (!*high || *high <= *low || p != end)
690 goto err;
691
692 done:
693 if (*end == ',')
694 end++;
695 *arg = end;
696 return 1;
697
698 err:
699 memprintf(err, "wrong sample range '%s'", *arg);
700 return 0;
701}
702
703/*
704 * Returns 1 if the range defined by <low> and <high> overlaps
705 * one of them in <rgs> array of ranges with <sz> the size of this
706 * array, 0 if not.
707 */
708int smp_log_ranges_overlap(struct smp_log_range *rgs, size_t sz,
709 unsigned int low, unsigned int high, char **err)
710{
711 size_t i;
712
713 for (i = 0; i < sz; i++) {
714 if ((low >= rgs[i].low && low <= rgs[i].high) ||
715 (high >= rgs[i].low && high <= rgs[i].high)) {
716 memprintf(err, "ranges are overlapping");
717 return 1;
718 }
719 }
720
721 return 0;
722}
723
724int smp_log_range_cmp(const void *a, const void *b)
725{
726 const struct smp_log_range *rg_a = a;
727 const struct smp_log_range *rg_b = b;
728
729 if (rg_a->high < rg_b->low)
730 return -1;
731 else if (rg_a->low > rg_b->high)
732 return 1;
733
734 return 0;
735}
736
Willy Tarreau211ea252022-03-17 19:47:33 +0100737/* frees log server <logsrv> after freeing all of its allocated fields. The
738 * server must not belong to a list anymore. Logsrv may be NULL, which is
739 * silently ignored.
740 */
741void free_logsrv(struct logsrv *logsrv)
742{
743 if (!logsrv)
744 return;
745
746 BUG_ON(LIST_INLIST(&logsrv->list));
747 ha_free(&logsrv->conf.file);
748 ha_free(&logsrv->ring_name);
749 free(logsrv);
750}
751
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200752/*
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200753 * Parse "log" keyword and update <logsrvs> list accordingly.
754 *
755 * When <do_del> is set, it means the "no log" line was parsed, so all log
756 * servers in <logsrvs> are released.
757 *
758 * Otherwise, we try to parse the "log" line. First of all, when the list is not
759 * the global one, we look for the parameter "global". If we find it,
760 * global.logsrvs is copied. Else we parse each arguments.
761 *
762 * The function returns 1 in success case, otherwise, it returns 0 and err is
763 * filled.
764 */
Emeric Brun9533a702021-04-02 10:13:43 +0200765int parse_logsrv(char **args, struct list *logsrvs, int do_del, const char *file, int linenum, char **err)
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200766{
Willy Tarreauae32ac72020-10-27 09:51:37 +0100767 struct smp_log_range *smp_rgs = NULL;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200768 struct sockaddr_storage *sk;
Emeric Brun94aab062021-04-02 10:41:36 +0200769 struct protocol *proto;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200770 struct logsrv *logsrv = NULL;
771 int port1, port2;
772 int cur_arg;
Willy Tarreau89599262020-09-15 14:03:26 +0200773 int fd;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200774
775 /*
776 * "no log": delete previous herited or defined syslog
777 * servers.
778 */
779 if (do_del) {
780 struct logsrv *back;
781
782 if (*(args[1]) != 0) {
783 memprintf(err, "'no log' does not expect arguments");
784 goto error;
785 }
786
787 list_for_each_entry_safe(logsrv, back, logsrvs, list) {
Willy Tarreau211ea252022-03-17 19:47:33 +0100788 LIST_DEL_INIT(&logsrv->list);
789 free_logsrv(logsrv);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200790 }
791 return 1;
792 }
793
794 /*
795 * "log global": copy global.logrsvs linked list to the end of logsrvs
796 * list. But first, we check (logsrvs != global.logsrvs).
797 */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100798 if (*(args[1]) && *(args[2]) == 0 && strcmp(args[1], "global") == 0) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200799 if (logsrvs == &global.logsrvs) {
800 memprintf(err, "'global' is not supported for a global syslog server");
801 goto error;
802 }
803 list_for_each_entry(logsrv, &global.logsrvs, list) {
Christopher Faulet28ac0992018-03-26 16:09:19 +0200804 struct logsrv *node;
805
806 list_for_each_entry(node, logsrvs, list) {
807 if (node->ref == logsrv)
808 goto skip_logsrv;
809 }
810
811 node = malloc(sizeof(*node));
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200812 memcpy(node, logsrv, sizeof(struct logsrv));
Christopher Faulet28ac0992018-03-26 16:09:19 +0200813 node->ref = logsrv;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200814 LIST_INIT(&node->list);
Willy Tarreau2b718102021-04-21 07:32:39 +0200815 LIST_APPEND(logsrvs, &node->list);
Willy Tarreau211ea252022-03-17 19:47:33 +0100816 node->ring_name = logsrv->ring_name ? strdup(logsrv->ring_name) : NULL;
Emeric Brun9533a702021-04-02 10:13:43 +0200817 node->conf.file = strdup(file);
818 node->conf.line = linenum;
Christopher Faulet28ac0992018-03-26 16:09:19 +0200819
820 skip_logsrv:
821 continue;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200822 }
823 return 1;
824 }
825
826 /*
827 * "log <address> ...: parse a syslog server line
828 */
829 if (*(args[1]) == 0 || *(args[2]) == 0) {
830 memprintf(err, "expects <address> and <facility> %s as arguments",
831 ((logsrvs == &global.logsrvs) ? "" : "or global"));
832 goto error;
833 }
834
Willy Tarreau5a32ecc2018-11-12 07:34:59 +0100835 /* take care of "stdout" and "stderr" as regular aliases for fd@1 / fd@2 */
836 if (strcmp(args[1], "stdout") == 0)
837 args[1] = "fd@1";
838 else if (strcmp(args[1], "stderr") == 0)
839 args[1] = "fd@2";
840
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200841 logsrv = calloc(1, sizeof(*logsrv));
842 if (!logsrv) {
843 memprintf(err, "out of memory");
844 goto error;
845 }
Christopher Fauletb4f96ed2022-03-29 14:17:09 +0200846 LIST_INIT(&logsrv->list);
Emeric Brun9533a702021-04-02 10:13:43 +0200847 logsrv->conf.file = strdup(file);
848 logsrv->conf.line = linenum;
849
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200850 /* skip address for now, it will be parsed at the end */
851 cur_arg = 2;
852
853 /* just after the address, a length may be specified */
854 logsrv->maxlen = MAX_SYSLOG_LEN;
855 if (strcmp(args[cur_arg], "len") == 0) {
856 int len = atoi(args[cur_arg+1]);
857 if (len < 80 || len > 65535) {
858 memprintf(err, "invalid log length '%s', must be between 80 and 65535",
859 args[cur_arg+1]);
860 goto error;
861 }
862 logsrv->maxlen = len;
863 cur_arg += 2;
864 }
865 if (logsrv->maxlen > global.max_syslog_len)
866 global.max_syslog_len = logsrv->maxlen;
867
868 /* after the length, a format may be specified */
869 if (strcmp(args[cur_arg], "format") == 0) {
870 logsrv->format = get_log_format(args[cur_arg+1]);
Emeric Brun54648852020-07-06 15:54:06 +0200871 if (logsrv->format == LOG_FORMAT_UNSPEC) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200872 memprintf(err, "unknown log format '%s'", args[cur_arg+1]);
873 goto error;
874 }
875 cur_arg += 2;
876 }
877
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200878 if (strcmp(args[cur_arg], "sample") == 0) {
879 unsigned low, high;
880 char *p, *beg, *end, *smp_sz_str;
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200881 size_t smp_rgs_sz = 0, smp_sz = 0, new_smp_sz;
882
883 p = args[cur_arg+1];
884 smp_sz_str = strchr(p, ':');
885 if (!smp_sz_str) {
886 memprintf(err, "Missing sample size");
887 goto error;
888 }
889
890 *smp_sz_str++ = '\0';
891
892 end = p + strlen(p);
893
894 while (p != end) {
895 if (!get_logsrv_smp_range(&low, &high, &p, err))
896 goto error;
897
898 if (smp_rgs && smp_log_ranges_overlap(smp_rgs, smp_rgs_sz, low, high, err))
899 goto error;
900
901 smp_rgs = my_realloc2(smp_rgs, (smp_rgs_sz + 1) * sizeof *smp_rgs);
902 if (!smp_rgs) {
903 memprintf(err, "out of memory error");
904 goto error;
905 }
906
907 smp_rgs[smp_rgs_sz].low = low;
908 smp_rgs[smp_rgs_sz].high = high;
909 smp_rgs[smp_rgs_sz].sz = high - low + 1;
910 smp_rgs[smp_rgs_sz].curr_idx = 0;
911 if (smp_rgs[smp_rgs_sz].high > smp_sz)
912 smp_sz = smp_rgs[smp_rgs_sz].high;
913 smp_rgs_sz++;
914 }
915
Tim Duesterhus21648002019-06-23 22:10:10 +0200916 if (smp_rgs == NULL) {
917 memprintf(err, "no sampling ranges given");
918 goto error;
919 }
920
Frédéric Lécailled95ea282019-04-24 16:14:33 +0200921 beg = smp_sz_str;
922 end = beg + strlen(beg);
923 new_smp_sz = read_uint((const char **)&beg, end);
924 if (!new_smp_sz || beg != end) {
925 memprintf(err, "wrong sample size '%s' for sample range '%s'",
926 smp_sz_str, args[cur_arg+1]);
927 goto error;
928 }
929
930 if (new_smp_sz < smp_sz) {
931 memprintf(err, "sample size %zu should be greater or equal to "
932 "%zu the maximum of the high ranges limits",
933 new_smp_sz, smp_sz);
934 goto error;
935 }
936 smp_sz = new_smp_sz;
937
938 /* Let's order <smp_rgs> array. */
939 qsort(smp_rgs, smp_rgs_sz, sizeof(struct smp_log_range), smp_log_range_cmp);
940
941 logsrv->lb.smp_rgs = smp_rgs;
942 logsrv->lb.smp_rgs_sz = smp_rgs_sz;
943 logsrv->lb.smp_sz = smp_sz;
944
945 cur_arg += 2;
946 }
Frédéric Lécailled803e472019-04-25 07:42:09 +0200947 HA_SPIN_INIT(&logsrv->lock);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200948 /* parse the facility */
949 logsrv->facility = get_log_facility(args[cur_arg]);
950 if (logsrv->facility < 0) {
951 memprintf(err, "unknown log facility '%s'", args[cur_arg]);
952 goto error;
953 }
954 cur_arg++;
955
956 /* parse the max syslog level (default: debug) */
957 logsrv->level = 7;
958 if (*(args[cur_arg])) {
959 logsrv->level = get_log_level(args[cur_arg]);
960 if (logsrv->level < 0) {
961 memprintf(err, "unknown optional log level '%s'", args[cur_arg]);
962 goto error;
963 }
964 cur_arg++;
965 }
966
967 /* parse the limit syslog level (default: emerg) */
968 logsrv->minlvl = 0;
969 if (*(args[cur_arg])) {
970 logsrv->minlvl = get_log_level(args[cur_arg]);
971 if (logsrv->minlvl < 0) {
972 memprintf(err, "unknown optional minimum log level '%s'", args[cur_arg]);
973 goto error;
974 }
975 cur_arg++;
976 }
977
978 /* Too many args */
979 if (*(args[cur_arg])) {
980 memprintf(err, "cannot handle unexpected argument '%s'", args[cur_arg]);
981 goto error;
982 }
983
984 /* now, back to the address */
Willy Tarreauf3dc30f2019-08-30 14:18:44 +0200985 logsrv->type = LOG_TARGET_DGRAM;
Willy Tarreauc046d162019-08-30 15:24:59 +0200986 if (strncmp(args[1], "ring@", 5) == 0) {
Willy Tarreauc046d162019-08-30 15:24:59 +0200987 logsrv->addr.ss_family = AF_UNSPEC;
988 logsrv->type = LOG_TARGET_BUFFER;
Emeric Brun99c453d2020-05-25 15:01:04 +0200989 logsrv->sink = NULL;
990 logsrv->ring_name = strdup(args[1] + 5);
Willy Tarreauc046d162019-08-30 15:24:59 +0200991 goto done;
992 }
993
Emeric Brun94aab062021-04-02 10:41:36 +0200994 sk = str2sa_range(args[1], NULL, &port1, &port2, &fd, &proto,
995 err, NULL, NULL,
996 PA_O_RESOLVE | PA_O_PORT_OK | PA_O_RAW_FD | PA_O_DGRAM | PA_O_STREAM | PA_O_DEFAULT_DGRAM);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +0200997 if (!sk)
998 goto error;
Willy Tarreau89599262020-09-15 14:03:26 +0200999
1000 if (fd != -1)
1001 logsrv->type = LOG_TARGET_FD;
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001002 logsrv->addr = *sk;
1003
1004 if (sk->ss_family == AF_INET || sk->ss_family == AF_INET6) {
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001005 if (!port1)
1006 set_host_port(&logsrv->addr, SYSLOG_PORT);
1007 }
Emeric Brun9533a702021-04-02 10:13:43 +02001008
Emeric Brun26754902021-04-07 14:26:44 +02001009 if (proto && proto->ctrl_type == SOCK_STREAM) {
Emeric Brun94aab062021-04-02 10:41:36 +02001010 static unsigned long ring_ids;
1011
1012 /* Implicit sink buffer will be
1013 * initialized in post_check
1014 */
1015 logsrv->type = LOG_TARGET_BUFFER;
1016 logsrv->sink = NULL;
1017 /* compute uniq name for the ring */
1018 memprintf(&logsrv->ring_name, "ring#%lu", ++ring_ids);
1019 }
1020
Willy Tarreauc046d162019-08-30 15:24:59 +02001021 done:
Willy Tarreau2b718102021-04-21 07:32:39 +02001022 LIST_APPEND(logsrvs, &logsrv->list);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001023 return 1;
1024
1025 error:
Willy Tarreauae32ac72020-10-27 09:51:37 +01001026 free(smp_rgs);
Willy Tarreau211ea252022-03-17 19:47:33 +01001027 free_logsrv(logsrv);
Christopher Faulet4b0b79d2018-03-26 15:54:32 +02001028 return 0;
1029}
1030
Amaury Denoyelle7b01a8d2021-03-29 10:29:07 +02001031
1032/*
Emeric Brun54648852020-07-06 15:54:06 +02001033 * returns log format, LOG_FORMAT_UNSPEC is return if not found.
Dragan Dosen1322d092015-09-22 16:05:32 +02001034 */
Emeric Brun54648852020-07-06 15:54:06 +02001035enum log_fmt get_log_format(const char *fmt)
Dragan Dosen1322d092015-09-22 16:05:32 +02001036{
Emeric Brun54648852020-07-06 15:54:06 +02001037 enum log_fmt format;
Dragan Dosen1322d092015-09-22 16:05:32 +02001038
1039 format = LOG_FORMATS - 1;
Emeric Brun54648852020-07-06 15:54:06 +02001040 while (format > 0 && log_formats[format].name
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001041 && strcmp(log_formats[format].name, fmt) != 0)
Dragan Dosen1322d092015-09-22 16:05:32 +02001042 format--;
1043
Emeric Brun54648852020-07-06 15:54:06 +02001044 /* Note: 0 is LOG_FORMAT_UNSPEC */
Dragan Dosen1322d092015-09-22 16:05:32 +02001045 return format;
1046}
1047
1048/*
Willy Tarreaubaaee002006-06-26 02:48:02 +02001049 * returns log level for <lev> or -1 if not found.
1050 */
1051int get_log_level(const char *lev)
1052{
1053 int level;
1054
1055 level = NB_LOG_LEVELS - 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001056 while (level >= 0 && strcmp(log_levels[level], lev) != 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001057 level--;
1058
1059 return level;
1060}
1061
Willy Tarreaubaaee002006-06-26 02:48:02 +02001062/*
1063 * returns log facility for <fac> or -1 if not found.
1064 */
1065int get_log_facility(const char *fac)
1066{
1067 int facility;
1068
1069 facility = NB_LOG_FACILITIES - 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001070 while (facility >= 0 && strcmp(log_facilities[facility], fac) != 0)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001071 facility--;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001072
Willy Tarreaubaaee002006-06-26 02:48:02 +02001073 return facility;
1074}
1075
William Lallemanda1cc3812012-02-08 16:38:44 +01001076/*
Dragan Dosen835b9212016-02-12 13:23:03 +01001077 * Encode the string.
1078 *
1079 * When using the +E log format option, it will try to escape '"\]'
1080 * characters with '\' as prefix. The same prefix should not be used as
1081 * <escape>.
1082 */
1083static char *lf_encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001084 const char escape, const long *map,
Dragan Dosen835b9212016-02-12 13:23:03 +01001085 const char *string,
1086 struct logformat_node *node)
1087{
1088 if (node->options & LOG_OPT_ESC) {
1089 if (start < stop) {
1090 stop--; /* reserve one byte for the final '\0' */
1091 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001092 if (!ha_bit_test((unsigned char)(*string), map)) {
1093 if (!ha_bit_test((unsigned char)(*string), rfc5424_escape_map))
Dragan Dosen835b9212016-02-12 13:23:03 +01001094 *start++ = *string;
1095 else {
1096 if (start + 2 >= stop)
1097 break;
1098 *start++ = '\\';
1099 *start++ = *string;
1100 }
1101 }
1102 else {
1103 if (start + 3 >= stop)
1104 break;
1105 *start++ = escape;
1106 *start++ = hextab[(*string >> 4) & 15];
1107 *start++ = hextab[*string & 15];
1108 }
1109 string++;
1110 }
1111 *start = '\0';
1112 }
1113 }
1114 else {
1115 return encode_string(start, stop, escape, map, string);
1116 }
1117
1118 return start;
1119}
1120
1121/*
1122 * Encode the chunk.
1123 *
1124 * When using the +E log format option, it will try to escape '"\]'
1125 * characters with '\' as prefix. The same prefix should not be used as
1126 * <escape>.
1127 */
1128static char *lf_encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001129 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001130 const struct buffer *chunk,
Dragan Dosen835b9212016-02-12 13:23:03 +01001131 struct logformat_node *node)
1132{
1133 char *str, *end;
1134
1135 if (node->options & LOG_OPT_ESC) {
1136 if (start < stop) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001137 str = chunk->area;
1138 end = chunk->area + chunk->data;
Dragan Dosen835b9212016-02-12 13:23:03 +01001139
1140 stop--; /* reserve one byte for the final '\0' */
1141 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001142 if (!ha_bit_test((unsigned char)(*str), map)) {
1143 if (!ha_bit_test((unsigned char)(*str), rfc5424_escape_map))
Dragan Dosen835b9212016-02-12 13:23:03 +01001144 *start++ = *str;
1145 else {
1146 if (start + 2 >= stop)
1147 break;
1148 *start++ = '\\';
1149 *start++ = *str;
1150 }
1151 }
1152 else {
1153 if (start + 3 >= stop)
1154 break;
1155 *start++ = escape;
1156 *start++ = hextab[(*str >> 4) & 15];
1157 *start++ = hextab[*str & 15];
1158 }
1159 str++;
1160 }
1161 *start = '\0';
1162 }
1163 }
1164 else {
1165 return encode_chunk(start, stop, escape, map, chunk);
1166 }
1167
1168 return start;
1169}
1170
1171/*
William Lallemanda1cc3812012-02-08 16:38:44 +01001172 * Write a string in the log string
Dragan Dosen835b9212016-02-12 13:23:03 +01001173 * Take cares of quote and escape options
William Lallemanda1cc3812012-02-08 16:38:44 +01001174 *
Joseph Herlant85b40592018-11-15 12:10:04 -08001175 * Return the address of the \0 character, or NULL on error
William Lallemanda1cc3812012-02-08 16:38:44 +01001176 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001177char *lf_text_len(char *dst, const char *src, size_t len, size_t size, const struct logformat_node *node)
William Lallemanda1cc3812012-02-08 16:38:44 +01001178{
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001179 if (size < 2)
1180 return NULL;
William Lallemanda1cc3812012-02-08 16:38:44 +01001181
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001182 if (node->options & LOG_OPT_QUOTE) {
1183 *(dst++) = '"';
1184 size--;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001185 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001186
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001187 if (src && len) {
Dragan Dosendb1b6f92016-07-25 11:35:02 +02001188 if (++len > size)
1189 len = size;
Dragan Dosen835b9212016-02-12 13:23:03 +01001190 if (node->options & LOG_OPT_ESC) {
Dragan Dosen835b9212016-02-12 13:23:03 +01001191 char *ret;
1192
Dragan Dosendb1b6f92016-07-25 11:35:02 +02001193 ret = escape_string(dst, dst + len, '\\', rfc5424_escape_map, src);
Dragan Dosen835b9212016-02-12 13:23:03 +01001194 if (ret == NULL || *ret != '\0')
1195 return NULL;
1196 len = ret - dst;
1197 }
1198 else {
Dragan Dosen835b9212016-02-12 13:23:03 +01001199 len = strlcpy2(dst, src, len);
1200 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001201
1202 size -= len;
1203 dst += len;
1204 }
Willy Tarreau6cbbdbf2013-02-05 18:52:25 +01001205 else if ((node->options & (LOG_OPT_QUOTE|LOG_OPT_MANDATORY)) == LOG_OPT_MANDATORY) {
1206 if (size < 2)
1207 return NULL;
1208 *(dst++) = '-';
1209 }
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001210
1211 if (node->options & LOG_OPT_QUOTE) {
1212 if (size < 2)
1213 return NULL;
1214 *(dst++) = '"';
1215 }
1216
1217 *dst = '\0';
William Lallemandbddd4fd2012-02-27 11:23:10 +01001218 return dst;
William Lallemanda1cc3812012-02-08 16:38:44 +01001219}
1220
Willy Tarreau26ffa852018-09-05 15:23:10 +02001221static inline char *lf_text(char *dst, const char *src, size_t size, const struct logformat_node *node)
Willy Tarreau2b0108a2012-12-21 19:23:44 +01001222{
1223 return lf_text_len(dst, src, size, size, node);
1224}
1225
William Lallemand5f232402012-04-05 18:02:55 +02001226/*
Joseph Herlant85b40592018-11-15 12:10:04 -08001227 * Write a IP address to the log string
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001228 * +X option write in hexadecimal notation, most significant byte on the left
William Lallemand5f232402012-04-05 18:02:55 +02001229 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001230char *lf_ip(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node)
William Lallemand5f232402012-04-05 18:02:55 +02001231{
1232 char *ret = dst;
1233 int iret;
1234 char pn[INET6_ADDRSTRLEN];
1235
1236 if (node->options & LOG_OPT_HEXA) {
Radek Zajic594c4562019-03-22 10:21:54 +00001237 unsigned char *addr = NULL;
1238 switch (sockaddr->sa_family) {
1239 case AF_INET:
1240 addr = (unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_addr.s_addr;
1241 iret = snprintf(dst, size, "%02X%02X%02X%02X", addr[0], addr[1], addr[2], addr[3]);
1242 break;
1243 case AF_INET6:
1244 addr = (unsigned char *)&((struct sockaddr_in6 *)sockaddr)->sin6_addr.s6_addr;
1245 iret = snprintf(dst, size, "%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X",
1246 addr[0], addr[1], addr[2], addr[3], addr[4], addr[5], addr[6], addr[7],
1247 addr[8], addr[9], addr[10], addr[11], addr[12], addr[13], addr[14], addr[15]);
1248 break;
1249 default:
1250 return NULL;
1251 }
William Lallemand5f232402012-04-05 18:02:55 +02001252 if (iret < 0 || iret > size)
1253 return NULL;
1254 ret += iret;
1255 } else {
1256 addr_to_str((struct sockaddr_storage *)sockaddr, pn, sizeof(pn));
1257 ret = lf_text(dst, pn, size, node);
1258 if (ret == NULL)
1259 return NULL;
1260 }
1261 return ret;
1262}
1263
1264/*
1265 * Write a port to the log
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001266 * +X option write in hexadecimal notation, most significant byte on the left
William Lallemand5f232402012-04-05 18:02:55 +02001267 */
Willy Tarreau26ffa852018-09-05 15:23:10 +02001268char *lf_port(char *dst, const struct sockaddr *sockaddr, size_t size, const struct logformat_node *node)
William Lallemand5f232402012-04-05 18:02:55 +02001269{
1270 char *ret = dst;
1271 int iret;
1272
1273 if (node->options & LOG_OPT_HEXA) {
1274 const unsigned char *port = (const unsigned char *)&((struct sockaddr_in *)sockaddr)->sin_port;
1275 iret = snprintf(dst, size, "%02X%02X", port[0], port[1]);
1276 if (iret < 0 || iret > size)
1277 return NULL;
1278 ret += iret;
1279 } else {
1280 ret = ltoa_o(get_host_port((struct sockaddr_storage *)sockaddr), dst, size);
1281 if (ret == NULL)
1282 return NULL;
1283 }
1284 return ret;
1285}
1286
Emeric Brun54648852020-07-06 15:54:06 +02001287
1288/*
1289 * This function sends the syslog message using a printf format string. It
1290 * expects an LF-terminated message.
Willy Tarreaub1a2faf2012-03-19 16:51:53 +01001291 */
Emeric Brun54648852020-07-06 15:54:06 +02001292void send_log(struct proxy *p, int level, const char *format, ...)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001293{
Emeric Brun54648852020-07-06 15:54:06 +02001294 va_list argp;
1295 int data_len;
1296
1297 if (level < 0 || format == NULL || logline == NULL)
1298 return;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001299
Emeric Brun54648852020-07-06 15:54:06 +02001300 va_start(argp, format);
1301 data_len = vsnprintf(logline, global.max_syslog_len, format, argp);
1302 if (data_len < 0 || data_len > global.max_syslog_len)
1303 data_len = global.max_syslog_len;
1304 va_end(argp);
Willy Tarreaufe944602007-10-25 10:34:16 +02001305
Emeric Brun54648852020-07-06 15:54:06 +02001306 __send_log((p ? &p->logsrvs : NULL), (p ? &p->log_tag : NULL), level,
1307 logline, data_len, default_rfc5424_sd_log_format, 2);
1308}
1309/*
1310 * This function builds a log header of given format using given
1311 * metadata, if format is set to LOF_FORMAT_UNSPEC, it tries
1312 * to determine format based on given metadas. It is useful
1313 * for log-forwarding to be able to forward any format without
1314 * settings.
1315 * This function returns a struct ist array of elements of the header
1316 * nbelem is set to the number of available elements.
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001317 * This function returns currently a maximum of NB_LOG_HDR_IST_ELEMENTS
Emeric Brun54648852020-07-06 15:54:06 +02001318 * elements.
1319 */
1320struct ist *build_log_header(enum log_fmt format, int level, int facility,
1321 struct ist *metadata, size_t *nbelem)
1322{
1323 static THREAD_LOCAL struct {
1324 struct ist ist_vector[NB_LOG_HDR_MAX_ELEMENTS];
1325 char timestamp_buffer[LOG_LEGACYTIME_LEN+1+1];
1326 time_t cur_legacy_time;
1327 char priority_buffer[6];
1328 } hdr_ctx = { .priority_buffer = "<<<<>" };
Willy Tarreaubaaee002006-06-26 02:48:02 +02001329
Emeric Brun54648852020-07-06 15:54:06 +02001330 struct tm logtime;
1331 int len;
1332 int fac_level = 0;
1333 time_t time = date.tv_sec;
Dragan Dosen43885c72015-10-01 13:18:13 +02001334
Emeric Brun54648852020-07-06 15:54:06 +02001335 *nbelem = 0;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001336
Emeric Brun54648852020-07-06 15:54:06 +02001337
1338 if (format == LOG_FORMAT_UNSPEC) {
1339 format = LOG_FORMAT_RAW;
1340 if (metadata) {
1341 /* If a hostname is set, it appears we want to perform syslog
1342 * because only rfc5427 or rfc3164 support an hostname.
1343 */
1344 if (metadata[LOG_META_HOST].len) {
1345 /* If a rfc5424 compliant timestamp is used we consider
1346 * that output format is rfc5424, else legacy format
1347 * is used as specified default for local logs
1348 * in documentation.
1349 */
1350 if ((metadata[LOG_META_TIME].len == 1 && metadata[LOG_META_TIME].ptr[0] == '-')
1351 || (metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN))
1352 format = LOG_FORMAT_RFC5424;
1353 else
1354 format = LOG_FORMAT_RFC3164;
1355 }
Emeric Brun0237c4e2020-11-27 16:24:34 +01001356 else if (metadata[LOG_META_TAG].len) {
1357 /* Tag is present but no hostname, we should
Ilya Shipitsinf38a0182020-12-21 01:16:17 +05001358 * consider we try to emit a local log
Emeric Brun0237c4e2020-11-27 16:24:34 +01001359 * in legacy format (analog to RFC3164 but
1360 * with stripped hostname).
1361 */
1362 format = LOG_FORMAT_LOCAL;
1363 }
Emeric Brun54648852020-07-06 15:54:06 +02001364 else if (metadata[LOG_META_PRIO].len) {
1365 /* the source seems a parsed message
1366 * offering a valid level/prio prefix
1367 * so we consider this format.
1368 */
1369 format = LOG_FORMAT_PRIO;
1370 }
1371 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001372 }
1373
Emeric Brun54648852020-07-06 15:54:06 +02001374 /* prepare priority, stored into 1 single elem */
1375 switch (format) {
Emeric Brun0237c4e2020-11-27 16:24:34 +01001376 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001377 case LOG_FORMAT_RFC3164:
1378 case LOG_FORMAT_RFC5424:
1379 case LOG_FORMAT_PRIO:
1380 fac_level = facility << 3;
1381 /* further format ignore the facility */
1382 /* fall through */
1383 case LOG_FORMAT_TIMED:
1384 case LOG_FORMAT_SHORT:
1385 fac_level += level;
1386 hdr_ctx.ist_vector[*nbelem].ptr = &hdr_ctx.priority_buffer[3]; /* last digit of the log level */
1387 do {
1388 *hdr_ctx.ist_vector[*nbelem].ptr = '0' + fac_level % 10;
1389 fac_level /= 10;
1390 hdr_ctx.ist_vector[*nbelem].ptr--;
1391 } while (fac_level && hdr_ctx.ist_vector[*nbelem].ptr > &hdr_ctx.priority_buffer[0]);
1392 *hdr_ctx.ist_vector[*nbelem].ptr = '<';
1393 hdr_ctx.ist_vector[(*nbelem)++].len = &hdr_ctx.priority_buffer[5] - hdr_ctx.ist_vector[0].ptr;
1394 break;
1395 case LOG_FORMAT_ISO:
1396 case LOG_FORMAT_RAW:
1397 break;
1398 case LOG_FORMAT_UNSPEC:
1399 case LOG_FORMATS:
1400 ABORT_NOW();
1401 }
Willy Tarreau094af4e2015-01-07 15:03:42 +01001402
William Lallemand2a4a44f2012-02-06 16:00:33 +01001403
Emeric Brun54648852020-07-06 15:54:06 +02001404 /* prepare timestamp, stored into a max of 4 elems */
1405 switch (format) {
Emeric Brun0237c4e2020-11-27 16:24:34 +01001406 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001407 case LOG_FORMAT_RFC3164:
1408 /* rfc3164 ex: 'Jan 1 00:00:00 ' */
1409 if (metadata && metadata[LOG_META_TIME].len == LOG_LEGACYTIME_LEN) {
1410 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1411 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001412 /* time is set, break immediately */
Emeric Brun54648852020-07-06 15:54:06 +02001413 break;
1414 }
1415 else if (metadata && metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN) {
1416 int month;
1417 char *timestamp = metadata[LOG_META_TIME].ptr;
Dragan Dosen1322d092015-09-22 16:05:32 +02001418
Emeric Brun54648852020-07-06 15:54:06 +02001419 /* iso time always begins like this: '1970-01-01T00:00:00' */
Dragan Dosen1322d092015-09-22 16:05:32 +02001420
Emeric Brun54648852020-07-06 15:54:06 +02001421 /* compute month */
1422 month = 10*(timestamp[5] - '0') + (timestamp[6] - '0');
1423 if (month)
1424 month--;
1425 if (month <= 11) {
1426 /* builds log prefix ex: 'Jan 1 ' */
1427 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1428 "%s %c%c ", monthname[month],
1429 timestamp[8] != '0' ? timestamp[8] : ' ',
1430 timestamp[9]);
1431 /* we reused the timestamp_buffer, signal that it does not
1432 * contain local time anymore
1433 */
1434 hdr_ctx.cur_legacy_time = 0;
1435 if (len == 7) {
1436 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], len);
1437 /* adds 'HH:MM:SS' from iso time */
1438 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&timestamp[11], 8);
1439 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1440 /* we successfully reuse iso time, we can break */
1441 break;
1442 }
1443 }
1444 /* Failed to reuse isotime time, fallback to local legacy time */
1445 }
Dragan Dosen1322d092015-09-22 16:05:32 +02001446
Emeric Brun54648852020-07-06 15:54:06 +02001447 if (unlikely(time != hdr_ctx.cur_legacy_time)) {
1448 /* re-builds timestamp from the current local time */
1449 get_localtime(time, &logtime);
1450
1451 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1452 "%s %2d %02d:%02d:%02d ",
1453 monthname[logtime.tm_mon],
1454 logtime.tm_mday, logtime.tm_hour, logtime.tm_min, logtime.tm_sec);
1455 if (len != LOG_LEGACYTIME_LEN+1)
1456 hdr_ctx.cur_legacy_time = 0;
1457 else
1458 hdr_ctx.cur_legacy_time = time;
1459 }
1460 if (likely(hdr_ctx.cur_legacy_time))
1461 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], LOG_LEGACYTIME_LEN+1);
1462 else
1463 hdr_ctx.ist_vector[(*nbelem)++] = ist2("Jan 1 00:00:00 ", LOG_LEGACYTIME_LEN+1);
1464 break;
1465 case LOG_FORMAT_RFC5424:
1466 /* adds rfc5425 version prefix */
1467 hdr_ctx.ist_vector[(*nbelem)++] = ist2("1 ", 2);
1468 if (metadata && metadata[LOG_META_TIME].len == 1 && metadata[LOG_META_TIME].ptr[0] == '-') {
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001469 /* submitted len is NILVALUE, it is a valid timestamp for rfc5425 */
Emeric Brun54648852020-07-06 15:54:06 +02001470 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1471 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1472 break;
1473 }
1474 /* let continue as 'timed' and 'iso' format for usual timestamp */
1475 /* fall through */
1476 case LOG_FORMAT_TIMED:
1477 case LOG_FORMAT_ISO:
1478 /* ISO format ex: '1900:01:01T12:00:00.123456Z'
1479 * '1900:01:01T14:00:00+02:00'
1480 * '1900:01:01T10:00:00.123456-02:00'
1481 */
1482 if (metadata && metadata[LOG_META_TIME].len >= LOG_ISOTIME_MINLEN) {
1483 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TIME];
1484 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001485 /* time is set, break immediately */
Emeric Brun54648852020-07-06 15:54:06 +02001486 break;
1487 }
1488 else if (metadata && metadata[LOG_META_TIME].len == LOG_LEGACYTIME_LEN) {
1489 int month;
1490 char *timestamp = metadata[LOG_META_TIME].ptr;
1491
1492 for (month = 0; month < 12; month++)
1493 if (!memcmp(monthname[month], timestamp, 3))
1494 break;
Dragan Dosen1322d092015-09-22 16:05:32 +02001495
Emeric Brun54648852020-07-06 15:54:06 +02001496 if (month < 12) {
1497
1498 /* get local time to retrieve year */
1499 get_localtime(time, &logtime);
1500
1501 /* year seems changed since log */
1502 if (logtime.tm_mon < month)
1503 logtime.tm_year--;
1504
1505 /* builds rfc5424 prefix ex: '1900-01-01T' */
1506 len = snprintf(hdr_ctx.timestamp_buffer, sizeof(hdr_ctx.timestamp_buffer),
1507 "%4d-%02d-%c%cT",
1508 logtime.tm_year+1900, month+1,
1509 timestamp[4] != ' ' ? timestamp[4] : '0',
1510 timestamp[5]);
1511
1512 /* we reused the timestamp_buffer, signal that it does not
1513 * contain local time anymore
1514 */
1515 hdr_ctx.cur_legacy_time = 0;
1516 if (len == 11) {
1517 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&hdr_ctx.timestamp_buffer[0], len);
1518 /* adds HH:MM:SS from legacy timestamp */
1519 hdr_ctx.ist_vector[(*nbelem)++] = ist2(&timestamp[7], 8);
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05001520 /* skip secfraq because it is optional */
Emeric Brun54648852020-07-06 15:54:06 +02001521 /* according to rfc: -00:00 means we don't know the timezone */
1522 hdr_ctx.ist_vector[(*nbelem)++] = ist2("-00:00 ", 7);
1523 /* we successfully reuse legacy time, we can break */
1524 break;
1525 }
1526 }
1527 /* Failed to reuse legacy time, fallback to local iso time */
1528 }
1529 hdr_ctx.ist_vector[(*nbelem)++] = ist2(timeofday_as_iso_us(1), LOG_ISOTIME_MAXLEN + 1);
1530 break;
1531 case LOG_FORMAT_PRIO:
1532 case LOG_FORMAT_SHORT:
1533 case LOG_FORMAT_RAW:
1534 break;
1535 case LOG_FORMAT_UNSPEC:
1536 case LOG_FORMATS:
1537 ABORT_NOW();
Dragan Dosen1322d092015-09-22 16:05:32 +02001538 }
1539
Emeric Brun54648852020-07-06 15:54:06 +02001540 /* prepare other meta data, stored into a max of 10 elems */
1541 switch (format) {
1542 case LOG_FORMAT_RFC3164:
1543 if (metadata && metadata[LOG_META_HOST].len) {
1544 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_HOST];
1545 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1546 }
Emeric Brun0237c4e2020-11-27 16:24:34 +01001547 else /* the caller MUST fill the hostname, this field is mandatory */
Emeric Brun54648852020-07-06 15:54:06 +02001548 hdr_ctx.ist_vector[(*nbelem)++] = ist2("localhost ", 10);
Emeric Brun0237c4e2020-11-27 16:24:34 +01001549 /* fall through */
1550 case LOG_FORMAT_LOCAL:
Emeric Brun54648852020-07-06 15:54:06 +02001551 if (!metadata || !metadata[LOG_META_TAG].len)
1552 break;
Dragan Dosen1322d092015-09-22 16:05:32 +02001553
Emeric Brun54648852020-07-06 15:54:06 +02001554 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TAG];
1555 if (metadata[LOG_META_PID].len) {
1556 hdr_ctx.ist_vector[(*nbelem)++] = ist2("[", 1);
1557 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_PID];
1558 hdr_ctx.ist_vector[(*nbelem)++] = ist2("]", 1);
1559 }
1560 hdr_ctx.ist_vector[(*nbelem)++] = ist2(": ", 2);
1561 break;
1562 case LOG_FORMAT_RFC5424:
1563 if (metadata && metadata[LOG_META_HOST].len) {
1564 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_HOST];
1565 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1566 }
1567 else
1568 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
Dragan Dosen1322d092015-09-22 16:05:32 +02001569
Emeric Brun54648852020-07-06 15:54:06 +02001570 if (metadata && metadata[LOG_META_TAG].len) {
1571 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_TAG];
1572 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1573 }
1574 else
1575 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001576
Emeric Brun54648852020-07-06 15:54:06 +02001577 if (metadata && metadata[LOG_META_PID].len) {
1578 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_PID];
1579 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1580 }
1581 else
1582 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001583
Emeric Brun54648852020-07-06 15:54:06 +02001584 if (metadata && metadata[LOG_META_MSGID].len) {
1585 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_MSGID];
1586 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1587 }
1588 else
1589 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
William Lallemand2a4a44f2012-02-06 16:00:33 +01001590
Emeric Brun54648852020-07-06 15:54:06 +02001591 if (metadata && metadata[LOG_META_STDATA].len) {
1592 hdr_ctx.ist_vector[(*nbelem)++] = metadata[LOG_META_STDATA];
1593 hdr_ctx.ist_vector[(*nbelem)++] = ist2(" ", 1);
1594 }
1595 else
1596 hdr_ctx.ist_vector[(*nbelem)++] = ist2("- ", 2);
1597 break;
1598 case LOG_FORMAT_PRIO:
1599 case LOG_FORMAT_SHORT:
1600 case LOG_FORMAT_TIMED:
1601 case LOG_FORMAT_ISO:
1602 case LOG_FORMAT_RAW:
1603 break;
1604 case LOG_FORMAT_UNSPEC:
1605 case LOG_FORMATS:
1606 ABORT_NOW();
1607 }
1608
1609 return hdr_ctx.ist_vector;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001610}
1611
1612/*
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001613 * This function sends a syslog message to <logsrv>.
Emeric Brun54648852020-07-06 15:54:06 +02001614 * The argument <metadata> MUST be an array of size
1615 * LOG_META_FIELDS*sizeof(struct ist) containing data to build the header.
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001616 * It overrides the last byte of the message vector with an LF character.
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001617 * Does not return any error,
William Lallemand2a4a44f2012-02-06 16:00:33 +01001618 */
Emeric Brun54648852020-07-06 15:54:06 +02001619static 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 +01001620{
Emeric Brun54648852020-07-06 15:54:06 +02001621 static THREAD_LOCAL struct iovec iovec[NB_LOG_HDR_MAX_ELEMENTS+1+1] = { }; /* header elements + message + LF */
Christopher Fauletf8188c62017-06-02 16:20:16 +02001622 static THREAD_LOCAL struct msghdr msghdr = {
1623 //.msg_iov = iovec,
Emeric Brun54648852020-07-06 15:54:06 +02001624 .msg_iovlen = NB_LOG_HDR_MAX_ELEMENTS+2
Dragan Dosen609ac2a2015-09-16 18:25:42 +02001625 };
Christopher Fauletf8188c62017-06-02 16:20:16 +02001626 static THREAD_LOCAL int logfdunix = -1; /* syslog to AF_UNIX socket */
1627 static THREAD_LOCAL int logfdinet = -1; /* syslog to AF_INET socket */
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001628 int *plogfd;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001629 int sent;
Emeric Brun54648852020-07-06 15:54:06 +02001630 size_t nbelem;
1631 struct ist *msg_header = NULL;
Christopher Fauletf8188c62017-06-02 16:20:16 +02001632
1633 msghdr.msg_iov = iovec;
William Lallemand2a4a44f2012-02-06 16:00:33 +01001634
Emeric Brunfa9d7802020-05-28 14:21:33 +02001635 /* historically some messages used to already contain the trailing LF
1636 * or Zero. Let's remove all trailing LF or Zero
1637 */
Emeric Brun54648852020-07-06 15:54:06 +02001638 while (size && (message[size-1] == '\n' || (message[size-1] == 0)))
Emeric Brun9e8ea0a2020-05-12 19:33:15 +02001639 size--;
1640
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001641 if (logsrv->type == LOG_TARGET_BUFFER) {
Willy Tarreauc046d162019-08-30 15:24:59 +02001642 plogfd = NULL;
Emeric Brune709e1e2020-05-06 17:23:59 +02001643 goto send;
Willy Tarreauc046d162019-08-30 15:24:59 +02001644 }
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001645 else if (logsrv->addr.ss_family == AF_CUST_EXISTING_FD) {
1646 /* the socket's address is a file descriptor */
1647 plogfd = (int *)&((struct sockaddr_in *)&logsrv->addr)->sin_addr.s_addr;
1648 }
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001649 else if (logsrv->addr.ss_family == AF_UNIX)
1650 plogfd = &logfdunix;
1651 else
1652 plogfd = &logfdinet;
Robert Tsai81ae1952007-12-05 10:47:29 +01001653
Willy Tarreauc046d162019-08-30 15:24:59 +02001654 if (plogfd && unlikely(*plogfd < 0)) {
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001655 /* socket not successfully initialized yet */
1656 if ((*plogfd = socket(logsrv->addr.ss_family, SOCK_DGRAM,
1657 (logsrv->addr.ss_family == AF_UNIX) ? 0 : IPPROTO_UDP)) < 0) {
1658 static char once;
William Lallemand0f99e342011-10-12 17:50:54 +02001659
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001660 if (!once) {
1661 once = 1; /* note: no need for atomic ops here */
1662 ha_alert("socket() failed in logger #%d: %s (errno=%d)\n",
1663 nblogger, strerror(errno), errno);
1664 }
1665 return;
1666 } else {
1667 /* we don't want to receive anything on this socket */
1668 setsockopt(*plogfd, SOL_SOCKET, SO_RCVBUF, &zero, sizeof(zero));
1669 /* does nothing under Linux, maybe needed for others */
1670 shutdown(*plogfd, SHUT_RD);
1671 fcntl(*plogfd, F_SETFD, fcntl(*plogfd, F_GETFD, FD_CLOEXEC) | FD_CLOEXEC);
1672 }
Dragan Dosen43885c72015-10-01 13:18:13 +02001673 }
1674
Emeric Brun54648852020-07-06 15:54:06 +02001675 msg_header = build_log_header(logsrv->format, level, facility, metadata, &nbelem);
1676 send:
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001677 if (logsrv->type == LOG_TARGET_BUFFER) {
Emeric Brun54648852020-07-06 15:54:06 +02001678 struct ist msg;
1679
1680 msg = ist2(message, size);
Tim Duesterhus2471f5c2021-11-08 09:05:01 +01001681 msg = isttrim(msg, logsrv->maxlen);
Willy Tarreaud52a7f82019-08-30 14:05:35 +02001682
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001683 sent = sink_write(logsrv->sink, &msg, 1, level, logsrv->facility, metadata);
1684 }
1685 else if (logsrv->addr.ss_family == AF_CUST_EXISTING_FD) {
1686 struct ist msg;
1687
1688 msg = ist2(message, size);
Tim Duesterhus2471f5c2021-11-08 09:05:01 +01001689 msg = isttrim(msg, logsrv->maxlen);
Willy Tarreaua5b325f2020-09-04 16:44:20 +02001690
1691 sent = fd_write_frag_line(*plogfd, logsrv->maxlen, msg_header, nbelem, &msg, 1, 1);
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001692 }
1693 else {
Emeric Brun54648852020-07-06 15:54:06 +02001694 int i = 0;
1695 int totlen = logsrv->maxlen;
1696
1697 for (i = 0 ; i < nbelem ; i++ ) {
1698 iovec[i].iov_base = msg_header[i].ptr;
1699 iovec[i].iov_len = msg_header[i].len;
1700 if (totlen <= iovec[i].iov_len) {
1701 iovec[i].iov_len = totlen;
1702 totlen = 0;
1703 break;
1704 }
1705 totlen -= iovec[i].iov_len;
1706 }
1707 if (totlen) {
1708 iovec[i].iov_base = message;
1709 iovec[i].iov_len = size;
1710 if (totlen <= iovec[i].iov_len)
1711 iovec[i].iov_len = totlen;
1712 i++;
1713 }
1714 iovec[i].iov_base = "\n"; /* insert a \n at the end of the message */
1715 iovec[i].iov_len = 1;
1716 i++;
Willy Tarreaud52a7f82019-08-30 14:05:35 +02001717
Emeric Brun54648852020-07-06 15:54:06 +02001718 msghdr.msg_iovlen = i;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001719 msghdr.msg_name = (struct sockaddr *)&logsrv->addr;
1720 msghdr.msg_namelen = get_addr_len(&logsrv->addr);
Dragan Dosen43885c72015-10-01 13:18:13 +02001721
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001722 sent = sendmsg(*plogfd, &msghdr, MSG_DONTWAIT | MSG_NOSIGNAL);
1723 }
Dragan Dosen43885c72015-10-01 13:18:13 +02001724
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001725 if (sent < 0) {
1726 static char once;
Dragan Dosen43885c72015-10-01 13:18:13 +02001727
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001728 if (errno == EAGAIN)
Willy Tarreau4781b152021-04-06 13:53:36 +02001729 _HA_ATOMIC_INC(&dropped_logs);
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001730 else if (!once) {
1731 once = 1; /* note: no need for atomic ops here */
1732 ha_alert("sendmsg()/writev() failed in logger #%d: %s (errno=%d)\n",
1733 nblogger, strerror(errno), errno);
Dragan Dosen0b85ece2015-09-25 19:17:44 +02001734 }
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001735 }
1736}
Dragan Dosen59cee972015-09-19 22:09:02 +02001737
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001738/*
1739 * This function sends a syslog message.
1740 * It doesn't care about errors nor does it report them.
Emeric Brun54648852020-07-06 15:54:06 +02001741 * The argument <metadata> MUST be an array of size
1742 * LOG_META_FIELDS*sizeof(struct ist) containing
1743 * data to build the header.
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001744 */
Emeric Brun54648852020-07-06 15:54:06 +02001745void process_send_log(struct list *logsrvs, int level, int facility,
1746 struct ist *metadata, char *message, size_t size)
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001747{
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001748 struct logsrv *logsrv;
1749 int nblogger;
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001750
1751 /* Send log messages to syslog server. */
1752 nblogger = 0;
1753 list_for_each_entry(logsrv, logsrvs, list) {
Emeric Brun2f4cc282020-07-10 15:47:11 +02001754 int in_range = 1;
Frédéric Lécailled803e472019-04-25 07:42:09 +02001755
Frédéric Lécaille0bad8402019-04-10 08:22:17 +02001756 /* we can filter the level of the messages that are sent to each logger */
1757 if (level > logsrv->level)
1758 continue;
1759
Frédéric Lécailled803e472019-04-25 07:42:09 +02001760 if (logsrv->lb.smp_rgs) {
1761 struct smp_log_range *curr_rg;
1762
1763 HA_SPIN_LOCK(LOGSRV_LOCK, &logsrv->lock);
1764 curr_rg = &logsrv->lb.smp_rgs[logsrv->lb.curr_rg];
1765 in_range = in_smp_log_range(curr_rg, logsrv->lb.curr_idx);
1766 if (in_range) {
1767 /* Let's consume this range. */
1768 curr_rg->curr_idx = (curr_rg->curr_idx + 1) % curr_rg->sz;
1769 if (!curr_rg->curr_idx) {
1770 /* If consumed, let's select the next range. */
1771 logsrv->lb.curr_rg = (logsrv->lb.curr_rg + 1) % logsrv->lb.smp_rgs_sz;
1772 }
1773 }
1774 logsrv->lb.curr_idx = (logsrv->lb.curr_idx + 1) % logsrv->lb.smp_sz;
1775 HA_SPIN_UNLOCK(LOGSRV_LOCK, &logsrv->lock);
1776 }
1777 if (in_range)
Emeric Brun54648852020-07-06 15:54:06 +02001778 __do_send_log(logsrv, ++nblogger, MAX(level, logsrv->minlvl),
1779 (facility == -1) ? logsrv->facility : facility,
1780 metadata, message, size);
Willy Tarreaubaaee002006-06-26 02:48:02 +02001781 }
1782}
1783
Emeric Brun54648852020-07-06 15:54:06 +02001784/*
1785 * This function sends a syslog message.
1786 * It doesn't care about errors nor does it report them.
1787 * The arguments <sd> and <sd_size> are used for the structured-data part
1788 * in RFC5424 formatted syslog messages.
1789 */
1790void __send_log(struct list *logsrvs, struct buffer *tagb, int level,
1791 char *message, size_t size, char *sd, size_t sd_size)
1792{
1793 static THREAD_LOCAL pid_t curr_pid;
1794 static THREAD_LOCAL char pidstr[16];
1795 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
1796
1797 if (logsrvs == NULL) {
1798 if (!LIST_ISEMPTY(&global.logsrvs)) {
1799 logsrvs = &global.logsrvs;
1800 }
1801 }
1802 if (!logsrvs || LIST_ISEMPTY(logsrvs))
1803 return;
1804
1805 if (!metadata[LOG_META_HOST].len) {
1806 if (global.log_send_hostname)
Tim Duesterhus77508502022-03-15 13:11:06 +01001807 metadata[LOG_META_HOST] = ist(global.log_send_hostname);
Emeric Brun54648852020-07-06 15:54:06 +02001808 }
1809
1810 if (!tagb || !tagb->area)
1811 tagb = &global.log_tag;
1812
1813 if (tagb)
1814 metadata[LOG_META_TAG] = ist2(tagb->area, tagb->data);
1815
1816 if (unlikely(curr_pid != getpid()))
1817 metadata[LOG_META_PID].len = 0;
1818
1819 if (!metadata[LOG_META_PID].len) {
1820 curr_pid = getpid();
1821 ltoa_o(curr_pid, pidstr, sizeof(pidstr));
1822 metadata[LOG_META_PID] = ist2(pidstr, strlen(pidstr));
1823 }
1824
1825 metadata[LOG_META_STDATA] = ist2(sd, sd_size);
1826
1827 /* Remove trailing space of structured data */
1828 while (metadata[LOG_META_STDATA].len && metadata[LOG_META_STDATA].ptr[metadata[LOG_META_STDATA].len-1] == ' ')
1829 metadata[LOG_META_STDATA].len--;
1830
1831 return process_send_log(logsrvs, level, -1, metadata, message, size);
1832}
Willy Tarreaubaaee002006-06-26 02:48:02 +02001833
Willy Tarreauc89ccb62012-04-05 21:18:22 +02001834const 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 +01001835const char sess_set_cookie[8] = "NPDIRU67"; /* No set-cookie, Set-cookie found and left unchanged (passive),
1836 Set-cookie Deleted, Set-Cookie Inserted, Set-cookie Rewritten,
1837 Set-cookie Updated, unknown, unknown */
1838
William Lallemand1d705562012-03-12 12:46:41 +01001839/*
1840 * try to write a character if there is enough space, or goto out
1841 */
William Lallemandbddd4fd2012-02-27 11:23:10 +01001842#define LOGCHAR(x) do { \
William Lallemand1d705562012-03-12 12:46:41 +01001843 if (tmplog < dst + maxsize - 1) { \
William Lallemandbddd4fd2012-02-27 11:23:10 +01001844 *(tmplog++) = (x); \
1845 } else { \
1846 goto out; \
1847 } \
1848 } while(0)
1849
Dragan Dosen835b9212016-02-12 13:23:03 +01001850
Willy Tarreaub6b3df32018-11-26 16:31:20 +01001851/* Initializes some log data at boot */
1852static void init_log()
Dragan Dosen835b9212016-02-12 13:23:03 +01001853{
1854 char *tmp;
Willy Tarreaue10cd482018-09-10 18:16:53 +02001855 int i;
Dragan Dosen835b9212016-02-12 13:23:03 +01001856
1857 /* Initialize the escape map for the RFC5424 structured-data : '"\]'
1858 * inside PARAM-VALUE should be escaped with '\' as prefix.
1859 * See https://tools.ietf.org/html/rfc5424#section-6.3.3 for more
1860 * details.
1861 */
1862 memset(rfc5424_escape_map, 0, sizeof(rfc5424_escape_map));
1863
1864 tmp = "\"\\]";
1865 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001866 ha_bit_set(*tmp, rfc5424_escape_map);
Dragan Dosen835b9212016-02-12 13:23:03 +01001867 tmp++;
1868 }
Willy Tarreaue10cd482018-09-10 18:16:53 +02001869
1870 /* initialize the log header encoding map : '{|}"#' should be encoded with
1871 * '#' as prefix, as well as non-printable characters ( <32 or >= 127 ).
1872 * URL encoding only requires '"', '#' to be encoded as well as non-
1873 * printable characters above.
1874 */
1875 memset(hdr_encode_map, 0, sizeof(hdr_encode_map));
1876 memset(url_encode_map, 0, sizeof(url_encode_map));
1877 for (i = 0; i < 32; i++) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001878 ha_bit_set(i, hdr_encode_map);
1879 ha_bit_set(i, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001880 }
1881 for (i = 127; i < 256; i++) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001882 ha_bit_set(i, hdr_encode_map);
1883 ha_bit_set(i, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001884 }
1885
1886 tmp = "\"#{|}";
1887 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001888 ha_bit_set(*tmp, hdr_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001889 tmp++;
1890 }
1891
1892 tmp = "\"#";
1893 while (*tmp) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001894 ha_bit_set(*tmp, url_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001895 tmp++;
1896 }
1897
1898 /* initialize the http header encoding map. The draft httpbis define the
1899 * header content as:
1900 *
1901 * HTTP-message = start-line
1902 * *( header-field CRLF )
1903 * CRLF
1904 * [ message-body ]
1905 * header-field = field-name ":" OWS field-value OWS
1906 * field-value = *( field-content / obs-fold )
1907 * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
1908 * obs-fold = CRLF 1*( SP / HTAB )
1909 * field-vchar = VCHAR / obs-text
1910 * VCHAR = %x21-7E
1911 * obs-text = %x80-FF
1912 *
1913 * All the chars are encoded except "VCHAR", "obs-text", SP and HTAB.
1914 * The encoded chars are form 0x00 to 0x08, 0x0a to 0x1f and 0x7f. The
Joseph Herlant85b40592018-11-15 12:10:04 -08001915 * "obs-fold" is voluntarily forgotten because haproxy remove this.
Willy Tarreaue10cd482018-09-10 18:16:53 +02001916 */
1917 memset(http_encode_map, 0, sizeof(http_encode_map));
1918 for (i = 0x00; i <= 0x08; i++)
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001919 ha_bit_set(i, http_encode_map);
Willy Tarreaue10cd482018-09-10 18:16:53 +02001920 for (i = 0x0a; i <= 0x1f; i++)
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001921 ha_bit_set(i, http_encode_map);
1922 ha_bit_set(0x7f, http_encode_map);
Dragan Dosen835b9212016-02-12 13:23:03 +01001923}
William Lallemand1d705562012-03-12 12:46:41 +01001924
Willy Tarreaub6b3df32018-11-26 16:31:20 +01001925INITCALL0(STG_PREPARE, init_log);
1926
Christopher Faulet0132d062017-07-26 15:33:35 +02001927/* Initialize log buffers used for syslog messages */
1928int init_log_buffers()
1929{
Christopher Faulet0132d062017-07-26 15:33:35 +02001930 logline = my_realloc2(logline, global.max_syslog_len + 1);
1931 logline_rfc5424 = my_realloc2(logline_rfc5424, global.max_syslog_len + 1);
Emeric Brun54648852020-07-06 15:54:06 +02001932 if (!logline || !logline_rfc5424)
Christopher Faulet0132d062017-07-26 15:33:35 +02001933 return 0;
1934 return 1;
1935}
1936
1937/* Deinitialize log buffers used for syslog messages */
1938void deinit_log_buffers()
1939{
Christopher Faulet0132d062017-07-26 15:33:35 +02001940 free(logline);
1941 free(logline_rfc5424);
Christopher Faulet0132d062017-07-26 15:33:35 +02001942 logline = NULL;
1943 logline_rfc5424 = NULL;
1944}
1945
Willy Tarreaudf974472012-12-28 02:44:01 +01001946/* Builds a log line in <dst> based on <list_format>, and stops before reaching
1947 * <maxsize> characters. Returns the size of the output string in characters,
1948 * not counting the trailing zero which is always added if the resulting size
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001949 * is not zero. It requires a valid session and optionally a stream. If the
1950 * stream is NULL, default values will be assumed for the stream part.
Willy Tarreaudf974472012-12-28 02:44:01 +01001951 */
Willy Tarreau43c538e2018-09-05 14:58:15 +02001952int 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 +02001953{
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02001954 struct proxy *fe = sess->fe;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001955 struct proxy *be;
1956 struct http_txn *txn;
1957 const struct strm_logs *logs;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02001958 struct connection *fe_conn, *be_conn;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001959 unsigned int s_flags;
1960 unsigned int uniq_id;
Willy Tarreau83061a82018-07-13 11:56:34 +02001961 struct buffer chunk;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001962 char *uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00001963 char *spc;
Andrew Hayworthe63ac872015-07-31 16:14:16 +00001964 char *qmark;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00001965 char *end;
Willy Tarreaufe944602007-10-25 10:34:16 +02001966 struct tm tm;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001967 int t_request;
1968 int hdr;
1969 int last_isspace = 1;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00001970 int nspaces = 0;
Willy Tarreaub1a2faf2012-03-19 16:51:53 +01001971 char *tmplog;
William Lallemand1d705562012-03-12 12:46:41 +01001972 char *ret;
1973 int iret;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02001974 int status;
William Lallemandbddd4fd2012-02-27 11:23:10 +01001975 struct logformat_node *tmp;
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02001976 struct timeval tv;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001977 struct strm_logs tmp_strm_log;
Maciej Zdebfcdfd852020-11-30 18:27:47 +00001978 struct ist path;
Amaury Denoyellec453f952021-07-06 11:40:12 +02001979 struct http_uri_parser parser;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001980
William Lallemandbddd4fd2012-02-27 11:23:10 +01001981 /* FIXME: let's limit ourselves to frontend logging for now. */
Willy Tarreaubaaee002006-06-26 02:48:02 +02001982
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001983 if (likely(s)) {
1984 be = s->be;
1985 txn = s->txn;
Christopher Faulet95a61e82021-12-22 14:22:03 +01001986 be_conn = cs_conn(s->csb);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02001987 status = (txn ? txn->status : 0);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02001988 s_flags = s->flags;
1989 uniq_id = s->uniq_id;
1990 logs = &s->logs;
1991 } else {
1992 /* we have no stream so we first need to initialize a few
1993 * things that are needed later. We do increment the request
1994 * ID so that it's uniquely assigned to this request just as
1995 * if the request had reached the point of being processed.
1996 * A request error is reported as it's the only element we have
1997 * here and which justifies emitting such a log.
1998 */
Christopher Fauletfd818482021-04-14 14:01:41 +02001999 be = ((obj_type(sess->origin) == OBJ_TYPE_CHECK) ? __objt_check(sess->origin)->proxy : fe);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002000 txn = NULL;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002001 fe_conn = objt_conn(sess->origin);
Christopher Fauletfd818482021-04-14 14:01:41 +02002002 be_conn = ((obj_type(sess->origin) == OBJ_TYPE_CHECK) ? cs_conn(__objt_check(sess->origin)->cs) : NULL);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002003 status = 0;
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002004 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
Willy Tarreau18515722021-04-06 11:57:41 +02002005 uniq_id = _HA_ATOMIC_FETCH_ADD(&global.req_count, 1);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002006
2007 /* prepare a valid log structure */
2008 tmp_strm_log.tv_accept = sess->tv_accept;
2009 tmp_strm_log.accept_date = sess->accept_date;
2010 tmp_strm_log.t_handshake = sess->t_handshake;
Christopher Fauletdd789212020-09-30 15:10:07 +02002011 tmp_strm_log.t_idle = (sess->t_idle >= 0 ? sess->t_idle : 0);
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002012 tv_zero(&tmp_strm_log.tv_request);
2013 tmp_strm_log.t_queue = -1;
2014 tmp_strm_log.t_connect = -1;
2015 tmp_strm_log.t_data = -1;
2016 tmp_strm_log.t_close = tv_ms_elapsed(&sess->tv_accept, &now);
2017 tmp_strm_log.bytes_in = 0;
2018 tmp_strm_log.bytes_out = 0;
2019 tmp_strm_log.prx_queue_pos = 0;
2020 tmp_strm_log.srv_queue_pos = 0;
2021
2022 logs = &tmp_strm_log;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002023
2024 if ((fe->mode == PR_MODE_HTTP) && fe_conn && fe_conn->mux && fe_conn->mux->ctl) {
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002025 enum mux_exit_status es = fe_conn->mux->ctl(fe_conn, MUX_EXIT_STATUS, &status);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002026
2027 switch (es) {
2028 case MUX_ES_SUCCESS:
2029 break;
2030 case MUX_ES_INVALID_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002031 status = (status ? status : 400);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002032 if ((fe_conn->flags & CO_FL_ERROR) || conn_xprt_read0_pending(fe_conn))
2033 s_flags = SF_ERR_CLICL | SF_FINST_R;
2034 else
2035 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
2036 break;
2037 case MUX_ES_TOUT_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002038 status = (status ? status : 408);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002039 s_flags = SF_ERR_CLITO | SF_FINST_R;
2040 break;
Christopher Faulet142dd332020-12-07 11:24:37 +01002041 case MUX_ES_NOTIMPL_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002042 status = (status ? status : 501);
Christopher Faulet142dd332020-12-07 11:24:37 +01002043 s_flags = SF_ERR_PRXCOND | SF_FINST_R;
2044 break;
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002045 case MUX_ES_INTERNAL_ERR:
Christopher Fauleta015b3e2021-09-28 11:36:28 +02002046 status = (status ? status : 500);
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002047 s_flags = SF_ERR_INTERNAL | SF_FINST_R;
2048 break;
2049 default:
2050 break;
2051 }
2052 }
Willy Tarreau09bb27c2018-09-05 16:55:15 +02002053 }
2054
William Lallemandbddd4fd2012-02-27 11:23:10 +01002055 t_request = -1;
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002056 if (tv_isge(&logs->tv_request, &logs->tv_accept))
2057 t_request = tv_ms_elapsed(&logs->tv_accept, &logs->tv_request);
William Lallemandbddd4fd2012-02-27 11:23:10 +01002058
William Lallemand1d705562012-03-12 12:46:41 +01002059 tmplog = dst;
Willy Tarreauc9bd0cc2009-05-10 11:57:02 +02002060
William Lallemandbddd4fd2012-02-27 11:23:10 +01002061 /* fill logbuffer */
William Lallemand1d705562012-03-12 12:46:41 +01002062 if (LIST_ISEMPTY(list_format))
2063 return 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002064
William Lallemand1d705562012-03-12 12:46:41 +01002065 list_for_each_entry(tmp, list_format, list) {
Christopher Faulet52b28d22021-10-27 11:58:05 +02002066#ifdef USE_OPENSSL
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002067 struct connection *conn;
Christopher Faulet52b28d22021-10-27 11:58:05 +02002068#endif
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002069 const struct sockaddr_storage *addr;
Willy Tarreau4f653562012-10-12 19:48:16 +02002070 const char *src = NULL;
Willy Tarreauc8368452012-12-21 00:09:23 +01002071 struct sample *key;
Willy Tarreau83061a82018-07-13 11:56:34 +02002072 const struct buffer empty = { };
William Lallemandbddd4fd2012-02-27 11:23:10 +01002073
Willy Tarreauc8368452012-12-21 00:09:23 +01002074 switch (tmp->type) {
William Lallemand1d705562012-03-12 12:46:41 +01002075 case LOG_FMT_SEPARATOR:
William Lallemandbddd4fd2012-02-27 11:23:10 +01002076 if (!last_isspace) {
2077 LOGCHAR(' ');
2078 last_isspace = 1;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002079 }
2080 break;
2081
William Lallemand1d705562012-03-12 12:46:41 +01002082 case LOG_FMT_TEXT: // text
William Lallemandbddd4fd2012-02-27 11:23:10 +01002083 src = tmp->arg;
William Lallemand5f232402012-04-05 18:02:55 +02002084 iret = strlcpy2(tmplog, src, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002085 if (iret == 0)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002086 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002087 tmplog += iret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002088 last_isspace = 0;
2089 break;
2090
Willy Tarreauc8368452012-12-21 00:09:23 +01002091 case LOG_FMT_EXPR: // sample expression, may be request or response
2092 key = NULL;
Christopher Faulet5f940702020-04-06 10:40:02 +02002093 if (tmp->options & LOG_OPT_REQ_CAP)
Adis Nezirovic79beb242015-07-06 15:41:02 +02002094 key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_REQ|SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
Willy Tarreau20b7a0f2021-09-03 08:53:29 +02002095
Christopher Faulet5f940702020-04-06 10:40:02 +02002096 if (!key && (tmp->options & LOG_OPT_RES_CAP))
Adis Nezirovic79beb242015-07-06 15:41:02 +02002097 key = sample_fetch_as_type(be, sess, s, SMP_OPT_DIR_RES|SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
Willy Tarreau20b7a0f2021-09-03 08:53:29 +02002098
2099 if (!key && !(tmp->options & (LOG_OPT_REQ_CAP|LOG_OPT_RES_CAP))) // cfg, cli
2100 key = sample_fetch_as_type(be, sess, s, SMP_OPT_FINAL, tmp->expr, SMP_T_STR);
2101
Thierry FOURNIERd048d8b2014-03-13 16:46:18 +01002102 if (tmp->options & LOG_OPT_HTTP)
Dragan Dosen835b9212016-02-12 13:23:03 +01002103 ret = lf_encode_chunk(tmplog, dst + maxsize,
2104 '%', http_encode_map, key ? &key->data.u.str : &empty, tmp);
Thierry FOURNIERd048d8b2014-03-13 16:46:18 +01002105 else
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002106 ret = lf_text_len(tmplog,
2107 key ? key->data.u.str.area : NULL,
2108 key ? key->data.u.str.data : 0,
2109 dst + maxsize - tmplog,
2110 tmp);
Willy Tarreauc8368452012-12-21 00:09:23 +01002111 if (ret == 0)
2112 goto out;
2113 tmplog = ret;
2114 last_isspace = 0;
2115 break;
2116
Willy Tarreau2beef582012-12-20 17:22:52 +01002117 case LOG_FMT_CLIENTIP: // %ci
Christopher Faulet8da67aa2022-03-29 17:53:09 +02002118 addr = (s ? cs_src(s->csf) : sess_src(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002119 if (addr)
2120 ret = lf_ip(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002121 else
2122 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002123
William Lallemand1d705562012-03-12 12:46:41 +01002124 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002125 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002126 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002127 last_isspace = 0;
2128 break;
2129
Willy Tarreau2beef582012-12-20 17:22:52 +01002130 case LOG_FMT_CLIENTPORT: // %cp
Christopher Faulet8da67aa2022-03-29 17:53:09 +02002131 addr = (s ? cs_src(s->csf) : sess_src(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002132 if (addr) {
Christopher Faulet1ccbe122021-11-15 11:31:08 +01002133 /* sess->listener is always defined when the session's owner is an inbound connections */
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002134 if (addr->ss_family == AF_UNIX)
Willy Tarreaufb0afa72015-04-03 14:46:27 +02002135 ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog);
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002136 else
2137 ret = lf_port(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
William Lallemand5f232402012-04-05 18:02:55 +02002138 }
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002139 else
2140 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2141
William Lallemand5f232402012-04-05 18:02:55 +02002142 if (ret == NULL)
2143 goto out;
2144 tmplog = ret;
2145 last_isspace = 0;
2146 break;
2147
Willy Tarreau2beef582012-12-20 17:22:52 +01002148 case LOG_FMT_FRONTENDIP: // %fi
Christopher Faulet8da67aa2022-03-29 17:53:09 +02002149 addr = (s ? cs_dst(s->csf) : sess_dst(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002150 if (addr)
2151 ret = lf_ip(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002152 else
2153 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2154
William Lallemand1d705562012-03-12 12:46:41 +01002155 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002156 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002157 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002158 last_isspace = 0;
2159 break;
2160
Willy Tarreau2beef582012-12-20 17:22:52 +01002161 case LOG_FMT_FRONTENDPORT: // %fp
Christopher Faulet8da67aa2022-03-29 17:53:09 +02002162 addr = (s ? cs_dst(s->csf) : sess_dst(sess));
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002163 if (addr) {
Christopher Faulet1ccbe122021-11-15 11:31:08 +01002164 /* sess->listener is always defined when the session's owner is an inbound connections */
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002165 if (addr->ss_family == AF_UNIX)
Willy Tarreaufb0afa72015-04-03 14:46:27 +02002166 ret = ltoa_o(sess->listener->luid, tmplog, dst + maxsize - tmplog);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002167 else
Christopher Fauletf9c4d8d2021-10-22 17:43:22 +02002168 ret = lf_port(tmplog, (struct sockaddr *)addr, dst + maxsize - tmplog, tmp);
William Lallemand5f232402012-04-05 18:02:55 +02002169 }
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002170 else
2171 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2172
William Lallemand5f232402012-04-05 18:02:55 +02002173 if (ret == NULL)
2174 goto out;
2175 tmplog = ret;
2176 last_isspace = 0;
2177 break;
2178
Willy Tarreau2beef582012-12-20 17:22:52 +01002179 case LOG_FMT_BACKENDIP: // %bi
Willy Tarreau8fa99842019-07-17 11:47:11 +02002180 if (be_conn && conn_get_src(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002181 ret = lf_ip(tmplog, (const struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002182 else
2183 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2184
William Lallemand1d705562012-03-12 12:46:41 +01002185 if (ret == NULL)
William Lallemandb7ff6a32012-03-02 14:35:21 +01002186 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002187 tmplog = ret;
William Lallemandb7ff6a32012-03-02 14:35:21 +01002188 last_isspace = 0;
2189 break;
2190
Willy Tarreau2beef582012-12-20 17:22:52 +01002191 case LOG_FMT_BACKENDPORT: // %bp
Willy Tarreau8fa99842019-07-17 11:47:11 +02002192 if (be_conn && conn_get_src(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002193 ret = lf_port(tmplog, (struct sockaddr *)be_conn->src, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002194 else
2195 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2196
William Lallemand5f232402012-04-05 18:02:55 +02002197 if (ret == NULL)
2198 goto out;
2199 tmplog = ret;
2200 last_isspace = 0;
2201 break;
2202
Willy Tarreau2beef582012-12-20 17:22:52 +01002203 case LOG_FMT_SERVERIP: // %si
Willy Tarreau8fa99842019-07-17 11:47:11 +02002204 if (be_conn && conn_get_dst(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002205 ret = lf_ip(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002206 else
2207 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2208
William Lallemand5f232402012-04-05 18:02:55 +02002209 if (ret == NULL)
2210 goto out;
2211 tmplog = ret;
2212 last_isspace = 0;
2213 break;
2214
Willy Tarreau2beef582012-12-20 17:22:52 +01002215 case LOG_FMT_SERVERPORT: // %sp
Willy Tarreau8fa99842019-07-17 11:47:11 +02002216 if (be_conn && conn_get_dst(be_conn))
Willy Tarreau6c6365f2019-07-17 16:48:18 +02002217 ret = lf_port(tmplog, (struct sockaddr *)be_conn->dst, dst + maxsize - tmplog, tmp);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002218 else
2219 ret = lf_text_len(tmplog, NULL, 0, dst + maxsize - tmplog, tmp);
2220
William Lallemand1d705562012-03-12 12:46:41 +01002221 if (ret == NULL)
William Lallemandb7ff6a32012-03-02 14:35:21 +01002222 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002223 tmplog = ret;
William Lallemandb7ff6a32012-03-02 14:35:21 +01002224 last_isspace = 0;
2225 break;
2226
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002227 case LOG_FMT_DATE: // %t = accept date
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002228 get_localtime(logs->accept_date.tv_sec, &tm);
2229 ret = date2str_log(tmplog, &tm, &logs->accept_date, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002230 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002231 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002232 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002233 last_isspace = 0;
2234 break;
2235
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002236 case LOG_FMT_tr: // %tr = start of request date
2237 /* Note that the timers are valid if we get here */
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002238 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 +02002239 get_localtime(tv.tv_sec, &tm);
2240 ret = date2str_log(tmplog, &tm, &tv, dst + maxsize - tmplog);
2241 if (ret == NULL)
2242 goto out;
2243 tmplog = ret;
2244 last_isspace = 0;
2245 break;
2246
2247 case LOG_FMT_DATEGMT: // %T = accept date, GMT
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002248 get_gmtime(logs->accept_date.tv_sec, &tm);
William Lallemand5f232402012-04-05 18:02:55 +02002249 ret = gmt2str_log(tmplog, &tm, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002250 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002251 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002252 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002253 last_isspace = 0;
2254 break;
2255
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002256 case LOG_FMT_trg: // %trg = start of request date, GMT
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002257 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 +02002258 get_gmtime(tv.tv_sec, &tm);
2259 ret = gmt2str_log(tmplog, &tm, dst + maxsize - tmplog);
2260 if (ret == NULL)
2261 goto out;
2262 tmplog = ret;
2263 last_isspace = 0;
2264 break;
2265
2266 case LOG_FMT_DATELOCAL: // %Tl = accept date, local
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002267 get_localtime(logs->accept_date.tv_sec, &tm);
2268 ret = localdate2str_log(tmplog, logs->accept_date.tv_sec, &tm, dst + maxsize - tmplog);
Yuxans Yao4e25b012012-10-19 10:36:09 +08002269 if (ret == NULL)
2270 goto out;
2271 tmplog = ret;
2272 last_isspace = 0;
2273 break;
2274
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002275 case LOG_FMT_trl: // %trl = start of request date, local
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002276 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 +02002277 get_localtime(tv.tv_sec, &tm);
2278 ret = localdate2str_log(tmplog, tv.tv_sec, &tm, dst + maxsize - tmplog);
2279 if (ret == NULL)
2280 goto out;
2281 tmplog = ret;
2282 last_isspace = 0;
2283 break;
2284
William Lallemand5f232402012-04-05 18:02:55 +02002285 case LOG_FMT_TS: // %Ts
William Lallemand5f232402012-04-05 18:02:55 +02002286 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002287 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", (unsigned int)logs->accept_date.tv_sec);
William Lallemand5f232402012-04-05 18:02:55 +02002288 if (iret < 0 || iret > dst + maxsize - tmplog)
2289 goto out;
2290 last_isspace = 0;
2291 tmplog += iret;
2292 } else {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002293 ret = ltoa_o(logs->accept_date.tv_sec, tmplog, dst + maxsize - tmplog);
William Lallemand5f232402012-04-05 18:02:55 +02002294 if (ret == NULL)
2295 goto out;
2296 tmplog = ret;
2297 last_isspace = 0;
2298 }
2299 break;
2300
William Lallemand1d705562012-03-12 12:46:41 +01002301 case LOG_FMT_MS: // %ms
William Lallemand5f232402012-04-05 18:02:55 +02002302 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002303 iret = snprintf(tmplog, dst + maxsize - tmplog, "%02X",(unsigned int)logs->accept_date.tv_usec/1000);
William Lallemand5f232402012-04-05 18:02:55 +02002304 if (iret < 0 || iret > dst + maxsize - tmplog)
2305 goto out;
2306 last_isspace = 0;
2307 tmplog += iret;
2308 } else {
2309 if ((dst + maxsize - tmplog) < 4)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002310 goto out;
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002311 ret = utoa_pad((unsigned int)logs->accept_date.tv_usec/1000,
Willy Tarreau9e60cd82013-01-24 01:18:16 +01002312 tmplog, 4);
2313 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002314 goto out;
Willy Tarreau9e60cd82013-01-24 01:18:16 +01002315 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002316 last_isspace = 0;
William Lallemand5f232402012-04-05 18:02:55 +02002317 }
2318 break;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002319
William Lallemand1d705562012-03-12 12:46:41 +01002320 case LOG_FMT_FRONTEND: // %f
William Lallemandbddd4fd2012-02-27 11:23:10 +01002321 src = fe->id;
William Lallemand5f232402012-04-05 18:02:55 +02002322 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002323 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002324 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002325 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002326 last_isspace = 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002327 break;
2328
Willy Tarreau773d65f2012-10-12 14:56:11 +02002329 case LOG_FMT_FRONTEND_XPRT: // %ft
2330 src = fe->id;
2331 if (tmp->options & LOG_OPT_QUOTE)
2332 LOGCHAR('"');
2333 iret = strlcpy2(tmplog, src, dst + maxsize - tmplog);
2334 if (iret == 0)
2335 goto out;
2336 tmplog += iret;
Christopher Faulet1ccbe122021-11-15 11:31:08 +01002337
2338 /* sess->listener may be undefined if the session's owner is a health-check */
Willy Tarreau807a3a52022-04-12 08:08:33 +02002339 if (sess->listener && sess->listener->bind_conf->xprt->get_ssl_sock_ctx)
Willy Tarreau773d65f2012-10-12 14:56:11 +02002340 LOGCHAR('~');
Willy Tarreau773d65f2012-10-12 14:56:11 +02002341 if (tmp->options & LOG_OPT_QUOTE)
2342 LOGCHAR('"');
2343 last_isspace = 0;
2344 break;
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002345#ifdef USE_OPENSSL
2346 case LOG_FMT_SSL_CIPHER: // %sslc
2347 src = NULL;
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002348 conn = objt_conn(sess->origin);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002349 if (conn) {
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02002350 src = ssl_sock_get_cipher_name(conn);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002351 }
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002352 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
2353 if (ret == NULL)
2354 goto out;
2355 tmplog = ret;
2356 last_isspace = 0;
2357 break;
Willy Tarreau773d65f2012-10-12 14:56:11 +02002358
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002359 case LOG_FMT_SSL_VERSION: // %sslv
2360 src = NULL;
Willy Tarreau9ad7bd42015-04-03 19:19:59 +02002361 conn = objt_conn(sess->origin);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002362 if (conn) {
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02002363 src = ssl_sock_get_proto_version(conn);
Willy Tarreaub363a1f2013-10-01 10:45:07 +02002364 }
Willy Tarreauffc3fcd2012-10-12 20:17:54 +02002365 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
2366 if (ret == NULL)
2367 goto out;
2368 tmplog = ret;
2369 last_isspace = 0;
2370 break;
2371#endif
William Lallemand1d705562012-03-12 12:46:41 +01002372 case LOG_FMT_BACKEND: // %b
William Lallemandbddd4fd2012-02-27 11:23:10 +01002373 src = be->id;
William Lallemand5f232402012-04-05 18:02:55 +02002374 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002375 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002376 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002377 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002378 last_isspace = 0;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002379 break;
2380
William Lallemand1d705562012-03-12 12:46:41 +01002381 case LOG_FMT_SERVER: // %s
Christopher Fauletfd818482021-04-14 14:01:41 +02002382 switch (obj_type(s ? s->target : sess->origin)) {
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002383 case OBJ_TYPE_SERVER:
Willy Tarreau1aaf3242018-09-20 11:13:58 +02002384 src = __objt_server(s->target)->id;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002385 break;
2386 case OBJ_TYPE_APPLET:
Willy Tarreau1aaf3242018-09-20 11:13:58 +02002387 src = __objt_applet(s->target)->name;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002388 break;
Christopher Fauletfd818482021-04-14 14:01:41 +02002389 case OBJ_TYPE_CHECK:
2390 src = (__objt_check(sess->origin)->server
2391 ? __objt_check(sess->origin)->server->id
2392 : "<NOSRV>");
2393 break;
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002394 default:
2395 src = "<NOSRV>";
2396 break;
2397 }
William Lallemand5f232402012-04-05 18:02:55 +02002398 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002399 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002400 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002401 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002402 last_isspace = 0;
2403 break;
2404
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002405 case LOG_FMT_Th: // %Th = handshake time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002406 ret = ltoa_o(logs->t_handshake, tmplog, dst + maxsize - tmplog);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002407 if (ret == NULL)
2408 goto out;
2409 tmplog = ret;
2410 last_isspace = 0;
2411 break;
2412
2413 case LOG_FMT_Ti: // %Ti = HTTP idle time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002414 ret = ltoa_o(logs->t_idle, tmplog, dst + maxsize - tmplog);
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002415 if (ret == NULL)
2416 goto out;
2417 tmplog = ret;
2418 last_isspace = 0;
2419 break;
2420
2421 case LOG_FMT_TR: // %TR = HTTP request time
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002422 ret = ltoa_o((t_request >= 0) ? t_request - logs->t_idle - logs->t_handshake : -1,
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002423 tmplog, dst + maxsize - tmplog);
2424 if (ret == NULL)
2425 goto out;
2426 tmplog = ret;
2427 last_isspace = 0;
2428 break;
2429
2430 case LOG_FMT_TQ: // %Tq = Th + Ti + TR
William Lallemand5f232402012-04-05 18:02:55 +02002431 ret = ltoa_o(t_request, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002432 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002433 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002434 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002435 last_isspace = 0;
2436 break;
2437
William Lallemand1d705562012-03-12 12:46:41 +01002438 case LOG_FMT_TW: // %Tw
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002439 ret = ltoa_o((logs->t_queue >= 0) ? logs->t_queue - t_request : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002440 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002441 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002442 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002443 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002444 last_isspace = 0;
2445 break;
2446
William Lallemand1d705562012-03-12 12:46:41 +01002447 case LOG_FMT_TC: // %Tc
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002448 ret = ltoa_o((logs->t_connect >= 0) ? logs->t_connect - logs->t_queue : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002449 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002450 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002451 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002452 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002453 last_isspace = 0;
2454 break;
2455
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002456 case LOG_FMT_Tr: // %Tr
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002457 ret = ltoa_o((logs->t_data >= 0) ? logs->t_data - logs->t_connect : -1,
William Lallemand5f232402012-04-05 18:02:55 +02002458 tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002459 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002460 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002461 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002462 last_isspace = 0;
2463 break;
2464
Willy Tarreau27b639d2016-05-17 17:55:27 +02002465 case LOG_FMT_TD: // %Td
Willy Tarreaua21c0e62018-09-05 15:07:15 +02002466 if (be->mode == PR_MODE_HTTP)
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002467 ret = ltoa_o((logs->t_data >= 0) ? logs->t_close - logs->t_data : -1,
Willy Tarreau27b639d2016-05-17 17:55:27 +02002468 tmplog, dst + maxsize - tmplog);
2469 else
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002470 ret = ltoa_o((logs->t_connect >= 0) ? logs->t_close - logs->t_connect : -1,
Willy Tarreau27b639d2016-05-17 17:55:27 +02002471 tmplog, dst + maxsize - tmplog);
2472 if (ret == NULL)
2473 goto out;
2474 tmplog = ret;
2475 last_isspace = 0;
2476 break;
2477
Thierry FOURNIER / OZON.IO4cac3592016-07-28 17:19:45 +02002478 case LOG_FMT_Ta: // %Ta = active time = Tt - Th - Ti
2479 if (!(fe->to_log & LW_BYTES))
2480 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002481 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 +02002482 tmplog, dst + maxsize - tmplog);
2483 if (ret == NULL)
2484 goto out;
2485 tmplog = ret;
2486 last_isspace = 0;
2487 break;
2488
2489 case LOG_FMT_TT: // %Tt = total time
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002490 if (!(fe->to_log & LW_BYTES))
William Lallemand1d705562012-03-12 12:46:41 +01002491 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002492 ret = ltoa_o(logs->t_close, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002493 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002494 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002495 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002496 last_isspace = 0;
2497 break;
2498
Damien Claisse57c8eb92020-04-28 12:09:19 +00002499 case LOG_FMT_TU: // %Tu = total time seen by user = Tt - Ti
2500 if (!(fe->to_log & LW_BYTES))
2501 LOGCHAR('+');
2502 ret = ltoa_o(logs->t_close - (logs->t_idle >= 0 ? logs->t_idle : 0),
2503 tmplog, dst + maxsize - tmplog);
2504 if (ret == NULL)
2505 goto out;
2506 tmplog = ret;
2507 last_isspace = 0;
2508 break;
2509
Willy Tarreau2beef582012-12-20 17:22:52 +01002510 case LOG_FMT_STATUS: // %ST
Christopher Fauletce5e6bc2020-10-06 15:11:43 +02002511 ret = ltoa_o(status, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002512 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002513 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002514 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002515 last_isspace = 0;
2516 break;
2517
William Lallemand1d705562012-03-12 12:46:41 +01002518 case LOG_FMT_BYTES: // %B
Willy Tarreaud79a3b22012-12-28 09:40:16 +01002519 if (!(fe->to_log & LW_BYTES))
William Lallemand1d705562012-03-12 12:46:41 +01002520 LOGCHAR('+');
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002521 ret = lltoa(logs->bytes_out, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002522 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002523 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002524 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002525 last_isspace = 0;
2526 break;
2527
Willy Tarreauc5259fd2012-12-20 15:38:04 +01002528 case LOG_FMT_BYTES_UP: // %U
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002529 ret = lltoa(logs->bytes_in, tmplog, dst + maxsize - tmplog);
Willy Tarreauc5259fd2012-12-20 15:38:04 +01002530 if (ret == NULL)
2531 goto out;
2532 tmplog = ret;
2533 last_isspace = 0;
2534 break;
2535
Willy Tarreau2beef582012-12-20 17:22:52 +01002536 case LOG_FMT_CCLIENT: // %CC
Willy Tarreau57bc8912016-04-25 17:09:40 +02002537 src = txn ? txn->cli_cookie : NULL;
William Lallemand5f232402012-04-05 18:02:55 +02002538 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002539 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002540 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002541 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002542 last_isspace = 0;
2543 break;
2544
Willy Tarreau2beef582012-12-20 17:22:52 +01002545 case LOG_FMT_CSERVER: // %CS
Willy Tarreau57bc8912016-04-25 17:09:40 +02002546 src = txn ? txn->srv_cookie : NULL;
William Lallemand5f232402012-04-05 18:02:55 +02002547 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002548 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002549 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002550 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002551 last_isspace = 0;
2552 break;
2553
William Lallemand1d705562012-03-12 12:46:41 +01002554 case LOG_FMT_TERMSTATE: // %ts
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002555 LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]);
2556 LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]);
Willy Tarreau6580c062012-03-12 15:09:42 +01002557 *tmplog = '\0';
2558 last_isspace = 0;
2559 break;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002560
William Lallemand1d705562012-03-12 12:46:41 +01002561 case LOG_FMT_TERMSTATE_CK: // %tsc, same as TS with cookie state (for mode HTTP)
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002562 LOGCHAR(sess_term_cond[(s_flags & SF_ERR_MASK) >> SF_ERR_SHIFT]);
2563 LOGCHAR(sess_fin_state[(s_flags & SF_FINST_MASK) >> SF_FINST_SHIFT]);
Willy Tarreau57bc8912016-04-25 17:09:40 +02002564 LOGCHAR((txn && (be->ck_opts & PR_CK_ANY)) ? sess_cookie[(txn->flags & TX_CK_MASK) >> TX_CK_SHIFT] : '-');
2565 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 +01002566 last_isspace = 0;
2567 break;
2568
William Lallemand1d705562012-03-12 12:46:41 +01002569 case LOG_FMT_ACTCONN: // %ac
William Lallemand5f232402012-04-05 18:02:55 +02002570 ret = ltoa_o(actconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002571 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002572 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002573 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002574 last_isspace = 0;
2575 break;
2576
William Lallemand1d705562012-03-12 12:46:41 +01002577 case LOG_FMT_FECONN: // %fc
William Lallemand5f232402012-04-05 18:02:55 +02002578 ret = ltoa_o(fe->feconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002579 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002580 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002581 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002582 last_isspace = 0;
2583 break;
2584
William Lallemand1d705562012-03-12 12:46:41 +01002585 case LOG_FMT_BECONN: // %bc
William Lallemand5f232402012-04-05 18:02:55 +02002586 ret = ltoa_o(be->beconn, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002587 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002588 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002589 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002590 last_isspace = 0;
2591 break;
2592
William Lallemand1d705562012-03-12 12:46:41 +01002593 case LOG_FMT_SRVCONN: // %sc
Christopher Fauletfd818482021-04-14 14:01:41 +02002594 switch (obj_type(s ? s->target : sess->origin)) {
2595 case OBJ_TYPE_SERVER:
2596 ret = ultoa_o(__objt_server(s->target)->cur_sess,
2597 tmplog, dst + maxsize - tmplog);
2598 break;
2599 case OBJ_TYPE_CHECK:
2600 ret = ultoa_o(__objt_check(sess->origin)->server
2601 ? __objt_check(sess->origin)->server->cur_sess
2602 : 0, tmplog, dst + maxsize - tmplog);
2603 break;
2604 default:
2605 ret = ultoa_o(0, tmplog, dst + maxsize - tmplog);
2606 break;
2607 }
2608
William Lallemand1d705562012-03-12 12:46:41 +01002609 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002610 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002611 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002612 last_isspace = 0;
2613 break;
2614
William Lallemand1d705562012-03-12 12:46:41 +01002615 case LOG_FMT_RETRIES: // %rq
Willy Tarreaub8bc5252018-09-05 15:51:28 +02002616 if (s_flags & SF_REDISP)
William Lallemand1d705562012-03-12 12:46:41 +01002617 LOGCHAR('+');
Christopher Faulet731c8e62022-03-29 16:08:44 +02002618 ret = ltoa_o((s ? s->conn_retries : 0), tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002619 if (ret == NULL)
William Lallemand51b5dca2012-03-26 17:52:55 +02002620 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002621 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002622 last_isspace = 0;
2623 break;
2624
William Lallemand1d705562012-03-12 12:46:41 +01002625 case LOG_FMT_SRVQUEUE: // %sq
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002626 ret = ltoa_o(logs->srv_queue_pos, tmplog, dst + maxsize - tmplog);
William Lallemand1d705562012-03-12 12:46:41 +01002627 if (ret == NULL)
William Lallemandbddd4fd2012-02-27 11:23:10 +01002628 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002629 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002630 last_isspace = 0;
2631 break;
2632
William Lallemand1d705562012-03-12 12:46:41 +01002633 case LOG_FMT_BCKQUEUE: // %bq
Willy Tarreau372ac5a2018-09-05 15:16:23 +02002634 ret = ltoa_o(logs->prx_queue_pos, 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_HDRREQUEST: // %hr
William Lallemandbddd4fd2012-02-27 11:23:10 +01002642 /* request header */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002643 if (fe->nb_req_cap && s && s->req_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002644 if (tmp->options & LOG_OPT_QUOTE)
2645 LOGCHAR('"');
2646 LOGCHAR('{');
2647 for (hdr = 0; hdr < fe->nb_req_cap; hdr++) {
2648 if (hdr)
2649 LOGCHAR('|');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002650 if (s->req_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002651 ret = lf_encode_string(tmplog, dst + maxsize,
2652 '#', hdr_encode_map, s->req_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002653 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002654 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002655 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002656 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002657 }
2658 LOGCHAR('}');
William Lallemand51b5dca2012-03-26 17:52:55 +02002659 if (tmp->options & LOG_OPT_QUOTE)
2660 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002661 last_isspace = 0;
2662 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002663 break;
2664
William Lallemand1d705562012-03-12 12:46:41 +01002665 case LOG_FMT_HDRREQUESTLIST: // %hrl
William Lallemandbddd4fd2012-02-27 11:23:10 +01002666 /* request header list */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002667 if (fe->nb_req_cap && s && s->req_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002668 for (hdr = 0; hdr < fe->nb_req_cap; hdr++) {
2669 if (hdr > 0)
2670 LOGCHAR(' ');
2671 if (tmp->options & LOG_OPT_QUOTE)
2672 LOGCHAR('"');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002673 if (s->req_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002674 ret = lf_encode_string(tmplog, dst + maxsize,
2675 '#', hdr_encode_map, s->req_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002676 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002677 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002678 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002679 } else if (!(tmp->options & LOG_OPT_QUOTE))
2680 LOGCHAR('-');
2681 if (tmp->options & LOG_OPT_QUOTE)
2682 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002683 last_isspace = 0;
2684 }
2685 }
2686 break;
Willy Tarreaubaaee002006-06-26 02:48:02 +02002687
William Lallemand1d705562012-03-12 12:46:41 +01002688
2689 case LOG_FMT_HDRRESPONS: // %hs
William Lallemandbddd4fd2012-02-27 11:23:10 +01002690 /* response header */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002691 if (fe->nb_rsp_cap && s && s->res_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002692 if (tmp->options & LOG_OPT_QUOTE)
2693 LOGCHAR('"');
2694 LOGCHAR('{');
2695 for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) {
2696 if (hdr)
2697 LOGCHAR('|');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002698 if (s->res_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002699 ret = lf_encode_string(tmplog, dst + maxsize,
2700 '#', hdr_encode_map, s->res_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002701 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002702 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002703 tmplog = ret;
William Lallemand51b5dca2012-03-26 17:52:55 +02002704 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002705 }
2706 LOGCHAR('}');
2707 last_isspace = 0;
2708 if (tmp->options & LOG_OPT_QUOTE)
2709 LOGCHAR('"');
2710 }
William Lallemandbddd4fd2012-02-27 11:23:10 +01002711 break;
2712
William Lallemand1d705562012-03-12 12:46:41 +01002713 case LOG_FMT_HDRRESPONSLIST: // %hsl
William Lallemandbddd4fd2012-02-27 11:23:10 +01002714 /* response header list */
Willy Tarreaud4f91662018-09-05 15:28:07 +02002715 if (fe->nb_rsp_cap && s && s->res_cap) {
William Lallemandbddd4fd2012-02-27 11:23:10 +01002716 for (hdr = 0; hdr < fe->nb_rsp_cap; hdr++) {
2717 if (hdr > 0)
2718 LOGCHAR(' ');
2719 if (tmp->options & LOG_OPT_QUOTE)
2720 LOGCHAR('"');
Willy Tarreaucb7dd012015-04-03 22:16:32 +02002721 if (s->res_cap[hdr] != NULL) {
Dragan Dosen835b9212016-02-12 13:23:03 +01002722 ret = lf_encode_string(tmplog, dst + maxsize,
2723 '#', hdr_encode_map, s->res_cap[hdr], tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002724 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002725 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002726 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002727 } else if (!(tmp->options & LOG_OPT_QUOTE))
2728 LOGCHAR('-');
2729 if (tmp->options & LOG_OPT_QUOTE)
2730 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002731 last_isspace = 0;
2732 }
2733 }
2734 break;
2735
William Lallemand1d705562012-03-12 12:46:41 +01002736 case LOG_FMT_REQ: // %r
William Lallemandbddd4fd2012-02-27 11:23:10 +01002737 /* Request */
2738 if (tmp->options & LOG_OPT_QUOTE)
2739 LOGCHAR('"');
Willy Tarreau57bc8912016-04-25 17:09:40 +02002740 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Dragan Dosen835b9212016-02-12 13:23:03 +01002741 ret = lf_encode_string(tmplog, dst + maxsize,
2742 '#', url_encode_map, uri, tmp);
William Lallemand1d705562012-03-12 12:46:41 +01002743 if (ret == NULL || *ret != '\0')
William Lallemand51b5dca2012-03-26 17:52:55 +02002744 goto out;
William Lallemand1d705562012-03-12 12:46:41 +01002745 tmplog = ret;
William Lallemandbddd4fd2012-02-27 11:23:10 +01002746 if (tmp->options & LOG_OPT_QUOTE)
2747 LOGCHAR('"');
William Lallemandbddd4fd2012-02-27 11:23:10 +01002748 last_isspace = 0;
2749 break;
William Lallemand5f232402012-04-05 18:02:55 +02002750
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002751 case LOG_FMT_HTTP_PATH: // %HP
Willy Tarreau57bc8912016-04-25 17:09:40 +02002752 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002753
Willy Tarreaub7636d12015-06-17 19:58:02 +02002754 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002755 LOGCHAR('"');
2756
2757 end = uri + strlen(uri);
2758 // look for the first whitespace character
2759 while (uri < end && !HTTP_IS_SPHT(*uri))
2760 uri++;
2761
2762 // keep advancing past multiple spaces
2763 while (uri < end && HTTP_IS_SPHT(*uri)) {
2764 uri++; nspaces++;
2765 }
2766
2767 // look for first space or question mark after url
2768 spc = uri;
2769 while (spc < end && *spc != '?' && !HTTP_IS_SPHT(*spc))
2770 spc++;
2771
Nenad Merdanovic54e439f2016-04-26 01:39:02 +02002772 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002773 chunk.area = "<BADREQ>";
2774 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002775 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002776 chunk.area = uri;
2777 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002778 }
2779
Dragan Dosen835b9212016-02-12 13:23:03 +01002780 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002781 if (ret == NULL || *ret != '\0')
2782 goto out;
2783
2784 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002785 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002786 LOGCHAR('"');
2787
2788 last_isspace = 0;
2789 break;
2790
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002791 case LOG_FMT_HTTP_PATH_ONLY: // %HPO
2792 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
2793
2794 if (tmp->options & LOG_OPT_QUOTE)
2795 LOGCHAR('"');
2796
2797 end = uri + strlen(uri);
2798
2799 // look for the first whitespace character
2800 while (uri < end && !HTTP_IS_SPHT(*uri))
2801 uri++;
2802
2803 // keep advancing past multiple spaces
2804 while (uri < end && HTTP_IS_SPHT(*uri)) {
2805 uri++; nspaces++;
2806 }
2807
2808 // look for first space after url
2809 spc = uri;
2810 while (spc < end && !HTTP_IS_SPHT(*spc))
2811 spc++;
2812
Tim Duesterhus92c696e2021-02-28 16:11:36 +01002813 path = ist2(uri, spc - uri);
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002814
2815 // extract relative path without query params from url
Amaury Denoyellec453f952021-07-06 11:40:12 +02002816 parser = http_uri_parser_init(path);
2817 path = iststop(http_parse_path(&parser), '?');
Maciej Zdebfcdfd852020-11-30 18:27:47 +00002818 if (!txn || !txn->uri || nspaces == 0) {
2819 chunk.area = "<BADREQ>";
2820 chunk.data = strlen("<BADREQ>");
2821 } else {
2822 chunk.area = path.ptr;
2823 chunk.data = path.len;
2824 }
2825
2826 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
2827 if (ret == NULL || *ret != '\0')
2828 goto out;
2829
2830 tmplog = ret;
2831 if (tmp->options & LOG_OPT_QUOTE)
2832 LOGCHAR('"');
2833
2834 last_isspace = 0;
2835 break;
2836
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002837 case LOG_FMT_HTTP_QUERY: // %HQ
2838 if (tmp->options & LOG_OPT_QUOTE)
2839 LOGCHAR('"');
2840
Willy Tarreau57bc8912016-04-25 17:09:40 +02002841 if (!txn || !txn->uri) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002842 chunk.area = "<BADREQ>";
2843 chunk.data = strlen("<BADREQ>");
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002844 } else {
2845 uri = txn->uri;
2846 end = uri + strlen(uri);
2847 // look for the first question mark
2848 while (uri < end && *uri != '?')
2849 uri++;
2850
2851 qmark = uri;
2852 // look for first space or question mark after url
2853 while (uri < end && !HTTP_IS_SPHT(*uri))
2854 uri++;
2855
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002856 chunk.area = qmark;
2857 chunk.data = uri - qmark;
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002858 }
2859
Dragan Dosen835b9212016-02-12 13:23:03 +01002860 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworthe63ac872015-07-31 16:14:16 +00002861 if (ret == NULL || *ret != '\0')
2862 goto out;
2863
2864 tmplog = ret;
2865 if (tmp->options & LOG_OPT_QUOTE)
2866 LOGCHAR('"');
2867
2868 last_isspace = 0;
2869 break;
2870
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002871 case LOG_FMT_HTTP_URI: // %HU
Willy Tarreau57bc8912016-04-25 17:09:40 +02002872 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002873
Willy Tarreaub7636d12015-06-17 19:58:02 +02002874 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002875 LOGCHAR('"');
2876
2877 end = uri + strlen(uri);
2878 // look for the first whitespace character
2879 while (uri < end && !HTTP_IS_SPHT(*uri))
2880 uri++;
2881
2882 // keep advancing past multiple spaces
2883 while (uri < end && HTTP_IS_SPHT(*uri)) {
2884 uri++; nspaces++;
2885 }
2886
2887 // look for first space after url
2888 spc = uri;
2889 while (spc < end && !HTTP_IS_SPHT(*spc))
2890 spc++;
2891
Willy Tarreau57bc8912016-04-25 17:09:40 +02002892 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002893 chunk.area = "<BADREQ>";
2894 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002895 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002896 chunk.area = uri;
2897 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002898 }
2899
Dragan Dosen835b9212016-02-12 13:23:03 +01002900 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002901 if (ret == NULL || *ret != '\0')
2902 goto out;
2903
2904 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002905 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002906 LOGCHAR('"');
2907
2908 last_isspace = 0;
2909 break;
2910
2911 case LOG_FMT_HTTP_METHOD: // %HM
Willy Tarreau57bc8912016-04-25 17:09:40 +02002912 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Willy Tarreaub7636d12015-06-17 19:58:02 +02002913 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002914 LOGCHAR('"');
2915
2916 end = uri + strlen(uri);
2917 // look for the first whitespace character
2918 spc = uri;
2919 while (spc < end && !HTTP_IS_SPHT(*spc))
2920 spc++;
2921
2922 if (spc == end) { // odd case, we have txn->uri, but we only got a verb
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002923 chunk.area = "<BADREQ>";
2924 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002925 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002926 chunk.area = uri;
2927 chunk.data = spc - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002928 }
2929
Dragan Dosen835b9212016-02-12 13:23:03 +01002930 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002931 if (ret == NULL || *ret != '\0')
2932 goto out;
2933
2934 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002935 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002936 LOGCHAR('"');
2937
2938 last_isspace = 0;
2939 break;
2940
2941 case LOG_FMT_HTTP_VERSION: // %HV
Willy Tarreau57bc8912016-04-25 17:09:40 +02002942 uri = txn && txn->uri ? txn->uri : "<BADREQ>";
Willy Tarreaub7636d12015-06-17 19:58:02 +02002943 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002944 LOGCHAR('"');
2945
2946 end = uri + strlen(uri);
2947 // look for the first whitespace character
2948 while (uri < end && !HTTP_IS_SPHT(*uri))
2949 uri++;
2950
2951 // keep advancing past multiple spaces
2952 while (uri < end && HTTP_IS_SPHT(*uri)) {
2953 uri++; nspaces++;
2954 }
2955
2956 // look for the next whitespace character
2957 while (uri < end && !HTTP_IS_SPHT(*uri))
2958 uri++;
2959
2960 // keep advancing past multiple spaces
2961 while (uri < end && HTTP_IS_SPHT(*uri))
2962 uri++;
2963
Willy Tarreau57bc8912016-04-25 17:09:40 +02002964 if (!txn || !txn->uri || nspaces == 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002965 chunk.area = "<BADREQ>";
2966 chunk.data = strlen("<BADREQ>");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002967 } else if (uri == end) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002968 chunk.area = "HTTP/0.9";
2969 chunk.data = strlen("HTTP/0.9");
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002970 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002971 chunk.area = uri;
2972 chunk.data = end - uri;
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002973 }
2974
Dragan Dosen835b9212016-02-12 13:23:03 +01002975 ret = lf_encode_chunk(tmplog, dst + maxsize, '#', url_encode_map, &chunk, tmp);
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002976 if (ret == NULL || *ret != '\0')
2977 goto out;
2978
2979 tmplog = ret;
Willy Tarreaub7636d12015-06-17 19:58:02 +02002980 if (tmp->options & LOG_OPT_QUOTE)
Andrew Hayworth0ebc55f2015-04-27 21:37:03 +00002981 LOGCHAR('"');
2982
2983 last_isspace = 0;
2984 break;
2985
William Lallemand5f232402012-04-05 18:02:55 +02002986 case LOG_FMT_COUNTER: // %rt
2987 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreau5cacab62018-09-05 15:52:59 +02002988 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", uniq_id);
William Lallemand5f232402012-04-05 18:02:55 +02002989 if (iret < 0 || iret > dst + maxsize - tmplog)
2990 goto out;
2991 last_isspace = 0;
2992 tmplog += iret;
2993 } else {
Willy Tarreau5cacab62018-09-05 15:52:59 +02002994 ret = ltoa_o(uniq_id, tmplog, dst + maxsize - tmplog);
William Lallemand5f232402012-04-05 18:02:55 +02002995 if (ret == NULL)
2996 goto out;
2997 tmplog = ret;
2998 last_isspace = 0;
2999 }
3000 break;
3001
Willy Tarreau7346acb2014-08-28 15:03:15 +02003002 case LOG_FMT_LOGCNT: // %lc
3003 if (tmp->options & LOG_OPT_HEXA) {
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003004 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", fe->log_count);
Willy Tarreau7346acb2014-08-28 15:03:15 +02003005 if (iret < 0 || iret > dst + maxsize - tmplog)
3006 goto out;
3007 last_isspace = 0;
3008 tmplog += iret;
3009 } else {
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003010 ret = ultoa_o(fe->log_count, tmplog, dst + maxsize - tmplog);
Willy Tarreau7346acb2014-08-28 15:03:15 +02003011 if (ret == NULL)
3012 goto out;
3013 tmplog = ret;
3014 last_isspace = 0;
3015 }
3016 break;
3017
William Lallemand5f232402012-04-05 18:02:55 +02003018 case LOG_FMT_HOSTNAME: // %H
3019 src = hostname;
3020 ret = lf_text(tmplog, src, dst + maxsize - tmplog, tmp);
3021 if (ret == NULL)
3022 goto out;
3023 tmplog = ret;
3024 last_isspace = 0;
3025 break;
3026
3027 case LOG_FMT_PID: // %pid
3028 if (tmp->options & LOG_OPT_HEXA) {
3029 iret = snprintf(tmplog, dst + maxsize - tmplog, "%04X", pid);
3030 if (iret < 0 || iret > dst + maxsize - tmplog)
3031 goto out;
3032 last_isspace = 0;
3033 tmplog += iret;
3034 } else {
3035 ret = ltoa_o(pid, tmplog, dst + maxsize - tmplog);
3036 if (ret == NULL)
3037 goto out;
3038 tmplog = ret;
3039 last_isspace = 0;
3040 }
3041 break;
William Lallemanda73203e2012-03-12 12:48:57 +01003042
3043 case LOG_FMT_UNIQUEID: // %ID
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003044 ret = NULL;
Tim Duesterhusa17e6622020-03-05 20:19:02 +01003045 if (s)
3046 ret = lf_text_len(tmplog, s->unique_id.ptr, s->unique_id.len, maxsize - (tmplog - dst), tmp);
3047 else
3048 ret = lf_text_len(tmplog, NULL, 0, maxsize - (tmplog - dst), tmp);
William Lallemanda73203e2012-03-12 12:48:57 +01003049 if (ret == NULL)
3050 goto out;
3051 tmplog = ret;
3052 last_isspace = 0;
3053 break;
3054
William Lallemandbddd4fd2012-02-27 11:23:10 +01003055 }
3056 }
3057
3058out:
William Lallemand1d705562012-03-12 12:46:41 +01003059 /* *tmplog is a unused character */
3060 *tmplog = '\0';
Willy Tarreaudf974472012-12-28 02:44:01 +01003061 return tmplog - dst;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003062
Willy Tarreaubaaee002006-06-26 02:48:02 +02003063}
3064
William Lallemand1d705562012-03-12 12:46:41 +01003065/*
Willy Tarreau87b09662015-04-03 00:22:06 +02003066 * send a log for the stream when we have enough info about it.
William Lallemand1d705562012-03-12 12:46:41 +01003067 * Will not log if the frontend has no log defined.
3068 */
Willy Tarreau87b09662015-04-03 00:22:06 +02003069void strm_log(struct stream *s)
William Lallemand1d705562012-03-12 12:46:41 +01003070{
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003071 struct session *sess = s->sess;
William Lallemand1d705562012-03-12 12:46:41 +01003072 int size, err, level;
Dragan Dosen0b85ece2015-09-25 19:17:44 +02003073 int sd_size = 0;
William Lallemand1d705562012-03-12 12:46:41 +01003074
3075 /* if we don't want to log normal traffic, return now */
Willy Tarreaue7dff022015-04-03 01:14:29 +02003076 err = (s->flags & SF_REDISP) ||
3077 ((s->flags & SF_ERR_MASK) > SF_ERR_LOCAL) ||
3078 (((s->flags & SF_ERR_MASK) == SF_ERR_NONE) &&
Christopher Faulet909f3182022-03-29 15:42:09 +02003079 (s->conn_retries != s->be->conn_retries)) ||
Willy Tarreaueee5b512015-04-03 23:46:31 +02003080 ((sess->fe->mode == PR_MODE_HTTP) && s->txn && s->txn->status >= 500);
Willy Tarreaubaaee002006-06-26 02:48:02 +02003081
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003082 if (!err && (sess->fe->options2 & PR_O2_NOLOGNORM))
William Lallemand1d705562012-03-12 12:46:41 +01003083 return;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003084
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003085 if (LIST_ISEMPTY(&sess->fe->logsrvs))
William Lallemand1d705562012-03-12 12:46:41 +01003086 return;
William Lallemandbddd4fd2012-02-27 11:23:10 +01003087
Willy Tarreauabcd5142013-06-11 17:18:02 +02003088 if (s->logs.level) { /* loglevel was overridden */
3089 if (s->logs.level == -1) {
3090 s->logs.logwait = 0; /* logs disabled */
3091 return;
3092 }
3093 level = s->logs.level - 1;
3094 }
3095 else {
3096 level = LOG_INFO;
Willy Tarreaue36cbcb2015-04-03 15:40:56 +02003097 if (err && (sess->fe->options2 & PR_O2_LOGERRORS))
Willy Tarreauabcd5142013-06-11 17:18:02 +02003098 level = LOG_ERR;
3099 }
William Lallemand1d705562012-03-12 12:46:41 +01003100
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003101 /* if unique-id was not generated */
Tim Duesterhusa17e6622020-03-05 20:19:02 +01003102 if (!isttest(s->unique_id) && !LIST_ISEMPTY(&sess->fe->format_unique_id)) {
Tim Duesterhus2825b4b2020-02-28 15:13:34 +01003103 stream_generate_unique_id(s, &sess->fe->format_unique_id);
William Lallemand5b7ea3a2013-08-28 15:44:19 +02003104 }
3105
Dragan Dosen0b85ece2015-09-25 19:17:44 +02003106 if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) {
3107 sd_size = build_logline(s, logline_rfc5424, global.max_syslog_len,
3108 &sess->fe->logformat_sd);
3109 }
3110
Dragan Dosen59cee972015-09-19 22:09:02 +02003111 size = build_logline(s, logline, global.max_syslog_len, &sess->fe->logformat);
William Lallemand1d705562012-03-12 12:46:41 +01003112 if (size > 0) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003113 _HA_ATOMIC_INC(&sess->fe->log_count);
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003114 __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level,
3115 logline, size + 1, logline_rfc5424, sd_size);
William Lallemand1d705562012-03-12 12:46:41 +01003116 s->logs.logwait = 0;
3117 }
3118}
William Lallemandbddd4fd2012-02-27 11:23:10 +01003119
Willy Tarreau53839352018-09-05 19:51:10 +02003120/*
3121 * send a minimalist log for the session. Will not log if the frontend has no
3122 * log defined. It is assumed that this is only used to report anomalies that
3123 * cannot lead to the creation of a regular stream. Because of this the log
3124 * level is LOG_INFO or LOG_ERR depending on the "log-separate-error" setting
3125 * in the frontend. The caller must simply know that it should not call this
Willy Tarreau9fa267d2018-10-05 10:22:27 +02003126 * function to report unimportant events. It is safe to call this function with
3127 * sess==NULL (will not do anything).
Willy Tarreau53839352018-09-05 19:51:10 +02003128 */
3129void sess_log(struct session *sess)
3130{
3131 int size, level;
3132 int sd_size = 0;
3133
Willy Tarreau9fa267d2018-10-05 10:22:27 +02003134 if (!sess)
3135 return;
3136
Willy Tarreau53839352018-09-05 19:51:10 +02003137 if (LIST_ISEMPTY(&sess->fe->logsrvs))
3138 return;
3139
3140 level = LOG_INFO;
3141 if (sess->fe->options2 & PR_O2_LOGERRORS)
3142 level = LOG_ERR;
3143
3144 if (!LIST_ISEMPTY(&sess->fe->logformat_sd)) {
3145 sd_size = sess_build_logline(sess, NULL,
3146 logline_rfc5424, global.max_syslog_len,
3147 &sess->fe->logformat_sd);
3148 }
3149
Remi Tricot-Le Bretonfe21fe72021-08-31 12:08:52 +02003150 if (!LIST_ISEMPTY(&sess->fe->logformat_error))
3151 size = sess_build_logline(sess, NULL, logline, global.max_syslog_len, &sess->fe->logformat_error);
3152 else
3153 size = sess_build_logline(sess, NULL, logline, global.max_syslog_len, &sess->fe->logformat);
Willy Tarreau53839352018-09-05 19:51:10 +02003154 if (size > 0) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003155 _HA_ATOMIC_INC(&sess->fe->log_count);
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003156 __send_log(&sess->fe->logsrvs, &sess->fe->log_tag, level,
3157 logline, size + 1, logline_rfc5424, sd_size);
Willy Tarreau53839352018-09-05 19:51:10 +02003158 }
3159}
3160
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003161void app_log(struct list *logsrvs, struct buffer *tag, int level, const char *format, ...)
3162{
3163 va_list argp;
3164 int data_len;
3165
3166 if (level < 0 || format == NULL || logline == NULL)
3167 return;
3168
3169 va_start(argp, format);
3170 data_len = vsnprintf(logline, global.max_syslog_len, format, argp);
3171 if (data_len < 0 || data_len > global.max_syslog_len)
3172 data_len = global.max_syslog_len;
3173 va_end(argp);
3174
3175 __send_log(logsrvs, tag, level, logline, data_len, default_rfc5424_sd_log_format, 2);
3176}
Emeric Brun54932b42020-07-07 09:43:24 +02003177/*
3178 * This function parse a received log message <buf>, of size <buflen>
3179 * it fills <level>, <facility> and <metadata> depending of the detected
3180 * header format and message will point on remaining payload of <size>
3181 *
3182 * <metadata> must point on a preallocated array of LOG_META_FIELDS*sizeof(struct ist)
3183 * struct ist len will be set to 0 if field is not found
3184 * <level> and <facility> will be set to -1 if not found.
3185 */
3186void parse_log_message(char *buf, size_t buflen, int *level, int *facility,
3187 struct ist *metadata, char **message, size_t *size)
3188{
3189
3190 char *p;
3191 int fac_level = 0;
3192
3193 *level = *facility = -1;
3194
3195 *message = buf;
3196 *size = buflen;
3197
3198 memset(metadata, 0, LOG_META_FIELDS*sizeof(struct ist));
3199
3200 p = buf;
3201 if (*size < 2 || *p != '<')
3202 return;
3203
3204 p++;
3205 while (*p != '>') {
3206 if (*p > '9' || *p < '0')
3207 return;
3208 fac_level = 10*fac_level + (*p - '0');
3209 p++;
3210 if ((p - buf) > buflen)
3211 return;
3212 }
3213
3214 *facility = fac_level >> 3;
3215 *level = fac_level & 0x7;
3216 p++;
3217
3218 metadata[LOG_META_PRIO] = ist2(buf, p - buf);
3219
3220 buflen -= p - buf;
3221 buf = p;
3222
3223 *size = buflen;
3224 *message = buf;
3225
3226 /* for rfc5424, prio is always followed by '1' and ' ' */
3227 if ((*size > 2) && (p[0] == '1') && (p[1] == ' ')) {
3228 /* format is always '1 TIMESTAMP HOSTNAME TAG PID MSGID STDATA '
3229 * followed by message.
3230 * Each header field can present NILVALUE: '-'
3231 */
3232
3233 p += 2;
3234 /* timestamp is NILVALUE '-' */
3235 if (*size > 2 && (p[0] == '-') && p[1] == ' ') {
3236 metadata[LOG_META_TIME] = ist2(p, 1);
3237 p++;
3238 }
3239 else if (*size > LOG_ISOTIME_MINLEN) {
3240 metadata[LOG_META_TIME].ptr = p;
3241
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05003242 /* check if optional secfrac is present
Emeric Brun54932b42020-07-07 09:43:24 +02003243 * in timestamp.
3244 * possible format are:
3245 * ex: '1970-01-01T00:00:00.000000Z'
3246 * '1970-01-01T00:00:00.000000+00:00'
3247 * '1970-01-01T00:00:00.000000-00:00'
3248 * '1970-01-01T00:00:00Z'
3249 * '1970-01-01T00:00:00+00:00'
3250 * '1970-01-01T00:00:00-00:00'
3251 */
3252 p += 19;
3253 if (*p == '.') {
3254 p++;
3255 if ((p - buf) >= buflen)
3256 goto bad_format;
3257 while (*p != 'Z' && *p != '+' && *p != '-') {
3258 if ((unsigned char)(*p - '0') > 9)
3259 goto bad_format;
3260
3261 p++;
3262 if ((p - buf) >= buflen)
3263 goto bad_format;
3264 }
3265 }
3266
3267 if (*p == 'Z')
3268 p++;
3269 else
3270 p += 6; /* case of '+00:00 or '-00:00' */
3271
3272 if ((p - buf) >= buflen || *p != ' ')
3273 goto bad_format;
3274 metadata[LOG_META_TIME].len = p - metadata[LOG_META_TIME].ptr;
3275 }
3276 else
3277 goto bad_format;
3278
3279
3280 p++;
3281 if ((p - buf) >= buflen || *p == ' ')
3282 goto bad_format;
3283
3284 metadata[LOG_META_HOST].ptr = p;
3285 while (*p != ' ') {
3286 p++;
3287 if ((p - buf) >= buflen)
3288 goto bad_format;
3289 }
3290 metadata[LOG_META_HOST].len = p - metadata[LOG_META_HOST].ptr;
3291 if (metadata[LOG_META_HOST].len == 1 && metadata[LOG_META_HOST].ptr[0] == '-')
3292 metadata[LOG_META_HOST].len = 0;
3293
3294 p++;
3295 if ((p - buf) >= buflen || *p == ' ')
3296 goto bad_format;
3297
3298 metadata[LOG_META_TAG].ptr = p;
3299 while (*p != ' ') {
3300 p++;
3301 if ((p - buf) >= buflen)
3302 goto bad_format;
3303 }
3304 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3305 if (metadata[LOG_META_TAG].len == 1 && metadata[LOG_META_TAG].ptr[0] == '-')
3306 metadata[LOG_META_TAG].len = 0;
3307
3308 p++;
3309 if ((p - buf) >= buflen || *p == ' ')
3310 goto bad_format;
3311
3312 metadata[LOG_META_PID].ptr = p;
3313 while (*p != ' ') {
3314 p++;
3315 if ((p - buf) >= buflen)
3316 goto bad_format;
3317 }
3318 metadata[LOG_META_PID].len = p - metadata[LOG_META_PID].ptr;
3319 if (metadata[LOG_META_PID].len == 1 && metadata[LOG_META_PID].ptr[0] == '-')
3320 metadata[LOG_META_PID].len = 0;
3321
3322 p++;
3323 if ((p - buf) >= buflen || *p == ' ')
3324 goto bad_format;
3325
3326 metadata[LOG_META_MSGID].ptr = p;
3327 while (*p != ' ') {
3328 p++;
3329 if ((p - buf) >= buflen)
3330 goto bad_format;
3331 }
3332 metadata[LOG_META_MSGID].len = p - metadata[LOG_META_MSGID].ptr;
3333 if (metadata[LOG_META_MSGID].len == 1 && metadata[LOG_META_MSGID].ptr[0] == '-')
3334 metadata[LOG_META_MSGID].len = 0;
3335
3336 p++;
3337 if ((p - buf) >= buflen || *p == ' ')
3338 goto bad_format;
3339
3340 /* structured data format is:
3341 * ex:
3342 * '[key1=value1 key2=value2][key3=value3]'
3343 *
3344 * space is invalid outside [] because
3345 * considered as the end of structured data field
3346 */
3347 metadata[LOG_META_STDATA].ptr = p;
3348 if (*p == '[') {
3349 int elem = 0;
3350
3351 while (1) {
3352 if (elem) {
3353 /* according to rfc this char is escaped in param values */
3354 if (*p == ']' && *(p-1) != '\\')
3355 elem = 0;
3356 }
3357 else {
3358 if (*p == '[')
3359 elem = 1;
3360 else if (*p == ' ')
3361 break;
3362 else
3363 goto bad_format;
3364 }
3365 p++;
3366 if ((p - buf) >= buflen)
3367 goto bad_format;
3368 }
3369 }
3370 else if (*p == '-') {
3371 /* case of NILVALUE */
3372 p++;
3373 if ((p - buf) >= buflen || *p != ' ')
3374 goto bad_format;
3375 }
3376 else
3377 goto bad_format;
3378
3379 metadata[LOG_META_STDATA].len = p - metadata[LOG_META_STDATA].ptr;
3380 if (metadata[LOG_META_STDATA].len == 1 && metadata[LOG_META_STDATA].ptr[0] == '-')
3381 metadata[LOG_META_STDATA].len = 0;
3382
3383 p++;
3384
3385 buflen -= p - buf;
3386 buf = p;
3387
3388 *size = buflen;
3389 *message = p;
3390 }
3391 else if (*size > LOG_LEGACYTIME_LEN) {
3392 int m;
3393
3394 /* supported header format according to rfc3164.
3395 * ex:
3396 * 'Jan 1 00:00:00 HOSTNAME TAG[PID]: '
3397 * or 'Jan 1 00:00:00 HOSTNAME TAG: '
3398 * or 'Jan 1 00:00:00 HOSTNAME '
3399 * Note: HOSTNAME is mandatory, and day
3400 * of month uses a single space prefix if
3401 * less than 10 to ensure hour offset is
3402 * always the same.
3403 */
3404
3405 /* Check month to see if it correspond to a rfc3164
3406 * header ex 'Jan 1 00:00:00' */
3407 for (m = 0; m < 12; m++)
3408 if (!memcmp(monthname[m], p, 3))
3409 break;
3410 /* Month not found */
3411 if (m == 12)
3412 goto bad_format;
3413
3414 metadata[LOG_META_TIME] = ist2(p, LOG_LEGACYTIME_LEN);
3415
3416 p += LOG_LEGACYTIME_LEN;
3417 if ((p - buf) >= buflen || *p != ' ')
3418 goto bad_format;
3419
3420 p++;
3421 if ((p - buf) >= buflen || *p == ' ')
3422 goto bad_format;
3423
3424 metadata[LOG_META_HOST].ptr = p;
3425 while (*p != ' ') {
3426 p++;
3427 if ((p - buf) >= buflen)
3428 goto bad_format;
3429 }
3430 metadata[LOG_META_HOST].len = p - metadata[LOG_META_HOST].ptr;
3431
3432 /* TAG seems to no be mandatory */
3433 p++;
3434
3435 buflen -= p - buf;
3436 buf = p;
3437
3438 *size = buflen;
3439 *message = buf;
3440
3441 if (!buflen)
3442 return;
3443
3444 while (((p - buf) < buflen) && *p != ' ' && *p != ':')
3445 p++;
3446
3447 /* a tag must present a trailing ':' */
3448 if (((p - buf) >= buflen) || *p != ':')
3449 return;
3450 p++;
3451 /* followed by a space */
3452 if (((p - buf) >= buflen) || *p != ' ')
3453 return;
3454
3455 /* rewind to parse tag and pid */
3456 p = buf;
3457 metadata[LOG_META_TAG].ptr = p;
3458 /* we have the guarantee that ':' will be reach before size limit */
3459 while (*p != ':') {
3460 if (*p == '[') {
3461 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3462 metadata[LOG_META_PID].ptr = p + 1;
3463 }
Tim Duesterhus7b5777d2021-03-02 18:57:28 +01003464 else if (*p == ']' && isttest(metadata[LOG_META_PID])) {
Emeric Brun54932b42020-07-07 09:43:24 +02003465 if (p[1] != ':')
3466 return;
3467 metadata[LOG_META_PID].len = p - metadata[LOG_META_PID].ptr;
3468 }
3469 p++;
3470 }
3471 if (!metadata[LOG_META_TAG].len)
3472 metadata[LOG_META_TAG].len = p - metadata[LOG_META_TAG].ptr;
3473
Ilya Shipitsin6b79f382020-07-23 00:32:55 +05003474 /* let pass ':' and ' ', we still have warranty size is large enough */
Emeric Brun54932b42020-07-07 09:43:24 +02003475 p += 2;
3476
3477 buflen -= p - buf;
3478 buf = p;
3479
3480 *size = buflen;
3481 *message = buf;
3482 }
3483
3484 return;
3485
3486bad_format:
3487 /* bad syslog format, we reset all parsed syslog fields
3488 * but priority is kept because we are able to re-build
3489 * this message using LOF_FORMAT_PRIO.
3490 */
3491 metadata[LOG_META_TIME].len = 0;
3492 metadata[LOG_META_HOST].len = 0;
3493 metadata[LOG_META_TAG].len = 0;
3494 metadata[LOG_META_PID].len = 0;
3495 metadata[LOG_META_MSGID].len = 0;
3496 metadata[LOG_META_STDATA].len = 0;
3497
3498 return;
3499}
3500
3501/*
3502 * UDP syslog fd handler
3503 */
3504void syslog_fd_handler(int fd)
3505{
3506 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
3507 ssize_t ret = 0;
3508 struct buffer *buf = get_trash_chunk();
3509 size_t size;
3510 char *message;
3511 int level;
3512 int facility;
3513 struct listener *l = objt_listener(fdtab[fd].owner);
3514 int max_accept;
3515
Tim Duesterhus16554242021-09-15 13:58:49 +02003516 BUG_ON(!l);
Emeric Brun54932b42020-07-07 09:43:24 +02003517
Willy Tarreauf5090652021-04-06 17:23:40 +02003518 if (fdtab[fd].state & FD_POLL_IN) {
Emeric Brun54932b42020-07-07 09:43:24 +02003519
3520 if (!fd_recv_ready(fd))
3521 return;
3522
3523 max_accept = l->maxaccept ? l->maxaccept : 1;
3524
3525 do {
3526 /* Source address */
3527 struct sockaddr_storage saddr = {0};
3528 socklen_t saddrlen;
3529
3530 saddrlen = sizeof(saddr);
3531
3532 ret = recvfrom(fd, buf->area, buf->size, 0, (struct sockaddr *)&saddr, &saddrlen);
3533 if (ret < 0) {
3534 if (errno == EINTR)
3535 continue;
3536 if (errno == EAGAIN)
3537 fd_cant_recv(fd);
3538 goto out;
3539 }
3540 buf->data = ret;
3541
Emeric Brun45c457a2020-07-09 23:23:34 +02003542 /* update counters */
Willy Tarreau4781b152021-04-06 13:53:36 +02003543 _HA_ATOMIC_INC(&cum_log_messages);
Emeric Bruna39ecbd2020-10-05 14:33:12 +02003544 proxy_inc_fe_req_ctr(l, l->bind_conf->frontend);
Emeric Brun45c457a2020-07-09 23:23:34 +02003545
Emeric Brun54932b42020-07-07 09:43:24 +02003546 parse_log_message(buf->area, buf->data, &level, &facility, metadata, &message, &size);
3547
3548 process_send_log(&l->bind_conf->frontend->logsrvs, level, facility, metadata, message, size);
3549
3550 } while (--max_accept);
3551 }
3552
3553out:
3554 return;
3555}
Christopher Faulet5c6fefc2019-08-11 19:40:12 +02003556
Emeric Brun12941c82020-07-07 14:19:42 +02003557/*
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003558 * IO Handler to handle message exchange with a syslog tcp client
3559 */
3560static void syslog_io_handler(struct appctx *appctx)
3561{
3562 static THREAD_LOCAL struct ist metadata[LOG_META_FIELDS];
Christopher Faulet908628c2022-03-25 16:43:49 +01003563 struct conn_stream *cs = appctx->owner;
3564 struct stream *s = __cs_strm(cs);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003565 struct proxy *frontend = strm_fe(s);
3566 struct listener *l = strm_li(s);
3567 struct buffer *buf = get_trash_chunk();
3568 int max_accept;
3569 int to_skip;
3570 int facility;
3571 int level;
3572 char *message;
3573 size_t size;
3574
3575 max_accept = l->maxaccept ? l->maxaccept : 1;
Christopher Faulet908628c2022-03-25 16:43:49 +01003576 while (co_data(cs_oc(cs))) {
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003577 char c;
3578
3579 if (max_accept <= 0)
3580 goto missing_budget;
3581 max_accept--;
3582
Christopher Faulet908628c2022-03-25 16:43:49 +01003583 to_skip = co_getchar(cs_oc(cs), &c);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003584 if (!to_skip)
3585 goto missing_data;
3586 else if (to_skip < 0)
3587 goto cli_abort;
3588
3589 if (c == '<') {
3590 /* rfc-6587, Non-Transparent-Framing: messages separated by
3591 * a trailing LF or CR LF
3592 */
Christopher Faulet908628c2022-03-25 16:43:49 +01003593 to_skip = co_getline(cs_oc(cs), buf->area, buf->size);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003594 if (!to_skip)
3595 goto missing_data;
3596 else if (to_skip < 0)
3597 goto cli_abort;
3598
3599 if (buf->area[to_skip - 1] != '\n')
3600 goto parse_error;
3601
3602 buf->data = to_skip - 1;
3603
3604 /* according to rfc-6587, some devices adds CR before LF */
3605 if (buf->data && buf->area[buf->data - 1] == '\r')
3606 buf->data--;
3607
3608 }
3609 else if ((unsigned char)(c - '1') <= 8) {
3610 /* rfc-6587, Octet-Counting: message length in ASCII
3611 * (first digit can not be ZERO), followed by a space
3612 * and message length
3613 */
3614 char *p = NULL;
3615 int msglen;
3616
Christopher Faulet908628c2022-03-25 16:43:49 +01003617 to_skip = co_getword(cs_oc(cs), buf->area, buf->size, ' ');
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003618 if (!to_skip)
3619 goto missing_data;
3620 else if (to_skip < 0)
3621 goto cli_abort;
3622
3623 if (buf->area[to_skip - 1] != ' ')
3624 goto parse_error;
3625
3626 msglen = strtol(trash.area, &p, 10);
3627 if (!msglen || p != &buf->area[to_skip - 1])
3628 goto parse_error;
3629
3630 /* message seems too large */
3631 if (msglen > buf->size)
3632 goto parse_error;
3633
Christopher Faulet908628c2022-03-25 16:43:49 +01003634 msglen = co_getblk(cs_oc(cs), buf->area, msglen, to_skip);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003635 if (!msglen)
3636 goto missing_data;
3637 else if (msglen < 0)
3638 goto cli_abort;
3639
3640
3641 buf->data = msglen;
3642 to_skip += msglen;
3643 }
3644 else
3645 goto parse_error;
3646
Christopher Faulet908628c2022-03-25 16:43:49 +01003647 co_skip(cs_oc(cs), to_skip);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003648
3649 /* update counters */
Willy Tarreau4781b152021-04-06 13:53:36 +02003650 _HA_ATOMIC_INC(&cum_log_messages);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003651 proxy_inc_fe_req_ctr(l, frontend);
3652
3653 parse_log_message(buf->area, buf->data, &level, &facility, metadata, &message, &size);
3654
3655 process_send_log(&frontend->logsrvs, level, facility, metadata, message, size);
3656
3657 }
3658
3659missing_data:
3660 /* we need more data to read */
Christopher Faulet908628c2022-03-25 16:43:49 +01003661 cs_oc(cs)->flags |= CF_READ_DONTWAIT;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003662
3663 return;
3664
3665missing_budget:
3666 /* it may remain some stuff to do, let's retry later */
3667 appctx_wakeup(appctx);
3668
3669 return;
3670
3671parse_error:
3672 if (l->counters)
Willy Tarreau4781b152021-04-06 13:53:36 +02003673 _HA_ATOMIC_INC(&l->counters->failed_req);
3674 _HA_ATOMIC_INC(&frontend->fe_counters.failed_req);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003675
3676 goto close;
3677
3678cli_abort:
3679 if (l->counters)
Willy Tarreau4781b152021-04-06 13:53:36 +02003680 _HA_ATOMIC_INC(&l->counters->cli_aborts);
3681 _HA_ATOMIC_INC(&frontend->fe_counters.cli_aborts);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003682
3683close:
Christopher Fauletda098e62022-03-31 17:44:45 +02003684 cs_shutw(cs);
3685 cs_shutr(cs);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003686
Christopher Faulet908628c2022-03-25 16:43:49 +01003687 cs_ic(cs)->flags |= CF_READ_NULL;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003688
3689 return;
3690}
3691
3692static struct applet syslog_applet = {
3693 .obj_type = OBJ_TYPE_APPLET,
3694 .name = "<SYSLOG>", /* used for logging */
3695 .fct = syslog_io_handler,
3696 .release = NULL,
3697};
3698
3699/*
Emeric Brun12941c82020-07-07 14:19:42 +02003700 * Parse "log-forward" section and create corresponding sink buffer.
3701 *
3702 * The function returns 0 in success case, otherwise, it returns error
3703 * flags.
3704 */
3705int cfg_parse_log_forward(const char *file, int linenum, char **args, int kwm)
3706{
3707 int err_code = 0;
3708 struct proxy *px;
3709 char *errmsg = NULL;
3710 const char *err = NULL;
3711
3712 if (strcmp(args[0], "log-forward") == 0) {
3713 if (!*args[1]) {
3714 ha_alert("parsing [%s:%d] : missing name for ip-forward section.\n", file, linenum);
3715 err_code |= ERR_ALERT | ERR_ABORT;
3716 goto out;
3717 }
3718
3719 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3720 goto out;
3721
3722 err = invalid_char(args[1]);
3723 if (err) {
3724 ha_alert("parsing [%s:%d] : character '%c' is not permitted in '%s' name '%s'.\n",
3725 file, linenum, *err, args[0], args[1]);
3726 err_code |= ERR_ALERT | ERR_ABORT;
3727 goto out;
3728 }
3729
Emeric Brunb0c331f2020-10-07 17:05:59 +02003730 px = log_forward_by_name(args[1]);
3731 if (px) {
3732 ha_alert("Parsing [%s:%d]: log-forward section '%s' has the same name as another log-forward section declared at %s:%d.\n",
3733 file, linenum, args[1], px->conf.file, px->conf.line);
3734 err_code |= ERR_ALERT | ERR_FATAL;
3735 }
3736
3737 px = proxy_find_by_name(args[1], 0, 0);
3738 if (px) {
3739 ha_alert("Parsing [%s:%d]: log forward section '%s' has the same name as %s '%s' declared at %s:%d.\n",
3740 file, linenum, args[1], proxy_type_str(px),
3741 px->id, px->conf.file, px->conf.line);
3742 err_code |= ERR_ALERT | ERR_FATAL;
Emeric Brun12941c82020-07-07 14:19:42 +02003743 }
3744
3745 px = calloc(1, sizeof *px);
3746 if (!px) {
3747 err_code |= ERR_ALERT | ERR_FATAL;
3748 goto out;
3749 }
3750
Emeric Brun2ad2b1c2021-12-01 12:08:42 +01003751 init_new_proxy(px);
Emeric Brun12941c82020-07-07 14:19:42 +02003752 px->next = cfg_log_forward;
3753 cfg_log_forward = px;
Emeric Brun12941c82020-07-07 14:19:42 +02003754 px->conf.file = strdup(file);
3755 px->conf.line = linenum;
3756 px->mode = PR_MODE_SYSLOG;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003757 px->last_change = now.tv_sec;
3758 px->cap = PR_CAP_FE;
3759 px->maxconn = 10;
3760 px->timeout.client = TICK_ETERNITY;
3761 px->accept = frontend_accept;
3762 px->default_target = &syslog_applet.obj_type;
Emeric Brun12941c82020-07-07 14:19:42 +02003763 px->id = strdup(args[1]);
3764
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003765 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003766 else if (strcmp(args[0], "maxconn") == 0) { /* maxconn */
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003767 if (warnifnotcap(cfg_log_forward, PR_CAP_FE, file, linenum, args[0], " Maybe you want 'fullconn' instead ?"))
3768 err_code |= ERR_WARN;
3769
3770 if (*(args[1]) == 0) {
3771 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", file, linenum, args[0]);
3772 err_code |= ERR_ALERT | ERR_FATAL;
3773 goto out;
3774 }
3775 cfg_log_forward->maxconn = atol(args[1]);
3776 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3777 goto out;
3778 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01003779 else if (strcmp(args[0], "backlog") == 0) { /* backlog */
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003780 if (warnifnotcap(cfg_log_forward, PR_CAP_FE, file, linenum, args[0], NULL))
3781 err_code |= ERR_WARN;
3782
3783 if (*(args[1]) == 0) {
3784 ha_alert("parsing [%s:%d] : '%s' expects an integer argument.\n", file, linenum, args[0]);
3785 err_code |= ERR_ALERT | ERR_FATAL;
3786 goto out;
3787 }
3788 cfg_log_forward->backlog = atol(args[1]);
3789 if (alertif_too_many_args(1, file, linenum, args, &err_code))
3790 goto out;
3791 }
3792 else if (strcmp(args[0], "bind") == 0) {
3793 int cur_arg;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003794 struct bind_conf *bind_conf;
3795 struct bind_kw *kw;
3796 struct listener *l;
3797
3798 cur_arg = 1;
3799
3800 bind_conf = bind_conf_alloc(cfg_log_forward, file, linenum,
3801 NULL, xprt_get(XPRT_RAW));
3802 if (!bind_conf) {
3803 ha_alert("parsing [%s:%d] : out of memory error.", file, linenum);
3804 err_code |= ERR_ALERT | ERR_FATAL;
3805 goto out;
3806 }
3807
3808 if (!str2listener(args[1], cfg_log_forward, bind_conf, file, linenum, &errmsg)) {
3809 if (errmsg && *errmsg) {
3810 indent_msg(&errmsg, 2);
3811 ha_alert("parsing [%s:%d] : '%s %s' : %s\n", file, linenum, args[0], args[1], errmsg);
3812 }
3813 else {
3814 ha_alert("parsing [%s:%d] : '%s %s' : error encountered while parsing listening address %s.\n",
3815 file, linenum, args[0], args[1], args[2]);
3816 err_code |= ERR_ALERT | ERR_FATAL;
3817 goto out;
3818 }
3819 }
3820 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau66161322021-02-19 15:50:27 +01003821 l->maxaccept = global.tune.maxaccept ? global.tune.maxaccept : MAX_ACCEPT;
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003822 l->accept = session_accept_fd;
3823 l->analysers |= cfg_log_forward->fe_req_ana;
3824 l->default_target = cfg_log_forward->default_target;
3825 global.maxsock++;
3826 }
3827 cur_arg++;
3828
3829 while (*args[cur_arg] && (kw = bind_find_kw(args[cur_arg]))) {
3830 int ret;
3831
3832 ret = kw->parse(args, cur_arg, cfg_log_forward, bind_conf, &errmsg);
3833 err_code |= ret;
3834 if (ret) {
3835 if (errmsg && *errmsg) {
3836 indent_msg(&errmsg, 2);
3837 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
3838 }
3839 else
3840 ha_alert("parsing [%s:%d]: error encountered while processing '%s'\n",
3841 file, linenum, args[cur_arg]);
3842 if (ret & ERR_FATAL)
3843 goto out;
3844 }
3845 cur_arg += 1 + kw->skip;
3846 }
3847 if (*args[cur_arg] != 0) {
Willy Tarreau433b05f2021-03-12 10:14:07 +01003848 const char *best = bind_find_best_kw(args[cur_arg]);
3849 if (best)
3850 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section; did you mean '%s' maybe ?\n",
3851 file, linenum, args[cur_arg], cursection, best);
3852 else
3853 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section.\n",
3854 file, linenum, args[cur_arg], cursection);
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003855 err_code |= ERR_ALERT | ERR_FATAL;
3856 goto out;
3857 }
Emeric Brun12941c82020-07-07 14:19:42 +02003858 }
Willy Tarreau76aaa7f2020-09-16 15:07:22 +02003859 else if (strcmp(args[0], "dgram-bind") == 0) {
Emeric Brun12941c82020-07-07 14:19:42 +02003860 int cur_arg;
Emeric Brun12941c82020-07-07 14:19:42 +02003861 struct bind_conf *bind_conf;
3862 struct bind_kw *kw;
3863 struct listener *l;
3864
3865 cur_arg = 1;
3866
3867 bind_conf = bind_conf_alloc(cfg_log_forward, file, linenum,
3868 NULL, xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +02003869 if (!bind_conf) {
3870 ha_alert("parsing [%s:%d] : out of memory error.", file, linenum);
3871 err_code |= ERR_ALERT | ERR_FATAL;
3872 goto out;
3873 }
Emeric Brun12941c82020-07-07 14:19:42 +02003874
Willy Tarreau26ff5da2020-09-16 15:22:19 +02003875 if (!str2receiver(args[1], cfg_log_forward, bind_conf, file, linenum, &errmsg)) {
Emeric Brun12941c82020-07-07 14:19:42 +02003876 if (errmsg && *errmsg) {
3877 indent_msg(&errmsg, 2);
3878 ha_alert("parsing [%s:%d] : '%s %s' : %s\n", file, linenum, args[0], args[1], errmsg);
3879 }
3880 else {
3881 ha_alert("parsing [%s:%d] : '%s %s' : error encountered while parsing listening address %s.\n",
3882 file, linenum, args[0], args[1], args[2]);
Emeric Brun12941c82020-07-07 14:19:42 +02003883 }
Willy Tarreau3b139e52020-09-16 16:24:14 +02003884 err_code |= ERR_ALERT | ERR_FATAL;
3885 goto out;
Emeric Brun12941c82020-07-07 14:19:42 +02003886 }
3887 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau26ff5da2020-09-16 15:22:19 +02003888 /* the fact that the sockets are of type dgram is guaranteed by str2receiver() */
Willy Tarreau66161322021-02-19 15:50:27 +01003889 l->maxaccept = global.tune.maxaccept ? global.tune.maxaccept : MAX_ACCEPT;
Willy Tarreaue140a692020-10-15 21:25:32 +02003890 l->rx.iocb = syslog_fd_handler;
Emeric Brun12941c82020-07-07 14:19:42 +02003891 global.maxsock++;
3892 }
3893 cur_arg++;
3894
3895 while (*args[cur_arg] && (kw = bind_find_kw(args[cur_arg]))) {
3896 int ret;
3897
3898 ret = kw->parse(args, cur_arg, cfg_log_forward, bind_conf, &errmsg);
3899 err_code |= ret;
3900 if (ret) {
3901 if (errmsg && *errmsg) {
3902 indent_msg(&errmsg, 2);
3903 ha_alert("parsing [%s:%d] : %s\n", file, linenum, errmsg);
3904 }
3905 else
3906 ha_alert("parsing [%s:%d]: error encountered while processing '%s'\n",
3907 file, linenum, args[cur_arg]);
3908 if (ret & ERR_FATAL)
3909 goto out;
3910 }
3911 cur_arg += 1 + kw->skip;
3912 }
3913 if (*args[cur_arg] != 0) {
Willy Tarreau433b05f2021-03-12 10:14:07 +01003914 const char *best = bind_find_best_kw(args[cur_arg]);
3915 if (best)
3916 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section; did you mean '%s' maybe ?\n",
3917 file, linenum, args[cur_arg], cursection, best);
3918 else
3919 ha_alert("parsing [%s:%d] : unknown keyword '%s' in '%s' section.\n",
3920 file, linenum, args[cur_arg], cursection);
Emeric Brun12941c82020-07-07 14:19:42 +02003921 err_code |= ERR_ALERT | ERR_FATAL;
3922 goto out;
3923 }
3924 }
3925 else if (strcmp(args[0], "log") == 0) {
Emeric Brun9533a702021-04-02 10:13:43 +02003926 if (!parse_logsrv(args, &cfg_log_forward->logsrvs, (kwm == KWM_NO), file, linenum, &errmsg)) {
Emeric Brun12941c82020-07-07 14:19:42 +02003927 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
3928 err_code |= ERR_ALERT | ERR_FATAL;
3929 goto out;
3930 }
Emeric Bruncbb7bf72020-10-05 14:39:35 +02003931 }
3932 else if (strcmp(args[0], "timeout") == 0) {
3933 const char *res;
3934 unsigned timeout;
3935
3936 if (strcmp(args[1], "client") != 0) {
3937 ha_alert("parsing [%s:%d] : unknown keyword '%s %s' in log-forward section.\n", file, linenum, args[0], args[1]);
3938 err_code |= ERR_ALERT | ERR_FATAL;
3939 goto out;
3940 }
3941
3942 if (*args[2] == 0) {
3943 ha_alert("parsing [%s:%d] : missing timeout client value.\n", file, linenum);
3944 err_code |= ERR_ALERT | ERR_FATAL;
3945 goto out;
3946 }
3947 res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
3948 if (res == PARSE_TIME_OVER) {
3949 memprintf(&errmsg, "timer overflow in argument '%s' to 'timeout client' (maximum value is 2147483647 ms or ~24.8 days)", args[2]);
3950 }
3951 else if (res == PARSE_TIME_UNDER) {
3952 memprintf(&errmsg, "timer underflow in argument '%s' to 'timeout client' (minimum non-null value is 1 ms)", args[2]);
3953 }
3954 else if (res) {
3955 memprintf(&errmsg, "unexpected character '%c' in 'timeout client'", *res);
3956 return -1;
3957 }
3958
3959 if (res) {
3960 ha_alert("parsing [%s:%d] : %s : %s\n", file, linenum, args[0], errmsg);
3961 err_code |= ERR_ALERT | ERR_FATAL;
3962 goto out;
3963 }
3964 cfg_log_forward->timeout.client = MS_TO_TICKS(timeout);
Emeric Brun12941c82020-07-07 14:19:42 +02003965 }
Willy Tarreauf9feec22020-09-16 15:04:33 +02003966 else {
3967 ha_alert("parsing [%s:%d] : unknown keyword '%s' in log-forward section.\n", file, linenum, args[0]);
3968 err_code |= ERR_ALERT | ERR_ABORT;
3969 goto out;
3970 }
Emeric Brun12941c82020-07-07 14:19:42 +02003971out:
3972 return err_code;
3973}
3974
Willy Tarreau0108d902018-11-25 19:14:37 +01003975
Emeric Brun12941c82020-07-07 14:19:42 +02003976/* config parsers for this section */
3977REGISTER_CONFIG_SECTION("log-forward", cfg_parse_log_forward, NULL);
3978
Willy Tarreau082b6282019-05-22 14:42:12 +02003979REGISTER_PER_THREAD_ALLOC(init_log_buffers);
3980REGISTER_PER_THREAD_FREE(deinit_log_buffers);
Willy Tarreau172f5ce2018-11-26 11:21:50 +01003981
Willy Tarreaubaaee002006-06-26 02:48:02 +02003982/*
3983 * Local variables:
3984 * c-indent-level: 8
3985 * c-basic-offset: 8
3986 * End:
3987 */