blob: 4b78fdac1b1bd93f10b7704ec6ee9a9605b66a24 [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020029#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020030#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020032#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020033#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020034#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020035#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020036#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020037#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020038#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020039#include <haproxy/fd.h>
40#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020041#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020042#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020043#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020044#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020045#include <haproxy/log.h>
William Lallemand3ba7c7b2021-11-10 10:57:18 +010046#include <haproxy/mworker.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020047#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020048#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020049#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/pipe.h>
51#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020052#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020053#include <haproxy/sample-t.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020054#include <haproxy/sc_strm.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020055#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020056#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020057#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020058#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020059#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020060#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020061#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020062#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020063#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020064#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020065#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010066
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020067#define PAYLOAD_PATTERN "<<"
68
William Lallemand74c24fb2016-11-21 17:18:36 +010069static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010070static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010071
Willy Tarreau4975d142021-03-13 11:00:33 +010072static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010073 "Permission denied\n"
74 "";
75
76
Christopher Faulet1bc04c72017-10-29 20:14:08 +010077static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010078
79/* List head of cli keywords */
80static struct cli_kw_list cli_keywords = {
81 .list = LIST_HEAD_INIT(cli_keywords.list)
82};
83
84extern const char *stat_status_codes[];
85
Eric Salama1b8dacc2021-03-16 15:12:17 +010086struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand56f73b22022-09-24 15:56:25 +020087struct bind_conf *mcli_reload_bind_conf;
William Lallemand8a022572018-10-26 14:47:35 +020088
Willy Tarreau307dbb32022-05-05 17:45:52 +020089/* CLI context for the "show env" command */
90struct show_env_ctx {
91 char **var; /* first variable to show */
92 int show_one; /* stop after showing the first one */
93};
94
Willy Tarreau741a5a92022-05-05 17:56:58 +020095/* CLI context for the "show fd" command */
96struct show_fd_ctx {
97 int fd; /* first FD to show */
98 int show_one; /* stop after showing one FD */
99};
100
Willy Tarreaub128f492022-05-05 19:11:05 +0200101/* CLI context for the "show cli sockets" command */
102struct show_sock_ctx {
103 struct bind_conf *bind_conf;
104 struct listener *listener;
105};
106
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200107static int cmp_kw_entries(const void *a, const void *b)
108{
109 const struct cli_kw *l = *(const struct cli_kw **)a;
110 const struct cli_kw *r = *(const struct cli_kw **)b;
111
112 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
113}
114
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100115/* This will show the help message and list the commands supported at the
116 * current level that match all of the first words of <args> if args is not
117 * NULL, or all args if none matches or if args is null.
118 */
119static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100120{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200121 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100122 struct cli_kw_list *kw_list;
123 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200124 struct buffer *tmp = get_trash_chunk();
125 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100126 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100127 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200128 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100129 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200130 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100131
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100132 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100133
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200134 if (args && *args && strcmp(*args, "help") == 0) {
135 args++;
136 ishelp = 1;
137 }
138
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100139 /* first, let's measure the longest match */
140 list_for_each_entry(kw_list, &cli_keywords.list, list) {
141 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100142 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100143 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100144 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
145 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100146 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
147 continue;
148
149 /* OK this command is visible */
150 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
151 if (!kw->str_kw[idx])
152 break; // end of keyword
153 if (!args || !args[idx] || !*args[idx])
154 break; // end of command line
155 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
156 break;
157 if (idx + 1 > length)
158 length = idx + 1;
159 }
160 }
161 }
162
Willy Tarreaub7364582021-03-12 18:24:46 +0100163 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100164 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200165 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100166 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Abhijeet Rastogic8601502022-11-17 04:42:38 -0800167 else {
168 chunk_strcat(tmp, "Unknown command: '");
169 if (args && *args)
170 chunk_strcat(tmp, *args);
171 chunk_strcat(tmp, "'");
172
173 if (!length && (!args || !*args || !**args)) // no match
174 chunk_strcat(tmp, ". Please enter one of the following commands only:\n");
175 else // partial match
176 chunk_strcat(tmp, ", but maybe one of the following ones is a better match:\n");
177 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100178
Willy Tarreaub7364582021-03-12 18:24:46 +0100179 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
180 matches[idx].kw = NULL;
181 matches[idx].dist = INT_MAX;
182 }
183
184 /* In case of partial match we'll look for the best matching entries
185 * starting from position <length>
186 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100187 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100188 list_for_each_entry(kw_list, &cli_keywords.list, list) {
189 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100190 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100191 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100192 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
193 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
194 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100195 continue;
196
197 for (idx = 0; idx < length; idx++) {
198 if (!kw->str_kw[idx])
199 break; // end of keyword
200 if (!args || !args[idx] || !*args[idx])
201 break; // end of command line
202 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
203 break;
204 }
205
206 /* extra non-matching words are fuzzy-matched */
207 if (kw->usage && idx == length && args[idx] && *args[idx]) {
208 uint8_t word_sig[1024];
209 uint8_t list_sig[1024];
210 int dist = 0;
211 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100212 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100213
214 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100215 * on the remaining words. For this we're computing the signature
216 * of everything that remains and the cumulated length of the
217 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100218 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100219 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100220 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
221 update_word_fingerprint(word_sig, args[i]);
222 totlen += strlen(args[i]);
223 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100224
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100225 memset(list_sig, 0, sizeof(list_sig));
226 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
227 update_word_fingerprint(list_sig, kw->str_kw[i]);
228 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100229 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100230
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100231 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100232
233 /* insert this one at its place if relevant, in order to keep only
234 * the best matches.
235 */
236 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100237 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100238 matches[CLI_MAX_MATCHES-1] = swp;
239 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
240 if (matches[idx+1].dist >= matches[idx].dist)
241 break;
242 matches[idx+1] = matches[idx];
243 matches[idx] = swp;
244 }
245 }
246 }
247 }
248 }
249 }
250
Willy Tarreauec197e82021-03-15 10:35:04 +0100251 if (matches[0].kw) {
252 /* we have fuzzy matches, let's propose them */
253 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
254 kw = matches[idx].kw;
255 if (!kw)
256 break;
257
258 /* stop the dump if some words look very unlikely candidates */
259 if (matches[idx].dist > 5*matches[0].dist/2)
260 break;
261
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200262 if (help_entries < CLI_MAX_HELP_ENTRIES)
263 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100264 }
265 }
266
William Lallemand74c24fb2016-11-21 17:18:36 +0100267 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100268 /* no full dump if we've already found nice candidates */
269 if (matches[0].kw)
270 break;
271
Willy Tarreau91bc3592021-03-12 15:20:39 +0100272 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200273
Willy Tarreau91bc3592021-03-12 15:20:39 +0100274 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100275 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100276 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100277 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100278 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200279
William Lallemand2a171912022-02-02 11:43:20 +0100280 /* in master, if the CLI don't have the
281 * ACCESS_MCLI_DEBUG don't display commands that have
282 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100283 */
William Lallemand2a171912022-02-02 11:43:20 +0100284 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
285 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
286 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100287 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200288
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100289 for (idx = 0; idx < length; idx++) {
290 if (!kw->str_kw[idx])
291 break; // end of keyword
292 if (!args || !args[idx] || !*args[idx])
293 break; // end of command line
294 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
295 break;
296 }
297
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200298 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
299 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100300 }
301 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100302
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200303 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
304
305 for (idx = 0; idx < help_entries; idx++)
306 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
307
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100308 /* always show the prompt/help/quit commands */
309 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200310 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200311 " prompt : toggle interactive mode with prompt\n"
312 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100313
William Lallemand74c24fb2016-11-21 17:18:36 +0100314 chunk_init(&out, NULL, 0);
315 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200316 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200317
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200318 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100319 return dynamic_usage_msg;
320}
321
322struct cli_kw* cli_find_kw(char **args)
323{
324 struct cli_kw_list *kw_list;
325 struct cli_kw *kw;/* current cli_kw */
326 char **tmp_args;
327 const char **tmp_str_kw;
328 int found = 0;
329
330 if (LIST_ISEMPTY(&cli_keywords.list))
331 return NULL;
332
333 list_for_each_entry(kw_list, &cli_keywords.list, list) {
334 kw = &kw_list->kw[0];
335 while (*kw->str_kw) {
336 tmp_args = args;
337 tmp_str_kw = kw->str_kw;
338 while (*tmp_str_kw) {
339 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
340 found = 1;
341 } else {
342 found = 0;
343 break;
344 }
345 tmp_args++;
346 tmp_str_kw++;
347 }
348 if (found)
349 return (kw);
350 kw++;
351 }
352 }
353 return NULL;
354}
355
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100356struct cli_kw* cli_find_kw_exact(char **args)
357{
358 struct cli_kw_list *kw_list;
359 int found = 0;
360 int i;
361 int j;
362
363 if (LIST_ISEMPTY(&cli_keywords.list))
364 return NULL;
365
366 list_for_each_entry(kw_list, &cli_keywords.list, list) {
367 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
368 found = 1;
369 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
370 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
371 break;
372 }
373 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
374 found = 0;
375 break;
376 }
377 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
378 found = 0;
379 break;
380 }
381 }
382 if (found)
383 return &kw_list->kw[i];
384 }
385 }
386 return NULL;
387}
388
William Lallemand74c24fb2016-11-21 17:18:36 +0100389void cli_register_kw(struct cli_kw_list *kw_list)
390{
Willy Tarreau2b718102021-04-21 07:32:39 +0200391 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100392}
393
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200394/* list all known keywords on stdout, one per line */
395void cli_list_keywords(void)
396{
397 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200398 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200399 int idx;
400
Willy Tarreau44651712022-03-30 12:02:35 +0200401 for (kwn = kwp = NULL;; kwp = kwn) {
402 list_for_each_entry(kw_list, &cli_keywords.list, list) {
403 /* note: we sort based on the usage message when available,
404 * otherwise we fall back to the first keyword.
405 */
406 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
407 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
408 kw->usage ? kw->usage : kw->str_kw[0],
409 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
410 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200411 }
Willy Tarreau44651712022-03-30 12:02:35 +0200412 }
413
414 if (kwn == kwp)
415 break;
416
417 for (idx = 0; kwn->str_kw[idx]; idx++) {
418 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200419 }
Willy Tarreau44651712022-03-30 12:02:35 +0200420 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
421 printf("[MASTER] ");
422 if (!(kwn->level & ACCESS_MASTER_ONLY))
423 printf("[WORKER] ");
424 if (kwn->level & ACCESS_EXPERT)
425 printf("[EXPERT] ");
426 if (kwn->level & ACCESS_EXPERIMENTAL)
427 printf("[EXPERIM] ");
428 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200429 }
430}
William Lallemand74c24fb2016-11-21 17:18:36 +0100431
432/* allocate a new stats frontend named <name>, and return it
433 * (or NULL in case of lack of memory).
434 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100435static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100436{
437 struct proxy *fe;
438
439 fe = calloc(1, sizeof(*fe));
440 if (!fe)
441 return NULL;
442
443 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100444 fe->next = proxies_list;
445 proxies_list = fe;
William Lallemand74c24fb2016-11-21 17:18:36 +0100446 fe->last_change = now.tv_sec;
447 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200448 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100449 fe->maxconn = 10; /* default to 10 concurrent connections */
450 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
451 fe->conf.file = strdup(file);
452 fe->conf.line = line;
453 fe->accept = frontend_accept;
454 fe->default_target = &cli_applet.obj_type;
455
456 /* the stats frontend is the only one able to assign ID #0 */
457 fe->conf.id.key = fe->uuid = 0;
458 eb32_insert(&used_proxy_id, &fe->conf.id);
459 return fe;
460}
461
462/* This function parses a "stats" statement in the "global" section. It returns
463 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
464 * error message into the <err> buffer which will be preallocated. The trailing
465 * '\n' must not be written. The function must be called with <args> pointing to
466 * the first word after "stats".
467 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100468static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
469 const struct proxy *defpx, const char *file, int line,
470 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100471{
472 struct bind_conf *bind_conf;
473 struct listener *l;
474
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100475 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100476 int cur_arg;
477
478 if (*args[2] == 0) {
479 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
480 return -1;
481 }
482
Willy Tarreau4975d142021-03-13 11:00:33 +0100483 if (!global.cli_fe) {
484 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100485 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
486 return -1;
487 }
488 }
489
Willy Tarreau4975d142021-03-13 11:00:33 +0100490 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200491 if (!bind_conf) {
492 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
493 return -1;
494 }
William Lallemand07a62f72017-05-24 00:57:40 +0200495 bind_conf->level &= ~ACCESS_LVL_MASK;
496 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
Willy Tarreau6bdf9452022-07-06 11:52:24 +0200497 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemand74c24fb2016-11-21 17:18:36 +0100498
Willy Tarreau4975d142021-03-13 11:00:33 +0100499 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100500 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
501 file, line, args[0], args[1], err && *err ? *err : "error");
502 return -1;
503 }
504
505 cur_arg = 3;
506 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100507 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100508 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100509 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100510
511 kw = bind_find_kw(args[cur_arg]);
512 if (kw) {
513 if (!kw->parse) {
514 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
515 args[0], args[1], args[cur_arg]);
516 return -1;
517 }
518
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100519 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
520
521 /* FIXME: this is ugly, we don't have a way to collect warnings,
522 * yet some important bind keywords may report warnings that we
523 * must display.
524 */
525 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
526 indent_msg(err, 2);
527 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
528 ha_free(err);
529 }
530
531 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100532 if (err && *err)
533 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
534 else
535 memprintf(err, "'%s %s' : error encountered while processing '%s'",
536 args[0], args[1], args[cur_arg]);
537 return -1;
538 }
539
540 cur_arg += 1 + kw->skip;
541 continue;
542 }
543
Willy Tarreau433b05f2021-03-12 10:14:07 +0100544 best = bind_find_best_kw(args[cur_arg]);
545 if (best)
546 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
547 args[0], args[1], args[cur_arg], best);
548 else
549 memprintf(err, "'%s %s' : unknown keyword '%s'.",
550 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100551 return -1;
552 }
553
Willy Tarreau30836152023-01-12 19:10:17 +0100554 bind_conf->accept = session_accept_fd;
Willy Tarreaud5983ce2023-01-12 19:18:34 +0100555
William Lallemand74c24fb2016-11-21 17:18:36 +0100556 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100557 l->options |= LI_O_UNLIMITED; /* don't make the peers subject to global limits */
558 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +0100559 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100560 }
561 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100562 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100563 unsigned timeout;
564 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
565
Willy Tarreau9faebe32019-06-07 19:00:37 +0200566 if (res == PARSE_TIME_OVER) {
567 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
568 args[2], args[0], args[1]);
569 return -1;
570 }
571 else if (res == PARSE_TIME_UNDER) {
572 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
573 args[2], args[0], args[1]);
574 return -1;
575 }
576 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100577 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
578 return -1;
579 }
580
581 if (!timeout) {
582 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
583 return -1;
584 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100585 if (!global.cli_fe) {
586 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
588 return -1;
589 }
590 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100591 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100592 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100593 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100594 int maxconn = atol(args[2]);
595
596 if (maxconn <= 0) {
597 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
598 return -1;
599 }
600
Willy Tarreau4975d142021-03-13 11:00:33 +0100601 if (!global.cli_fe) {
602 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100603 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
604 return -1;
605 }
606 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100607 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100608 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200609 else if (strcmp(args[1], "bind-process") == 0) {
610 memprintf(err, "'%s' is not supported anymore.", args[0]);
611 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100612 }
613 else {
614 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
615 return -1;
616 }
617 return 0;
618}
619
William Lallemand33d29e22019-04-01 11:30:06 +0200620/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200621 * This function exports the bound addresses of a <frontend> in the environment
622 * variable <varname>. Those addresses are separated by semicolons and prefixed
623 * with their type (abns@, unix@, sockpair@ etc)
624 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200625 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200626int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200627{
628 struct buffer *trash = get_trash_chunk();
629 struct bind_conf *bind_conf;
630
William Lallemand9a37fd02019-04-12 16:09:24 +0200631 if (frontend) {
632 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200633 struct listener *l;
634
635 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
636 char addr[46];
637 char port[6];
638
William Lallemand620072b2019-04-12 16:09:25 +0200639 /* separate listener by semicolons */
640 if (trash->data)
641 chunk_appendf(trash, ";");
642
Willy Tarreau37159062020-08-27 07:48:42 +0200643 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200644 const struct sockaddr_un *un;
645
Willy Tarreau37159062020-08-27 07:48:42 +0200646 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200647 if (un->sun_path[0] == '\0') {
648 chunk_appendf(trash, "abns@%s", un->sun_path+1);
649 } else {
650 chunk_appendf(trash, "unix@%s", un->sun_path);
651 }
Willy Tarreau37159062020-08-27 07:48:42 +0200652 } else if (l->rx.addr.ss_family == AF_INET) {
653 addr_to_str(&l->rx.addr, addr, sizeof(addr));
654 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200655 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200656 } else if (l->rx.addr.ss_family == AF_INET6) {
657 addr_to_str(&l->rx.addr, addr, sizeof(addr));
658 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200659 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200660 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
661 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200662 }
William Lallemand33d29e22019-04-01 11:30:06 +0200663 }
664 }
665 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200666 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200667 return -1;
668 }
669
670 return 0;
671}
672
William Lallemand9a37fd02019-04-12 16:09:24 +0200673int cli_socket_setenv()
674{
Willy Tarreau4975d142021-03-13 11:00:33 +0100675 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200676 return -1;
677 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
678 return -1;
679
680 return 0;
681}
682
William Lallemand33d29e22019-04-01 11:30:06 +0200683REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
684
Willy Tarreaude57a572016-11-23 17:01:39 +0100685/* Verifies that the CLI at least has a level at least as high as <level>
686 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
687 * failure, an error message is prepared and the appctx's state is adjusted
688 * to print it so that a return 1 is enough to abort any processing.
689 */
690int cli_has_level(struct appctx *appctx, int level)
691{
Willy Tarreaude57a572016-11-23 17:01:39 +0100692
William Lallemandf630d012018-12-13 09:05:44 +0100693 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100694 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100695 return 0;
696 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100697 return 1;
698}
699
William Lallemandb7ea1412018-12-13 09:05:47 +0100700/* same as cli_has_level but for the CLI proxy and without error message */
701int pcli_has_level(struct stream *s, int level)
702{
703 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
704 return 0;
705 }
706 return 1;
707}
708
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200709/* Returns severity_output for the current session if set, or default for the socket */
710static int cli_get_severity_output(struct appctx *appctx)
711{
712 if (appctx->cli_severity_output)
713 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200714 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200715}
William Lallemand74c24fb2016-11-21 17:18:36 +0100716
Willy Tarreau41908562016-11-24 16:23:38 +0100717/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100718 * from the CLI's IO handler running in an appctx context. The function returns
719 * 1 if the request was understood, otherwise zero (in which case an error
720 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100721 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
722 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
723 * have its own I/O handler called again. Most of the time, parsers will only
724 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100725 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
726 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100727 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200728static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100729{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100730 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200731 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100732 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100733
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200734 p = appctx->chunk->area;
735 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100736
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200737 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738 * Get pointers on words.
739 * One extra slot is reserved to store a pointer on a null byte.
740 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100741 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100743
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200744 /* skip leading spaces/tabs */
745 p += strspn(p, " \t");
746 if (!*p)
747 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200748
749 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
750 /* payload pattern recognized here, this is not an arg anymore,
751 * the payload starts at the first byte that follows the zero
752 * after the pattern.
753 */
754 payload = p + strlen(PAYLOAD_PATTERN) + 1;
755 break;
756 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100757
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200758 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200759 while (1) {
760 p += strcspn(p, " \t\\");
761 /* escaped chars using backlashes (\) */
762 if (*p == '\\') {
763 if (!*++p)
764 break;
765 if (!*++p)
766 break;
767 } else {
768 break;
769 }
770 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200771 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100772
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200773 /* unescape backslashes (\) */
774 for (j = 0, k = 0; args[i][k]; k++) {
775 if (args[i][k] == '\\') {
776 if (args[i][k + 1] == '\\')
777 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100778 else
779 continue;
780 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200781 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100782 j++;
783 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200784 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100785
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200786 i++;
787 }
788 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200789 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100790 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200791 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100792
793 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100794 if (!kw ||
795 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100796 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
797 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100798 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100799 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100800 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100801 }
William Lallemand14721be2018-10-26 14:47:37 +0200802
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100803 /* don't handle expert mode commands if not in this mode. */
804 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
805 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200806 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100807 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200808
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100809 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
810 cli_err(appctx, "This command is restricted to experimental mode only.\n");
811 return 0;
812 }
813
Amaury Denoyellef4929922021-05-05 16:29:23 +0200814 if (kw->level == ACCESS_EXPERT)
815 mark_tainted(TAINTED_CLI_EXPERT_MODE);
816 else if (kw->level == ACCESS_EXPERIMENTAL)
817 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
818
Willy Tarreau41908562016-11-24 16:23:38 +0100819 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200820 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200821
822 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
823 goto fail;
824
825 /* kw->parse could set its own io_handler or io_release handler */
826 if (!appctx->io_handler)
827 goto fail;
828
829 appctx->st0 = CLI_ST_CALLBACK;
830 return 1;
831fail:
832 appctx->io_handler = NULL;
833 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100834 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100835}
836
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200837/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
838static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
839{
Willy Tarreau83061a82018-07-13 11:56:34 +0200840 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200841
842 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200843 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200844
845 tmp = get_trash_chunk();
846 chunk_reset(tmp);
847
848 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100849 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200850 chunk_printf(tmp, "[%d]: ", severity);
851 }
852 else {
853 switch (severity_output) {
854 case CLI_SEVERITY_NUMBER:
855 chunk_printf(tmp, "[%d]: ", severity);
856 break;
857 case CLI_SEVERITY_STRING:
858 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
859 break;
860 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100861 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200862 }
863 }
864 chunk_appendf(tmp, "%s", msg);
865
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200866 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200867}
868
Willy Tarreau4596fe22022-05-17 19:07:51 +0200869/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100870 * used to processes I/O from/to the stats unix socket. The system relies on a
871 * state machine handling requests and various responses. We read a request,
872 * then we process it and send the response, and we possibly display a prompt.
873 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100874 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100875 * or not.
876 */
877static void cli_io_handler(struct appctx *appctx)
878{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200879 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200880 struct channel *req = sc_oc(sc);
881 struct channel *res = sc_ic(sc);
882 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100883 int reql;
884 int len;
885
Willy Tarreau475e4632022-05-27 10:26:46 +0200886 if (unlikely(sc->state == SC_ST_DIS || sc->state == SC_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100887 goto out;
888
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800889 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200890 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100891 /* buf.size==0 means we failed to get a buffer and were
892 * already subscribed to a wait list to get a buffer.
893 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100894 goto out;
895 }
896
William Lallemand74c24fb2016-11-21 17:18:36 +0100897 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100898 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200899 /* reset severity to default at init */
900 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau1addf8b2022-08-18 18:04:37 +0200901 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100902 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100903 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100904 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100905 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100906 /* Let's close for real now. We just close the request
907 * side, the conditions below will complete if needed.
908 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200909 sc_shutw(sc);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200910 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200911 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100912 break;
913 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100914 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200915 char *str;
916
917 /* use a trash chunk to store received data */
918 if (!appctx->chunk) {
919 appctx->chunk = alloc_trash_chunk();
920 if (!appctx->chunk) {
921 appctx->st0 = CLI_ST_END;
922 continue;
923 }
924 }
925
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200926 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200927
William Lallemand74c24fb2016-11-21 17:18:36 +0100928 /* ensure we have some output room left in the event we
929 * would want to return some info right after parsing.
930 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200931 if (buffer_almost_full(sc_ib(sc))) {
932 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +0100933 break;
934 }
935
Willy Tarreau0011c252022-01-19 17:23:52 +0100936 /* payload doesn't take escapes nor does it end on semi-colons, so
937 * we use the regular getline. Normal mode however must stop on
938 * LFs and semi-colons that are not prefixed by a backslash. Note
939 * that we reserve one byte at the end to insert a trailing nul byte.
940 */
941
942 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200943 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100944 appctx->chunk->size - appctx->chunk->data - 1);
945 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200946 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100947 appctx->chunk->size - appctx->chunk->data - 1,
948 "\n;", '\\');
949
William Lallemand74c24fb2016-11-21 17:18:36 +0100950 if (reql <= 0) { /* closed or EOL not found */
951 if (reql == 0)
952 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100953 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100954 continue;
955 }
956
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200957 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
958 /* seek for a possible unescaped semi-colon. If we find
959 * one, we replace it with an LF and skip only this part.
960 */
961 for (len = 0; len < reql; len++) {
962 if (str[len] == '\\') {
963 len++;
964 continue;
965 }
966 if (str[len] == ';') {
967 str[len] = '\n';
968 reql = len + 1;
969 break;
970 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100971 }
972 }
973
974 /* now it is time to check that we have a full line,
975 * remove the trailing \n and possibly \r, then cut the
976 * line.
977 */
978 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200979 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100980 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100981 continue;
982 }
983
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200984 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100985 len--;
986
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200987 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200988 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200989
990 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200991 appctx->chunk->area[appctx->chunk->data] = '\n';
992 appctx->chunk->area[appctx->chunk->data + 1] = 0;
993 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200994 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100995
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100996 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200997
998 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
999 /* empty line */
1000 if (!len) {
1001 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001002 appctx->chunk->data -= 2;
1003 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001004 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001005 chunk_reset(appctx->chunk);
1006 /* NB: cli_sock_parse_request() may have put
1007 * another CLI_ST_O_* into appctx->st0.
1008 */
1009
1010 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001011 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001012 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001013 else {
1014 /*
1015 * Look for the "payload start" pattern at the end of a line
1016 * Its location is not remembered here, this is just to switch
1017 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001018 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001019 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001020 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001021 appctx->chunk->data++; // keep the trailing \0 after '<<'
1022 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001023 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001024 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001025 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001026 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001027 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001028 }
1029
1030 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001031 co_skip(sc_oc(sc), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001032 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1033 }
1034 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001035 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001036 const char *msg;
1037 int sev;
1038
William Lallemand74c24fb2016-11-21 17:18:36 +01001039 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001040 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001041 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001042 case CLI_ST_PRINT: /* print const message in msg */
1043 case CLI_ST_PRINT_ERR: /* print const error in msg */
1044 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001045 case CLI_ST_PRINT_DYNERR: /* print dyn error in err, free */
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001046 case CLI_ST_PRINT_UMSG: /* print usermsgs_ctx and reset it */
1047 case CLI_ST_PRINT_UMSGERR: /* print usermsgs_ctx as error and reset it */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001048 /* the message is in the svcctx */
1049 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001050 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1051 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001052 LOG_ERR : ctx->severity;
1053 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001054 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001055 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
1056 sev = appctx->st0 == CLI_ST_PRINT_DYNERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001057 LOG_ERR : ctx->severity;
1058 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001059 if (!msg) {
1060 sev = LOG_ERR;
1061 msg = "Out of memory.\n";
1062 }
1063 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001064 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1065 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1066 sev = appctx->st0 == CLI_ST_PRINT_UMSGERR ?
1067 LOG_ERR : ctx->severity;
1068 msg = usermsgs_str();
1069 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001070 else {
1071 sev = LOG_ERR;
1072 msg = "Internal error.\n";
1073 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001074
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001075 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001076 if (appctx->st0 == CLI_ST_PRINT_DYN ||
1077 appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001078 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001079 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001080 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1081 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1082 usermsgs_clr(NULL);
1083 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001084 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001085 }
1086 else
Willy Tarreau475e4632022-05-27 10:26:46 +02001087 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001088 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001089
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001090 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001091 if (appctx->io_handler)
1092 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001093 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001094 if (appctx->io_release) {
1095 appctx->io_release(appctx);
1096 appctx->io_release = NULL;
1097 }
1098 }
1099 break;
1100 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001101 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001102 break;
1103 }
1104
1105 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001106 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001107 const char *prompt = "";
1108
1109 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1110 /*
1111 * when entering a payload with interactive mode, change the prompt
1112 * to emphasize that more data can still be sent
1113 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001114 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001115 prompt = "+ ";
1116 else
1117 prompt = "\n> ";
1118 }
1119 else {
William Lallemandad032882019-07-01 10:56:15 +02001120 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001121 prompt = "\n";
1122 }
1123
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001124 if (applet_putstr(appctx, prompt) != -1) {
1125 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001126 appctx->st0 = CLI_ST_GETREQ;
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001127 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001128 }
1129
1130 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001131 if (appctx->st0 >= CLI_ST_OUTPUT) {
1132 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001133 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001134 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001135
1136 /* Now we close the output if one of the writers did so,
1137 * or if we're not in interactive mode and the request
1138 * buffer is empty. This still allows pipelined requests
1139 * to be sent in non-interactive mode.
1140 */
William Lallemand3de09d52018-12-11 16:10:56 +01001141 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1142 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001143 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001144 continue;
1145 }
1146
1147 /* switch state back to GETREQ to read next requests */
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001148 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001149 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001150 applet_will_consume(appctx);
1151
William Lallemandad032882019-07-01 10:56:15 +02001152 /* reactivate the \n at the end of the response for the next command */
1153 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001154
1155 /* this forces us to yield between pipelined commands and
1156 * avoid extremely long latencies (e.g. "del map" etc). In
1157 * addition this increases the likelihood that the stream
1158 * refills the buffer with new bytes in non-interactive
1159 * mode, avoiding to close on apparently empty commands.
1160 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001161 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001162 appctx_wakeup(appctx);
1163 goto out;
1164 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001165 }
1166 }
1167
Willy Tarreau475e4632022-05-27 10:26:46 +02001168 if ((res->flags & CF_SHUTR) && (sc->state == SC_ST_EST)) {
1169 DPRINTF(stderr, "%s@%d: sc to buf closed. req=%08x, res=%08x, st=%d\n",
1170 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001171 /* Other side has closed, let's abort if we have no more processing to do
1172 * and nothing more to consume. This is comparable to a broken pipe, so
1173 * we forward the close to the request side so that it flows upstream to
1174 * the client.
1175 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001176 sc_shutw(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001177 }
1178
Willy Tarreau475e4632022-05-27 10:26:46 +02001179 if ((req->flags & CF_SHUTW) && (sc->state == SC_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
1180 DPRINTF(stderr, "%s@%d: buf to sc closed. req=%08x, res=%08x, st=%d\n",
1181 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001182 /* We have no more processing to do, and nothing more to send, and
1183 * the client side has closed. So we'll forward this state downstream
1184 * on the response buffer.
1185 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001186 sc_shutr(sc);
Christopher Faulet6e1bbc42022-12-12 08:08:15 +01001187 res->flags |= CF_READ_EVENT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001188 }
1189
1190 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001191 DPRINTF(stderr, "%s@%d: st=%d, rqf=%x, rpf=%x, rqh=%lu, rqs=%lu, rh=%lu, rs=%lu\n",
William Lallemand74c24fb2016-11-21 17:18:36 +01001192 __FUNCTION__, __LINE__,
Willy Tarreau475e4632022-05-27 10:26:46 +02001193 sc->state, req->flags, res->flags, ci_data(req), co_data(req), ci_data(res), co_data(res));
William Lallemand74c24fb2016-11-21 17:18:36 +01001194}
1195
Willy Tarreau4596fe22022-05-17 19:07:51 +02001196/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001197 * external abort, we won't call the i/o handler anymore so we may need to
1198 * remove back references to the stream currently being dumped.
1199 */
1200static void cli_release_handler(struct appctx *appctx)
1201{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001202 free_trash_chunk(appctx->chunk);
1203 appctx->chunk = NULL;
1204
William Lallemand74c24fb2016-11-21 17:18:36 +01001205 if (appctx->io_release) {
1206 appctx->io_release(appctx);
1207 appctx->io_release = NULL;
1208 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001209 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001210 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1211
1212 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001213 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001214 else if (appctx->st0 == CLI_ST_PRINT_UMSG || appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1215 usermsgs_clr(NULL);
1216 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001217}
1218
1219/* This function dumps all environmnent variables to the buffer. It returns 0
1220 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001221 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1222 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001223 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001224static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001225{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001226 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001227 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001228 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001229
Christopher Fauletda89e9b2023-01-04 14:11:10 +01001230 if (unlikely(sc_ic(sc)->flags & CF_SHUTW))
William Lallemand74c24fb2016-11-21 17:18:36 +01001231 return 1;
1232
1233 chunk_reset(&trash);
1234
1235 /* we have two inner loops here, one for the proxy, the other one for
1236 * the buffer.
1237 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001238 while (*var) {
1239 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001240
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001241 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001242 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001243
Willy Tarreau307dbb32022-05-05 17:45:52 +02001244 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001245 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001246 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001247 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001248 }
1249
1250 /* dump complete */
1251 return 1;
1252}
1253
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001254/* This function dumps all file descriptors states (or the requested one) to
1255 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001256 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1257 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1258 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001259 */
1260static int cli_io_handler_show_fd(struct appctx *appctx)
1261{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001262 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001263 struct show_fd_ctx *fdctx = appctx->svcctx;
1264 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001265 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001266
Christopher Fauletda89e9b2023-01-04 14:11:10 +01001267 if (unlikely(sc_ic(sc)->flags & CF_SHUTW))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001268 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001269
1270 chunk_reset(&trash);
1271
Willy Tarreauca1b1572018-12-18 15:45:11 +01001272 /* isolate the threads once per round. We're limited to a buffer worth
1273 * of output anyway, it cannot last very long.
1274 */
1275 thread_isolate();
1276
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001277 /* we have two inner loops here, one for the proxy, the other one for
1278 * the buffer.
1279 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001280 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001281 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001282 const struct listener *li = NULL;
1283 const struct server *sv = NULL;
1284 const struct proxy *px = NULL;
1285 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001286 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001287 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001288 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001289 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001290 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001291 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001292 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001293
1294 fdt = fdtab[fd];
1295
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001296 /* When DEBUG_FD is set, we also report closed FDs that have a
1297 * non-null event count to detect stuck ones.
1298 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001299 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001300#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001301 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001302#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001303 goto skip; // closed
1304 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001305 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001306 conn = (const struct connection *)fdt.owner;
1307 conn_flags = conn->flags;
1308 mux = conn->mux;
1309 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001310 xprt = conn->xprt;
1311 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001312 li = objt_listener(conn->target);
1313 sv = objt_server(conn->target);
1314 px = objt_proxy(conn->target);
1315 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001316 if (atleast2(fdt.thread_mask))
1317 suspicious = 1;
1318 if (conn->handle.fd != fd)
1319 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001320 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001321 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001322 li = fdt.owner;
1323
Willy Tarreaudacfde42021-01-21 09:07:29 +01001324 if (!fdt.thread_mask)
1325 suspicious = 1;
1326
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001327 chunk_printf(&trash,
Willy Tarreauc2431822022-07-08 10:23:01 +02001328 " %5d : st=0x%06x(%c%c %c%c%c%c%c W:%c%c%c R:%c%c%c) ref=%#x gid=%d tmask=0x%lx umask=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001329 fd,
1330 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001331 (fdt.state & FD_CLONED) ? 'C' : 'c',
1332 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001333 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1334 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1335 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1336 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1337 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001338 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1339 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1340 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1341 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1342 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1343 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001344 (fdt.refc_tgid >> 4) & 0xffff,
1345 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001346 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001347 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001348 fdt.iocb);
1349 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001350
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001351 if (!fdt.owner) {
1352 chunk_appendf(&trash, ")");
1353 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001354 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001355 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001356
1357 if (conn->handle.fd != fd) {
1358 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1359 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001360 } else {
1361 struct sockaddr_storage sa;
1362 socklen_t salen;
1363
1364 salen = sizeof(sa);
1365 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1366 if (sa.ss_family == AF_INET)
1367 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1368 else if (sa.ss_family == AF_INET6)
1369 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1370 else if (sa.ss_family == AF_UNIX)
1371 chunk_appendf(&trash, " fam=unix");
1372 }
1373
1374 salen = sizeof(sa);
1375 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1376 if (sa.ss_family == AF_INET)
1377 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1378 else if (sa.ss_family == AF_INET6)
1379 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1380 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001381 }
1382
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001383 if (px)
1384 chunk_appendf(&trash, " px=%s", px->id);
1385 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001386 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001387 else if (li)
1388 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001389
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001390 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001391 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001392 if (!ctx)
1393 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001394 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001395 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001396 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001397 else
1398 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001399
1400 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001401 if (xprt) {
1402 if (xprt_ctx || xprt->show_fd)
1403 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1404 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001405 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001406 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001407 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001408 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001409 struct sockaddr_storage sa;
1410 socklen_t salen;
1411
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001412 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001413 listener_state_str(li),
1414 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001415
1416 salen = sizeof(sa);
1417 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1418 if (sa.ss_family == AF_INET)
1419 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1420 else if (sa.ss_family == AF_INET6)
1421 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1422 else if (sa.ss_family == AF_UNIX)
1423 chunk_appendf(&trash, " fam=unix");
1424 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001425 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001426 else
1427 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001428
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001429#ifdef DEBUG_FD
1430 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001431 if (fdtab[fd].event_count >= 1000000)
1432 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001433#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001434 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001435
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001436 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001437 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001438 ret = 0;
1439 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001440 }
1441 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001442 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001443 break;
1444
1445 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001446 }
1447
Willy Tarreauca1b1572018-12-18 15:45:11 +01001448 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001449 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001450
1451 thread_release();
1452 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001453}
1454
William Lallemandeceddf72016-12-15 18:06:44 +01001455/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001456 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001457 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1458 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001459 */
1460static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1461{
Willy Tarreaub128f492022-05-05 19:11:05 +02001462 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1463 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001464
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001465 if (!global.cli_fe)
1466 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001467
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001468 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001469
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001470 if (!bind_conf) {
1471 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001472 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001473 goto full;
1474 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1475 }
William Lallemandeceddf72016-12-15 18:06:44 +01001476
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001477 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001478 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001479
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001480 if (!l)
1481 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001482
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001483 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1484 char addr[46];
1485 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001486
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001487 if (l->rx.addr.ss_family == AF_UNIX) {
1488 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001489
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001490 un = (struct sockaddr_un *)&l->rx.addr;
1491 if (un->sun_path[0] == '\0') {
1492 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1493 } else {
1494 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1495 }
1496 } else if (l->rx.addr.ss_family == AF_INET) {
1497 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1498 port_to_str(&l->rx.addr, port, sizeof(port));
1499 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1500 } else if (l->rx.addr.ss_family == AF_INET6) {
1501 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1502 port_to_str(&l->rx.addr, port, sizeof(port));
1503 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1504 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1505 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1506 } else
1507 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001508
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001509 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1510 chunk_appendf(&trash, "admin ");
1511 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1512 chunk_appendf(&trash, "operator ");
1513 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1514 chunk_appendf(&trash, "user ");
1515 else
1516 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001517
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001518 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001519
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001520 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001521 ctx->bind_conf = bind_conf;
1522 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001523 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001524 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001525 }
William Lallemandeceddf72016-12-15 18:06:44 +01001526 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001527 done:
1528 return 1;
1529 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001530 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001531}
1532
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001533
Willy Tarreau0a739292016-11-22 20:21:23 +01001534/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001535 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1536 * be dumped as well as a flag if a single variable is requested, otherwise puts
1537 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001538 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001539static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001540{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001541 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001542 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001543 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001544
1545 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1546 return 1;
1547
Willy Tarreauf6710f82016-12-16 17:45:44 +01001548 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001549
1550 if (*args[2]) {
1551 int len = strlen(args[2]);
1552
Willy Tarreauf6710f82016-12-16 17:45:44 +01001553 for (; *var; var++) {
1554 if (strncmp(*var, args[2], len) == 0 &&
1555 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001556 break;
1557 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001558 if (!*var)
1559 return cli_err(appctx, "Variable not found\n");
1560
Willy Tarreau307dbb32022-05-05 17:45:52 +02001561 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001562 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001563 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001564 return 0;
1565}
1566
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001567/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001568 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1569 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001570 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001571static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001572{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001573 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1574
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001575 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1576 return 1;
1577
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001578 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001579 ctx->fd = atoi(args[2]);
1580 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001581 }
1582 return 0;
1583}
1584
Willy Tarreau599852e2016-11-22 20:33:32 +01001585/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001586static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001587{
Willy Tarreau0698c802022-05-11 14:09:57 +02001588 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001589
1590 if (strcmp(args[2], "cli") == 0) {
1591 unsigned timeout;
1592 const char *res;
1593
Willy Tarreau9d008692019-08-09 11:21:01 +02001594 if (!*args[3])
1595 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001596
1597 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001598 if (res || timeout < 1)
1599 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001600
1601 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1602 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1603 return 1;
1604 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001605
1606 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001607}
1608
Willy Tarreau2af99412016-11-23 11:10:59 +01001609/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001610static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001611{
1612 int v;
1613
1614 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1615 return 1;
1616
Willy Tarreau9d008692019-08-09 11:21:01 +02001617 if (!*args[3])
1618 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001619
1620 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001621 if (v > global.hardmaxconn)
1622 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001623
1624 /* check for unlimited values */
1625 if (v <= 0)
1626 v = global.hardmaxconn;
1627
1628 global.maxconn = v;
1629
1630 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001631 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001632
1633 return 1;
1634}
1635
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001636static int set_severity_output(int *target, char *argument)
1637{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001638 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001639 *target = CLI_SEVERITY_NONE;
1640 return 1;
1641 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001642 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001643 *target = CLI_SEVERITY_NUMBER;
1644 return 1;
1645 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001646 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001647 *target = CLI_SEVERITY_STRING;
1648 return 1;
1649 }
1650 return 0;
1651}
1652
1653/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001654static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001655{
1656 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1657 return 0;
1658
Willy Tarreau9d008692019-08-09 11:21:01 +02001659 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001660}
William Lallemandeceddf72016-12-15 18:06:44 +01001661
William Lallemand67a234f2018-12-13 09:05:45 +01001662
1663/* show the level of the current CLI session */
1664static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1665{
William Lallemand67a234f2018-12-13 09:05:45 +01001666 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001667 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001668 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001669 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001670 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001671 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001672 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001673 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001674}
1675
1676/* parse and set the CLI level dynamically */
1677static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1678{
William Lallemandad032882019-07-01 10:56:15 +02001679 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001680 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001681 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1682
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001683 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001684 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1685 return 1;
1686 }
1687 appctx->cli_level &= ~ACCESS_LVL_MASK;
1688 appctx->cli_level |= ACCESS_LVL_OPER;
1689
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001690 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001691 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1692 return 1;
1693 }
1694 appctx->cli_level &= ~ACCESS_LVL_MASK;
1695 appctx->cli_level |= ACCESS_LVL_USER;
1696 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001697 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001698 return 1;
1699}
1700
1701
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001702/* parse and set the CLI expert/experimental-mode dynamically */
1703static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001704{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001705 int level;
1706 char *level_str;
1707 char *output = NULL;
1708
William Lallemand7267f782022-02-01 16:08:50 +01001709 /* this will ask the applet to not output a \n after the command */
1710 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1711 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1712
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001713 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1714 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001715
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001716 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001717 level = ACCESS_EXPERT;
1718 level_str = "expert-mode";
1719 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001720 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001721 level = ACCESS_EXPERIMENTAL;
1722 level_str = "experimental-mode";
1723 }
William Lallemand2a171912022-02-02 11:43:20 +01001724 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1725 level = ACCESS_MCLI_DEBUG;
1726 level_str = "mcli-debug-mode";
1727 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001728 else {
1729 return 1;
1730 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001731
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001732 if (!*args[1]) {
1733 memprintf(&output, "%s is %s\n", level_str,
1734 (appctx->cli_level & level) ? "ON" : "OFF");
1735 return cli_dynmsg(appctx, LOG_INFO, output);
1736 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001737
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001738 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001739 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001740 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001741 return 1;
1742}
1743
William Lallemand740629e2021-12-14 15:22:29 +01001744/* shows HAProxy version */
1745static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1746{
1747 char *msg = NULL;
1748
1749 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1750}
1751
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001752int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001753{
1754 return 0;
1755}
1756
Erwan Le Goas54966df2022-09-14 17:24:22 +02001757/* enable or disable the anonymized mode, it returns 1 when it works or displays an error message if it doesn't. */
1758static int cli_parse_set_anon(char **args, char *payload, struct appctx *appctx, void *private)
1759{
1760 uint32_t tmp;
1761 long long key;
1762
1763 if (strcmp(args[2], "on") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001764
1765 if (*args[3]) {
1766 key = atoll(args[3]);
1767 if (key < 1 || key > UINT_MAX)
1768 return cli_err(appctx, "Value out of range (1 to 4294967295 expected).\n");
1769 appctx->cli_anon_key = key;
1770 }
Erwan Le Goas54966df2022-09-14 17:24:22 +02001771 else {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001772 tmp = HA_ATOMIC_LOAD(&global.anon_key);
1773 if (tmp != 0)
1774 appctx->cli_anon_key = tmp;
1775 else
1776 appctx->cli_anon_key = ha_random32();
Erwan Le Goas54966df2022-09-14 17:24:22 +02001777 }
1778 }
1779 else if (strcmp(args[2], "off") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001780
1781 if (*args[3]) {
Erwan Le Goas54966df2022-09-14 17:24:22 +02001782 return cli_err(appctx, "Key can't be added while disabling anonymized mode\n");
1783 }
1784 else {
1785 appctx->cli_anon_key = 0;
1786 }
1787 }
1788 else {
1789 return cli_err(appctx,
1790 "'set anon' only supports :\n"
1791 " - 'on' [key] to enable the anonymized mode\n"
1792 " - 'off' to disable the anonymized mode");
1793 }
1794 return 1;
1795}
1796
Erwan Le Goasfad9da82022-09-14 17:24:22 +02001797/* This function set the global anonyzing key, restricted to level 'admin' */
1798static int cli_parse_set_global_key(char **args, char *payload, struct appctx *appctx, void *private)
1799{
1800 long long key;
1801
1802 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1803 return cli_err(appctx, "Permission denied\n");
1804 if (!*args[2])
1805 return cli_err(appctx, "Expects an integer value.\n");
1806
1807 key = atoll(args[2]);
1808 if (key < 0 || key > UINT_MAX)
1809 return cli_err(appctx, "Value out of range (0 to 4294967295 expected).\n");
1810
1811 HA_ATOMIC_STORE(&global.anon_key, key);
1812 return 1;
1813}
1814
Erwan Le Goas54966df2022-09-14 17:24:22 +02001815/* shows the anonymized mode state to everyone, and the key except for users, it always returns 1. */
1816static int cli_parse_show_anon(char **args, char *payload, struct appctx *appctx, void *private)
1817{
1818 char *msg = NULL;
1819 char *anon_mode = NULL;
1820 uint32_t c_key = appctx->cli_anon_key;
1821
1822 if (!c_key)
1823 anon_mode = "Anonymized mode disabled";
1824 else
1825 anon_mode = "Anonymized mode enabled";
1826
1827 if ( !((appctx->cli_level & ACCESS_LVL_MASK) < ACCESS_LVL_OPER) && c_key != 0) {
1828 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\nKey : %u\n", anon_mode, c_key));
1829 }
1830 else {
1831 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", anon_mode));
1832 }
1833
1834 return 1;
1835}
1836
Willy Tarreau45c742b2016-11-24 14:51:17 +01001837/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001838static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001839{
1840 int v;
1841 int *res;
1842 int mul = 1;
1843
1844 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1845 return 1;
1846
1847 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1848 res = &global.cps_lim;
1849 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1850 res = &global.sps_lim;
1851#ifdef USE_OPENSSL
1852 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1853 res = &global.ssl_lim;
1854#endif
1855 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1856 res = &global.comp_rate_lim;
1857 mul = 1024;
1858 }
1859 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001860 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001861 "'set rate-limit' only supports :\n"
1862 " - 'connections global' to set the per-process maximum connection rate\n"
1863 " - 'sessions global' to set the per-process maximum session rate\n"
1864#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001865 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001866#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001867 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001868 }
1869
Willy Tarreau9d008692019-08-09 11:21:01 +02001870 if (!*args[4])
1871 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001872
1873 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001874 if (v < 0)
1875 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001876
1877 *res = v * mul;
1878
1879 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001880 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001881
1882 return 1;
1883}
1884
William Lallemandf6975e92017-05-26 17:42:10 +02001885/* parse the "expose-fd" argument on the bind lines */
1886static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1887{
1888 if (!*args[cur_arg + 1]) {
1889 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1890 return ERR_ALERT | ERR_FATAL;
1891 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001892 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001893 conf->level |= ACCESS_FD_LISTENERS;
1894 } else {
1895 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1896 args[cur_arg], args[cur_arg+1]);
1897 return ERR_ALERT | ERR_FATAL;
1898 }
1899
1900 return 0;
1901}
1902
William Lallemand74c24fb2016-11-21 17:18:36 +01001903/* parse the "level" argument on the bind lines */
1904static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1905{
1906 if (!*args[cur_arg + 1]) {
1907 memprintf(err, "'%s' : missing level", args[cur_arg]);
1908 return ERR_ALERT | ERR_FATAL;
1909 }
1910
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001911 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001912 conf->level &= ~ACCESS_LVL_MASK;
1913 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001914 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001915 conf->level &= ~ACCESS_LVL_MASK;
1916 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001917 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001918 conf->level &= ~ACCESS_LVL_MASK;
1919 conf->level |= ACCESS_LVL_ADMIN;
1920 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001921 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1922 args[cur_arg], args[cur_arg+1]);
1923 return ERR_ALERT | ERR_FATAL;
1924 }
1925
1926 return 0;
1927}
1928
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001929static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1930{
1931 if (!*args[cur_arg + 1]) {
1932 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1933 return ERR_ALERT | ERR_FATAL;
1934 }
1935
1936 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1937 return 0;
1938 else {
1939 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1940 args[cur_arg], args[cur_arg+1]);
1941 return ERR_ALERT | ERR_FATAL;
1942 }
1943}
1944
Olivier Houchardf886e342017-04-05 22:24:59 +02001945/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001946static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001947{
William Lallemandb5d062d2022-07-28 15:33:41 +02001948 static int already_sent = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001949 char *cmsgbuf = NULL;
1950 unsigned char *tmpbuf = NULL;
1951 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001952 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02001953 struct stream *s = __sc_strm(sc);
1954 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02001955 struct msghdr msghdr;
1956 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001957 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001958 const char *ns_name, *if_name;
1959 unsigned char ns_nlen, if_nlen;
1960 int nb_queued;
1961 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001962 int *tmpfd;
1963 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001964 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001965 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001966 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001967 int ret;
1968
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001969 if (!remote) {
1970 ha_warning("Only works on real connections\n");
1971 goto out;
1972 }
1973
1974 fd = remote->handle.fd;
1975
Olivier Houchardf886e342017-04-05 22:24:59 +02001976 /* Temporary set the FD in blocking mode, that will make our life easier */
1977 old_fcntl = fcntl(fd, F_GETFL);
1978 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001979 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001980 goto out;
1981 }
1982 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1983 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001984 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001985 goto out;
1986 }
1987 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001988 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001989 goto out;
1990 }
Olivier Houchard54740872017-04-06 14:45:14 +02001991 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001992 iov.iov_base = &tot_fd_nb;
1993 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001994 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001995 goto out;
1996 memset(&msghdr, 0, sizeof(msghdr));
1997 /*
1998 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001999 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002000 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002001 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002002 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002003
William Lallemandb5d062d2022-07-28 15:33:41 +02002004 if (tot_fd_nb == 0) {
2005 if (already_sent)
2006 ha_warning("_getsocks: attempt to get sockets but they were already sent and closed in this process!\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002007 goto out;
William Lallemandb5d062d2022-07-28 15:33:41 +02002008 }
Olivier Houchardf886e342017-04-05 22:24:59 +02002009
2010 /* First send the total number of file descriptors, so that the
2011 * receiving end knows what to expect.
2012 */
2013 msghdr.msg_iov = &iov;
2014 msghdr.msg_iovlen = 1;
2015 ret = sendmsg(fd, &msghdr, 0);
2016 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002017 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002018 goto out;
2019 }
2020
2021 /* Now send the fds */
2022 msghdr.msg_control = cmsgbuf;
2023 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2024 cmsg = CMSG_FIRSTHDR(&msghdr);
2025 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2026 cmsg->cmsg_level = SOL_SOCKET;
2027 cmsg->cmsg_type = SCM_RIGHTS;
2028 tmpfd = (int *)CMSG_DATA(cmsg);
2029
Olivier Houchardf886e342017-04-05 22:24:59 +02002030 /* For each socket, e message is sent, containing the following :
2031 * Size of the namespace name (or 0 if none), as an unsigned char.
2032 * The namespace name, if any
2033 * Size of the interface name (or 0 if none), as an unsigned char
2034 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002035 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002036 */
2037 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002038 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002039 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002040 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002041 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002042 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002043 goto out;
2044 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002045
2046 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002047 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002048 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002049 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002050 continue;
2051
2052 ns_name = if_name = "";
2053 ns_nlen = if_nlen = 0;
2054
2055 /* for now we can only retrieve namespaces and interfaces from
2056 * pure listeners.
2057 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002058 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002059 const struct listener *l = fdtab[cur_fd].owner;
2060
Willy Tarreau818a92e2020-09-03 07:50:19 +02002061 if (l->rx.settings->interface) {
2062 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002063 if_nlen = strlen(if_name);
2064 }
2065
2066#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002067 if (l->rx.settings->netns) {
2068 ns_name = l->rx.settings->netns->node.key;
2069 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002070 }
2071#endif
2072 }
2073
2074 /* put the FD into the CMSG_DATA */
2075 tmpfd[nb_queued++] = cur_fd;
2076
2077 /* first block is <ns_name_len> <ns_name> */
2078 tmpbuf[curoff++] = ns_nlen;
2079 if (ns_nlen)
2080 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2081 curoff += ns_nlen;
2082
2083 /* second block is <if_name_len> <if_name> */
2084 tmpbuf[curoff++] = if_nlen;
2085 if (if_nlen)
2086 memcpy(tmpbuf + curoff, if_name, if_nlen);
2087 curoff += if_nlen;
2088
2089 /* we used to send the listener options here before 2.3 */
2090 memset(tmpbuf + curoff, 0, sizeof(int));
2091 curoff += sizeof(int);
2092
2093 /* there's a limit to how many FDs may be sent at once */
2094 if (nb_queued == MAX_SEND_FD) {
2095 iov.iov_len = curoff;
2096 if (sendmsg(fd, &msghdr, 0) != curoff) {
2097 ha_warning("Failed to transfer sockets\n");
2098 return -1;
2099 }
2100
2101 /* Wait for an ack */
2102 do {
2103 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2104 } while (ret == -1 && errno == EINTR);
2105
2106 if (ret <= 0) {
2107 ha_warning("Unexpected error while transferring sockets\n");
2108 return -1;
2109 }
2110 curoff = 0;
2111 nb_queued = 0;
2112 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002113 }
2114
William Lallemandb5d062d2022-07-28 15:33:41 +02002115 already_sent = 1;
2116
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002117 /* flush pending stuff */
2118 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002119 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002120 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2121 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002122 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002123 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002124 goto out;
2125 }
2126 }
2127
2128out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002129 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002130 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002131 goto out;
2132 }
2133 appctx->st0 = CLI_ST_END;
2134 free(cmsgbuf);
2135 free(tmpbuf);
2136 return 1;
2137}
2138
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002139static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2140{
2141 if (*args[0] == 'h')
2142 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002143 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002144 else if (*args[0] == 'p')
2145 /* prompt */
2146 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2147 else if (*args[0] == 'q')
2148 /* quit */
2149 appctx->st0 = CLI_ST_END;
2150
2151 return 1;
2152}
Olivier Houchardf886e342017-04-05 22:24:59 +02002153
William Lallemand2f4ce202018-10-26 14:47:47 +02002154void pcli_write_prompt(struct stream *s)
2155{
2156 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002157 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002158
William Lallemanddc12c2e2018-12-13 09:05:46 +01002159 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002160 return;
2161
William Lallemanddc12c2e2018-12-13 09:05:46 +01002162 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002163 chunk_appendf(msg, "+ ");
2164 } else {
2165 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002166 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002167 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002168 else
William Lallemanddae12c72022-02-02 14:13:54 +01002169 chunk_appendf(msg, "%d", s->pcli_next_pid);
2170
2171 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2172 chunk_appendf(msg, "(");
2173
2174 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2175 chunk_appendf(msg, "x");
2176
2177 if (s->pcli_flags & ACCESS_EXPERT)
2178 chunk_appendf(msg, "e");
2179
2180 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2181 chunk_appendf(msg, "d");
2182
2183 chunk_appendf(msg, ")");
2184 }
2185
2186 chunk_appendf(msg, "> ");
2187
2188
William Lallemandebf61802018-12-11 16:10:57 +01002189 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002190 co_inject(oc, msg->area, msg->data);
2191}
2192
William Lallemand291810d2018-10-26 14:47:38 +02002193
William Lallemandcf62f7e2018-10-26 14:47:40 +02002194/* The pcli_* functions are used for the CLI proxy in the master */
2195
William Lallemanddeeaa592018-10-26 14:47:48 +02002196void pcli_reply_and_close(struct stream *s, const char *msg)
2197{
2198 struct buffer *buf = get_trash_chunk();
2199
2200 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002201 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002202}
2203
William Lallemand291810d2018-10-26 14:47:38 +02002204static enum obj_type *pcli_pid_to_server(int proc_pid)
2205{
2206 struct mworker_proc *child;
2207
William Lallemand99e0bb92020-11-05 10:28:53 +01002208 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002209 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002210 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002211
William Lallemand291810d2018-10-26 14:47:38 +02002212 list_for_each_entry(child, &proc_list, list) {
2213 if (child->pid == proc_pid){
2214 return &child->srv->obj_type;
2215 }
2216 }
2217 return NULL;
2218}
2219
2220/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2221 * Return:
2222 * 0: master
2223 * > 0: pid of a worker
2224 * < 0: didn't find a worker
2225 */
2226static int pcli_prefix_to_pid(const char *prefix)
2227{
2228 int proc_pid;
2229 struct mworker_proc *child;
2230 char *errtol = NULL;
2231
2232 if (*prefix != '@') /* not a prefix, should not happen */
2233 return -1;
2234
2235 prefix++;
2236 if (!*prefix) /* sent @ alone, return the master */
2237 return 0;
2238
2239 if (strcmp("master", prefix) == 0) {
2240 return 0;
2241 } else if (*prefix == '!') {
2242 prefix++;
2243 if (!*prefix)
2244 return -1;
2245
2246 proc_pid = strtol(prefix, &errtol, 10);
2247 if (*errtol != '\0')
2248 return -1;
2249 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002250 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002251 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002252 if (child->pid == proc_pid){
2253 return child->pid;
2254 }
2255 }
2256 } else {
2257 struct mworker_proc *chosen = NULL;
2258 /* this is a relative pid */
2259
2260 proc_pid = strtol(prefix, &errtol, 10);
2261 if (*errtol != '\0')
2262 return -1;
2263
2264 if (proc_pid == 0) /* return the master */
2265 return 0;
2266
William Lallemandbac3a822022-07-20 14:30:56 +02002267 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2268 return -1;
2269
William Lallemand291810d2018-10-26 14:47:38 +02002270 /* chose the right process, the current one is the one with the
2271 least number of reloads */
2272 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002273 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002274 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002275 if (child->reloads == 0)
2276 return child->pid;
2277 else if (chosen == NULL || child->reloads < chosen->reloads)
2278 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002279 }
2280 if (chosen)
2281 return chosen->pid;
2282 }
2283 return -1;
2284}
2285
William Lallemandbddd33a2018-12-11 16:10:53 +01002286/* Return::
2287 * >= 0 : number of words to escape
2288 * = -1 : error
2289 */
2290
2291int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2292{
2293 if (argl < 1)
2294 return 0;
2295
2296 /* there is a prefix */
2297 if (args[0][0] == '@') {
2298 int target_pid = pcli_prefix_to_pid(args[0]);
2299
2300 if (target_pid == -1) {
2301 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2302 return -1;
2303 }
2304
2305 /* if the prefix is alone, define a default target */
2306 if (argl == 1)
2307 s->pcli_next_pid = target_pid;
2308 else
2309 *next_pid = target_pid;
2310 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002311 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002312 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002313 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002314
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002315 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002316 channel_shutr_now(&s->req);
2317 channel_shutw_now(&s->res);
2318 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002319 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002320 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2321 memprintf(errmsg, "Permission denied!\n");
2322 return -1;
2323 }
2324 s->pcli_flags &= ~ACCESS_LVL_MASK;
2325 s->pcli_flags |= ACCESS_LVL_OPER;
2326 return argl;
2327
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002328 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002329 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2330 memprintf(errmsg, "Permission denied!\n");
2331 return -1;
2332 }
2333 s->pcli_flags &= ~ACCESS_LVL_MASK;
2334 s->pcli_flags |= ACCESS_LVL_USER;
2335 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002336
2337 } else if (strcmp(args[0], "expert-mode") == 0) {
2338 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2339 memprintf(errmsg, "Permission denied!\n");
2340 return -1;
2341 }
2342
2343 s->pcli_flags &= ~ACCESS_EXPERT;
2344 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2345 s->pcli_flags |= ACCESS_EXPERT;
2346 return argl;
2347
2348 } else if (strcmp(args[0], "experimental-mode") == 0) {
2349 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2350 memprintf(errmsg, "Permission denied!\n");
2351 return -1;
2352 }
2353 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2354 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2355 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2356 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002357 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2358 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2359 memprintf(errmsg, "Permission denied!\n");
2360 return -1;
2361 }
2362 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2363 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2364 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2365 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002366 }
2367
2368 return 0;
2369}
2370
2371/*
2372 * Parse the CLI request:
2373 * - It does basically the same as the cli_io_handler, but as a proxy
2374 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002375 *
2376 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002377 * - the number of characters to forward or
2378 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002379 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002380int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002381{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002382 char *str;
2383 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002384 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002385 int argl; /* number of args */
2386 char *p;
2387 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002388 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002389 int wtrim = 0; /* number of words to trim */
2390 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002391 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002392 int i = 0;
2393
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002394 /* we cannot deal with a wrapping buffer, so let's take care of this
2395 * first.
2396 */
2397 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2398 b_slow_realign(&req->buf, trash.area, co_data(req));
2399
2400 str = (char *)ci_head(req);
2401 end = (char *)ci_stop(req);
2402
William Lallemandbddd33a2018-12-11 16:10:53 +01002403 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002404
William Lallemanddc12c2e2018-12-13 09:05:46 +01002405 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002406
2407 /* Looks for the end of one command */
2408 while (p+reql < end) {
2409 /* handle escaping */
2410 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002411 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002412 continue;
2413 }
2414 if (p[reql] == ';' || p[reql] == '\n') {
2415 /* found the end of the command */
2416 p[reql] = '\n';
2417 reql++;
2418 break;
2419 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002420 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002421 }
William Lallemandebf61802018-12-11 16:10:57 +01002422 } else {
2423 while (p+reql < end) {
2424 if (p[reql] == '\n') {
2425 /* found the end of the line */
2426 reql++;
2427 break;
2428 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002429 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002430 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002431 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002432
William Lallemandbddd33a2018-12-11 16:10:53 +01002433 /* set end to first byte after the end of the command */
2434 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002435
William Lallemandbddd33a2018-12-11 16:10:53 +01002436 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002437 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002438 return -1;
2439 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002440
William Lallemand3301f3e2018-12-13 09:05:48 +01002441 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2442 if (reql == 1) /* last line of the payload */
2443 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002444 return reql;
2445 }
2446
William Lallemandbddd33a2018-12-11 16:10:53 +01002447 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002448
William Lallemandbddd33a2018-12-11 16:10:53 +01002449 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002450 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002451 /* skip leading spaces/tabs */
2452 p += strspn(p, " \t");
2453 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002454 break;
2455
William Lallemandbddd33a2018-12-11 16:10:53 +01002456 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002457 while (1) {
2458 p += strcspn(p, " \t\\");
2459 /* escaped chars using backlashes (\) */
2460 if (*p == '\\') {
2461 if (!*++p)
2462 break;
2463 if (!*++p)
2464 break;
2465 } else {
2466 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002467 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002468 }
William Lallemandfe249c32020-06-18 18:03:57 +02002469 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002470 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002471 }
2472
William Lallemandbddd33a2018-12-11 16:10:53 +01002473 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002474
Willy Tarreauf14c7572021-03-13 10:59:23 +01002475 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002476 args[i] = NULL;
2477
2478 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2479
2480 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002481 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002482 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002483 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002484 if (*p == '\0')
2485 *p = ' ';
2486 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002487 }
2488
William Lallemand3301f3e2018-12-13 09:05:48 +01002489 payload = strstr(str, PAYLOAD_PATTERN);
2490 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2491 /* if the payload pattern is at the end */
2492 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002493 }
2494
William Lallemandbddd33a2018-12-11 16:10:53 +01002495 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002496
William Lallemandbddd33a2018-12-11 16:10:53 +01002497 if (wtrim > 0) {
2498 trim = &args[wtrim][0];
2499 if (trim == NULL) /* if this was the last word in the table */
2500 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002501
William Lallemandbddd33a2018-12-11 16:10:53 +01002502 b_del(&req->buf, trim - str);
2503
William Lallemandb7ea1412018-12-13 09:05:47 +01002504 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002505 } else if (wtrim < 0) {
2506 /* parsing error */
2507 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002508 } else {
2509 /* the whole string */
2510 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002511 }
2512
William Lallemandb7ea1412018-12-13 09:05:47 +01002513 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002514
2515 /* the mcli-debug-mode is only sent to the applet of the master */
2516 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2517 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2518 ret += strlen("mcli-debug-mode on -") + 2;
2519 }
William Lallemand7267f782022-02-01 16:08:50 +01002520 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2521 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2522 ret += strlen("experimental-mode on -") + 2;
2523 }
2524 if (s->pcli_flags & ACCESS_EXPERT) {
2525 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2526 ret += strlen("expert-mode on -") + 2;
2527 }
2528
William Lallemandb7ea1412018-12-13 09:05:47 +01002529 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2530 goto end;
2531 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002532 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2533 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002534 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002535 ci_insert_line2(req, 0, "user -", strlen("user -"));
2536 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002537 }
2538 }
2539end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002540
William Lallemandb7ea1412018-12-13 09:05:47 +01002541 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002542}
2543
2544int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2545{
William Lallemandbddd33a2018-12-11 16:10:53 +01002546 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002547 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002548 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002549
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002550 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002551 * current one. Just wait. At this stage, errors should be handled by
2552 * the response analyzer.
2553 */
2554 if (s->res.analysers & AN_RES_WAIT_CLI)
2555 return 0;
2556
William Lallemandb7ea1412018-12-13 09:05:47 +01002557 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2558 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2559
William Lallemand0a0512f2022-09-24 16:14:50 +02002560 /* stream that comes from the reload listener only responses the reload
2561 * status and quits */
2562 if (!(s->pcli_flags & PCLI_F_RELOAD)
2563 && strm_li(s)->bind_conf == mcli_reload_bind_conf)
2564 goto send_status;
2565
2566
William Lallemandcf62f7e2018-10-26 14:47:40 +02002567read_again:
2568 /* if the channel is closed for read, we won't receive any more data
2569 from the client, but we don't want to forward this close to the
2570 server */
2571 channel_dont_close(req);
2572
2573 /* We don't know yet to which server we will connect */
2574 channel_dont_connect(req);
2575
William Lallemandcf62f7e2018-10-26 14:47:40 +02002576 req->flags |= CF_READ_DONTWAIT;
2577
2578 /* need more data */
2579 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002580 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002581
2582 /* If there is data available for analysis, log the end of the idle time. */
2583 if (c_data(req) && s->logs.t_idle == -1)
2584 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2585
William Lallemandbddd33a2018-12-11 16:10:53 +01002586 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002587 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002588 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002589 /* enough data */
2590
William Lallemandcf62f7e2018-10-26 14:47:40 +02002591 /* forward only 1 command */
2592 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002593
William Lallemanddc12c2e2018-12-13 09:05:46 +01002594 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002595 /* we send only 1 command per request, and we write close after it */
2596 channel_shutw_now(req);
2597 } else {
2598 pcli_write_prompt(s);
2599 }
2600
2601 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002602 s->res.analysers |= AN_RES_WAIT_CLI;
2603
William Lallemandebf61802018-12-11 16:10:57 +01002604 if (!(s->flags & SF_ASSIGNED)) {
2605 if (next_pid > -1)
2606 target_pid = next_pid;
2607 else
2608 target_pid = s->pcli_next_pid;
2609 /* we can connect now */
2610 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002611
William Lallemanddcbe7b92021-12-10 14:14:53 +01002612 if (!s->target)
2613 goto server_disconnect;
2614
William Lallemandebf61802018-12-11 16:10:57 +01002615 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2616 channel_auto_connect(req);
2617 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002618
2619 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002620 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002621 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002622 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002623 } else if (to_forward == -1) {
2624 if (errmsg) {
2625 /* there was an error during the parsing */
2626 pcli_reply_and_close(s, errmsg);
2627 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2628 return 0;
2629 }
2630 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002631 }
2632
2633 return 0;
2634
2635send_help:
2636 b_reset(&req->buf);
2637 b_putblk(&req->buf, "help\n", 5);
2638 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002639
William Lallemand0a0512f2022-09-24 16:14:50 +02002640send_status:
2641 s->pcli_flags |= PCLI_F_RELOAD;
2642 /* dont' use ci_putblk here because SHUTW could have been sent */
2643 b_reset(&req->buf);
2644 b_putblk(&req->buf, "_loadstatus;quit\n", 17);
2645 goto read_again;
2646
Christopher Faulet0f727da2022-01-18 08:44:23 +01002647missing_data:
2648 if (req->flags & CF_SHUTR) {
2649 /* There is no more request or a only a partial one and we
2650 * receive a close from the client, we can leave */
2651 channel_shutw_now(&s->res);
2652 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2653 return 1;
2654 }
2655 else if (channel_full(req, global.tune.maxrewrite)) {
2656 /* buffer is full and we didn't catch the end of a command */
2657 goto send_help;
2658 }
2659 return 0;
2660
William Lallemanddcbe7b92021-12-10 14:14:53 +01002661server_disconnect:
2662 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2663 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002664}
2665
2666int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2667{
2668 struct proxy *fe = strm_fe(s);
2669 struct proxy *be = s->be;
2670
Christopher Faulete8cefac2022-03-07 18:20:21 +01002671 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2672 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002673 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002674 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002675 s->res.analysers &= ~AN_RES_WAIT_CLI;
2676 return 0;
2677 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002678 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2679 rep->flags |= CF_NEVER_WAIT;
2680
2681 /* don't forward the close */
2682 channel_dont_close(&s->res);
2683 channel_dont_close(&s->req);
2684
William Lallemanddc12c2e2018-12-13 09:05:46 +01002685 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002686 s->res.analysers &= ~AN_RES_WAIT_CLI;
2687 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2688 return 0;
2689 }
2690
William Lallemandcf62f7e2018-10-26 14:47:40 +02002691 /* forward the data */
2692 if (ci_data(rep)) {
2693 c_adv(rep, ci_data(rep));
2694 return 0;
2695 }
2696
Christopher Faulet446d8032022-12-12 07:53:18 +01002697 if (rep->flags & CF_SHUTR) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002698 /* stream cleanup */
2699
William Lallemand2f4ce202018-10-26 14:47:47 +02002700 pcli_write_prompt(s);
2701
Willy Tarreaucb041662022-05-17 19:44:42 +02002702 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Willy Tarreauf61dd192022-05-27 09:00:19 +02002703 sc_shutr(s->scb);
2704 sc_shutw(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002705
2706 /*
2707 * starting from there this the same code as
2708 * http_end_txn_clean_session().
2709 *
2710 * It allows to do frontend keepalive while reconnecting to a
2711 * new server for each request.
2712 */
2713
2714 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002715 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002716 if (unlikely(s->srv_conn))
2717 sess_change_server(s, NULL);
2718 }
2719
2720 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2721 stream_process_counters(s);
2722
2723 /* don't count other requests' data */
2724 s->logs.bytes_in -= ci_data(&s->req);
2725 s->logs.bytes_out -= ci_data(&s->res);
2726
2727 /* we may need to know the position in the queue */
2728 pendconn_free(s);
2729
2730 /* let's do a final log if we need it */
2731 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2732 !(s->flags & SF_MONITOR) &&
2733 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2734 s->do_log(s);
2735 }
2736
2737 /* stop tracking content-based counters */
2738 stream_stop_content_counters(s);
2739 stream_update_time_stats(s);
2740
2741 s->logs.accept_date = date; /* user-visible date for logging */
2742 s->logs.tv_accept = now; /* corrected date for internal use */
2743 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2744 s->logs.t_idle = -1;
2745 tv_zero(&s->logs.tv_request);
2746 s->logs.t_queue = -1;
2747 s->logs.t_connect = -1;
2748 s->logs.t_data = -1;
2749 s->logs.t_close = 0;
2750 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2751 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2752
2753 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2754 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2755
2756 stream_del_srv_conn(s);
2757 if (objt_server(s->target)) {
2758 if (s->flags & SF_CURR_SESS) {
2759 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002760 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002761 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002762 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002763 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002764 }
2765
2766 s->target = NULL;
2767
2768 /* only release our endpoint if we don't intend to reuse the
2769 * connection.
2770 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002771 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002772 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002773 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002774 if (!s->conn_err_type)
2775 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002776 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002777 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002778 return 1;
2779 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002780 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002781 }
2782
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002783 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002784
Willy Tarreau74568cf2022-05-27 09:03:30 +02002785 sc_set_state(s->scb, SC_ST_INI);
Willy Tarreaucb041662022-05-17 19:44:42 +02002786 s->scb->flags &= SC_FL_ISBACK | SC_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet22dc2482019-07-16 14:43:08 +02002787 s->req.flags &= ~(CF_SHUTW|CF_SHUTW_NOW|CF_AUTO_CONNECT|CF_WRITE_ERROR|CF_STREAMER|CF_STREAMER_FAST|CF_NEVER_WAIT|CF_WROTE_DATA);
Christopher Faulet23577182022-12-20 18:47:39 +01002788 s->res.flags &= ~(CF_SHUTR|CF_SHUTR_NOW|CF_READ_ERROR|CF_READ_NOEXP|CF_STREAMER|CF_STREAMER_FAST|CF_WRITE_EVENT|CF_NEVER_WAIT|CF_WROTE_DATA|CF_READ_EVENT);
Willy Tarreau03bd3952022-05-02 16:36:47 +02002789 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002790 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2791 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002792 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002793 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002794 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002795 /* reinitialise the current rule list pointer to NULL. We are sure that
2796 * any rulelist match the NULL pointer.
2797 */
2798 s->current_rule_list = NULL;
2799
2800 s->be = strm_fe(s);
2801 s->logs.logwait = strm_fe(s)->to_log;
2802 s->logs.level = 0;
2803 stream_del_srv_conn(s);
2804 s->target = NULL;
2805 /* re-init store persistence */
2806 s->store_count = 0;
2807 s->uniq_id = global.req_count++;
2808
2809 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2810
2811 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2812
William Lallemandcf62f7e2018-10-26 14:47:40 +02002813 s->res.analysers &= ~AN_RES_WAIT_CLI;
2814
2815 /* We must trim any excess data from the response buffer, because we
2816 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002817 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002818 * we want those data to come along with next response. A typical
2819 * example of such data would be from a buggy server responding to
2820 * a HEAD with some data, or sending more than the advertised
2821 * content-length.
2822 */
2823 if (unlikely(ci_data(&s->res)))
2824 b_set_data(&s->res.buf, co_data(&s->res));
2825
2826 /* Now we can realign the response buffer */
2827 c_realign_if_empty(&s->res);
2828
2829 s->req.rto = strm_fe(s)->timeout.client;
2830 s->req.wto = TICK_ETERNITY;
2831
2832 s->res.rto = TICK_ETERNITY;
2833 s->res.wto = strm_fe(s)->timeout.client;
2834
2835 s->req.rex = TICK_ETERNITY;
2836 s->req.wex = TICK_ETERNITY;
2837 s->req.analyse_exp = TICK_ETERNITY;
2838 s->res.rex = TICK_ETERNITY;
2839 s->res.wex = TICK_ETERNITY;
2840 s->res.analyse_exp = TICK_ETERNITY;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002841 s->scb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002842
2843 /* we're removing the analysers, we MUST re-enable events detection.
2844 * We don't enable close on the response channel since it's either
2845 * already closed, or in keep-alive with an idle connection handler.
2846 */
2847 channel_auto_read(&s->req);
2848 channel_auto_close(&s->req);
2849 channel_auto_read(&s->res);
2850
2851
2852 return 1;
2853 }
2854 return 0;
2855}
2856
William Lallemand8a022572018-10-26 14:47:35 +02002857/*
2858 * The mworker functions are used to initialize the CLI in the master process
2859 */
2860
William Lallemand309dc9a2018-10-26 14:47:45 +02002861 /*
2862 * Stop the mworker proxy
2863 */
2864void mworker_cli_proxy_stop()
2865{
William Lallemand550db6d2018-11-06 17:37:12 +01002866 if (mworker_proxy)
2867 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002868}
2869
William Lallemand8a022572018-10-26 14:47:35 +02002870/*
2871 * Create the mworker CLI proxy
2872 */
2873int mworker_cli_proxy_create()
2874{
2875 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002876 char *msg = NULL;
2877 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002878
William Lallemandae787ba2021-07-29 15:13:22 +02002879 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002880 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002881 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002882
William Lallemandcf62f7e2018-10-26 14:47:40 +02002883 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002884 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2885 mworker_proxy->timeout.client = 0; /* no timeout */
2886 mworker_proxy->conf.file = strdup("MASTER");
2887 mworker_proxy->conf.line = 0;
2888 mworker_proxy->accept = frontend_accept;
2889 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2890
2891 /* Does not init the default target the CLI applet, but must be done in
2892 * the request parsing code */
2893 mworker_proxy->default_target = NULL;
2894
William Lallemand8a022572018-10-26 14:47:35 +02002895 /* create all servers using the mworker_proc list */
2896 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002897 struct server *newsrv = NULL;
2898 struct sockaddr_storage *sk;
2899 int port1, port2, port;
2900 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002901
William Lallemanda31b09e2020-01-14 15:25:02 +01002902 /* only the workers support the master CLI */
2903 if (!(child->options & PROC_O_TYPE_WORKER))
2904 continue;
2905
William Lallemand8a022572018-10-26 14:47:35 +02002906 newsrv = new_server(mworker_proxy);
2907 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002908 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002909
2910 /* we don't know the new pid yet */
2911 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002912 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002913 else
2914 memprintf(&msg, "old-%d", child->pid);
2915
2916 newsrv->next = mworker_proxy->srv;
2917 mworker_proxy->srv = newsrv;
2918 newsrv->conf.file = strdup(msg);
2919 newsrv->id = strdup(msg);
2920 newsrv->conf.line = 0;
2921
2922 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002923 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002924 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002925 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002926 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002927 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002928
Willy Tarreau5fc93282020-09-16 18:25:03 +02002929 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002930 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002931 }
2932
2933 /* no port specified */
2934 newsrv->flags |= SRV_F_MAPPORTS;
2935 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002936 /* don't let the server participate to load balancing */
2937 newsrv->iweight = 0;
2938 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002939 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002940
2941 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002942 }
William Lallemandae787ba2021-07-29 15:13:22 +02002943
2944 mworker_proxy->next = proxies_list;
2945 proxies_list = mworker_proxy;
2946
William Lallemand8a022572018-10-26 14:47:35 +02002947 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002948
2949error:
William Lallemand744a0892018-11-22 16:46:51 +01002950
2951 list_for_each_entry(child, &proc_list, list) {
2952 free((char *)child->srv->conf.file); /* cast because of const char * */
2953 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002954 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002955 }
William Lallemandae787ba2021-07-29 15:13:22 +02002956 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002957 free(msg);
2958
William Lallemandae787ba2021-07-29 15:13:22 +02002959error_proxy:
2960 ha_alert("%s\n", errmsg);
2961 free(errmsg);
2962
William Lallemand744a0892018-11-22 16:46:51 +01002963 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002964}
Olivier Houchardf886e342017-04-05 22:24:59 +02002965
William Lallemandce83b4a2018-10-26 14:47:30 +02002966/*
William Lallemande7361152018-10-26 14:47:36 +02002967 * Create a new listener for the master CLI proxy
2968 */
William Lallemand21623b52022-09-24 15:51:27 +02002969struct bind_conf *mworker_cli_proxy_new_listener(char *line)
William Lallemande7361152018-10-26 14:47:36 +02002970{
2971 struct bind_conf *bind_conf;
2972 struct listener *l;
2973 char *err = NULL;
2974 char *args[MAX_LINE_ARGS + 1];
2975 int arg;
2976 int cur_arg;
2977
William Lallemand2e945c82019-11-25 09:58:37 +01002978 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002979 args[0] = line;
2980
2981 /* args is a bind configuration with spaces replaced by commas */
2982 while (*line && arg < MAX_LINE_ARGS) {
2983
2984 if (*line == ',') {
2985 *line++ = '\0';
2986 while (*line == ',')
2987 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002988 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002989 }
2990 line++;
2991 }
2992
William Lallemand2e945c82019-11-25 09:58:37 +01002993 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002994
2995 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002996 if (!bind_conf)
2997 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002998
2999 bind_conf->level &= ~ACCESS_LVL_MASK;
3000 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003001 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
Willy Tarreaudcbd7632022-07-06 11:46:34 +02003002 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemande7361152018-10-26 14:47:36 +02003003
3004 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3005 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003006 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003007 }
3008
3009 cur_arg = 1;
3010
3011 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003012 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003013 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003014
3015 kw = bind_find_kw(args[cur_arg]);
3016 if (kw) {
3017 if (!kw->parse) {
3018 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3019 args[0], args[1], args[cur_arg]);
3020 goto err;
3021 }
3022
Willy Tarreau4975d142021-03-13 11:00:33 +01003023 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003024 if (err)
3025 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3026 else
3027 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3028 args[0], args[1], args[cur_arg]);
3029 goto err;
3030 }
3031
3032 cur_arg += 1 + kw->skip;
3033 continue;
3034 }
3035
Willy Tarreau433b05f2021-03-12 10:14:07 +01003036 best = bind_find_best_kw(args[cur_arg]);
3037 if (best)
3038 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3039 args[0], args[1], args[cur_arg], best);
3040 else
3041 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3042 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003043 goto err;
3044 }
3045
3046
Willy Tarreau30836152023-01-12 19:10:17 +01003047 bind_conf->accept = session_accept_fd;
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003048
William Lallemande7361152018-10-26 14:47:36 +02003049 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemande7361152018-10-26 14:47:36 +02003050 /* don't make the peers subject to global limits and don't close it in the master */
Willy Tarreau18c20d22020-10-09 16:11:46 +02003051 l->options |= LI_O_UNLIMITED;
3052 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
William Lallemande7361152018-10-26 14:47:36 +02003053 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003054 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003055 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003056 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003057
William Lallemand21623b52022-09-24 15:51:27 +02003058 return bind_conf;
William Lallemande7361152018-10-26 14:47:36 +02003059
3060err:
3061 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003062 free(err);
3063 free(bind_conf);
William Lallemand21623b52022-09-24 15:51:27 +02003064 return NULL;
William Lallemande7361152018-10-26 14:47:36 +02003065
3066}
3067
3068/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003069 * Create a new CLI socket using a socketpair for a worker process
3070 * <mworker_proc> is the process structure, and <proc> is the process number
3071 */
3072int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3073{
3074 struct bind_conf *bind_conf;
3075 struct listener *l;
3076 char *path = NULL;
3077 char *err = NULL;
3078
3079 /* master pipe to ensure the master is still alive */
3080 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3081 ha_alert("Cannot create worker socketpair.\n");
3082 return -1;
3083 }
3084
3085 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003086 if (!global.cli_fe) {
3087 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003088 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003089 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003090 }
3091 }
3092
Willy Tarreau4975d142021-03-13 11:00:33 +01003093 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003094 if (!bind_conf)
3095 goto error;
3096
William Lallemandce83b4a2018-10-26 14:47:30 +02003097 bind_conf->level &= ~ACCESS_LVL_MASK;
3098 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003099 bind_conf->level |= ACCESS_FD_LISTENERS;
Willy Tarreaudcbd7632022-07-06 11:46:34 +02003100 bind_conf->bind_tgroup = 1; // bind to a single group in any case
William Lallemandce83b4a2018-10-26 14:47:30 +02003101
William Lallemandce83b4a2018-10-26 14:47:30 +02003102 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3103 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003104 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003105 }
3106
Willy Tarreau4975d142021-03-13 11:00:33 +01003107 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003108 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003109 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003110 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003111 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003112 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003113
Willy Tarreau30836152023-01-12 19:10:17 +01003114 bind_conf->accept = session_accept_fd;
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003115
William Lallemandce83b4a2018-10-26 14:47:30 +02003116 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
William Lallemanda3372292018-11-16 16:57:22 +01003117 l->options |= (LI_O_UNLIMITED | LI_O_NOSTOP);
Willy Tarreau4781b152021-04-06 13:53:36 +02003118 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003119 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003120 l->rx.flags &= ~RX_F_INHERITED;
William Lallemandce83b4a2018-10-26 14:47:30 +02003121 l->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003122 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003123 }
3124
3125 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003126
3127error:
3128 close(mworker_proc->ipc_fd[0]);
3129 close(mworker_proc->ipc_fd[1]);
3130 free(err);
3131
3132 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003133}
3134
William Lallemand74c24fb2016-11-21 17:18:36 +01003135static struct applet cli_applet = {
3136 .obj_type = OBJ_TYPE_APPLET,
3137 .name = "<CLI>", /* used for logging */
3138 .fct = cli_io_handler,
3139 .release = cli_release_handler,
3140};
3141
William Lallemand99e0bb92020-11-05 10:28:53 +01003142/* master CLI */
3143static struct applet mcli_applet = {
3144 .obj_type = OBJ_TYPE_APPLET,
3145 .name = "<MCLI>", /* used for logging */
3146 .fct = cli_io_handler,
3147 .release = cli_release_handler,
3148};
3149
Willy Tarreau0a739292016-11-22 20:21:23 +01003150/* register cli keywords */
3151static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003152 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3153 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3154 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3155 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003156 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3157 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003158 { { "mcli-debug-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER_ONLY }, // not listed
Erwan Le Goas54966df2022-09-14 17:24:22 +02003159 { { "set", "anon", NULL }, "set anon <setting> [value] : change the anonymized mode setting", cli_parse_set_anon, NULL, NULL },
Erwan Le Goasd7869312022-09-29 10:36:11 +02003160 { { "set", "anon", "global-key", NULL }, "set anon global-key <value> : change the global anonymizing key", cli_parse_set_global_key, NULL, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003161 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3162 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3163 { { "set", "severity-output", NULL }, "set severity-output [none|number|string]: set presence of severity level in feedback information", cli_parse_set_severity_output, NULL, NULL },
3164 { { "set", "timeout", NULL }, "set timeout [cli] <delay> : change a timeout setting", cli_parse_set_timeout, NULL, NULL },
Erwan Le Goas54966df2022-09-14 17:24:22 +02003165 { { "show", "anon", NULL }, "show anon : display the current state of anonymized mode", cli_parse_show_anon, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003166 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3167 { { "show", "cli", "sockets", NULL }, "show cli sockets : dump list of cli sockets", cli_parse_default, cli_io_handler_show_cli_sock, NULL, NULL, ACCESS_MASTER },
3168 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3169 { { "show", "fd", NULL }, "show fd [num] : dump list of file descriptors in use or a specific one", cli_parse_show_fd, cli_io_handler_show_fd, NULL },
William Lallemand740629e2021-12-14 15:22:29 +01003170 { { "show", "version", NULL }, "show version : show version of the current process", cli_parse_show_version, NULL, NULL, NULL, ACCESS_MASTER },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003171 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3172 { { "user", NULL }, "user : lower the level of the current CLI session to user", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau0a739292016-11-22 20:21:23 +01003173 {{},}
3174}};
3175
Willy Tarreau0108d902018-11-25 19:14:37 +01003176INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3177
William Lallemand74c24fb2016-11-21 17:18:36 +01003178static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003179 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003180 { 0, NULL, NULL },
3181}};
3182
Willy Tarreau0108d902018-11-25 19:14:37 +01003183INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3184
William Lallemand74c24fb2016-11-21 17:18:36 +01003185static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003186 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3187 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003188 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003189 { NULL, NULL, 0 },
3190}};
3191
Willy Tarreau0108d902018-11-25 19:14:37 +01003192INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003193
3194/*
3195 * Local variables:
3196 * c-indent-level: 8
3197 * c-basic-offset: 8
3198 * End:
3199 */