blob: a54146434b5f6d1c21a1a12fca369720cfb29e6e [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 */
William Lallemand74c24fb2016-11-21 17:18:36 +0100497
Willy Tarreau4975d142021-03-13 11:00:33 +0100498 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100499 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
500 file, line, args[0], args[1], err && *err ? *err : "error");
501 return -1;
502 }
503
504 cur_arg = 3;
505 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100506 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100507 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100508 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100509
510 kw = bind_find_kw(args[cur_arg]);
511 if (kw) {
512 if (!kw->parse) {
513 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
514 args[0], args[1], args[cur_arg]);
515 return -1;
516 }
517
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100518 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
519
520 /* FIXME: this is ugly, we don't have a way to collect warnings,
521 * yet some important bind keywords may report warnings that we
522 * must display.
523 */
524 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
525 indent_msg(err, 2);
526 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
527 ha_free(err);
528 }
529
530 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100531 if (err && *err)
532 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
533 else
534 memprintf(err, "'%s %s' : error encountered while processing '%s'",
535 args[0], args[1], args[cur_arg]);
536 return -1;
537 }
538
539 cur_arg += 1 + kw->skip;
540 continue;
541 }
542
Willy Tarreau433b05f2021-03-12 10:14:07 +0100543 best = bind_find_best_kw(args[cur_arg]);
544 if (best)
545 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
546 args[0], args[1], args[cur_arg], best);
547 else
548 memprintf(err, "'%s %s' : unknown keyword '%s'.",
549 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100550 return -1;
551 }
552
Willy Tarreau30836152023-01-12 19:10:17 +0100553 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +0100554 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +0100555 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +0100556
William Lallemand74c24fb2016-11-21 17:18:36 +0100557 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18215cb2019-02-27 16:25:28 +0100558 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100559 }
560 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100561 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100562 unsigned timeout;
563 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
564
Willy Tarreau9faebe32019-06-07 19:00:37 +0200565 if (res == PARSE_TIME_OVER) {
566 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
567 args[2], args[0], args[1]);
568 return -1;
569 }
570 else if (res == PARSE_TIME_UNDER) {
571 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
572 args[2], args[0], args[1]);
573 return -1;
574 }
575 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100576 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
577 return -1;
578 }
579
580 if (!timeout) {
581 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
582 return -1;
583 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100584 if (!global.cli_fe) {
585 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100586 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
587 return -1;
588 }
589 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100590 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100591 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100592 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100593 int maxconn = atol(args[2]);
594
595 if (maxconn <= 0) {
596 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
597 return -1;
598 }
599
Willy Tarreau4975d142021-03-13 11:00:33 +0100600 if (!global.cli_fe) {
601 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
603 return -1;
604 }
605 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100606 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100607 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200608 else if (strcmp(args[1], "bind-process") == 0) {
609 memprintf(err, "'%s' is not supported anymore.", args[0]);
610 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100611 }
612 else {
613 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
614 return -1;
615 }
616 return 0;
617}
618
William Lallemand33d29e22019-04-01 11:30:06 +0200619/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200620 * This function exports the bound addresses of a <frontend> in the environment
621 * variable <varname>. Those addresses are separated by semicolons and prefixed
622 * with their type (abns@, unix@, sockpair@ etc)
623 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200624 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200625int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200626{
627 struct buffer *trash = get_trash_chunk();
628 struct bind_conf *bind_conf;
629
William Lallemand9a37fd02019-04-12 16:09:24 +0200630 if (frontend) {
631 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200632 struct listener *l;
633
634 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
635 char addr[46];
636 char port[6];
637
William Lallemand620072b2019-04-12 16:09:25 +0200638 /* separate listener by semicolons */
639 if (trash->data)
640 chunk_appendf(trash, ";");
641
Willy Tarreau37159062020-08-27 07:48:42 +0200642 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200643 const struct sockaddr_un *un;
644
Willy Tarreau37159062020-08-27 07:48:42 +0200645 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200646 if (un->sun_path[0] == '\0') {
647 chunk_appendf(trash, "abns@%s", un->sun_path+1);
648 } else {
649 chunk_appendf(trash, "unix@%s", un->sun_path);
650 }
Willy Tarreau37159062020-08-27 07:48:42 +0200651 } else if (l->rx.addr.ss_family == AF_INET) {
652 addr_to_str(&l->rx.addr, addr, sizeof(addr));
653 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200654 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200655 } else if (l->rx.addr.ss_family == AF_INET6) {
656 addr_to_str(&l->rx.addr, addr, sizeof(addr));
657 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200658 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200659 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
660 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200661 }
William Lallemand33d29e22019-04-01 11:30:06 +0200662 }
663 }
664 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200665 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200666 return -1;
667 }
668
669 return 0;
670}
671
William Lallemand9a37fd02019-04-12 16:09:24 +0200672int cli_socket_setenv()
673{
Willy Tarreau4975d142021-03-13 11:00:33 +0100674 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200675 return -1;
676 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
677 return -1;
678
679 return 0;
680}
681
William Lallemand33d29e22019-04-01 11:30:06 +0200682REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
683
Willy Tarreaude57a572016-11-23 17:01:39 +0100684/* Verifies that the CLI at least has a level at least as high as <level>
685 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
686 * failure, an error message is prepared and the appctx's state is adjusted
687 * to print it so that a return 1 is enough to abort any processing.
688 */
689int cli_has_level(struct appctx *appctx, int level)
690{
Willy Tarreaude57a572016-11-23 17:01:39 +0100691
William Lallemandf630d012018-12-13 09:05:44 +0100692 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100693 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100694 return 0;
695 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100696 return 1;
697}
698
William Lallemandb7ea1412018-12-13 09:05:47 +0100699/* same as cli_has_level but for the CLI proxy and without error message */
700int pcli_has_level(struct stream *s, int level)
701{
702 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
703 return 0;
704 }
705 return 1;
706}
707
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200708/* Returns severity_output for the current session if set, or default for the socket */
709static int cli_get_severity_output(struct appctx *appctx)
710{
711 if (appctx->cli_severity_output)
712 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200713 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200714}
William Lallemand74c24fb2016-11-21 17:18:36 +0100715
Willy Tarreau41908562016-11-24 16:23:38 +0100716/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100717 * from the CLI's IO handler running in an appctx context. The function returns
718 * 1 if the request was understood, otherwise zero (in which case an error
719 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100720 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
721 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
722 * have its own I/O handler called again. Most of the time, parsers will only
723 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100724 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
725 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100726 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200727static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100728{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100729 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200730 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100731 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100732
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200733 p = appctx->chunk->area;
734 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100735
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200736 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200737 * Get pointers on words.
738 * One extra slot is reserved to store a pointer on a null byte.
739 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100740 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100742
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200743 /* skip leading spaces/tabs */
744 p += strspn(p, " \t");
745 if (!*p)
746 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200747
748 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
749 /* payload pattern recognized here, this is not an arg anymore,
750 * the payload starts at the first byte that follows the zero
751 * after the pattern.
752 */
753 payload = p + strlen(PAYLOAD_PATTERN) + 1;
754 break;
755 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100756
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200757 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200758 while (1) {
759 p += strcspn(p, " \t\\");
760 /* escaped chars using backlashes (\) */
761 if (*p == '\\') {
762 if (!*++p)
763 break;
764 if (!*++p)
765 break;
766 } else {
767 break;
768 }
769 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200770 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100771
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200772 /* unescape backslashes (\) */
773 for (j = 0, k = 0; args[i][k]; k++) {
774 if (args[i][k] == '\\') {
775 if (args[i][k + 1] == '\\')
776 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100777 else
778 continue;
779 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200780 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100781 j++;
782 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200783 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100784
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200785 i++;
786 }
787 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200788 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100789 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200790 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100791
792 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100793 if (!kw ||
794 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100795 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
796 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100797 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100798 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100799 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100800 }
William Lallemand14721be2018-10-26 14:47:37 +0200801
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100802 /* don't handle expert mode commands if not in this mode. */
803 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
804 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200805 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100806 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200807
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100808 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
809 cli_err(appctx, "This command is restricted to experimental mode only.\n");
810 return 0;
811 }
812
Amaury Denoyellef4929922021-05-05 16:29:23 +0200813 if (kw->level == ACCESS_EXPERT)
814 mark_tainted(TAINTED_CLI_EXPERT_MODE);
815 else if (kw->level == ACCESS_EXPERIMENTAL)
816 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
817
Willy Tarreau41908562016-11-24 16:23:38 +0100818 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200819 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200820
821 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
822 goto fail;
823
824 /* kw->parse could set its own io_handler or io_release handler */
825 if (!appctx->io_handler)
826 goto fail;
827
828 appctx->st0 = CLI_ST_CALLBACK;
829 return 1;
830fail:
831 appctx->io_handler = NULL;
832 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100833 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100834}
835
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200836/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
837static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
838{
Willy Tarreau83061a82018-07-13 11:56:34 +0200839 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200840
841 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200842 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200843
844 tmp = get_trash_chunk();
845 chunk_reset(tmp);
846
847 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100848 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200849 chunk_printf(tmp, "[%d]: ", severity);
850 }
851 else {
852 switch (severity_output) {
853 case CLI_SEVERITY_NUMBER:
854 chunk_printf(tmp, "[%d]: ", severity);
855 break;
856 case CLI_SEVERITY_STRING:
857 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
858 break;
859 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100860 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200861 }
862 }
863 chunk_appendf(tmp, "%s", msg);
864
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200865 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200866}
867
Willy Tarreau4596fe22022-05-17 19:07:51 +0200868/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100869 * used to processes I/O from/to the stats unix socket. The system relies on a
870 * state machine handling requests and various responses. We read a request,
871 * then we process it and send the response, and we possibly display a prompt.
872 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100873 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100874 * or not.
875 */
876static void cli_io_handler(struct appctx *appctx)
877{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200878 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200879 struct channel *req = sc_oc(sc);
880 struct channel *res = sc_ic(sc);
881 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100882 int reql;
883 int len;
884
Willy Tarreau475e4632022-05-27 10:26:46 +0200885 if (unlikely(sc->state == SC_ST_DIS || sc->state == SC_ST_CLO))
William Lallemand74c24fb2016-11-21 17:18:36 +0100886 goto out;
887
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800888 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200889 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +0100890 /* buf.size==0 means we failed to get a buffer and were
891 * already subscribed to a wait list to get a buffer.
892 */
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100893 goto out;
894 }
895
William Lallemand74c24fb2016-11-21 17:18:36 +0100896 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100897 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200898 /* reset severity to default at init */
899 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau1addf8b2022-08-18 18:04:37 +0200900 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100901 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100902 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100903 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100904 else if (appctx->st0 == CLI_ST_END) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100905 /* Let's close for real now. We just close the request
906 * side, the conditions below will complete if needed.
907 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200908 sc_shutw(sc);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200909 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200910 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100911 break;
912 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100913 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200914 char *str;
915
916 /* use a trash chunk to store received data */
917 if (!appctx->chunk) {
918 appctx->chunk = alloc_trash_chunk();
919 if (!appctx->chunk) {
920 appctx->st0 = CLI_ST_END;
921 continue;
922 }
923 }
924
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200925 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200926
William Lallemand74c24fb2016-11-21 17:18:36 +0100927 /* ensure we have some output room left in the event we
928 * would want to return some info right after parsing.
929 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200930 if (buffer_almost_full(sc_ib(sc))) {
931 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +0100932 break;
933 }
934
Willy Tarreau0011c252022-01-19 17:23:52 +0100935 /* payload doesn't take escapes nor does it end on semi-colons, so
936 * we use the regular getline. Normal mode however must stop on
937 * LFs and semi-colons that are not prefixed by a backslash. Note
938 * that we reserve one byte at the end to insert a trailing nul byte.
939 */
940
941 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200942 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100943 appctx->chunk->size - appctx->chunk->data - 1);
944 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200945 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100946 appctx->chunk->size - appctx->chunk->data - 1,
947 "\n;", '\\');
948
William Lallemand74c24fb2016-11-21 17:18:36 +0100949 if (reql <= 0) { /* closed or EOL not found */
950 if (reql == 0)
951 break;
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100952 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100953 continue;
954 }
955
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200956 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
957 /* seek for a possible unescaped semi-colon. If we find
958 * one, we replace it with an LF and skip only this part.
959 */
960 for (len = 0; len < reql; len++) {
961 if (str[len] == '\\') {
962 len++;
963 continue;
964 }
965 if (str[len] == ';') {
966 str[len] = '\n';
967 reql = len + 1;
968 break;
969 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100970 }
971 }
972
973 /* now it is time to check that we have a full line,
974 * remove the trailing \n and possibly \r, then cut the
975 * line.
976 */
977 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200978 if (str[len] != '\n') {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100979 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100980 continue;
981 }
982
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200983 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100984 len--;
985
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200986 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200987 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200988
989 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200990 appctx->chunk->area[appctx->chunk->data] = '\n';
991 appctx->chunk->area[appctx->chunk->data + 1] = 0;
992 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200993 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100994
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100995 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200996
997 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
998 /* empty line */
999 if (!len) {
1000 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001001 appctx->chunk->data -= 2;
1002 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001003 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001004 chunk_reset(appctx->chunk);
1005 /* NB: cli_sock_parse_request() may have put
1006 * another CLI_ST_O_* into appctx->st0.
1007 */
1008
1009 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001010 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001011 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001012 else {
1013 /*
1014 * Look for the "payload start" pattern at the end of a line
1015 * Its location is not remembered here, this is just to switch
1016 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001017 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001018 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001019 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001020 appctx->chunk->data++; // keep the trailing \0 after '<<'
1021 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001022 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001023 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001024 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001025 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001026 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001027 }
1028
1029 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001030 co_skip(sc_oc(sc), reql);
William Lallemand74c24fb2016-11-21 17:18:36 +01001031 req->flags |= CF_READ_DONTWAIT; /* we plan to read small requests */
1032 }
1033 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001034 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001035 const char *msg;
1036 int sev;
1037
William Lallemand74c24fb2016-11-21 17:18:36 +01001038 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001039 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001040 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001041 case CLI_ST_PRINT: /* print const message in msg */
1042 case CLI_ST_PRINT_ERR: /* print const error in msg */
1043 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001044 case CLI_ST_PRINT_DYNERR: /* print dyn error in err, free */
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001045 case CLI_ST_PRINT_UMSG: /* print usermsgs_ctx and reset it */
1046 case CLI_ST_PRINT_UMSGERR: /* print usermsgs_ctx as error and reset it */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001047 /* the message is in the svcctx */
1048 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001049 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1050 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001051 LOG_ERR : ctx->severity;
1052 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001053 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001054 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
1055 sev = appctx->st0 == CLI_ST_PRINT_DYNERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001056 LOG_ERR : ctx->severity;
1057 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001058 if (!msg) {
1059 sev = LOG_ERR;
1060 msg = "Out of memory.\n";
1061 }
1062 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001063 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1064 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1065 sev = appctx->st0 == CLI_ST_PRINT_UMSGERR ?
1066 LOG_ERR : ctx->severity;
1067 msg = usermsgs_str();
1068 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001069 else {
1070 sev = LOG_ERR;
1071 msg = "Internal error.\n";
1072 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001073
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001074 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001075 if (appctx->st0 == CLI_ST_PRINT_DYN ||
1076 appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001077 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001078 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001079 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1080 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1081 usermsgs_clr(NULL);
1082 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001083 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001084 }
1085 else
Willy Tarreau475e4632022-05-27 10:26:46 +02001086 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001087 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001088
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001089 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001090 if (appctx->io_handler)
1091 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001092 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001093 if (appctx->io_release) {
1094 appctx->io_release(appctx);
1095 appctx->io_release = NULL;
1096 }
1097 }
1098 break;
1099 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001100 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001101 break;
1102 }
1103
1104 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001105 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001106 const char *prompt = "";
1107
1108 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1109 /*
1110 * when entering a payload with interactive mode, change the prompt
1111 * to emphasize that more data can still be sent
1112 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001113 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001114 prompt = "+ ";
1115 else
1116 prompt = "\n> ";
1117 }
1118 else {
William Lallemandad032882019-07-01 10:56:15 +02001119 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001120 prompt = "\n";
1121 }
1122
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001123 if (applet_putstr(appctx, prompt) != -1) {
1124 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001125 appctx->st0 = CLI_ST_GETREQ;
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001126 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001127 }
1128
1129 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001130 if (appctx->st0 >= CLI_ST_OUTPUT) {
1131 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001132 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001133 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001134
1135 /* Now we close the output if one of the writers did so,
1136 * or if we're not in interactive mode and the request
1137 * buffer is empty. This still allows pipelined requests
1138 * to be sent in non-interactive mode.
1139 */
William Lallemand3de09d52018-12-11 16:10:56 +01001140 if (((res->flags & (CF_SHUTW|CF_SHUTW_NOW))) ||
1141 (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)))) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001142 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001143 continue;
1144 }
1145
1146 /* switch state back to GETREQ to read next requests */
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001147 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001148 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001149 applet_will_consume(appctx);
1150
William Lallemandad032882019-07-01 10:56:15 +02001151 /* reactivate the \n at the end of the response for the next command */
1152 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001153
1154 /* this forces us to yield between pipelined commands and
1155 * avoid extremely long latencies (e.g. "del map" etc). In
1156 * addition this increases the likelihood that the stream
1157 * refills the buffer with new bytes in non-interactive
1158 * mode, avoiding to close on apparently empty commands.
1159 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001160 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001161 appctx_wakeup(appctx);
1162 goto out;
1163 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001164 }
1165 }
1166
Willy Tarreau475e4632022-05-27 10:26:46 +02001167 if ((res->flags & CF_SHUTR) && (sc->state == SC_ST_EST)) {
1168 DPRINTF(stderr, "%s@%d: sc to buf closed. req=%08x, res=%08x, st=%d\n",
1169 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001170 /* Other side has closed, let's abort if we have no more processing to do
1171 * and nothing more to consume. This is comparable to a broken pipe, so
1172 * we forward the close to the request side so that it flows upstream to
1173 * the client.
1174 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001175 sc_shutw(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001176 }
1177
Willy Tarreau475e4632022-05-27 10:26:46 +02001178 if ((req->flags & CF_SHUTW) && (sc->state == SC_ST_EST) && (appctx->st0 < CLI_ST_OUTPUT)) {
1179 DPRINTF(stderr, "%s@%d: buf to sc closed. req=%08x, res=%08x, st=%d\n",
1180 __FUNCTION__, __LINE__, req->flags, res->flags, sc->state);
William Lallemand74c24fb2016-11-21 17:18:36 +01001181 /* We have no more processing to do, and nothing more to send, and
1182 * the client side has closed. So we'll forward this state downstream
1183 * on the response buffer.
1184 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001185 sc_shutr(sc);
Christopher Faulet6e1bbc42022-12-12 08:08:15 +01001186 res->flags |= CF_READ_EVENT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001187 }
1188
1189 out:
Christopher Faulet45073512018-07-20 10:16:29 +02001190 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 +01001191 __FUNCTION__, __LINE__,
Willy Tarreau475e4632022-05-27 10:26:46 +02001192 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 +01001193}
1194
Willy Tarreau4596fe22022-05-17 19:07:51 +02001195/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001196 * external abort, we won't call the i/o handler anymore so we may need to
1197 * remove back references to the stream currently being dumped.
1198 */
1199static void cli_release_handler(struct appctx *appctx)
1200{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001201 free_trash_chunk(appctx->chunk);
1202 appctx->chunk = NULL;
1203
William Lallemand74c24fb2016-11-21 17:18:36 +01001204 if (appctx->io_release) {
1205 appctx->io_release(appctx);
1206 appctx->io_release = NULL;
1207 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001208 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001209 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1210
1211 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001212 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001213 else if (appctx->st0 == CLI_ST_PRINT_UMSG || appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1214 usermsgs_clr(NULL);
1215 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001216}
1217
1218/* This function dumps all environmnent variables to the buffer. It returns 0
1219 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001220 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1221 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001222 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001223static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001224{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001225 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001226 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001227 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001228
Christopher Fauletda89e9b2023-01-04 14:11:10 +01001229 if (unlikely(sc_ic(sc)->flags & CF_SHUTW))
William Lallemand74c24fb2016-11-21 17:18:36 +01001230 return 1;
1231
1232 chunk_reset(&trash);
1233
1234 /* we have two inner loops here, one for the proxy, the other one for
1235 * the buffer.
1236 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001237 while (*var) {
1238 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001239
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001240 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001241 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001242
Willy Tarreau307dbb32022-05-05 17:45:52 +02001243 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001244 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001245 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001246 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001247 }
1248
1249 /* dump complete */
1250 return 1;
1251}
1252
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001253/* This function dumps all file descriptors states (or the requested one) to
1254 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001255 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1256 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1257 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001258 */
1259static int cli_io_handler_show_fd(struct appctx *appctx)
1260{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001261 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001262 struct show_fd_ctx *fdctx = appctx->svcctx;
1263 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001264 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001265
Christopher Fauletda89e9b2023-01-04 14:11:10 +01001266 if (unlikely(sc_ic(sc)->flags & CF_SHUTW))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001267 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001268
1269 chunk_reset(&trash);
1270
Willy Tarreauca1b1572018-12-18 15:45:11 +01001271 /* isolate the threads once per round. We're limited to a buffer worth
1272 * of output anyway, it cannot last very long.
1273 */
1274 thread_isolate();
1275
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001276 /* we have two inner loops here, one for the proxy, the other one for
1277 * the buffer.
1278 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001279 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001280 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001281 const struct listener *li = NULL;
1282 const struct server *sv = NULL;
1283 const struct proxy *px = NULL;
1284 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001285 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001286 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001287 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001288 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001289 uint32_t conn_flags = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001290 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001291 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001292
1293 fdt = fdtab[fd];
1294
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001295 /* When DEBUG_FD is set, we also report closed FDs that have a
1296 * non-null event count to detect stuck ones.
1297 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001298 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001299#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001300 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001301#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001302 goto skip; // closed
1303 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001304 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001305 conn = (const struct connection *)fdt.owner;
1306 conn_flags = conn->flags;
1307 mux = conn->mux;
1308 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001309 xprt = conn->xprt;
1310 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001311 li = objt_listener(conn->target);
1312 sv = objt_server(conn->target);
1313 px = objt_proxy(conn->target);
1314 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001315 if (atleast2(fdt.thread_mask))
1316 suspicious = 1;
1317 if (conn->handle.fd != fd)
1318 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001319 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001320 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001321 li = fdt.owner;
1322
Willy Tarreaudacfde42021-01-21 09:07:29 +01001323 if (!fdt.thread_mask)
1324 suspicious = 1;
1325
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001326 chunk_printf(&trash,
Willy Tarreauc2431822022-07-08 10:23:01 +02001327 " %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 +02001328 fd,
1329 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001330 (fdt.state & FD_CLONED) ? 'C' : 'c',
1331 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001332 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1333 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1334 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1335 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1336 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001337 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1338 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1339 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1340 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1341 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1342 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001343 (fdt.refc_tgid >> 4) & 0xffff,
1344 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001345 fdt.thread_mask, fdt.update_mask,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001346 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001347 fdt.iocb);
1348 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001349
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001350 if (!fdt.owner) {
1351 chunk_appendf(&trash, ")");
1352 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001353 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001354 chunk_appendf(&trash, ") back=%d cflg=0x%08x", is_back, conn_flags);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001355
1356 if (conn->handle.fd != fd) {
1357 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1358 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001359 } else {
1360 struct sockaddr_storage sa;
1361 socklen_t salen;
1362
1363 salen = sizeof(sa);
1364 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1365 if (sa.ss_family == AF_INET)
1366 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1367 else if (sa.ss_family == AF_INET6)
1368 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1369 else if (sa.ss_family == AF_UNIX)
1370 chunk_appendf(&trash, " fam=unix");
1371 }
1372
1373 salen = sizeof(sa);
1374 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1375 if (sa.ss_family == AF_INET)
1376 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1377 else if (sa.ss_family == AF_INET6)
1378 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1379 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001380 }
1381
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001382 if (px)
1383 chunk_appendf(&trash, " px=%s", px->id);
1384 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001385 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001386 else if (li)
1387 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001388
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001389 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001390 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001391 if (!ctx)
1392 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001393 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001394 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001395 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001396 else
1397 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001398
1399 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001400 if (xprt) {
1401 if (xprt_ctx || xprt->show_fd)
1402 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1403 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001404 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001405 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001406 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001407 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001408 struct sockaddr_storage sa;
1409 socklen_t salen;
1410
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001411 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001412 listener_state_str(li),
1413 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001414
1415 salen = sizeof(sa);
1416 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1417 if (sa.ss_family == AF_INET)
1418 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1419 else if (sa.ss_family == AF_INET6)
1420 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1421 else if (sa.ss_family == AF_UNIX)
1422 chunk_appendf(&trash, " fam=unix");
1423 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001424 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001425 else
1426 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001427
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001428#ifdef DEBUG_FD
1429 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001430 if (fdtab[fd].event_count >= 1000000)
1431 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001432#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001433 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001434
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001435 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001436 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001437 ret = 0;
1438 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001439 }
1440 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001441 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001442 break;
1443
1444 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001445 }
1446
Willy Tarreauca1b1572018-12-18 15:45:11 +01001447 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001448 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001449
1450 thread_release();
1451 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001452}
1453
William Lallemandeceddf72016-12-15 18:06:44 +01001454/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001455 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001456 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1457 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001458 */
1459static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1460{
Willy Tarreaub128f492022-05-05 19:11:05 +02001461 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1462 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001463
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001464 if (!global.cli_fe)
1465 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001466
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001467 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001468
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001469 if (!bind_conf) {
1470 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001471 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001472 goto full;
1473 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1474 }
William Lallemandeceddf72016-12-15 18:06:44 +01001475
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001476 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001477 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001478
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001479 if (!l)
1480 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001481
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001482 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1483 char addr[46];
1484 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001485
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001486 if (l->rx.addr.ss_family == AF_UNIX) {
1487 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001488
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001489 un = (struct sockaddr_un *)&l->rx.addr;
1490 if (un->sun_path[0] == '\0') {
1491 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1492 } else {
1493 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1494 }
1495 } else if (l->rx.addr.ss_family == AF_INET) {
1496 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1497 port_to_str(&l->rx.addr, port, sizeof(port));
1498 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1499 } else if (l->rx.addr.ss_family == AF_INET6) {
1500 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1501 port_to_str(&l->rx.addr, port, sizeof(port));
1502 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1503 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1504 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1505 } else
1506 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001507
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001508 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1509 chunk_appendf(&trash, "admin ");
1510 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1511 chunk_appendf(&trash, "operator ");
1512 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1513 chunk_appendf(&trash, "user ");
1514 else
1515 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001516
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001517 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001518
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001519 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001520 ctx->bind_conf = bind_conf;
1521 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001522 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001523 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001524 }
William Lallemandeceddf72016-12-15 18:06:44 +01001525 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001526 done:
1527 return 1;
1528 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001529 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001530}
1531
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001532
Willy Tarreau0a739292016-11-22 20:21:23 +01001533/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001534 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1535 * be dumped as well as a flag if a single variable is requested, otherwise puts
1536 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001537 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001538static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001539{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001540 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001541 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001542 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001543
1544 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1545 return 1;
1546
Willy Tarreauf6710f82016-12-16 17:45:44 +01001547 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001548
1549 if (*args[2]) {
1550 int len = strlen(args[2]);
1551
Willy Tarreauf6710f82016-12-16 17:45:44 +01001552 for (; *var; var++) {
1553 if (strncmp(*var, args[2], len) == 0 &&
1554 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001555 break;
1556 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001557 if (!*var)
1558 return cli_err(appctx, "Variable not found\n");
1559
Willy Tarreau307dbb32022-05-05 17:45:52 +02001560 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001561 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001562 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001563 return 0;
1564}
1565
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001566/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001567 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1568 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001569 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001570static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001571{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001572 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1573
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001574 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1575 return 1;
1576
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001577 if (*args[2]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001578 ctx->fd = atoi(args[2]);
1579 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001580 }
1581 return 0;
1582}
1583
Willy Tarreau599852e2016-11-22 20:33:32 +01001584/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001585static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001586{
Willy Tarreau0698c802022-05-11 14:09:57 +02001587 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001588
1589 if (strcmp(args[2], "cli") == 0) {
1590 unsigned timeout;
1591 const char *res;
1592
Willy Tarreau9d008692019-08-09 11:21:01 +02001593 if (!*args[3])
1594 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001595
1596 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001597 if (res || timeout < 1)
1598 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001599
1600 s->req.rto = s->res.wto = 1 + MS_TO_TICKS(timeout*1000);
1601 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1602 return 1;
1603 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001604
1605 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001606}
1607
Willy Tarreau2af99412016-11-23 11:10:59 +01001608/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001609static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001610{
1611 int v;
1612
1613 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1614 return 1;
1615
Willy Tarreau9d008692019-08-09 11:21:01 +02001616 if (!*args[3])
1617 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001618
1619 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001620 if (v > global.hardmaxconn)
1621 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001622
1623 /* check for unlimited values */
1624 if (v <= 0)
1625 v = global.hardmaxconn;
1626
1627 global.maxconn = v;
1628
1629 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001630 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001631
1632 return 1;
1633}
1634
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001635static int set_severity_output(int *target, char *argument)
1636{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001637 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001638 *target = CLI_SEVERITY_NONE;
1639 return 1;
1640 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001641 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001642 *target = CLI_SEVERITY_NUMBER;
1643 return 1;
1644 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001645 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001646 *target = CLI_SEVERITY_STRING;
1647 return 1;
1648 }
1649 return 0;
1650}
1651
1652/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001653static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001654{
1655 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1656 return 0;
1657
Willy Tarreau9d008692019-08-09 11:21:01 +02001658 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001659}
William Lallemandeceddf72016-12-15 18:06:44 +01001660
William Lallemand67a234f2018-12-13 09:05:45 +01001661
1662/* show the level of the current CLI session */
1663static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1664{
William Lallemand67a234f2018-12-13 09:05:45 +01001665 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001666 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001667 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001668 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001669 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001670 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001671 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001672 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001673}
1674
1675/* parse and set the CLI level dynamically */
1676static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1677{
William Lallemandad032882019-07-01 10:56:15 +02001678 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001679 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001680 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1681
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001682 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001683 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1684 return 1;
1685 }
1686 appctx->cli_level &= ~ACCESS_LVL_MASK;
1687 appctx->cli_level |= ACCESS_LVL_OPER;
1688
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001689 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001690 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1691 return 1;
1692 }
1693 appctx->cli_level &= ~ACCESS_LVL_MASK;
1694 appctx->cli_level |= ACCESS_LVL_USER;
1695 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001696 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001697 return 1;
1698}
1699
1700
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001701/* parse and set the CLI expert/experimental-mode dynamically */
1702static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001703{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001704 int level;
1705 char *level_str;
1706 char *output = NULL;
1707
William Lallemand7267f782022-02-01 16:08:50 +01001708 /* this will ask the applet to not output a \n after the command */
1709 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1710 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1711
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001712 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1713 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001714
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001715 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001716 level = ACCESS_EXPERT;
1717 level_str = "expert-mode";
1718 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001719 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001720 level = ACCESS_EXPERIMENTAL;
1721 level_str = "experimental-mode";
1722 }
William Lallemand2a171912022-02-02 11:43:20 +01001723 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1724 level = ACCESS_MCLI_DEBUG;
1725 level_str = "mcli-debug-mode";
1726 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001727 else {
1728 return 1;
1729 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001730
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001731 if (!*args[1]) {
1732 memprintf(&output, "%s is %s\n", level_str,
1733 (appctx->cli_level & level) ? "ON" : "OFF");
1734 return cli_dynmsg(appctx, LOG_INFO, output);
1735 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001736
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001737 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001738 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001739 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001740 return 1;
1741}
1742
William Lallemand740629e2021-12-14 15:22:29 +01001743/* shows HAProxy version */
1744static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1745{
1746 char *msg = NULL;
1747
1748 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1749}
1750
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001751int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001752{
1753 return 0;
1754}
1755
Erwan Le Goas54966df2022-09-14 17:24:22 +02001756/* enable or disable the anonymized mode, it returns 1 when it works or displays an error message if it doesn't. */
1757static int cli_parse_set_anon(char **args, char *payload, struct appctx *appctx, void *private)
1758{
1759 uint32_t tmp;
1760 long long key;
1761
1762 if (strcmp(args[2], "on") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001763
1764 if (*args[3]) {
1765 key = atoll(args[3]);
1766 if (key < 1 || key > UINT_MAX)
1767 return cli_err(appctx, "Value out of range (1 to 4294967295 expected).\n");
1768 appctx->cli_anon_key = key;
1769 }
Erwan Le Goas54966df2022-09-14 17:24:22 +02001770 else {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001771 tmp = HA_ATOMIC_LOAD(&global.anon_key);
1772 if (tmp != 0)
1773 appctx->cli_anon_key = tmp;
1774 else
1775 appctx->cli_anon_key = ha_random32();
Erwan Le Goas54966df2022-09-14 17:24:22 +02001776 }
1777 }
1778 else if (strcmp(args[2], "off") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001779
1780 if (*args[3]) {
Erwan Le Goas54966df2022-09-14 17:24:22 +02001781 return cli_err(appctx, "Key can't be added while disabling anonymized mode\n");
1782 }
1783 else {
1784 appctx->cli_anon_key = 0;
1785 }
1786 }
1787 else {
1788 return cli_err(appctx,
1789 "'set anon' only supports :\n"
1790 " - 'on' [key] to enable the anonymized mode\n"
1791 " - 'off' to disable the anonymized mode");
1792 }
1793 return 1;
1794}
1795
Erwan Le Goasfad9da82022-09-14 17:24:22 +02001796/* This function set the global anonyzing key, restricted to level 'admin' */
1797static int cli_parse_set_global_key(char **args, char *payload, struct appctx *appctx, void *private)
1798{
1799 long long key;
1800
1801 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1802 return cli_err(appctx, "Permission denied\n");
1803 if (!*args[2])
1804 return cli_err(appctx, "Expects an integer value.\n");
1805
1806 key = atoll(args[2]);
1807 if (key < 0 || key > UINT_MAX)
1808 return cli_err(appctx, "Value out of range (0 to 4294967295 expected).\n");
1809
1810 HA_ATOMIC_STORE(&global.anon_key, key);
1811 return 1;
1812}
1813
Erwan Le Goas54966df2022-09-14 17:24:22 +02001814/* shows the anonymized mode state to everyone, and the key except for users, it always returns 1. */
1815static int cli_parse_show_anon(char **args, char *payload, struct appctx *appctx, void *private)
1816{
1817 char *msg = NULL;
1818 char *anon_mode = NULL;
1819 uint32_t c_key = appctx->cli_anon_key;
1820
1821 if (!c_key)
1822 anon_mode = "Anonymized mode disabled";
1823 else
1824 anon_mode = "Anonymized mode enabled";
1825
1826 if ( !((appctx->cli_level & ACCESS_LVL_MASK) < ACCESS_LVL_OPER) && c_key != 0) {
1827 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\nKey : %u\n", anon_mode, c_key));
1828 }
1829 else {
1830 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", anon_mode));
1831 }
1832
1833 return 1;
1834}
1835
Willy Tarreau45c742b2016-11-24 14:51:17 +01001836/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001837static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001838{
1839 int v;
1840 int *res;
1841 int mul = 1;
1842
1843 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1844 return 1;
1845
1846 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1847 res = &global.cps_lim;
1848 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1849 res = &global.sps_lim;
1850#ifdef USE_OPENSSL
1851 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1852 res = &global.ssl_lim;
1853#endif
1854 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1855 res = &global.comp_rate_lim;
1856 mul = 1024;
1857 }
1858 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001859 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001860 "'set rate-limit' only supports :\n"
1861 " - 'connections global' to set the per-process maximum connection rate\n"
1862 " - 'sessions global' to set the per-process maximum session rate\n"
1863#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001864 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001865#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001866 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001867 }
1868
Willy Tarreau9d008692019-08-09 11:21:01 +02001869 if (!*args[4])
1870 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001871
1872 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001873 if (v < 0)
1874 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001875
1876 *res = v * mul;
1877
1878 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001879 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001880
1881 return 1;
1882}
1883
William Lallemandf6975e92017-05-26 17:42:10 +02001884/* parse the "expose-fd" argument on the bind lines */
1885static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1886{
1887 if (!*args[cur_arg + 1]) {
1888 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1889 return ERR_ALERT | ERR_FATAL;
1890 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001891 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001892 conf->level |= ACCESS_FD_LISTENERS;
1893 } else {
1894 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1895 args[cur_arg], args[cur_arg+1]);
1896 return ERR_ALERT | ERR_FATAL;
1897 }
1898
1899 return 0;
1900}
1901
William Lallemand74c24fb2016-11-21 17:18:36 +01001902/* parse the "level" argument on the bind lines */
1903static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1904{
1905 if (!*args[cur_arg + 1]) {
1906 memprintf(err, "'%s' : missing level", args[cur_arg]);
1907 return ERR_ALERT | ERR_FATAL;
1908 }
1909
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001910 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001911 conf->level &= ~ACCESS_LVL_MASK;
1912 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001913 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001914 conf->level &= ~ACCESS_LVL_MASK;
1915 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001916 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001917 conf->level &= ~ACCESS_LVL_MASK;
1918 conf->level |= ACCESS_LVL_ADMIN;
1919 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001920 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1921 args[cur_arg], args[cur_arg+1]);
1922 return ERR_ALERT | ERR_FATAL;
1923 }
1924
1925 return 0;
1926}
1927
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001928static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1929{
1930 if (!*args[cur_arg + 1]) {
1931 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1932 return ERR_ALERT | ERR_FATAL;
1933 }
1934
1935 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1936 return 0;
1937 else {
1938 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1939 args[cur_arg], args[cur_arg+1]);
1940 return ERR_ALERT | ERR_FATAL;
1941 }
1942}
1943
Olivier Houchardf886e342017-04-05 22:24:59 +02001944/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001945static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001946{
William Lallemandb5d062d2022-07-28 15:33:41 +02001947 static int already_sent = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001948 char *cmsgbuf = NULL;
1949 unsigned char *tmpbuf = NULL;
1950 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001951 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02001952 struct stream *s = __sc_strm(sc);
1953 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02001954 struct msghdr msghdr;
1955 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001956 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001957 const char *ns_name, *if_name;
1958 unsigned char ns_nlen, if_nlen;
1959 int nb_queued;
1960 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001961 int *tmpfd;
1962 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001963 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001964 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001965 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02001966 int ret;
1967
Willy Tarreauc2b7f802018-09-20 11:22:29 +02001968 if (!remote) {
1969 ha_warning("Only works on real connections\n");
1970 goto out;
1971 }
1972
1973 fd = remote->handle.fd;
1974
Olivier Houchardf886e342017-04-05 22:24:59 +02001975 /* Temporary set the FD in blocking mode, that will make our life easier */
1976 old_fcntl = fcntl(fd, F_GETFL);
1977 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001978 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001979 goto out;
1980 }
1981 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
1982 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001983 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001984 goto out;
1985 }
1986 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001987 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02001988 goto out;
1989 }
Olivier Houchard54740872017-04-06 14:45:14 +02001990 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02001991 iov.iov_base = &tot_fd_nb;
1992 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02001993 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02001994 goto out;
1995 memset(&msghdr, 0, sizeof(msghdr));
1996 /*
1997 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05001998 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02001999 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002000 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002001 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002002
William Lallemandb5d062d2022-07-28 15:33:41 +02002003 if (tot_fd_nb == 0) {
2004 if (already_sent)
2005 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 +02002006 goto out;
William Lallemandb5d062d2022-07-28 15:33:41 +02002007 }
Olivier Houchardf886e342017-04-05 22:24:59 +02002008
2009 /* First send the total number of file descriptors, so that the
2010 * receiving end knows what to expect.
2011 */
2012 msghdr.msg_iov = &iov;
2013 msghdr.msg_iovlen = 1;
2014 ret = sendmsg(fd, &msghdr, 0);
2015 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002016 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002017 goto out;
2018 }
2019
2020 /* Now send the fds */
2021 msghdr.msg_control = cmsgbuf;
2022 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2023 cmsg = CMSG_FIRSTHDR(&msghdr);
2024 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2025 cmsg->cmsg_level = SOL_SOCKET;
2026 cmsg->cmsg_type = SCM_RIGHTS;
2027 tmpfd = (int *)CMSG_DATA(cmsg);
2028
Olivier Houchardf886e342017-04-05 22:24:59 +02002029 /* For each socket, e message is sent, containing the following :
2030 * Size of the namespace name (or 0 if none), as an unsigned char.
2031 * The namespace name, if any
2032 * Size of the interface name (or 0 if none), as an unsigned char
2033 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002034 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002035 */
2036 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002037 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002038 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002039 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002040 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002041 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002042 goto out;
2043 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002044
2045 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002046 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002047 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002048 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002049 continue;
2050
2051 ns_name = if_name = "";
2052 ns_nlen = if_nlen = 0;
2053
2054 /* for now we can only retrieve namespaces and interfaces from
2055 * pure listeners.
2056 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002057 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002058 const struct listener *l = fdtab[cur_fd].owner;
2059
Willy Tarreau818a92e2020-09-03 07:50:19 +02002060 if (l->rx.settings->interface) {
2061 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002062 if_nlen = strlen(if_name);
2063 }
2064
2065#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002066 if (l->rx.settings->netns) {
2067 ns_name = l->rx.settings->netns->node.key;
2068 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002069 }
2070#endif
2071 }
2072
2073 /* put the FD into the CMSG_DATA */
2074 tmpfd[nb_queued++] = cur_fd;
2075
2076 /* first block is <ns_name_len> <ns_name> */
2077 tmpbuf[curoff++] = ns_nlen;
2078 if (ns_nlen)
2079 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2080 curoff += ns_nlen;
2081
2082 /* second block is <if_name_len> <if_name> */
2083 tmpbuf[curoff++] = if_nlen;
2084 if (if_nlen)
2085 memcpy(tmpbuf + curoff, if_name, if_nlen);
2086 curoff += if_nlen;
2087
2088 /* we used to send the listener options here before 2.3 */
2089 memset(tmpbuf + curoff, 0, sizeof(int));
2090 curoff += sizeof(int);
2091
2092 /* there's a limit to how many FDs may be sent at once */
2093 if (nb_queued == MAX_SEND_FD) {
2094 iov.iov_len = curoff;
2095 if (sendmsg(fd, &msghdr, 0) != curoff) {
2096 ha_warning("Failed to transfer sockets\n");
2097 return -1;
2098 }
2099
2100 /* Wait for an ack */
2101 do {
2102 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2103 } while (ret == -1 && errno == EINTR);
2104
2105 if (ret <= 0) {
2106 ha_warning("Unexpected error while transferring sockets\n");
2107 return -1;
2108 }
2109 curoff = 0;
2110 nb_queued = 0;
2111 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002112 }
2113
William Lallemandb5d062d2022-07-28 15:33:41 +02002114 already_sent = 1;
2115
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002116 /* flush pending stuff */
2117 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002118 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002119 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2120 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002121 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002122 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002123 goto out;
2124 }
2125 }
2126
2127out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002128 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002129 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002130 goto out;
2131 }
2132 appctx->st0 = CLI_ST_END;
2133 free(cmsgbuf);
2134 free(tmpbuf);
2135 return 1;
2136}
2137
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002138static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2139{
2140 if (*args[0] == 'h')
2141 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002142 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002143 else if (*args[0] == 'p')
2144 /* prompt */
2145 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
2146 else if (*args[0] == 'q')
2147 /* quit */
2148 appctx->st0 = CLI_ST_END;
2149
2150 return 1;
2151}
Olivier Houchardf886e342017-04-05 22:24:59 +02002152
William Lallemand2f4ce202018-10-26 14:47:47 +02002153void pcli_write_prompt(struct stream *s)
2154{
2155 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002156 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002157
William Lallemanddc12c2e2018-12-13 09:05:46 +01002158 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002159 return;
2160
William Lallemanddc12c2e2018-12-13 09:05:46 +01002161 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002162 chunk_appendf(msg, "+ ");
2163 } else {
2164 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002165 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002166 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002167 else
William Lallemanddae12c72022-02-02 14:13:54 +01002168 chunk_appendf(msg, "%d", s->pcli_next_pid);
2169
2170 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2171 chunk_appendf(msg, "(");
2172
2173 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2174 chunk_appendf(msg, "x");
2175
2176 if (s->pcli_flags & ACCESS_EXPERT)
2177 chunk_appendf(msg, "e");
2178
2179 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2180 chunk_appendf(msg, "d");
2181
2182 chunk_appendf(msg, ")");
2183 }
2184
2185 chunk_appendf(msg, "> ");
2186
2187
William Lallemandebf61802018-12-11 16:10:57 +01002188 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002189 co_inject(oc, msg->area, msg->data);
2190}
2191
William Lallemand291810d2018-10-26 14:47:38 +02002192
William Lallemandcf62f7e2018-10-26 14:47:40 +02002193/* The pcli_* functions are used for the CLI proxy in the master */
2194
William Lallemanddeeaa592018-10-26 14:47:48 +02002195void pcli_reply_and_close(struct stream *s, const char *msg)
2196{
2197 struct buffer *buf = get_trash_chunk();
2198
2199 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002200 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002201}
2202
William Lallemand291810d2018-10-26 14:47:38 +02002203static enum obj_type *pcli_pid_to_server(int proc_pid)
2204{
2205 struct mworker_proc *child;
2206
William Lallemand99e0bb92020-11-05 10:28:53 +01002207 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002208 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002209 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002210
William Lallemand291810d2018-10-26 14:47:38 +02002211 list_for_each_entry(child, &proc_list, list) {
2212 if (child->pid == proc_pid){
2213 return &child->srv->obj_type;
2214 }
2215 }
2216 return NULL;
2217}
2218
2219/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2220 * Return:
2221 * 0: master
2222 * > 0: pid of a worker
2223 * < 0: didn't find a worker
2224 */
2225static int pcli_prefix_to_pid(const char *prefix)
2226{
2227 int proc_pid;
2228 struct mworker_proc *child;
2229 char *errtol = NULL;
2230
2231 if (*prefix != '@') /* not a prefix, should not happen */
2232 return -1;
2233
2234 prefix++;
2235 if (!*prefix) /* sent @ alone, return the master */
2236 return 0;
2237
2238 if (strcmp("master", prefix) == 0) {
2239 return 0;
2240 } else if (*prefix == '!') {
2241 prefix++;
2242 if (!*prefix)
2243 return -1;
2244
2245 proc_pid = strtol(prefix, &errtol, 10);
2246 if (*errtol != '\0')
2247 return -1;
2248 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002249 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002250 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002251 if (child->pid == proc_pid){
2252 return child->pid;
2253 }
2254 }
2255 } else {
2256 struct mworker_proc *chosen = NULL;
2257 /* this is a relative pid */
2258
2259 proc_pid = strtol(prefix, &errtol, 10);
2260 if (*errtol != '\0')
2261 return -1;
2262
2263 if (proc_pid == 0) /* return the master */
2264 return 0;
2265
William Lallemandbac3a822022-07-20 14:30:56 +02002266 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2267 return -1;
2268
William Lallemand291810d2018-10-26 14:47:38 +02002269 /* chose the right process, the current one is the one with the
2270 least number of reloads */
2271 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002272 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002273 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002274 if (child->reloads == 0)
2275 return child->pid;
2276 else if (chosen == NULL || child->reloads < chosen->reloads)
2277 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002278 }
2279 if (chosen)
2280 return chosen->pid;
2281 }
2282 return -1;
2283}
2284
William Lallemandbddd33a2018-12-11 16:10:53 +01002285/* Return::
2286 * >= 0 : number of words to escape
2287 * = -1 : error
2288 */
2289
2290int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2291{
2292 if (argl < 1)
2293 return 0;
2294
2295 /* there is a prefix */
2296 if (args[0][0] == '@') {
2297 int target_pid = pcli_prefix_to_pid(args[0]);
2298
2299 if (target_pid == -1) {
2300 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2301 return -1;
2302 }
2303
2304 /* if the prefix is alone, define a default target */
2305 if (argl == 1)
2306 s->pcli_next_pid = target_pid;
2307 else
2308 *next_pid = target_pid;
2309 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002310 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002311 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002312 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002313
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002314 } else if (strcmp("quit", args[0]) == 0) {
William Lallemand5f610682018-12-11 16:10:55 +01002315 channel_shutr_now(&s->req);
2316 channel_shutw_now(&s->res);
2317 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002318 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002319 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2320 memprintf(errmsg, "Permission denied!\n");
2321 return -1;
2322 }
2323 s->pcli_flags &= ~ACCESS_LVL_MASK;
2324 s->pcli_flags |= ACCESS_LVL_OPER;
2325 return argl;
2326
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002327 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002328 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2329 memprintf(errmsg, "Permission denied!\n");
2330 return -1;
2331 }
2332 s->pcli_flags &= ~ACCESS_LVL_MASK;
2333 s->pcli_flags |= ACCESS_LVL_USER;
2334 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002335
2336 } else if (strcmp(args[0], "expert-mode") == 0) {
2337 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2338 memprintf(errmsg, "Permission denied!\n");
2339 return -1;
2340 }
2341
2342 s->pcli_flags &= ~ACCESS_EXPERT;
2343 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2344 s->pcli_flags |= ACCESS_EXPERT;
2345 return argl;
2346
2347 } else if (strcmp(args[0], "experimental-mode") == 0) {
2348 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2349 memprintf(errmsg, "Permission denied!\n");
2350 return -1;
2351 }
2352 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2353 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2354 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2355 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002356 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2357 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2358 memprintf(errmsg, "Permission denied!\n");
2359 return -1;
2360 }
2361 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2362 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2363 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2364 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002365 }
2366
2367 return 0;
2368}
2369
2370/*
2371 * Parse the CLI request:
2372 * - It does basically the same as the cli_io_handler, but as a proxy
2373 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002374 *
2375 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002376 * - the number of characters to forward or
2377 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002378 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002379int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002380{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002381 char *str;
2382 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002383 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002384 int argl; /* number of args */
2385 char *p;
2386 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002387 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002388 int wtrim = 0; /* number of words to trim */
2389 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002390 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002391 int i = 0;
2392
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002393 /* we cannot deal with a wrapping buffer, so let's take care of this
2394 * first.
2395 */
2396 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2397 b_slow_realign(&req->buf, trash.area, co_data(req));
2398
2399 str = (char *)ci_head(req);
2400 end = (char *)ci_stop(req);
2401
William Lallemandbddd33a2018-12-11 16:10:53 +01002402 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002403
William Lallemanddc12c2e2018-12-13 09:05:46 +01002404 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002405
2406 /* Looks for the end of one command */
2407 while (p+reql < end) {
2408 /* handle escaping */
2409 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002410 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002411 continue;
2412 }
2413 if (p[reql] == ';' || p[reql] == '\n') {
2414 /* found the end of the command */
2415 p[reql] = '\n';
2416 reql++;
2417 break;
2418 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002419 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002420 }
William Lallemandebf61802018-12-11 16:10:57 +01002421 } else {
2422 while (p+reql < end) {
2423 if (p[reql] == '\n') {
2424 /* found the end of the line */
2425 reql++;
2426 break;
2427 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002428 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002429 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002430 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002431
William Lallemandbddd33a2018-12-11 16:10:53 +01002432 /* set end to first byte after the end of the command */
2433 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002434
William Lallemandbddd33a2018-12-11 16:10:53 +01002435 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002436 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002437 return -1;
2438 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002439
William Lallemand3301f3e2018-12-13 09:05:48 +01002440 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2441 if (reql == 1) /* last line of the payload */
2442 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002443 return reql;
2444 }
2445
William Lallemandbddd33a2018-12-11 16:10:53 +01002446 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002447
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002449 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002450 /* skip leading spaces/tabs */
2451 p += strspn(p, " \t");
2452 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002453 break;
2454
William Lallemandbddd33a2018-12-11 16:10:53 +01002455 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002456 while (1) {
2457 p += strcspn(p, " \t\\");
2458 /* escaped chars using backlashes (\) */
2459 if (*p == '\\') {
2460 if (!*++p)
2461 break;
2462 if (!*++p)
2463 break;
2464 } else {
2465 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002466 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002467 }
William Lallemandfe249c32020-06-18 18:03:57 +02002468 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002469 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002470 }
2471
William Lallemandbddd33a2018-12-11 16:10:53 +01002472 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002473
Willy Tarreauf14c7572021-03-13 10:59:23 +01002474 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002475 args[i] = NULL;
2476
2477 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2478
2479 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002480 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002481 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002482 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002483 if (*p == '\0')
2484 *p = ' ';
2485 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002486 }
2487
William Lallemand3301f3e2018-12-13 09:05:48 +01002488 payload = strstr(str, PAYLOAD_PATTERN);
2489 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2490 /* if the payload pattern is at the end */
2491 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002492 }
2493
William Lallemandbddd33a2018-12-11 16:10:53 +01002494 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002495
William Lallemandbddd33a2018-12-11 16:10:53 +01002496 if (wtrim > 0) {
2497 trim = &args[wtrim][0];
2498 if (trim == NULL) /* if this was the last word in the table */
2499 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002500
William Lallemandbddd33a2018-12-11 16:10:53 +01002501 b_del(&req->buf, trim - str);
2502
William Lallemandb7ea1412018-12-13 09:05:47 +01002503 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002504 } else if (wtrim < 0) {
2505 /* parsing error */
2506 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002507 } else {
2508 /* the whole string */
2509 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002510 }
2511
William Lallemandb7ea1412018-12-13 09:05:47 +01002512 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002513
2514 /* the mcli-debug-mode is only sent to the applet of the master */
2515 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2516 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2517 ret += strlen("mcli-debug-mode on -") + 2;
2518 }
William Lallemand7267f782022-02-01 16:08:50 +01002519 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2520 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2521 ret += strlen("experimental-mode on -") + 2;
2522 }
2523 if (s->pcli_flags & ACCESS_EXPERT) {
2524 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2525 ret += strlen("expert-mode on -") + 2;
2526 }
2527
William Lallemandb7ea1412018-12-13 09:05:47 +01002528 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2529 goto end;
2530 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002531 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2532 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002533 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002534 ci_insert_line2(req, 0, "user -", strlen("user -"));
2535 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002536 }
2537 }
2538end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002539
William Lallemandb7ea1412018-12-13 09:05:47 +01002540 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002541}
2542
2543int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2544{
William Lallemandbddd33a2018-12-11 16:10:53 +01002545 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002546 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002547 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002548
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002549 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002550 * current one. Just wait. At this stage, errors should be handled by
2551 * the response analyzer.
2552 */
2553 if (s->res.analysers & AN_RES_WAIT_CLI)
2554 return 0;
2555
William Lallemandb7ea1412018-12-13 09:05:47 +01002556 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2557 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2558
William Lallemand0a0512f2022-09-24 16:14:50 +02002559 /* stream that comes from the reload listener only responses the reload
2560 * status and quits */
2561 if (!(s->pcli_flags & PCLI_F_RELOAD)
2562 && strm_li(s)->bind_conf == mcli_reload_bind_conf)
2563 goto send_status;
2564
2565
William Lallemandcf62f7e2018-10-26 14:47:40 +02002566read_again:
2567 /* if the channel is closed for read, we won't receive any more data
2568 from the client, but we don't want to forward this close to the
2569 server */
2570 channel_dont_close(req);
2571
2572 /* We don't know yet to which server we will connect */
2573 channel_dont_connect(req);
2574
William Lallemandcf62f7e2018-10-26 14:47:40 +02002575 req->flags |= CF_READ_DONTWAIT;
2576
2577 /* need more data */
2578 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002579 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002580
2581 /* If there is data available for analysis, log the end of the idle time. */
2582 if (c_data(req) && s->logs.t_idle == -1)
2583 s->logs.t_idle = tv_ms_elapsed(&s->logs.tv_accept, &now) - s->logs.t_handshake;
2584
William Lallemandbddd33a2018-12-11 16:10:53 +01002585 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002586 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002587 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002588 /* enough data */
2589
William Lallemandcf62f7e2018-10-26 14:47:40 +02002590 /* forward only 1 command */
2591 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002592
William Lallemanddc12c2e2018-12-13 09:05:46 +01002593 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002594 /* we send only 1 command per request, and we write close after it */
2595 channel_shutw_now(req);
2596 } else {
2597 pcli_write_prompt(s);
2598 }
2599
2600 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002601 s->res.analysers |= AN_RES_WAIT_CLI;
2602
William Lallemandebf61802018-12-11 16:10:57 +01002603 if (!(s->flags & SF_ASSIGNED)) {
2604 if (next_pid > -1)
2605 target_pid = next_pid;
2606 else
2607 target_pid = s->pcli_next_pid;
2608 /* we can connect now */
2609 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002610
William Lallemanddcbe7b92021-12-10 14:14:53 +01002611 if (!s->target)
2612 goto server_disconnect;
2613
William Lallemandebf61802018-12-11 16:10:57 +01002614 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2615 channel_auto_connect(req);
2616 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002617
2618 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002619 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002620 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002621 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002622 } else if (to_forward == -1) {
2623 if (errmsg) {
2624 /* there was an error during the parsing */
2625 pcli_reply_and_close(s, errmsg);
2626 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2627 return 0;
2628 }
2629 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002630 }
2631
2632 return 0;
2633
2634send_help:
2635 b_reset(&req->buf);
2636 b_putblk(&req->buf, "help\n", 5);
2637 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002638
William Lallemand0a0512f2022-09-24 16:14:50 +02002639send_status:
2640 s->pcli_flags |= PCLI_F_RELOAD;
2641 /* dont' use ci_putblk here because SHUTW could have been sent */
2642 b_reset(&req->buf);
2643 b_putblk(&req->buf, "_loadstatus;quit\n", 17);
2644 goto read_again;
2645
Christopher Faulet0f727da2022-01-18 08:44:23 +01002646missing_data:
2647 if (req->flags & CF_SHUTR) {
2648 /* There is no more request or a only a partial one and we
2649 * receive a close from the client, we can leave */
2650 channel_shutw_now(&s->res);
2651 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2652 return 1;
2653 }
2654 else if (channel_full(req, global.tune.maxrewrite)) {
2655 /* buffer is full and we didn't catch the end of a command */
2656 goto send_help;
2657 }
2658 return 0;
2659
William Lallemanddcbe7b92021-12-10 14:14:53 +01002660server_disconnect:
2661 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2662 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002663}
2664
2665int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2666{
2667 struct proxy *fe = strm_fe(s);
2668 struct proxy *be = s->be;
2669
Christopher Faulete8cefac2022-03-07 18:20:21 +01002670 if ((rep->flags & (CF_READ_ERROR|CF_READ_TIMEOUT|CF_WRITE_ERROR|CF_WRITE_TIMEOUT)) ||
2671 ((rep->flags & CF_SHUTW) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002672 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002673 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002674 s->res.analysers &= ~AN_RES_WAIT_CLI;
2675 return 0;
2676 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002677 rep->flags |= CF_READ_DONTWAIT; /* try to get back here ASAP */
2678 rep->flags |= CF_NEVER_WAIT;
2679
2680 /* don't forward the close */
2681 channel_dont_close(&s->res);
2682 channel_dont_close(&s->req);
2683
William Lallemanddc12c2e2018-12-13 09:05:46 +01002684 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002685 s->res.analysers &= ~AN_RES_WAIT_CLI;
2686 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2687 return 0;
2688 }
2689
William Lallemandcf62f7e2018-10-26 14:47:40 +02002690 /* forward the data */
2691 if (ci_data(rep)) {
2692 c_adv(rep, ci_data(rep));
2693 return 0;
2694 }
2695
Christopher Faulet446d8032022-12-12 07:53:18 +01002696 if (rep->flags & CF_SHUTR) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002697 /* stream cleanup */
2698
William Lallemand2f4ce202018-10-26 14:47:47 +02002699 pcli_write_prompt(s);
2700
Willy Tarreaucb041662022-05-17 19:44:42 +02002701 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Willy Tarreauf61dd192022-05-27 09:00:19 +02002702 sc_shutr(s->scb);
2703 sc_shutw(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002704
2705 /*
2706 * starting from there this the same code as
2707 * http_end_txn_clean_session().
2708 *
2709 * It allows to do frontend keepalive while reconnecting to a
2710 * new server for each request.
2711 */
2712
2713 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002714 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002715 if (unlikely(s->srv_conn))
2716 sess_change_server(s, NULL);
2717 }
2718
2719 s->logs.t_close = tv_ms_elapsed(&s->logs.tv_accept, &now);
2720 stream_process_counters(s);
2721
2722 /* don't count other requests' data */
2723 s->logs.bytes_in -= ci_data(&s->req);
2724 s->logs.bytes_out -= ci_data(&s->res);
2725
2726 /* we may need to know the position in the queue */
2727 pendconn_free(s);
2728
2729 /* let's do a final log if we need it */
2730 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2731 !(s->flags & SF_MONITOR) &&
2732 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2733 s->do_log(s);
2734 }
2735
2736 /* stop tracking content-based counters */
2737 stream_stop_content_counters(s);
2738 stream_update_time_stats(s);
2739
2740 s->logs.accept_date = date; /* user-visible date for logging */
2741 s->logs.tv_accept = now; /* corrected date for internal use */
2742 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2743 s->logs.t_idle = -1;
2744 tv_zero(&s->logs.tv_request);
2745 s->logs.t_queue = -1;
2746 s->logs.t_connect = -1;
2747 s->logs.t_data = -1;
2748 s->logs.t_close = 0;
2749 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2750 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2751
2752 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2753 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2754
2755 stream_del_srv_conn(s);
2756 if (objt_server(s->target)) {
2757 if (s->flags & SF_CURR_SESS) {
2758 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002759 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002760 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002761 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002762 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002763 }
2764
2765 s->target = NULL;
2766
2767 /* only release our endpoint if we don't intend to reuse the
2768 * connection.
2769 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002770 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002771 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002772 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002773 if (!s->conn_err_type)
2774 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002775 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002776 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002777 return 1;
2778 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002779 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002780 }
2781
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002782 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002783
Willy Tarreau74568cf2022-05-27 09:03:30 +02002784 sc_set_state(s->scb, SC_ST_INI);
Willy Tarreaucb041662022-05-17 19:44:42 +02002785 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 +02002786 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 +01002787 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 +02002788 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002789 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2790 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002791 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002792 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002793 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002794 /* reinitialise the current rule list pointer to NULL. We are sure that
2795 * any rulelist match the NULL pointer.
2796 */
2797 s->current_rule_list = NULL;
2798
2799 s->be = strm_fe(s);
2800 s->logs.logwait = strm_fe(s)->to_log;
2801 s->logs.level = 0;
2802 stream_del_srv_conn(s);
2803 s->target = NULL;
2804 /* re-init store persistence */
2805 s->store_count = 0;
2806 s->uniq_id = global.req_count++;
2807
2808 s->req.flags |= CF_READ_DONTWAIT; /* one read is usually enough */
2809
2810 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2811
William Lallemandcf62f7e2018-10-26 14:47:40 +02002812 s->res.analysers &= ~AN_RES_WAIT_CLI;
2813
2814 /* We must trim any excess data from the response buffer, because we
2815 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002816 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002817 * we want those data to come along with next response. A typical
2818 * example of such data would be from a buggy server responding to
2819 * a HEAD with some data, or sending more than the advertised
2820 * content-length.
2821 */
2822 if (unlikely(ci_data(&s->res)))
2823 b_set_data(&s->res.buf, co_data(&s->res));
2824
2825 /* Now we can realign the response buffer */
2826 c_realign_if_empty(&s->res);
2827
2828 s->req.rto = strm_fe(s)->timeout.client;
2829 s->req.wto = TICK_ETERNITY;
2830
2831 s->res.rto = TICK_ETERNITY;
2832 s->res.wto = strm_fe(s)->timeout.client;
2833
2834 s->req.rex = TICK_ETERNITY;
2835 s->req.wex = TICK_ETERNITY;
2836 s->req.analyse_exp = TICK_ETERNITY;
2837 s->res.rex = TICK_ETERNITY;
2838 s->res.wex = TICK_ETERNITY;
2839 s->res.analyse_exp = TICK_ETERNITY;
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002840 s->scb->hcto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002841
2842 /* we're removing the analysers, we MUST re-enable events detection.
2843 * We don't enable close on the response channel since it's either
2844 * already closed, or in keep-alive with an idle connection handler.
2845 */
2846 channel_auto_read(&s->req);
2847 channel_auto_close(&s->req);
2848 channel_auto_read(&s->res);
2849
2850
2851 return 1;
2852 }
2853 return 0;
2854}
2855
William Lallemand8a022572018-10-26 14:47:35 +02002856/*
2857 * The mworker functions are used to initialize the CLI in the master process
2858 */
2859
William Lallemand309dc9a2018-10-26 14:47:45 +02002860 /*
2861 * Stop the mworker proxy
2862 */
2863void mworker_cli_proxy_stop()
2864{
William Lallemand550db6d2018-11-06 17:37:12 +01002865 if (mworker_proxy)
2866 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002867}
2868
William Lallemand8a022572018-10-26 14:47:35 +02002869/*
2870 * Create the mworker CLI proxy
2871 */
2872int mworker_cli_proxy_create()
2873{
2874 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002875 char *msg = NULL;
2876 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002877
William Lallemandae787ba2021-07-29 15:13:22 +02002878 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002879 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002880 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002881
William Lallemandcf62f7e2018-10-26 14:47:40 +02002882 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002883 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2884 mworker_proxy->timeout.client = 0; /* no timeout */
2885 mworker_proxy->conf.file = strdup("MASTER");
2886 mworker_proxy->conf.line = 0;
2887 mworker_proxy->accept = frontend_accept;
2888 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2889
2890 /* Does not init the default target the CLI applet, but must be done in
2891 * the request parsing code */
2892 mworker_proxy->default_target = NULL;
2893
William Lallemand8a022572018-10-26 14:47:35 +02002894 /* create all servers using the mworker_proc list */
2895 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002896 struct server *newsrv = NULL;
2897 struct sockaddr_storage *sk;
2898 int port1, port2, port;
2899 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002900
William Lallemanda31b09e2020-01-14 15:25:02 +01002901 /* only the workers support the master CLI */
2902 if (!(child->options & PROC_O_TYPE_WORKER))
2903 continue;
2904
William Lallemand8a022572018-10-26 14:47:35 +02002905 newsrv = new_server(mworker_proxy);
2906 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002907 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002908
2909 /* we don't know the new pid yet */
2910 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002911 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002912 else
2913 memprintf(&msg, "old-%d", child->pid);
2914
2915 newsrv->next = mworker_proxy->srv;
2916 mworker_proxy->srv = newsrv;
2917 newsrv->conf.file = strdup(msg);
2918 newsrv->id = strdup(msg);
2919 newsrv->conf.line = 0;
2920
2921 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002922 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002923 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002924 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002925 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002926 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002927
Willy Tarreau5fc93282020-09-16 18:25:03 +02002928 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002929 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002930 }
2931
2932 /* no port specified */
2933 newsrv->flags |= SRV_F_MAPPORTS;
2934 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002935 /* don't let the server participate to load balancing */
2936 newsrv->iweight = 0;
2937 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002938 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002939
2940 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002941 }
William Lallemandae787ba2021-07-29 15:13:22 +02002942
2943 mworker_proxy->next = proxies_list;
2944 proxies_list = mworker_proxy;
2945
William Lallemand8a022572018-10-26 14:47:35 +02002946 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002947
2948error:
William Lallemand744a0892018-11-22 16:46:51 +01002949
2950 list_for_each_entry(child, &proc_list, list) {
2951 free((char *)child->srv->conf.file); /* cast because of const char * */
2952 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002953 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002954 }
William Lallemandae787ba2021-07-29 15:13:22 +02002955 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002956 free(msg);
2957
William Lallemandae787ba2021-07-29 15:13:22 +02002958error_proxy:
2959 ha_alert("%s\n", errmsg);
2960 free(errmsg);
2961
William Lallemand744a0892018-11-22 16:46:51 +01002962 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02002963}
Olivier Houchardf886e342017-04-05 22:24:59 +02002964
William Lallemandce83b4a2018-10-26 14:47:30 +02002965/*
William Lallemande7361152018-10-26 14:47:36 +02002966 * Create a new listener for the master CLI proxy
2967 */
William Lallemand21623b52022-09-24 15:51:27 +02002968struct bind_conf *mworker_cli_proxy_new_listener(char *line)
William Lallemande7361152018-10-26 14:47:36 +02002969{
2970 struct bind_conf *bind_conf;
2971 struct listener *l;
2972 char *err = NULL;
2973 char *args[MAX_LINE_ARGS + 1];
2974 int arg;
2975 int cur_arg;
2976
William Lallemand2e945c82019-11-25 09:58:37 +01002977 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02002978 args[0] = line;
2979
2980 /* args is a bind configuration with spaces replaced by commas */
2981 while (*line && arg < MAX_LINE_ARGS) {
2982
2983 if (*line == ',') {
2984 *line++ = '\0';
2985 while (*line == ',')
2986 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01002987 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02002988 }
2989 line++;
2990 }
2991
William Lallemand2e945c82019-11-25 09:58:37 +01002992 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02002993
2994 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01002995 if (!bind_conf)
2996 goto err;
William Lallemande7361152018-10-26 14:47:36 +02002997
2998 bind_conf->level &= ~ACCESS_LVL_MASK;
2999 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003000 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003001
3002 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3003 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003004 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003005 }
3006
3007 cur_arg = 1;
3008
3009 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003010 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003011 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003012
3013 kw = bind_find_kw(args[cur_arg]);
3014 if (kw) {
3015 if (!kw->parse) {
3016 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3017 args[0], args[1], args[cur_arg]);
3018 goto err;
3019 }
3020
Willy Tarreau4975d142021-03-13 11:00:33 +01003021 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003022 if (err)
3023 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3024 else
3025 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3026 args[0], args[1], args[cur_arg]);
3027 goto err;
3028 }
3029
3030 cur_arg += 1 + kw->skip;
3031 continue;
3032 }
3033
Willy Tarreau433b05f2021-03-12 10:14:07 +01003034 best = bind_find_best_kw(args[cur_arg]);
3035 if (best)
3036 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3037 args[0], args[1], args[cur_arg], best);
3038 else
3039 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3040 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003041 goto err;
3042 }
3043
3044
Willy Tarreau30836152023-01-12 19:10:17 +01003045 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003046 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003047 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
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) {
Willy Tarreau18c20d22020-10-09 16:11:46 +02003050 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003051 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003052 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003053 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003054
William Lallemand21623b52022-09-24 15:51:27 +02003055 return bind_conf;
William Lallemande7361152018-10-26 14:47:36 +02003056
3057err:
3058 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003059 free(err);
3060 free(bind_conf);
William Lallemand21623b52022-09-24 15:51:27 +02003061 return NULL;
William Lallemande7361152018-10-26 14:47:36 +02003062
3063}
3064
3065/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003066 * Create a new CLI socket using a socketpair for a worker process
3067 * <mworker_proc> is the process structure, and <proc> is the process number
3068 */
3069int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3070{
3071 struct bind_conf *bind_conf;
3072 struct listener *l;
3073 char *path = NULL;
3074 char *err = NULL;
3075
3076 /* master pipe to ensure the master is still alive */
3077 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3078 ha_alert("Cannot create worker socketpair.\n");
3079 return -1;
3080 }
3081
3082 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003083 if (!global.cli_fe) {
3084 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003085 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003086 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003087 }
3088 }
3089
Willy Tarreau4975d142021-03-13 11:00:33 +01003090 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003091 if (!bind_conf)
3092 goto error;
3093
William Lallemandce83b4a2018-10-26 14:47:30 +02003094 bind_conf->level &= ~ACCESS_LVL_MASK;
3095 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003096 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003097
William Lallemandce83b4a2018-10-26 14:47:30 +02003098 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3099 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003100 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003101 }
3102
Willy Tarreau4975d142021-03-13 11:00:33 +01003103 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003104 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003105 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003106 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003107 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003108 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003109
Willy Tarreau30836152023-01-12 19:10:17 +01003110 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003111 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003112 bind_conf->options |= BC_O_UNLIMITED | BC_O_NOSTOP;
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003113
William Lallemandce83b4a2018-10-26 14:47:30 +02003114 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003115 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003116 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003117 l->rx.flags &= ~RX_F_INHERITED;
Willy Tarreau18215cb2019-02-27 16:25:28 +01003118 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003119 }
3120
3121 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003122
3123error:
3124 close(mworker_proc->ipc_fd[0]);
3125 close(mworker_proc->ipc_fd[1]);
3126 free(err);
3127
3128 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003129}
3130
William Lallemand74c24fb2016-11-21 17:18:36 +01003131static struct applet cli_applet = {
3132 .obj_type = OBJ_TYPE_APPLET,
3133 .name = "<CLI>", /* used for logging */
3134 .fct = cli_io_handler,
3135 .release = cli_release_handler,
3136};
3137
William Lallemand99e0bb92020-11-05 10:28:53 +01003138/* master CLI */
3139static struct applet mcli_applet = {
3140 .obj_type = OBJ_TYPE_APPLET,
3141 .name = "<MCLI>", /* used for logging */
3142 .fct = cli_io_handler,
3143 .release = cli_release_handler,
3144};
3145
Willy Tarreau0a739292016-11-22 20:21:23 +01003146/* register cli keywords */
3147static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003148 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3149 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3150 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3151 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003152 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3153 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003154 { { "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 +02003155 { { "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 +02003156 { { "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 +02003157 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3158 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3159 { { "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 },
3160 { { "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 +02003161 { { "show", "anon", NULL }, "show anon : display the current state of anonymized mode", cli_parse_show_anon, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003162 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3163 { { "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 },
3164 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3165 { { "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 +01003166 { { "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 +02003167 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3168 { { "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 +01003169 {{},}
3170}};
3171
Willy Tarreau0108d902018-11-25 19:14:37 +01003172INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3173
William Lallemand74c24fb2016-11-21 17:18:36 +01003174static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003175 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003176 { 0, NULL, NULL },
3177}};
3178
Willy Tarreau0108d902018-11-25 19:14:37 +01003179INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3180
William Lallemand74c24fb2016-11-21 17:18:36 +01003181static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003182 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3183 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003184 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003185 { NULL, NULL, 0 },
3186}};
3187
Willy Tarreau0108d902018-11-25 19:14:37 +01003188INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003189
3190/*
3191 * Local variables:
3192 * c-indent-level: 8
3193 * c-basic-offset: 8
3194 * End:
3195 */