blob: 0ec005a37049b243be65fe1f934dd94e4e7f942f [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 */
Willy Tarreau1cb041a2023-03-31 16:33:53 +020096/* flags for show_fd_ctx->show_mask */
97#define CLI_SHOWFD_F_PI 0x00000001 /* pipes */
98#define CLI_SHOWFD_F_LI 0x00000002 /* listeners */
99#define CLI_SHOWFD_F_FE 0x00000004 /* frontend conns */
100#define CLI_SHOWFD_F_SV 0x00000010 /* server-only conns */
101#define CLI_SHOWFD_F_PX 0x00000020 /* proxy-only conns */
102#define CLI_SHOWFD_F_BE 0x00000030 /* backend: srv+px */
103#define CLI_SHOWFD_F_CO 0x00000034 /* conn: be+fe */
104#define CLI_SHOWFD_F_ANY 0x0000003f /* any type */
105
Willy Tarreau741a5a92022-05-05 17:56:58 +0200106struct show_fd_ctx {
107 int fd; /* first FD to show */
108 int show_one; /* stop after showing one FD */
Willy Tarreau1cb041a2023-03-31 16:33:53 +0200109 uint show_mask; /* CLI_SHOWFD_F_xxx */
Willy Tarreau741a5a92022-05-05 17:56:58 +0200110};
111
Willy Tarreaub128f492022-05-05 19:11:05 +0200112/* CLI context for the "show cli sockets" command */
113struct show_sock_ctx {
114 struct bind_conf *bind_conf;
115 struct listener *listener;
116};
117
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200118static int cmp_kw_entries(const void *a, const void *b)
119{
120 const struct cli_kw *l = *(const struct cli_kw **)a;
121 const struct cli_kw *r = *(const struct cli_kw **)b;
122
123 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
124}
125
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100126/* This will show the help message and list the commands supported at the
127 * current level that match all of the first words of <args> if args is not
128 * NULL, or all args if none matches or if args is null.
129 */
130static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100131{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200132 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100133 struct cli_kw_list *kw_list;
134 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200135 struct buffer *tmp = get_trash_chunk();
136 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100137 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100138 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200139 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100140 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200141 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100142
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100143 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100144
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200145 if (args && *args && strcmp(*args, "help") == 0) {
146 args++;
147 ishelp = 1;
148 }
149
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100150 /* first, let's measure the longest match */
151 list_for_each_entry(kw_list, &cli_keywords.list, list) {
152 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100153 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100154 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100155 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
156 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100157 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
158 continue;
159
160 /* OK this command is visible */
161 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
162 if (!kw->str_kw[idx])
163 break; // end of keyword
164 if (!args || !args[idx] || !*args[idx])
165 break; // end of command line
166 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
167 break;
168 if (idx + 1 > length)
169 length = idx + 1;
170 }
171 }
172 }
173
Willy Tarreaub7364582021-03-12 18:24:46 +0100174 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100175 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200176 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100177 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Abhijeet Rastogic8601502022-11-17 04:42:38 -0800178 else {
179 chunk_strcat(tmp, "Unknown command: '");
180 if (args && *args)
181 chunk_strcat(tmp, *args);
182 chunk_strcat(tmp, "'");
183
184 if (!length && (!args || !*args || !**args)) // no match
185 chunk_strcat(tmp, ". Please enter one of the following commands only:\n");
186 else // partial match
187 chunk_strcat(tmp, ", but maybe one of the following ones is a better match:\n");
188 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100189
Willy Tarreaub7364582021-03-12 18:24:46 +0100190 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
191 matches[idx].kw = NULL;
192 matches[idx].dist = INT_MAX;
193 }
194
195 /* In case of partial match we'll look for the best matching entries
196 * starting from position <length>
197 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100198 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100199 list_for_each_entry(kw_list, &cli_keywords.list, list) {
200 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100201 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100202 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100203 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
204 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
205 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100206 continue;
207
208 for (idx = 0; idx < length; idx++) {
209 if (!kw->str_kw[idx])
210 break; // end of keyword
211 if (!args || !args[idx] || !*args[idx])
212 break; // end of command line
213 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
214 break;
215 }
216
217 /* extra non-matching words are fuzzy-matched */
218 if (kw->usage && idx == length && args[idx] && *args[idx]) {
219 uint8_t word_sig[1024];
220 uint8_t list_sig[1024];
221 int dist = 0;
222 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100223 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100224
225 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100226 * on the remaining words. For this we're computing the signature
227 * of everything that remains and the cumulated length of the
228 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100229 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100230 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100231 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
232 update_word_fingerprint(word_sig, args[i]);
233 totlen += strlen(args[i]);
234 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100235
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100236 memset(list_sig, 0, sizeof(list_sig));
237 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
238 update_word_fingerprint(list_sig, kw->str_kw[i]);
239 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100240 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100241
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100242 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100243
244 /* insert this one at its place if relevant, in order to keep only
245 * the best matches.
246 */
247 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100248 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100249 matches[CLI_MAX_MATCHES-1] = swp;
250 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
251 if (matches[idx+1].dist >= matches[idx].dist)
252 break;
253 matches[idx+1] = matches[idx];
254 matches[idx] = swp;
255 }
256 }
257 }
258 }
259 }
260 }
261
Willy Tarreauec197e82021-03-15 10:35:04 +0100262 if (matches[0].kw) {
263 /* we have fuzzy matches, let's propose them */
264 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
265 kw = matches[idx].kw;
266 if (!kw)
267 break;
268
269 /* stop the dump if some words look very unlikely candidates */
270 if (matches[idx].dist > 5*matches[0].dist/2)
271 break;
272
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200273 if (help_entries < CLI_MAX_HELP_ENTRIES)
274 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100275 }
276 }
277
William Lallemand74c24fb2016-11-21 17:18:36 +0100278 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100279 /* no full dump if we've already found nice candidates */
280 if (matches[0].kw)
281 break;
282
Willy Tarreau91bc3592021-03-12 15:20:39 +0100283 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200284
Willy Tarreau91bc3592021-03-12 15:20:39 +0100285 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100286 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100287 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100288 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100289 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200290
William Lallemand2a171912022-02-02 11:43:20 +0100291 /* in master, if the CLI don't have the
292 * ACCESS_MCLI_DEBUG don't display commands that have
293 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100294 */
William Lallemand2a171912022-02-02 11:43:20 +0100295 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
296 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
297 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100298 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200299
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100300 for (idx = 0; idx < length; idx++) {
301 if (!kw->str_kw[idx])
302 break; // end of keyword
303 if (!args || !args[idx] || !*args[idx])
304 break; // end of command line
305 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
306 break;
307 }
308
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200309 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
310 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100311 }
312 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100313
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200314 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
315
316 for (idx = 0; idx < help_entries; idx++)
317 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
318
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100319 /* always show the prompt/help/quit commands */
320 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200321 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200322 " prompt : toggle interactive mode with prompt\n"
323 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100324
William Lallemand74c24fb2016-11-21 17:18:36 +0100325 chunk_init(&out, NULL, 0);
326 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200327 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200328
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200329 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100330 return dynamic_usage_msg;
331}
332
333struct cli_kw* cli_find_kw(char **args)
334{
335 struct cli_kw_list *kw_list;
336 struct cli_kw *kw;/* current cli_kw */
337 char **tmp_args;
338 const char **tmp_str_kw;
339 int found = 0;
340
341 if (LIST_ISEMPTY(&cli_keywords.list))
342 return NULL;
343
344 list_for_each_entry(kw_list, &cli_keywords.list, list) {
345 kw = &kw_list->kw[0];
346 while (*kw->str_kw) {
347 tmp_args = args;
348 tmp_str_kw = kw->str_kw;
349 while (*tmp_str_kw) {
350 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
351 found = 1;
352 } else {
353 found = 0;
354 break;
355 }
356 tmp_args++;
357 tmp_str_kw++;
358 }
359 if (found)
360 return (kw);
361 kw++;
362 }
363 }
364 return NULL;
365}
366
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100367struct cli_kw* cli_find_kw_exact(char **args)
368{
369 struct cli_kw_list *kw_list;
370 int found = 0;
371 int i;
372 int j;
373
374 if (LIST_ISEMPTY(&cli_keywords.list))
375 return NULL;
376
377 list_for_each_entry(kw_list, &cli_keywords.list, list) {
378 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
379 found = 1;
380 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
381 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
382 break;
383 }
384 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
385 found = 0;
386 break;
387 }
388 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
389 found = 0;
390 break;
391 }
392 }
393 if (found)
394 return &kw_list->kw[i];
395 }
396 }
397 return NULL;
398}
399
William Lallemand74c24fb2016-11-21 17:18:36 +0100400void cli_register_kw(struct cli_kw_list *kw_list)
401{
Willy Tarreau2b718102021-04-21 07:32:39 +0200402 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100403}
404
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200405/* list all known keywords on stdout, one per line */
406void cli_list_keywords(void)
407{
408 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200409 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200410 int idx;
411
Willy Tarreau44651712022-03-30 12:02:35 +0200412 for (kwn = kwp = NULL;; kwp = kwn) {
413 list_for_each_entry(kw_list, &cli_keywords.list, list) {
414 /* note: we sort based on the usage message when available,
415 * otherwise we fall back to the first keyword.
416 */
417 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
418 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
419 kw->usage ? kw->usage : kw->str_kw[0],
420 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
421 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200422 }
Willy Tarreau44651712022-03-30 12:02:35 +0200423 }
424
425 if (kwn == kwp)
426 break;
427
428 for (idx = 0; kwn->str_kw[idx]; idx++) {
429 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200430 }
Willy Tarreau44651712022-03-30 12:02:35 +0200431 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
432 printf("[MASTER] ");
433 if (!(kwn->level & ACCESS_MASTER_ONLY))
434 printf("[WORKER] ");
435 if (kwn->level & ACCESS_EXPERT)
436 printf("[EXPERT] ");
437 if (kwn->level & ACCESS_EXPERIMENTAL)
438 printf("[EXPERIM] ");
439 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200440 }
441}
William Lallemand74c24fb2016-11-21 17:18:36 +0100442
443/* allocate a new stats frontend named <name>, and return it
444 * (or NULL in case of lack of memory).
445 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100446static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100447{
448 struct proxy *fe;
449
450 fe = calloc(1, sizeof(*fe));
451 if (!fe)
452 return NULL;
453
454 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100455 fe->next = proxies_list;
456 proxies_list = fe;
Willy Tarreau69530f52023-04-28 09:16:15 +0200457 fe->last_change = ns_to_sec(now_ns);
William Lallemand74c24fb2016-11-21 17:18:36 +0100458 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200459 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100460 fe->maxconn = 10; /* default to 10 concurrent connections */
461 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
462 fe->conf.file = strdup(file);
463 fe->conf.line = line;
464 fe->accept = frontend_accept;
465 fe->default_target = &cli_applet.obj_type;
466
467 /* the stats frontend is the only one able to assign ID #0 */
468 fe->conf.id.key = fe->uuid = 0;
469 eb32_insert(&used_proxy_id, &fe->conf.id);
470 return fe;
471}
472
473/* This function parses a "stats" statement in the "global" section. It returns
474 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
475 * error message into the <err> buffer which will be preallocated. The trailing
476 * '\n' must not be written. The function must be called with <args> pointing to
477 * the first word after "stats".
478 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100479static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
480 const struct proxy *defpx, const char *file, int line,
481 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100482{
483 struct bind_conf *bind_conf;
484 struct listener *l;
485
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100486 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100487 int cur_arg;
488
489 if (*args[2] == 0) {
490 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
491 return -1;
492 }
493
Willy Tarreau4975d142021-03-13 11:00:33 +0100494 if (!global.cli_fe) {
495 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100496 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
497 return -1;
498 }
499 }
500
Willy Tarreau4975d142021-03-13 11:00:33 +0100501 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200502 if (!bind_conf) {
503 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
504 return -1;
505 }
William Lallemand07a62f72017-05-24 00:57:40 +0200506 bind_conf->level &= ~ACCESS_LVL_MASK;
507 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100508
Willy Tarreau4975d142021-03-13 11:00:33 +0100509 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100510 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
511 file, line, args[0], args[1], err && *err ? *err : "error");
512 return -1;
513 }
514
515 cur_arg = 3;
516 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100517 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100518 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100519 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100520
521 kw = bind_find_kw(args[cur_arg]);
522 if (kw) {
523 if (!kw->parse) {
524 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
525 args[0], args[1], args[cur_arg]);
526 return -1;
527 }
528
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100529 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
530
531 /* FIXME: this is ugly, we don't have a way to collect warnings,
532 * yet some important bind keywords may report warnings that we
533 * must display.
534 */
535 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
536 indent_msg(err, 2);
537 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
538 ha_free(err);
539 }
540
541 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 if (err && *err)
543 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
544 else
545 memprintf(err, "'%s %s' : error encountered while processing '%s'",
546 args[0], args[1], args[cur_arg]);
547 return -1;
548 }
549
550 cur_arg += 1 + kw->skip;
551 continue;
552 }
553
Willy Tarreau433b05f2021-03-12 10:14:07 +0100554 best = bind_find_best_kw(args[cur_arg]);
555 if (best)
556 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
557 args[0], args[1], args[cur_arg], best);
558 else
559 memprintf(err, "'%s %s' : unknown keyword '%s'.",
560 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100561 return -1;
562 }
563
Willy Tarreau30836152023-01-12 19:10:17 +0100564 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +0100565 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +0100566 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +0100567
William Lallemand74c24fb2016-11-21 17:18:36 +0100568 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18215cb2019-02-27 16:25:28 +0100569 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100570 }
571 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100572 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100573 unsigned timeout;
574 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
575
Willy Tarreau9faebe32019-06-07 19:00:37 +0200576 if (res == PARSE_TIME_OVER) {
577 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
578 args[2], args[0], args[1]);
579 return -1;
580 }
581 else if (res == PARSE_TIME_UNDER) {
582 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
583 args[2], args[0], args[1]);
584 return -1;
585 }
586 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
588 return -1;
589 }
590
591 if (!timeout) {
592 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
593 return -1;
594 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100595 if (!global.cli_fe) {
596 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100597 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
598 return -1;
599 }
600 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100601 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100603 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100604 int maxconn = atol(args[2]);
605
606 if (maxconn <= 0) {
607 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
608 return -1;
609 }
610
Willy Tarreau4975d142021-03-13 11:00:33 +0100611 if (!global.cli_fe) {
612 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100613 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
614 return -1;
615 }
616 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100617 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100618 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200619 else if (strcmp(args[1], "bind-process") == 0) {
Willy Tarreau023c3112023-04-23 09:40:56 +0200620 memprintf(err, "'%s %s' is not supported anymore.", args[0], args[1]);
Willy Tarreau94f763b2022-07-15 17:14:40 +0200621 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100622 }
623 else {
624 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
625 return -1;
626 }
627 return 0;
628}
629
William Lallemand33d29e22019-04-01 11:30:06 +0200630/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200631 * This function exports the bound addresses of a <frontend> in the environment
632 * variable <varname>. Those addresses are separated by semicolons and prefixed
633 * with their type (abns@, unix@, sockpair@ etc)
634 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200635 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200636int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200637{
638 struct buffer *trash = get_trash_chunk();
639 struct bind_conf *bind_conf;
640
William Lallemand9a37fd02019-04-12 16:09:24 +0200641 if (frontend) {
642 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200643 struct listener *l;
644
645 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
646 char addr[46];
647 char port[6];
648
William Lallemand620072b2019-04-12 16:09:25 +0200649 /* separate listener by semicolons */
650 if (trash->data)
651 chunk_appendf(trash, ";");
652
Willy Tarreau37159062020-08-27 07:48:42 +0200653 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200654 const struct sockaddr_un *un;
655
Willy Tarreau37159062020-08-27 07:48:42 +0200656 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200657 if (un->sun_path[0] == '\0') {
658 chunk_appendf(trash, "abns@%s", un->sun_path+1);
659 } else {
660 chunk_appendf(trash, "unix@%s", un->sun_path);
661 }
Willy Tarreau37159062020-08-27 07:48:42 +0200662 } else if (l->rx.addr.ss_family == AF_INET) {
663 addr_to_str(&l->rx.addr, addr, sizeof(addr));
664 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200665 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200666 } else if (l->rx.addr.ss_family == AF_INET6) {
667 addr_to_str(&l->rx.addr, addr, sizeof(addr));
668 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200669 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200670 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
671 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200672 }
William Lallemand33d29e22019-04-01 11:30:06 +0200673 }
674 }
675 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200676 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200677 return -1;
678 }
679
680 return 0;
681}
682
William Lallemand9a37fd02019-04-12 16:09:24 +0200683int cli_socket_setenv()
684{
Willy Tarreau4975d142021-03-13 11:00:33 +0100685 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200686 return -1;
687 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
688 return -1;
689
690 return 0;
691}
692
William Lallemand33d29e22019-04-01 11:30:06 +0200693REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
694
Willy Tarreaude57a572016-11-23 17:01:39 +0100695/* Verifies that the CLI at least has a level at least as high as <level>
696 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
697 * failure, an error message is prepared and the appctx's state is adjusted
698 * to print it so that a return 1 is enough to abort any processing.
699 */
700int cli_has_level(struct appctx *appctx, int level)
701{
Willy Tarreaude57a572016-11-23 17:01:39 +0100702
William Lallemandf630d012018-12-13 09:05:44 +0100703 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100704 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100705 return 0;
706 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100707 return 1;
708}
709
William Lallemandb7ea1412018-12-13 09:05:47 +0100710/* same as cli_has_level but for the CLI proxy and without error message */
711int pcli_has_level(struct stream *s, int level)
712{
713 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
714 return 0;
715 }
716 return 1;
717}
718
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200719/* Returns severity_output for the current session if set, or default for the socket */
720static int cli_get_severity_output(struct appctx *appctx)
721{
722 if (appctx->cli_severity_output)
723 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200724 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200725}
William Lallemand74c24fb2016-11-21 17:18:36 +0100726
Willy Tarreau41908562016-11-24 16:23:38 +0100727/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100728 * from the CLI's IO handler running in an appctx context. The function returns
729 * 1 if the request was understood, otherwise zero (in which case an error
730 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100731 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
732 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
733 * have its own I/O handler called again. Most of the time, parsers will only
734 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100735 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
736 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100737 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100739{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100740 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100742 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100743
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200744 p = appctx->chunk->area;
745 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100746
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200747 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748 * Get pointers on words.
749 * One extra slot is reserved to store a pointer on a null byte.
750 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100751 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200752 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100753
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200754 /* skip leading spaces/tabs */
755 p += strspn(p, " \t");
756 if (!*p)
757 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200758
759 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
760 /* payload pattern recognized here, this is not an arg anymore,
761 * the payload starts at the first byte that follows the zero
762 * after the pattern.
763 */
764 payload = p + strlen(PAYLOAD_PATTERN) + 1;
765 break;
766 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100767
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200768 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200769 while (1) {
770 p += strcspn(p, " \t\\");
771 /* escaped chars using backlashes (\) */
772 if (*p == '\\') {
773 if (!*++p)
774 break;
775 if (!*++p)
776 break;
777 } else {
778 break;
779 }
780 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200781 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100782
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200783 /* unescape backslashes (\) */
784 for (j = 0, k = 0; args[i][k]; k++) {
785 if (args[i][k] == '\\') {
786 if (args[i][k + 1] == '\\')
787 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100788 else
789 continue;
790 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200791 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100792 j++;
793 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200794 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100795
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200796 i++;
797 }
798 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200799 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100800 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200801 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100802
803 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100804 if (!kw ||
805 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100806 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
807 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100808 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100809 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100810 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100811 }
William Lallemand14721be2018-10-26 14:47:37 +0200812
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100813 /* don't handle expert mode commands if not in this mode. */
814 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
815 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200816 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100817 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200818
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100819 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
820 cli_err(appctx, "This command is restricted to experimental mode only.\n");
821 return 0;
822 }
823
Amaury Denoyellef4929922021-05-05 16:29:23 +0200824 if (kw->level == ACCESS_EXPERT)
825 mark_tainted(TAINTED_CLI_EXPERT_MODE);
826 else if (kw->level == ACCESS_EXPERIMENTAL)
827 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
828
Willy Tarreau41908562016-11-24 16:23:38 +0100829 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200830 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200831
832 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
833 goto fail;
834
835 /* kw->parse could set its own io_handler or io_release handler */
836 if (!appctx->io_handler)
837 goto fail;
838
839 appctx->st0 = CLI_ST_CALLBACK;
840 return 1;
841fail:
842 appctx->io_handler = NULL;
843 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100844 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100845}
846
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200847/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
848static int cli_output_msg(struct channel *chn, const char *msg, int severity, int severity_output)
849{
Willy Tarreau83061a82018-07-13 11:56:34 +0200850 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200851
852 if (likely(severity_output == CLI_SEVERITY_NONE))
Willy Tarreau06d80a92017-10-19 14:32:15 +0200853 return ci_putblk(chn, msg, strlen(msg));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200854
855 tmp = get_trash_chunk();
856 chunk_reset(tmp);
857
858 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100859 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200860 chunk_printf(tmp, "[%d]: ", severity);
861 }
862 else {
863 switch (severity_output) {
864 case CLI_SEVERITY_NUMBER:
865 chunk_printf(tmp, "[%d]: ", severity);
866 break;
867 case CLI_SEVERITY_STRING:
868 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
869 break;
870 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100871 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200872 }
873 }
874 chunk_appendf(tmp, "%s", msg);
875
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200876 return ci_putblk(chn, tmp->area, strlen(tmp->area));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200877}
878
Willy Tarreau4596fe22022-05-17 19:07:51 +0200879/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100880 * used to processes I/O from/to the stats unix socket. The system relies on a
881 * state machine handling requests and various responses. We read a request,
882 * then we process it and send the response, and we possibly display a prompt.
883 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100884 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100885 * or not.
886 */
887static void cli_io_handler(struct appctx *appctx)
888{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200889 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200890 struct channel *req = sc_oc(sc);
891 struct channel *res = sc_ic(sc);
892 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100893 int reql;
894 int len;
895
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200896 if (unlikely(se_fl_test(appctx->sedesc, (SE_FL_EOS|SE_FL_ERROR|SE_FL_SHR|SE_FL_SHW)))) {
897 co_skip(sc_oc(sc), co_data(sc_oc(sc)));
William Lallemand74c24fb2016-11-21 17:18:36 +0100898 goto out;
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200899 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100900
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800901 /* Check if the input buffer is available. */
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200902 if (!b_size(&res->buf)) {
903 sc_need_room(sc);
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100904 goto out;
905 }
906
William Lallemand74c24fb2016-11-21 17:18:36 +0100907 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100908 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200909 /* reset severity to default at init */
910 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau1addf8b2022-08-18 18:04:37 +0200911 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100912 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100913 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100914 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100915 else if (appctx->st0 == CLI_ST_END) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200916 se_fl_set(appctx->sedesc, SE_FL_EOS);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200917 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200918 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100919 break;
920 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100921 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200922 char *str;
923
924 /* use a trash chunk to store received data */
925 if (!appctx->chunk) {
926 appctx->chunk = alloc_trash_chunk();
927 if (!appctx->chunk) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200928 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200929 appctx->st0 = CLI_ST_END;
930 continue;
931 }
932 }
933
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200934 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200935
William Lallemand74c24fb2016-11-21 17:18:36 +0100936 /* ensure we have some output room left in the event we
937 * would want to return some info right after parsing.
938 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200939 if (buffer_almost_full(sc_ib(sc))) {
940 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +0100941 break;
942 }
943
Willy Tarreau0011c252022-01-19 17:23:52 +0100944 /* payload doesn't take escapes nor does it end on semi-colons, so
945 * we use the regular getline. Normal mode however must stop on
946 * LFs and semi-colons that are not prefixed by a backslash. Note
947 * that we reserve one byte at the end to insert a trailing nul byte.
948 */
949
950 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200951 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100952 appctx->chunk->size - appctx->chunk->data - 1);
953 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200954 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100955 appctx->chunk->size - appctx->chunk->data - 1,
956 "\n;", '\\');
957
William Lallemand74c24fb2016-11-21 17:18:36 +0100958 if (reql <= 0) { /* closed or EOL not found */
959 if (reql == 0)
960 break;
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200961 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100962 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100963 continue;
964 }
965
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200966 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
967 /* seek for a possible unescaped semi-colon. If we find
968 * one, we replace it with an LF and skip only this part.
969 */
970 for (len = 0; len < reql; len++) {
971 if (str[len] == '\\') {
972 len++;
973 continue;
974 }
975 if (str[len] == ';') {
976 str[len] = '\n';
977 reql = len + 1;
978 break;
979 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100980 }
981 }
982
983 /* now it is time to check that we have a full line,
984 * remove the trailing \n and possibly \r, then cut the
985 * line.
986 */
987 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200988 if (str[len] != '\n') {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200989 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100990 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100991 continue;
992 }
993
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200994 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100995 len--;
996
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200997 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200998 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200999
1000 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001001 appctx->chunk->area[appctx->chunk->data] = '\n';
1002 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1003 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001004 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001005
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001006 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001007
1008 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1009 /* empty line */
1010 if (!len) {
1011 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001012 appctx->chunk->data -= 2;
1013 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001014 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001015 chunk_reset(appctx->chunk);
1016 /* NB: cli_sock_parse_request() may have put
1017 * another CLI_ST_O_* into appctx->st0.
1018 */
1019
1020 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001021 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001022 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001023 else {
1024 /*
1025 * Look for the "payload start" pattern at the end of a line
1026 * Its location is not remembered here, this is just to switch
1027 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001028 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001029 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001030 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001031 appctx->chunk->data++; // keep the trailing \0 after '<<'
1032 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001033 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001034 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001035 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001036 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001037 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001038 }
1039
1040 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001041 co_skip(sc_oc(sc), reql);
Christopher Faulet9a790f62023-03-16 14:40:03 +01001042 sc_opposite(sc)->flags |= SC_FL_RCV_ONCE; /* we plan to read small requests */
William Lallemand74c24fb2016-11-21 17:18:36 +01001043 }
1044 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001045 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001046 const char *msg;
1047 int sev;
1048
William Lallemand74c24fb2016-11-21 17:18:36 +01001049 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001050 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001051 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001052 case CLI_ST_PRINT: /* print const message in msg */
1053 case CLI_ST_PRINT_ERR: /* print const error in msg */
1054 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001055 case CLI_ST_PRINT_DYNERR: /* print dyn error in err, free */
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001056 case CLI_ST_PRINT_UMSG: /* print usermsgs_ctx and reset it */
1057 case CLI_ST_PRINT_UMSGERR: /* print usermsgs_ctx as error and reset it */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001058 /* the message is in the svcctx */
1059 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001060 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1061 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001062 LOG_ERR : ctx->severity;
1063 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001064 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001065 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
1066 sev = appctx->st0 == CLI_ST_PRINT_DYNERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001067 LOG_ERR : ctx->severity;
1068 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001069 if (!msg) {
1070 sev = LOG_ERR;
1071 msg = "Out of memory.\n";
1072 }
1073 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001074 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1075 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1076 sev = appctx->st0 == CLI_ST_PRINT_UMSGERR ?
1077 LOG_ERR : ctx->severity;
1078 msg = usermsgs_str();
1079 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001080 else {
1081 sev = LOG_ERR;
1082 msg = "Internal error.\n";
1083 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001084
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001085 if (cli_output_msg(res, msg, sev, cli_get_severity_output(appctx)) != -1) {
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001086 if (appctx->st0 == CLI_ST_PRINT_DYN ||
1087 appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001088 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001089 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001090 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1091 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1092 usermsgs_clr(NULL);
1093 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001094 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001095 }
1096 else
Willy Tarreau475e4632022-05-27 10:26:46 +02001097 sc_need_room(sc);
William Lallemand74c24fb2016-11-21 17:18:36 +01001098 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001099
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001100 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001101 if (appctx->io_handler)
1102 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001103 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001104 if (appctx->io_release) {
1105 appctx->io_release(appctx);
1106 appctx->io_release = NULL;
1107 }
1108 }
1109 break;
1110 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001111 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001112 break;
1113 }
1114
1115 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001116 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001117 const char *prompt = "";
1118
1119 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1120 /*
1121 * when entering a payload with interactive mode, change the prompt
1122 * to emphasize that more data can still be sent
1123 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001124 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001125 prompt = "+ ";
1126 else
1127 prompt = "\n> ";
1128 }
1129 else {
William Lallemandad032882019-07-01 10:56:15 +02001130 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001131 prompt = "\n";
1132 }
1133
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001134 if (applet_putstr(appctx, prompt) != -1) {
1135 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001136 appctx->st0 = CLI_ST_GETREQ;
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001137 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001138 }
1139
1140 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001141 if (appctx->st0 >= CLI_ST_OUTPUT) {
1142 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001143 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001144 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001145
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001146 /* Now we close the output if we're not in interactive
1147 * mode and the request buffer is empty. This still
1148 * allows pipelined requests to be sent in
1149 * non-interactive mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001150 */
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001151 if (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))) {
1152 se_fl_set(appctx->sedesc, SE_FL_EOI);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001153 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001154 continue;
1155 }
1156
1157 /* switch state back to GETREQ to read next requests */
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001158 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001159 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001160 applet_will_consume(appctx);
1161
William Lallemandad032882019-07-01 10:56:15 +02001162 /* reactivate the \n at the end of the response for the next command */
1163 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001164
1165 /* this forces us to yield between pipelined commands and
1166 * avoid extremely long latencies (e.g. "del map" etc). In
1167 * addition this increases the likelihood that the stream
1168 * refills the buffer with new bytes in non-interactive
1169 * mode, avoiding to close on apparently empty commands.
1170 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001171 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001172 appctx_wakeup(appctx);
1173 goto out;
1174 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001175 }
1176 }
1177
William Lallemand74c24fb2016-11-21 17:18:36 +01001178 out:
Christopher Faulet845f7c42023-04-18 18:36:43 +02001179 return;
William Lallemand74c24fb2016-11-21 17:18:36 +01001180}
1181
Willy Tarreau4596fe22022-05-17 19:07:51 +02001182/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001183 * external abort, we won't call the i/o handler anymore so we may need to
1184 * remove back references to the stream currently being dumped.
1185 */
1186static void cli_release_handler(struct appctx *appctx)
1187{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001188 free_trash_chunk(appctx->chunk);
1189 appctx->chunk = NULL;
1190
William Lallemand74c24fb2016-11-21 17:18:36 +01001191 if (appctx->io_release) {
1192 appctx->io_release(appctx);
1193 appctx->io_release = NULL;
1194 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001195 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001196 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1197
1198 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001199 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001200 else if (appctx->st0 == CLI_ST_PRINT_UMSG || appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1201 usermsgs_clr(NULL);
1202 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001203}
1204
1205/* This function dumps all environmnent variables to the buffer. It returns 0
1206 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001207 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1208 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001209 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001210static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001211{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001212 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001213 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001214 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001215
Christopher Faulet87633c32023-04-03 18:32:50 +02001216 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001217 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
William Lallemand74c24fb2016-11-21 17:18:36 +01001218 return 1;
1219
1220 chunk_reset(&trash);
1221
1222 /* we have two inner loops here, one for the proxy, the other one for
1223 * the buffer.
1224 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001225 while (*var) {
1226 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001227
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001228 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001229 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001230
Willy Tarreau307dbb32022-05-05 17:45:52 +02001231 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001232 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001233 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001234 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001235 }
1236
1237 /* dump complete */
1238 return 1;
1239}
1240
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001241/* This function dumps all file descriptors states (or the requested one) to
1242 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001243 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1244 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1245 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001246 */
1247static int cli_io_handler_show_fd(struct appctx *appctx)
1248{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001249 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001250 struct show_fd_ctx *fdctx = appctx->svcctx;
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001251 uint match = fdctx->show_mask;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001252 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001253 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001254
Christopher Faulet87633c32023-04-03 18:32:50 +02001255 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001256 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001257 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001258
1259 chunk_reset(&trash);
1260
Willy Tarreauca1b1572018-12-18 15:45:11 +01001261 /* isolate the threads once per round. We're limited to a buffer worth
1262 * of output anyway, it cannot last very long.
1263 */
1264 thread_isolate();
1265
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001266 /* we have two inner loops here, one for the proxy, the other one for
1267 * the buffer.
1268 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001269 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001270 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001271 const struct listener *li = NULL;
1272 const struct server *sv = NULL;
1273 const struct proxy *px = NULL;
1274 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001275 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001276 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001277 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001278 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001279 uint32_t conn_flags = 0;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001280 uint8_t conn_err = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001281 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001282 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001283
1284 fdt = fdtab[fd];
1285
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001286 /* When DEBUG_FD is set, we also report closed FDs that have a
1287 * non-null event count to detect stuck ones.
1288 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001289 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001290#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001291 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001292#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001293 goto skip; // closed
1294 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001295 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001296 conn = (const struct connection *)fdt.owner;
1297 conn_flags = conn->flags;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001298 conn_err = conn->err_code;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001299 mux = conn->mux;
1300 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001301 xprt = conn->xprt;
1302 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001303 li = objt_listener(conn->target);
1304 sv = objt_server(conn->target);
1305 px = objt_proxy(conn->target);
1306 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001307 if (atleast2(fdt.thread_mask))
1308 suspicious = 1;
1309 if (conn->handle.fd != fd)
1310 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001311 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001312 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001313 li = fdt.owner;
1314
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001315 if (!((conn &&
1316 ((match & CLI_SHOWFD_F_SV && sv) ||
1317 (match & CLI_SHOWFD_F_PX && px) ||
1318 (match & CLI_SHOWFD_F_FE && li))) ||
1319 (!conn &&
1320 ((match & CLI_SHOWFD_F_LI && li) ||
1321 (match & CLI_SHOWFD_F_PI && !li /* only pipes match this */))))) {
1322 /* not a desired type */
1323 goto skip;
1324 }
1325
Willy Tarreaudacfde42021-01-21 09:07:29 +01001326 if (!fdt.thread_mask)
1327 suspicious = 1;
1328
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001329 chunk_printf(&trash,
Willy Tarreau677c0062023-03-02 15:05:31 +01001330 " %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 prmsk=0x%lx pwmsk=0x%lx owner=%p iocb=%p(",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001331 fd,
1332 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001333 (fdt.state & FD_CLONED) ? 'C' : 'c',
1334 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001335 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1336 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1337 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1338 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1339 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001340 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1341 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1342 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1343 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1344 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1345 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001346 (fdt.refc_tgid >> 4) & 0xffff,
1347 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001348 fdt.thread_mask, fdt.update_mask,
Willy Tarreau677c0062023-03-02 15:05:31 +01001349 polled_mask[fd].poll_recv,
1350 polled_mask[fd].poll_send,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001351 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001352 fdt.iocb);
1353 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001354
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001355 if (!fdt.owner) {
1356 chunk_appendf(&trash, ")");
1357 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001358 else if (fdt.iocb == sock_conn_iocb) {
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001359 chunk_appendf(&trash, ") back=%d cflg=0x%08x cerr=%d", is_back, conn_flags, conn_err);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001360
1361 if (conn->handle.fd != fd) {
1362 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1363 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001364 } else {
1365 struct sockaddr_storage sa;
1366 socklen_t salen;
1367
1368 salen = sizeof(sa);
1369 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1370 if (sa.ss_family == AF_INET)
1371 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1372 else if (sa.ss_family == AF_INET6)
1373 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1374 else if (sa.ss_family == AF_UNIX)
1375 chunk_appendf(&trash, " fam=unix");
1376 }
1377
1378 salen = sizeof(sa);
1379 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1380 if (sa.ss_family == AF_INET)
1381 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1382 else if (sa.ss_family == AF_INET6)
1383 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1384 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001385 }
1386
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001387 if (px)
1388 chunk_appendf(&trash, " px=%s", px->id);
1389 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001390 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001391 else if (li)
1392 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001393
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001394 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001395 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001396 if (!ctx)
1397 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001398 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001399 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001400 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001401 else
1402 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001403
1404 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001405 if (xprt) {
1406 if (xprt_ctx || xprt->show_fd)
1407 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1408 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001409 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001410 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001411 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001412 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001413 struct sockaddr_storage sa;
1414 socklen_t salen;
1415
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001416 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001417 listener_state_str(li),
1418 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001419
1420 salen = sizeof(sa);
1421 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1422 if (sa.ss_family == AF_INET)
1423 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1424 else if (sa.ss_family == AF_INET6)
1425 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1426 else if (sa.ss_family == AF_UNIX)
1427 chunk_appendf(&trash, " fam=unix");
1428 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001429 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001430 else
1431 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001432
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001433#ifdef DEBUG_FD
1434 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001435 if (fdtab[fd].event_count >= 1000000)
1436 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001437#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001438 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001439
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001440 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001441 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001442 ret = 0;
1443 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001444 }
1445 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001446 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001447 break;
1448
1449 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001450 }
1451
Willy Tarreauca1b1572018-12-18 15:45:11 +01001452 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001453 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001454
1455 thread_release();
1456 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001457}
1458
William Lallemandeceddf72016-12-15 18:06:44 +01001459/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001460 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001461 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1462 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001463 */
1464static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1465{
Willy Tarreaub128f492022-05-05 19:11:05 +02001466 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1467 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001468
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001469 if (!global.cli_fe)
1470 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001471
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001472 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001473
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001474 if (!bind_conf) {
1475 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001476 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001477 goto full;
1478 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1479 }
William Lallemandeceddf72016-12-15 18:06:44 +01001480
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001481 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001482 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001483
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001484 if (!l)
1485 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001486
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001487 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1488 char addr[46];
1489 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001490
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001491 if (l->rx.addr.ss_family == AF_UNIX) {
1492 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001493
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001494 un = (struct sockaddr_un *)&l->rx.addr;
1495 if (un->sun_path[0] == '\0') {
1496 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1497 } else {
1498 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1499 }
1500 } else if (l->rx.addr.ss_family == AF_INET) {
1501 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1502 port_to_str(&l->rx.addr, port, sizeof(port));
1503 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1504 } else if (l->rx.addr.ss_family == AF_INET6) {
1505 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1506 port_to_str(&l->rx.addr, port, sizeof(port));
1507 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1508 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1509 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1510 } else
1511 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001512
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001513 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1514 chunk_appendf(&trash, "admin ");
1515 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1516 chunk_appendf(&trash, "operator ");
1517 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1518 chunk_appendf(&trash, "user ");
1519 else
1520 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001521
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001522 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001523
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001524 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001525 ctx->bind_conf = bind_conf;
1526 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001527 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001528 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001529 }
William Lallemandeceddf72016-12-15 18:06:44 +01001530 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001531 done:
1532 return 1;
1533 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001534 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001535}
1536
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001537
Willy Tarreau0a739292016-11-22 20:21:23 +01001538/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001539 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1540 * be dumped as well as a flag if a single variable is requested, otherwise puts
1541 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001542 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001543static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001544{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001545 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001546 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001547 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001548
1549 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1550 return 1;
1551
Willy Tarreauf6710f82016-12-16 17:45:44 +01001552 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001553
1554 if (*args[2]) {
1555 int len = strlen(args[2]);
1556
Willy Tarreauf6710f82016-12-16 17:45:44 +01001557 for (; *var; var++) {
1558 if (strncmp(*var, args[2], len) == 0 &&
1559 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001560 break;
1561 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001562 if (!*var)
1563 return cli_err(appctx, "Variable not found\n");
1564
Willy Tarreau307dbb32022-05-05 17:45:52 +02001565 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001566 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001567 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001568 return 0;
1569}
1570
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001571/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001572 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1573 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001574 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001575static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001576{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001577 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001578 const char *c;
1579 int arg;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001580
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001581 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1582 return 1;
1583
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001584 arg = 2;
1585
1586 /* when starting with an inversion we preset every flag */
1587 if (*args[arg] == '!' || *args[arg] == '-')
1588 ctx->show_mask = CLI_SHOWFD_F_ANY;
1589
1590 while (*args[arg] && !isdigit((uchar)*args[arg])) {
1591 uint flag = 0, inv = 0;
1592 c = args[arg];
1593 while (*c) {
1594 switch (*c) {
1595 case '!': inv = !inv; break;
1596 case '-': inv = !inv; break;
1597 case 'p': flag = CLI_SHOWFD_F_PI; break;
1598 case 'l': flag = CLI_SHOWFD_F_LI; break;
1599 case 'c': flag = CLI_SHOWFD_F_CO; break;
1600 case 'f': flag = CLI_SHOWFD_F_FE; break;
1601 case 'b': flag = CLI_SHOWFD_F_BE; break;
1602 case 's': flag = CLI_SHOWFD_F_SV; break;
1603 case 'd': flag = CLI_SHOWFD_F_PX; break;
1604 default: return cli_err(appctx, "Invalid FD type\n");
1605 }
1606 c++;
1607 if (!inv)
1608 ctx->show_mask |= flag;
1609 else
1610 ctx->show_mask &= ~flag;
1611 }
1612 arg++;
1613 }
1614
1615 /* default mask is to show everything */
1616 if (!ctx->show_mask)
1617 ctx->show_mask = CLI_SHOWFD_F_ANY;
1618
1619 if (*args[arg]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001620 ctx->fd = atoi(args[2]);
1621 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001622 }
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001623
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001624 return 0;
1625}
1626
Willy Tarreau599852e2016-11-22 20:33:32 +01001627/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001628static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001629{
Willy Tarreau0698c802022-05-11 14:09:57 +02001630 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001631
1632 if (strcmp(args[2], "cli") == 0) {
1633 unsigned timeout;
1634 const char *res;
1635
Willy Tarreau9d008692019-08-09 11:21:01 +02001636 if (!*args[3])
1637 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001638
1639 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001640 if (res || timeout < 1)
1641 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001642
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01001643 s->scf->ioto = 1 + MS_TO_TICKS(timeout*1000);
Willy Tarreau599852e2016-11-22 20:33:32 +01001644 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1645 return 1;
1646 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001647
1648 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001649}
1650
Willy Tarreau2af99412016-11-23 11:10:59 +01001651/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001652static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001653{
1654 int v;
1655
1656 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1657 return 1;
1658
Willy Tarreau9d008692019-08-09 11:21:01 +02001659 if (!*args[3])
1660 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001661
1662 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001663 if (v > global.hardmaxconn)
1664 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001665
1666 /* check for unlimited values */
1667 if (v <= 0)
1668 v = global.hardmaxconn;
1669
1670 global.maxconn = v;
1671
1672 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001673 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001674
1675 return 1;
1676}
1677
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001678static int set_severity_output(int *target, char *argument)
1679{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001680 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001681 *target = CLI_SEVERITY_NONE;
1682 return 1;
1683 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001684 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001685 *target = CLI_SEVERITY_NUMBER;
1686 return 1;
1687 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001688 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001689 *target = CLI_SEVERITY_STRING;
1690 return 1;
1691 }
1692 return 0;
1693}
1694
1695/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001696static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001697{
1698 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1699 return 0;
1700
Willy Tarreau9d008692019-08-09 11:21:01 +02001701 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001702}
William Lallemandeceddf72016-12-15 18:06:44 +01001703
William Lallemand67a234f2018-12-13 09:05:45 +01001704
1705/* show the level of the current CLI session */
1706static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1707{
William Lallemand67a234f2018-12-13 09:05:45 +01001708 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001709 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001710 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001711 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001712 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001713 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001714 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001715 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001716}
1717
1718/* parse and set the CLI level dynamically */
1719static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1720{
William Lallemandad032882019-07-01 10:56:15 +02001721 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001722 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001723 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1724
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001725 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001726 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1727 return 1;
1728 }
1729 appctx->cli_level &= ~ACCESS_LVL_MASK;
1730 appctx->cli_level |= ACCESS_LVL_OPER;
1731
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001732 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001733 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1734 return 1;
1735 }
1736 appctx->cli_level &= ~ACCESS_LVL_MASK;
1737 appctx->cli_level |= ACCESS_LVL_USER;
1738 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001739 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001740 return 1;
1741}
1742
1743
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001744/* parse and set the CLI expert/experimental-mode dynamically */
1745static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001746{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001747 int level;
1748 char *level_str;
1749 char *output = NULL;
1750
William Lallemand7267f782022-02-01 16:08:50 +01001751 /* this will ask the applet to not output a \n after the command */
1752 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1753 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1754
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001755 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1756 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001757
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001758 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001759 level = ACCESS_EXPERT;
1760 level_str = "expert-mode";
1761 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001762 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001763 level = ACCESS_EXPERIMENTAL;
1764 level_str = "experimental-mode";
1765 }
William Lallemand2a171912022-02-02 11:43:20 +01001766 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1767 level = ACCESS_MCLI_DEBUG;
1768 level_str = "mcli-debug-mode";
1769 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001770 else {
1771 return 1;
1772 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001773
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001774 if (!*args[1]) {
1775 memprintf(&output, "%s is %s\n", level_str,
1776 (appctx->cli_level & level) ? "ON" : "OFF");
1777 return cli_dynmsg(appctx, LOG_INFO, output);
1778 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001779
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001780 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001781 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001782 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001783 return 1;
1784}
1785
William Lallemand740629e2021-12-14 15:22:29 +01001786/* shows HAProxy version */
1787static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1788{
1789 char *msg = NULL;
1790
1791 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1792}
1793
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001794int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001795{
1796 return 0;
1797}
1798
Erwan Le Goas54966df2022-09-14 17:24:22 +02001799/* enable or disable the anonymized mode, it returns 1 when it works or displays an error message if it doesn't. */
1800static int cli_parse_set_anon(char **args, char *payload, struct appctx *appctx, void *private)
1801{
1802 uint32_t tmp;
1803 long long key;
1804
1805 if (strcmp(args[2], "on") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001806
1807 if (*args[3]) {
1808 key = atoll(args[3]);
1809 if (key < 1 || key > UINT_MAX)
1810 return cli_err(appctx, "Value out of range (1 to 4294967295 expected).\n");
1811 appctx->cli_anon_key = key;
1812 }
Erwan Le Goas54966df2022-09-14 17:24:22 +02001813 else {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001814 tmp = HA_ATOMIC_LOAD(&global.anon_key);
1815 if (tmp != 0)
1816 appctx->cli_anon_key = tmp;
1817 else
1818 appctx->cli_anon_key = ha_random32();
Erwan Le Goas54966df2022-09-14 17:24:22 +02001819 }
1820 }
1821 else if (strcmp(args[2], "off") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001822
1823 if (*args[3]) {
Erwan Le Goas54966df2022-09-14 17:24:22 +02001824 return cli_err(appctx, "Key can't be added while disabling anonymized mode\n");
1825 }
1826 else {
1827 appctx->cli_anon_key = 0;
1828 }
1829 }
1830 else {
1831 return cli_err(appctx,
1832 "'set anon' only supports :\n"
1833 " - 'on' [key] to enable the anonymized mode\n"
1834 " - 'off' to disable the anonymized mode");
1835 }
1836 return 1;
1837}
1838
Erwan Le Goasfad9da82022-09-14 17:24:22 +02001839/* This function set the global anonyzing key, restricted to level 'admin' */
1840static int cli_parse_set_global_key(char **args, char *payload, struct appctx *appctx, void *private)
1841{
1842 long long key;
1843
1844 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1845 return cli_err(appctx, "Permission denied\n");
1846 if (!*args[2])
1847 return cli_err(appctx, "Expects an integer value.\n");
1848
1849 key = atoll(args[2]);
1850 if (key < 0 || key > UINT_MAX)
1851 return cli_err(appctx, "Value out of range (0 to 4294967295 expected).\n");
1852
1853 HA_ATOMIC_STORE(&global.anon_key, key);
1854 return 1;
1855}
1856
Erwan Le Goas54966df2022-09-14 17:24:22 +02001857/* shows the anonymized mode state to everyone, and the key except for users, it always returns 1. */
1858static int cli_parse_show_anon(char **args, char *payload, struct appctx *appctx, void *private)
1859{
1860 char *msg = NULL;
1861 char *anon_mode = NULL;
1862 uint32_t c_key = appctx->cli_anon_key;
1863
1864 if (!c_key)
1865 anon_mode = "Anonymized mode disabled";
1866 else
1867 anon_mode = "Anonymized mode enabled";
1868
1869 if ( !((appctx->cli_level & ACCESS_LVL_MASK) < ACCESS_LVL_OPER) && c_key != 0) {
1870 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\nKey : %u\n", anon_mode, c_key));
1871 }
1872 else {
1873 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", anon_mode));
1874 }
1875
1876 return 1;
1877}
1878
Willy Tarreau45c742b2016-11-24 14:51:17 +01001879/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001880static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001881{
1882 int v;
1883 int *res;
1884 int mul = 1;
1885
1886 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1887 return 1;
1888
1889 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1890 res = &global.cps_lim;
1891 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1892 res = &global.sps_lim;
1893#ifdef USE_OPENSSL
1894 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1895 res = &global.ssl_lim;
1896#endif
1897 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1898 res = &global.comp_rate_lim;
1899 mul = 1024;
1900 }
1901 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001902 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001903 "'set rate-limit' only supports :\n"
1904 " - 'connections global' to set the per-process maximum connection rate\n"
1905 " - 'sessions global' to set the per-process maximum session rate\n"
1906#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001907 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001908#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001909 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001910 }
1911
Willy Tarreau9d008692019-08-09 11:21:01 +02001912 if (!*args[4])
1913 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001914
1915 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001916 if (v < 0)
1917 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001918
1919 *res = v * mul;
1920
1921 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001922 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001923
1924 return 1;
1925}
1926
William Lallemandf6975e92017-05-26 17:42:10 +02001927/* parse the "expose-fd" argument on the bind lines */
1928static int bind_parse_expose_fd(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 fd type", args[cur_arg]);
1932 return ERR_ALERT | ERR_FATAL;
1933 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001934 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001935 conf->level |= ACCESS_FD_LISTENERS;
1936 } else {
1937 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1938 args[cur_arg], args[cur_arg+1]);
1939 return ERR_ALERT | ERR_FATAL;
1940 }
1941
1942 return 0;
1943}
1944
William Lallemand74c24fb2016-11-21 17:18:36 +01001945/* parse the "level" argument on the bind lines */
1946static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1947{
1948 if (!*args[cur_arg + 1]) {
1949 memprintf(err, "'%s' : missing level", args[cur_arg]);
1950 return ERR_ALERT | ERR_FATAL;
1951 }
1952
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001953 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001954 conf->level &= ~ACCESS_LVL_MASK;
1955 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001956 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001957 conf->level &= ~ACCESS_LVL_MASK;
1958 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001959 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001960 conf->level &= ~ACCESS_LVL_MASK;
1961 conf->level |= ACCESS_LVL_ADMIN;
1962 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001963 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1964 args[cur_arg], args[cur_arg+1]);
1965 return ERR_ALERT | ERR_FATAL;
1966 }
1967
1968 return 0;
1969}
1970
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001971static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1972{
1973 if (!*args[cur_arg + 1]) {
1974 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1975 return ERR_ALERT | ERR_FATAL;
1976 }
1977
1978 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1979 return 0;
1980 else {
1981 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1982 args[cur_arg], args[cur_arg+1]);
1983 return ERR_ALERT | ERR_FATAL;
1984 }
1985}
1986
Olivier Houchardf886e342017-04-05 22:24:59 +02001987/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001988static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001989{
William Lallemandb5d062d2022-07-28 15:33:41 +02001990 static int already_sent = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001991 char *cmsgbuf = NULL;
1992 unsigned char *tmpbuf = NULL;
1993 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001994 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02001995 struct stream *s = __sc_strm(sc);
1996 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02001997 struct msghdr msghdr;
1998 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001999 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002000 const char *ns_name, *if_name;
2001 unsigned char ns_nlen, if_nlen;
2002 int nb_queued;
2003 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002004 int *tmpfd;
2005 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002006 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002007 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002008 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002009 int ret;
2010
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002011 if (!remote) {
2012 ha_warning("Only works on real connections\n");
2013 goto out;
2014 }
2015
2016 fd = remote->handle.fd;
2017
Olivier Houchardf886e342017-04-05 22:24:59 +02002018 /* Temporary set the FD in blocking mode, that will make our life easier */
2019 old_fcntl = fcntl(fd, F_GETFL);
2020 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002021 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002022 goto out;
2023 }
2024 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2025 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002026 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002027 goto out;
2028 }
2029 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002030 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002031 goto out;
2032 }
Olivier Houchard54740872017-04-06 14:45:14 +02002033 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002034 iov.iov_base = &tot_fd_nb;
2035 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002036 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002037 goto out;
2038 memset(&msghdr, 0, sizeof(msghdr));
2039 /*
2040 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002041 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002042 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002043 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002044 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002045
William Lallemandb5d062d2022-07-28 15:33:41 +02002046 if (tot_fd_nb == 0) {
2047 if (already_sent)
2048 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 +02002049 goto out;
William Lallemandb5d062d2022-07-28 15:33:41 +02002050 }
Olivier Houchardf886e342017-04-05 22:24:59 +02002051
2052 /* First send the total number of file descriptors, so that the
2053 * receiving end knows what to expect.
2054 */
2055 msghdr.msg_iov = &iov;
2056 msghdr.msg_iovlen = 1;
2057 ret = sendmsg(fd, &msghdr, 0);
2058 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002059 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002060 goto out;
2061 }
2062
2063 /* Now send the fds */
2064 msghdr.msg_control = cmsgbuf;
2065 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2066 cmsg = CMSG_FIRSTHDR(&msghdr);
2067 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2068 cmsg->cmsg_level = SOL_SOCKET;
2069 cmsg->cmsg_type = SCM_RIGHTS;
2070 tmpfd = (int *)CMSG_DATA(cmsg);
2071
Olivier Houchardf886e342017-04-05 22:24:59 +02002072 /* For each socket, e message is sent, containing the following :
2073 * Size of the namespace name (or 0 if none), as an unsigned char.
2074 * The namespace name, if any
2075 * Size of the interface name (or 0 if none), as an unsigned char
2076 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002077 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002078 */
2079 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002080 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002081 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002082 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002083 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002084 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002085 goto out;
2086 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002087
2088 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002089 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002090 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002091 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002092 continue;
2093
2094 ns_name = if_name = "";
2095 ns_nlen = if_nlen = 0;
2096
2097 /* for now we can only retrieve namespaces and interfaces from
2098 * pure listeners.
2099 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002100 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002101 const struct listener *l = fdtab[cur_fd].owner;
2102
Willy Tarreau818a92e2020-09-03 07:50:19 +02002103 if (l->rx.settings->interface) {
2104 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002105 if_nlen = strlen(if_name);
2106 }
2107
2108#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002109 if (l->rx.settings->netns) {
2110 ns_name = l->rx.settings->netns->node.key;
2111 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002112 }
2113#endif
2114 }
2115
2116 /* put the FD into the CMSG_DATA */
2117 tmpfd[nb_queued++] = cur_fd;
2118
2119 /* first block is <ns_name_len> <ns_name> */
2120 tmpbuf[curoff++] = ns_nlen;
2121 if (ns_nlen)
2122 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2123 curoff += ns_nlen;
2124
2125 /* second block is <if_name_len> <if_name> */
2126 tmpbuf[curoff++] = if_nlen;
2127 if (if_nlen)
2128 memcpy(tmpbuf + curoff, if_name, if_nlen);
2129 curoff += if_nlen;
2130
2131 /* we used to send the listener options here before 2.3 */
2132 memset(tmpbuf + curoff, 0, sizeof(int));
2133 curoff += sizeof(int);
2134
2135 /* there's a limit to how many FDs may be sent at once */
2136 if (nb_queued == MAX_SEND_FD) {
2137 iov.iov_len = curoff;
2138 if (sendmsg(fd, &msghdr, 0) != curoff) {
2139 ha_warning("Failed to transfer sockets\n");
2140 return -1;
2141 }
2142
2143 /* Wait for an ack */
2144 do {
2145 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2146 } while (ret == -1 && errno == EINTR);
2147
2148 if (ret <= 0) {
2149 ha_warning("Unexpected error while transferring sockets\n");
2150 return -1;
2151 }
2152 curoff = 0;
2153 nb_queued = 0;
2154 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002155 }
2156
William Lallemandb5d062d2022-07-28 15:33:41 +02002157 already_sent = 1;
2158
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002159 /* flush pending stuff */
2160 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002161 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002162 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2163 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002164 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002165 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002166 goto out;
2167 }
2168 }
2169
2170out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002171 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002172 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002173 goto out;
2174 }
Christopher Faulet33af9962023-04-07 17:58:21 +02002175 se_fl_set(appctx->sedesc, SE_FL_EOI);
Olivier Houchardf886e342017-04-05 22:24:59 +02002176 appctx->st0 = CLI_ST_END;
2177 free(cmsgbuf);
2178 free(tmpbuf);
2179 return 1;
2180}
2181
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002182static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2183{
2184 if (*args[0] == 'h')
2185 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002186 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002187 else if (*args[0] == 'p')
2188 /* prompt */
2189 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
Christopher Faulet33af9962023-04-07 17:58:21 +02002190 else if (*args[0] == 'q') {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002191 /* quit */
Christopher Faulet33af9962023-04-07 17:58:21 +02002192 se_fl_set(appctx->sedesc, SE_FL_EOI);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002193 appctx->st0 = CLI_ST_END;
Christopher Faulet33af9962023-04-07 17:58:21 +02002194 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002195
2196 return 1;
2197}
Olivier Houchardf886e342017-04-05 22:24:59 +02002198
William Lallemand2f4ce202018-10-26 14:47:47 +02002199void pcli_write_prompt(struct stream *s)
2200{
2201 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002202 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002203
William Lallemanddc12c2e2018-12-13 09:05:46 +01002204 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002205 return;
2206
William Lallemanddc12c2e2018-12-13 09:05:46 +01002207 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002208 chunk_appendf(msg, "+ ");
2209 } else {
2210 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002211 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002212 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002213 else
William Lallemanddae12c72022-02-02 14:13:54 +01002214 chunk_appendf(msg, "%d", s->pcli_next_pid);
2215
2216 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2217 chunk_appendf(msg, "(");
2218
2219 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2220 chunk_appendf(msg, "x");
2221
2222 if (s->pcli_flags & ACCESS_EXPERT)
2223 chunk_appendf(msg, "e");
2224
2225 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2226 chunk_appendf(msg, "d");
2227
2228 chunk_appendf(msg, ")");
2229 }
2230
2231 chunk_appendf(msg, "> ");
2232
2233
William Lallemandebf61802018-12-11 16:10:57 +01002234 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002235 co_inject(oc, msg->area, msg->data);
2236}
2237
William Lallemand291810d2018-10-26 14:47:38 +02002238
William Lallemandcf62f7e2018-10-26 14:47:40 +02002239/* The pcli_* functions are used for the CLI proxy in the master */
2240
William Lallemanddeeaa592018-10-26 14:47:48 +02002241void pcli_reply_and_close(struct stream *s, const char *msg)
2242{
2243 struct buffer *buf = get_trash_chunk();
2244
2245 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002246 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002247}
2248
William Lallemand291810d2018-10-26 14:47:38 +02002249static enum obj_type *pcli_pid_to_server(int proc_pid)
2250{
2251 struct mworker_proc *child;
2252
William Lallemand99e0bb92020-11-05 10:28:53 +01002253 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002254 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002255 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002256
William Lallemand291810d2018-10-26 14:47:38 +02002257 list_for_each_entry(child, &proc_list, list) {
2258 if (child->pid == proc_pid){
2259 return &child->srv->obj_type;
2260 }
2261 }
2262 return NULL;
2263}
2264
2265/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2266 * Return:
2267 * 0: master
2268 * > 0: pid of a worker
2269 * < 0: didn't find a worker
2270 */
2271static int pcli_prefix_to_pid(const char *prefix)
2272{
2273 int proc_pid;
2274 struct mworker_proc *child;
2275 char *errtol = NULL;
2276
2277 if (*prefix != '@') /* not a prefix, should not happen */
2278 return -1;
2279
2280 prefix++;
2281 if (!*prefix) /* sent @ alone, return the master */
2282 return 0;
2283
2284 if (strcmp("master", prefix) == 0) {
2285 return 0;
2286 } else if (*prefix == '!') {
2287 prefix++;
2288 if (!*prefix)
2289 return -1;
2290
2291 proc_pid = strtol(prefix, &errtol, 10);
2292 if (*errtol != '\0')
2293 return -1;
2294 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002295 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002296 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002297 if (child->pid == proc_pid){
2298 return child->pid;
2299 }
2300 }
2301 } else {
2302 struct mworker_proc *chosen = NULL;
2303 /* this is a relative pid */
2304
2305 proc_pid = strtol(prefix, &errtol, 10);
2306 if (*errtol != '\0')
2307 return -1;
2308
2309 if (proc_pid == 0) /* return the master */
2310 return 0;
2311
William Lallemandbac3a822022-07-20 14:30:56 +02002312 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2313 return -1;
2314
William Lallemand291810d2018-10-26 14:47:38 +02002315 /* chose the right process, the current one is the one with the
2316 least number of reloads */
2317 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002318 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002319 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002320 if (child->reloads == 0)
2321 return child->pid;
2322 else if (chosen == NULL || child->reloads < chosen->reloads)
2323 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002324 }
2325 if (chosen)
2326 return chosen->pid;
2327 }
2328 return -1;
2329}
2330
William Lallemandbddd33a2018-12-11 16:10:53 +01002331/* Return::
2332 * >= 0 : number of words to escape
2333 * = -1 : error
2334 */
2335
2336int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2337{
2338 if (argl < 1)
2339 return 0;
2340
2341 /* there is a prefix */
2342 if (args[0][0] == '@') {
2343 int target_pid = pcli_prefix_to_pid(args[0]);
2344
2345 if (target_pid == -1) {
2346 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2347 return -1;
2348 }
2349
2350 /* if the prefix is alone, define a default target */
2351 if (argl == 1)
2352 s->pcli_next_pid = target_pid;
2353 else
2354 *next_pid = target_pid;
2355 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002356 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002357 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002358 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002359
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002360 } else if (strcmp("quit", args[0]) == 0) {
Christopher Faulet12762f02023-04-13 15:40:10 +02002361 sc_schedule_abort(s->scf);
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002362 sc_schedule_shutdown(s->scf);
William Lallemand5f610682018-12-11 16:10:55 +01002363 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002364 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002365 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2366 memprintf(errmsg, "Permission denied!\n");
2367 return -1;
2368 }
2369 s->pcli_flags &= ~ACCESS_LVL_MASK;
2370 s->pcli_flags |= ACCESS_LVL_OPER;
2371 return argl;
2372
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002373 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002374 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2375 memprintf(errmsg, "Permission denied!\n");
2376 return -1;
2377 }
2378 s->pcli_flags &= ~ACCESS_LVL_MASK;
2379 s->pcli_flags |= ACCESS_LVL_USER;
2380 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002381
2382 } else if (strcmp(args[0], "expert-mode") == 0) {
2383 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2384 memprintf(errmsg, "Permission denied!\n");
2385 return -1;
2386 }
2387
2388 s->pcli_flags &= ~ACCESS_EXPERT;
2389 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2390 s->pcli_flags |= ACCESS_EXPERT;
2391 return argl;
2392
2393 } else if (strcmp(args[0], "experimental-mode") == 0) {
2394 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2395 memprintf(errmsg, "Permission denied!\n");
2396 return -1;
2397 }
2398 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2399 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2400 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2401 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002402 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2403 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2404 memprintf(errmsg, "Permission denied!\n");
2405 return -1;
2406 }
2407 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2408 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2409 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2410 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002411 }
2412
2413 return 0;
2414}
2415
2416/*
2417 * Parse the CLI request:
2418 * - It does basically the same as the cli_io_handler, but as a proxy
2419 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002420 *
2421 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002422 * - the number of characters to forward or
2423 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002424 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002425int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002426{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002427 char *str;
2428 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002429 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002430 int argl; /* number of args */
2431 char *p;
2432 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002433 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002434 int wtrim = 0; /* number of words to trim */
2435 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002436 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002437 int i = 0;
2438
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002439 /* we cannot deal with a wrapping buffer, so let's take care of this
2440 * first.
2441 */
2442 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2443 b_slow_realign(&req->buf, trash.area, co_data(req));
2444
2445 str = (char *)ci_head(req);
2446 end = (char *)ci_stop(req);
2447
William Lallemandbddd33a2018-12-11 16:10:53 +01002448 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002449
William Lallemanddc12c2e2018-12-13 09:05:46 +01002450 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002451
2452 /* Looks for the end of one command */
2453 while (p+reql < end) {
2454 /* handle escaping */
2455 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002456 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002457 continue;
2458 }
2459 if (p[reql] == ';' || p[reql] == '\n') {
2460 /* found the end of the command */
2461 p[reql] = '\n';
2462 reql++;
2463 break;
2464 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002465 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002466 }
William Lallemandebf61802018-12-11 16:10:57 +01002467 } else {
2468 while (p+reql < end) {
2469 if (p[reql] == '\n') {
2470 /* found the end of the line */
2471 reql++;
2472 break;
2473 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002474 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002475 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002476 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002477
William Lallemandbddd33a2018-12-11 16:10:53 +01002478 /* set end to first byte after the end of the command */
2479 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002480
William Lallemandbddd33a2018-12-11 16:10:53 +01002481 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002482 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002483 return -1;
2484 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002485
William Lallemand3301f3e2018-12-13 09:05:48 +01002486 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2487 if (reql == 1) /* last line of the payload */
2488 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002489 return reql;
2490 }
2491
William Lallemandbddd33a2018-12-11 16:10:53 +01002492 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002493
William Lallemandbddd33a2018-12-11 16:10:53 +01002494 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002495 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002496 /* skip leading spaces/tabs */
2497 p += strspn(p, " \t");
2498 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002499 break;
2500
William Lallemandbddd33a2018-12-11 16:10:53 +01002501 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002502 while (1) {
2503 p += strcspn(p, " \t\\");
2504 /* escaped chars using backlashes (\) */
2505 if (*p == '\\') {
2506 if (!*++p)
2507 break;
2508 if (!*++p)
2509 break;
2510 } else {
2511 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002512 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002513 }
William Lallemandfe249c32020-06-18 18:03:57 +02002514 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002515 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002516 }
2517
William Lallemandbddd33a2018-12-11 16:10:53 +01002518 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002519
Willy Tarreauf14c7572021-03-13 10:59:23 +01002520 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002521 args[i] = NULL;
2522
2523 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2524
2525 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002526 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002527 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002528 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002529 if (*p == '\0')
2530 *p = ' ';
2531 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002532 }
2533
William Lallemand3301f3e2018-12-13 09:05:48 +01002534 payload = strstr(str, PAYLOAD_PATTERN);
2535 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2536 /* if the payload pattern is at the end */
2537 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002538 }
2539
William Lallemandbddd33a2018-12-11 16:10:53 +01002540 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002541
William Lallemandbddd33a2018-12-11 16:10:53 +01002542 if (wtrim > 0) {
2543 trim = &args[wtrim][0];
2544 if (trim == NULL) /* if this was the last word in the table */
2545 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002546
William Lallemandbddd33a2018-12-11 16:10:53 +01002547 b_del(&req->buf, trim - str);
2548
William Lallemandb7ea1412018-12-13 09:05:47 +01002549 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002550 } else if (wtrim < 0) {
2551 /* parsing error */
2552 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002553 } else {
2554 /* the whole string */
2555 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002556 }
2557
William Lallemandb7ea1412018-12-13 09:05:47 +01002558 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002559
2560 /* the mcli-debug-mode is only sent to the applet of the master */
2561 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2562 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2563 ret += strlen("mcli-debug-mode on -") + 2;
2564 }
William Lallemand7267f782022-02-01 16:08:50 +01002565 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2566 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2567 ret += strlen("experimental-mode on -") + 2;
2568 }
2569 if (s->pcli_flags & ACCESS_EXPERT) {
2570 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2571 ret += strlen("expert-mode on -") + 2;
2572 }
2573
William Lallemandb7ea1412018-12-13 09:05:47 +01002574 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2575 goto end;
2576 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002577 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2578 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002579 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002580 ci_insert_line2(req, 0, "user -", strlen("user -"));
2581 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002582 }
2583 }
2584end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002585
William Lallemandb7ea1412018-12-13 09:05:47 +01002586 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002587}
2588
2589int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2590{
William Lallemandbddd33a2018-12-11 16:10:53 +01002591 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002592 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002593 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002594
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002595 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002596 * current one. Just wait. At this stage, errors should be handled by
2597 * the response analyzer.
2598 */
2599 if (s->res.analysers & AN_RES_WAIT_CLI)
2600 return 0;
2601
William Lallemandb7ea1412018-12-13 09:05:47 +01002602 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2603 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2604
William Lallemand0a0512f2022-09-24 16:14:50 +02002605 /* stream that comes from the reload listener only responses the reload
2606 * status and quits */
2607 if (!(s->pcli_flags & PCLI_F_RELOAD)
2608 && strm_li(s)->bind_conf == mcli_reload_bind_conf)
2609 goto send_status;
2610
2611
William Lallemandcf62f7e2018-10-26 14:47:40 +02002612read_again:
2613 /* if the channel is closed for read, we won't receive any more data
2614 from the client, but we don't want to forward this close to the
2615 server */
2616 channel_dont_close(req);
2617
2618 /* We don't know yet to which server we will connect */
2619 channel_dont_connect(req);
2620
Christopher Faulet9a790f62023-03-16 14:40:03 +01002621 s->scf->flags |= SC_FL_RCV_ONCE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002622
2623 /* need more data */
2624 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002625 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002626
2627 /* If there is data available for analysis, log the end of the idle time. */
2628 if (c_data(req) && s->logs.t_idle == -1)
Willy Tarreau69530f52023-04-28 09:16:15 +02002629 s->logs.t_idle = ns_to_ms(now_ns - s->logs.accept_ts) - s->logs.t_handshake;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002630
William Lallemandbddd33a2018-12-11 16:10:53 +01002631 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002632 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002633 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002634 /* enough data */
2635
William Lallemandcf62f7e2018-10-26 14:47:40 +02002636 /* forward only 1 command */
2637 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002638
William Lallemanddc12c2e2018-12-13 09:05:46 +01002639 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002640 /* we send only 1 command per request, and we write close after it */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002641 sc_schedule_shutdown(s->scb);
William Lallemandebf61802018-12-11 16:10:57 +01002642 } else {
2643 pcli_write_prompt(s);
2644 }
2645
2646 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002647 s->res.analysers |= AN_RES_WAIT_CLI;
2648
William Lallemandebf61802018-12-11 16:10:57 +01002649 if (!(s->flags & SF_ASSIGNED)) {
2650 if (next_pid > -1)
2651 target_pid = next_pid;
2652 else
2653 target_pid = s->pcli_next_pid;
2654 /* we can connect now */
2655 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002656
William Lallemanddcbe7b92021-12-10 14:14:53 +01002657 if (!s->target)
2658 goto server_disconnect;
2659
William Lallemandebf61802018-12-11 16:10:57 +01002660 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2661 channel_auto_connect(req);
2662 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002663
2664 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002665 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002666 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002667 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002668 } else if (to_forward == -1) {
2669 if (errmsg) {
2670 /* there was an error during the parsing */
2671 pcli_reply_and_close(s, errmsg);
2672 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2673 return 0;
2674 }
2675 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002676 }
2677
2678 return 0;
2679
2680send_help:
2681 b_reset(&req->buf);
2682 b_putblk(&req->buf, "help\n", 5);
2683 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002684
William Lallemand0a0512f2022-09-24 16:14:50 +02002685send_status:
2686 s->pcli_flags |= PCLI_F_RELOAD;
Christopher Faulet208c7122023-04-13 16:16:15 +02002687 /* dont' use ci_putblk here because SHUT_DONE could have been sent */
William Lallemand0a0512f2022-09-24 16:14:50 +02002688 b_reset(&req->buf);
2689 b_putblk(&req->buf, "_loadstatus;quit\n", 17);
2690 goto read_again;
2691
Christopher Faulet0f727da2022-01-18 08:44:23 +01002692missing_data:
Christopher Fauletca5309a2023-04-17 16:17:32 +02002693 if (s->scf->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
Christopher Faulet0f727da2022-01-18 08:44:23 +01002694 /* There is no more request or a only a partial one and we
2695 * receive a close from the client, we can leave */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002696 sc_schedule_shutdown(s->scf);
Christopher Faulet0f727da2022-01-18 08:44:23 +01002697 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2698 return 1;
2699 }
2700 else if (channel_full(req, global.tune.maxrewrite)) {
2701 /* buffer is full and we didn't catch the end of a command */
2702 goto send_help;
2703 }
2704 return 0;
2705
William Lallemanddcbe7b92021-12-10 14:14:53 +01002706server_disconnect:
2707 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2708 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002709}
2710
2711int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2712{
2713 struct proxy *fe = strm_fe(s);
2714 struct proxy *be = s->be;
2715
Christopher Fauletd7bac882023-04-14 12:05:55 +02002716 if ((s->scb->flags & SC_FL_ERROR) || (rep->flags & (CF_READ_TIMEOUT|CF_WRITE_TIMEOUT)) ||
Christopher Faulet64350bb2023-04-13 16:37:37 +02002717 ((s->scf->flags & SC_FL_SHUT_DONE) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002718 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002719 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002720 s->res.analysers &= ~AN_RES_WAIT_CLI;
2721 return 0;
2722 }
Christopher Faulet9a790f62023-03-16 14:40:03 +01002723 s->scb->flags |= SC_FL_RCV_ONCE; /* try to get back here ASAP */
Christopher Faulet68ef2182023-03-17 15:38:18 +01002724 s->scf->flags |= SC_FL_SND_NEVERWAIT;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002725
2726 /* don't forward the close */
2727 channel_dont_close(&s->res);
2728 channel_dont_close(&s->req);
2729
William Lallemanddc12c2e2018-12-13 09:05:46 +01002730 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002731 s->res.analysers &= ~AN_RES_WAIT_CLI;
2732 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2733 return 0;
2734 }
2735
William Lallemandcf62f7e2018-10-26 14:47:40 +02002736 /* forward the data */
2737 if (ci_data(rep)) {
2738 c_adv(rep, ci_data(rep));
2739 return 0;
2740 }
2741
Christopher Fauletca5309a2023-04-17 16:17:32 +02002742 if (s->scb->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002743 /* stream cleanup */
2744
William Lallemand2f4ce202018-10-26 14:47:47 +02002745 pcli_write_prompt(s);
2746
Willy Tarreaucb041662022-05-17 19:44:42 +02002747 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Christopher Fauletcfc11c02023-04-13 16:10:23 +02002748 sc_abort(s->scb);
Christopher Fauletb2b1c3a2023-04-13 16:23:48 +02002749 sc_shutdown(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002750
2751 /*
2752 * starting from there this the same code as
2753 * http_end_txn_clean_session().
2754 *
2755 * It allows to do frontend keepalive while reconnecting to a
2756 * new server for each request.
2757 */
2758
2759 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002760 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002761 if (unlikely(s->srv_conn))
2762 sess_change_server(s, NULL);
2763 }
2764
Willy Tarreau69530f52023-04-28 09:16:15 +02002765 s->logs.t_close = ns_to_ms(now_ns - s->logs.accept_ts);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002766 stream_process_counters(s);
2767
2768 /* don't count other requests' data */
2769 s->logs.bytes_in -= ci_data(&s->req);
2770 s->logs.bytes_out -= ci_data(&s->res);
2771
2772 /* we may need to know the position in the queue */
2773 pendconn_free(s);
2774
2775 /* let's do a final log if we need it */
2776 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2777 !(s->flags & SF_MONITOR) &&
2778 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2779 s->do_log(s);
2780 }
2781
2782 /* stop tracking content-based counters */
2783 stream_stop_content_counters(s);
2784 stream_update_time_stats(s);
2785
2786 s->logs.accept_date = date; /* user-visible date for logging */
Willy Tarreau69530f52023-04-28 09:16:15 +02002787 s->logs.accept_ts = now_ns; /* corrected date for internal use */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002788 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2789 s->logs.t_idle = -1;
Willy Tarreauad5a5f62023-04-27 09:46:02 +02002790 s->logs.request_ts = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002791 s->logs.t_queue = -1;
2792 s->logs.t_connect = -1;
2793 s->logs.t_data = -1;
2794 s->logs.t_close = 0;
2795 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2796 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2797
2798 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2799 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2800
2801 stream_del_srv_conn(s);
2802 if (objt_server(s->target)) {
2803 if (s->flags & SF_CURR_SESS) {
2804 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002805 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002806 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002807 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002808 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002809 }
2810
2811 s->target = NULL;
2812
2813 /* only release our endpoint if we don't intend to reuse the
2814 * connection.
2815 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002816 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002817 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002818 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002819 if (!s->conn_err_type)
2820 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002821 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002822 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002823 return 1;
2824 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002825 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002826 }
2827
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002828 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002829
Willy Tarreau74568cf2022-05-27 09:03:30 +02002830 sc_set_state(s->scb, SC_ST_INI);
Christopher Fauleta1d14a72023-04-14 10:42:08 +02002831 s->scb->flags &= ~(SC_FL_ERROR|SC_FL_SHUT_DONE|SC_FL_SHUT_WANTED);
Willy Tarreaucb041662022-05-17 19:44:42 +02002832 s->scb->flags &= SC_FL_ISBACK | SC_FL_DONT_WAKE; /* we're in the context of process_stream */
Christopher Faulet87633c32023-04-03 18:32:50 +02002833
2834 s->req.flags &= ~(CF_AUTO_CONNECT|CF_STREAMER|CF_STREAMER_FAST|CF_WROTE_DATA);
2835 s->res.flags &= ~(CF_STREAMER|CF_STREAMER_FAST|CF_WRITE_EVENT|CF_WROTE_DATA|CF_READ_EVENT);
Willy Tarreau03bd3952022-05-02 16:36:47 +02002836 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002837 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2838 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002839 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002840 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002841 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002842 /* reinitialise the current rule list pointer to NULL. We are sure that
2843 * any rulelist match the NULL pointer.
2844 */
2845 s->current_rule_list = NULL;
2846
2847 s->be = strm_fe(s);
2848 s->logs.logwait = strm_fe(s)->to_log;
2849 s->logs.level = 0;
2850 stream_del_srv_conn(s);
2851 s->target = NULL;
2852 /* re-init store persistence */
2853 s->store_count = 0;
2854 s->uniq_id = global.req_count++;
2855
Christopher Fauletca5309a2023-04-17 16:17:32 +02002856 s->scf->flags &= ~(SC_FL_EOS|SC_FL_ERROR|SC_FL_ABRT_DONE|SC_FL_ABRT_WANTED);
Christopher Faulet68ef2182023-03-17 15:38:18 +01002857 s->scf->flags &= ~SC_FL_SND_NEVERWAIT;
Christopher Faulet9a790f62023-03-16 14:40:03 +01002858 s->scf->flags |= SC_FL_RCV_ONCE; /* one read is usually enough */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002859
2860 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2861
William Lallemandcf62f7e2018-10-26 14:47:40 +02002862 s->res.analysers &= ~AN_RES_WAIT_CLI;
2863
2864 /* We must trim any excess data from the response buffer, because we
2865 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002866 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002867 * we want those data to come along with next response. A typical
2868 * example of such data would be from a buggy server responding to
2869 * a HEAD with some data, or sending more than the advertised
2870 * content-length.
2871 */
2872 if (unlikely(ci_data(&s->res)))
2873 b_set_data(&s->res.buf, co_data(&s->res));
2874
2875 /* Now we can realign the response buffer */
2876 c_realign_if_empty(&s->res);
2877
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01002878 s->scf->ioto = strm_fe(s)->timeout.client;
2879 s->scb->ioto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002880
William Lallemandcf62f7e2018-10-26 14:47:40 +02002881 s->req.analyse_exp = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002882 s->res.analyse_exp = TICK_ETERNITY;
Christopher Faulet15315d62023-02-20 08:23:51 +01002883
William Lallemandcf62f7e2018-10-26 14:47:40 +02002884 /* we're removing the analysers, we MUST re-enable events detection.
2885 * We don't enable close on the response channel since it's either
2886 * already closed, or in keep-alive with an idle connection handler.
2887 */
2888 channel_auto_read(&s->req);
2889 channel_auto_close(&s->req);
2890 channel_auto_read(&s->res);
2891
2892
2893 return 1;
2894 }
2895 return 0;
2896}
2897
William Lallemand8a022572018-10-26 14:47:35 +02002898/*
2899 * The mworker functions are used to initialize the CLI in the master process
2900 */
2901
William Lallemand309dc9a2018-10-26 14:47:45 +02002902 /*
2903 * Stop the mworker proxy
2904 */
2905void mworker_cli_proxy_stop()
2906{
William Lallemand550db6d2018-11-06 17:37:12 +01002907 if (mworker_proxy)
2908 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002909}
2910
William Lallemand8a022572018-10-26 14:47:35 +02002911/*
2912 * Create the mworker CLI proxy
2913 */
2914int mworker_cli_proxy_create()
2915{
2916 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002917 char *msg = NULL;
2918 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002919
William Lallemandae787ba2021-07-29 15:13:22 +02002920 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002921 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002922 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002923
William Lallemandcf62f7e2018-10-26 14:47:40 +02002924 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002925 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2926 mworker_proxy->timeout.client = 0; /* no timeout */
2927 mworker_proxy->conf.file = strdup("MASTER");
2928 mworker_proxy->conf.line = 0;
2929 mworker_proxy->accept = frontend_accept;
2930 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2931
2932 /* Does not init the default target the CLI applet, but must be done in
2933 * the request parsing code */
2934 mworker_proxy->default_target = NULL;
2935
William Lallemand8a022572018-10-26 14:47:35 +02002936 /* create all servers using the mworker_proc list */
2937 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002938 struct server *newsrv = NULL;
2939 struct sockaddr_storage *sk;
2940 int port1, port2, port;
2941 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002942
William Lallemanda31b09e2020-01-14 15:25:02 +01002943 /* only the workers support the master CLI */
2944 if (!(child->options & PROC_O_TYPE_WORKER))
2945 continue;
2946
William Lallemand8a022572018-10-26 14:47:35 +02002947 newsrv = new_server(mworker_proxy);
2948 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002949 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002950
2951 /* we don't know the new pid yet */
2952 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002953 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002954 else
2955 memprintf(&msg, "old-%d", child->pid);
2956
2957 newsrv->next = mworker_proxy->srv;
2958 mworker_proxy->srv = newsrv;
2959 newsrv->conf.file = strdup(msg);
2960 newsrv->id = strdup(msg);
2961 newsrv->conf.line = 0;
2962
2963 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002964 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002965 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002966 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002967 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002968 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002969
Willy Tarreau5fc93282020-09-16 18:25:03 +02002970 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002971 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002972 }
2973
2974 /* no port specified */
2975 newsrv->flags |= SRV_F_MAPPORTS;
2976 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002977 /* don't let the server participate to load balancing */
2978 newsrv->iweight = 0;
2979 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002980 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002981
2982 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002983 }
William Lallemandae787ba2021-07-29 15:13:22 +02002984
2985 mworker_proxy->next = proxies_list;
2986 proxies_list = mworker_proxy;
2987
William Lallemand8a022572018-10-26 14:47:35 +02002988 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002989
2990error:
William Lallemand744a0892018-11-22 16:46:51 +01002991
2992 list_for_each_entry(child, &proc_list, list) {
2993 free((char *)child->srv->conf.file); /* cast because of const char * */
2994 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002995 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002996 }
William Lallemandae787ba2021-07-29 15:13:22 +02002997 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002998 free(msg);
2999
William Lallemandae787ba2021-07-29 15:13:22 +02003000error_proxy:
3001 ha_alert("%s\n", errmsg);
3002 free(errmsg);
3003
William Lallemand744a0892018-11-22 16:46:51 +01003004 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02003005}
Olivier Houchardf886e342017-04-05 22:24:59 +02003006
William Lallemandce83b4a2018-10-26 14:47:30 +02003007/*
William Lallemande7361152018-10-26 14:47:36 +02003008 * Create a new listener for the master CLI proxy
3009 */
William Lallemand21623b52022-09-24 15:51:27 +02003010struct bind_conf *mworker_cli_proxy_new_listener(char *line)
William Lallemande7361152018-10-26 14:47:36 +02003011{
3012 struct bind_conf *bind_conf;
3013 struct listener *l;
3014 char *err = NULL;
3015 char *args[MAX_LINE_ARGS + 1];
3016 int arg;
3017 int cur_arg;
3018
William Lallemand2e945c82019-11-25 09:58:37 +01003019 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02003020 args[0] = line;
3021
3022 /* args is a bind configuration with spaces replaced by commas */
3023 while (*line && arg < MAX_LINE_ARGS) {
3024
3025 if (*line == ',') {
3026 *line++ = '\0';
3027 while (*line == ',')
3028 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01003029 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02003030 }
3031 line++;
3032 }
3033
William Lallemand2e945c82019-11-25 09:58:37 +01003034 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02003035
3036 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003037 if (!bind_conf)
3038 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003039
3040 bind_conf->level &= ~ACCESS_LVL_MASK;
3041 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003042 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003043
3044 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3045 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003046 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003047 }
3048
3049 cur_arg = 1;
3050
3051 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003052 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003053 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003054
3055 kw = bind_find_kw(args[cur_arg]);
3056 if (kw) {
3057 if (!kw->parse) {
3058 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3059 args[0], args[1], args[cur_arg]);
3060 goto err;
3061 }
3062
Willy Tarreau4975d142021-03-13 11:00:33 +01003063 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003064 if (err)
3065 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3066 else
3067 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3068 args[0], args[1], args[cur_arg]);
3069 goto err;
3070 }
3071
3072 cur_arg += 1 + kw->skip;
3073 continue;
3074 }
3075
Willy Tarreau433b05f2021-03-12 10:14:07 +01003076 best = bind_find_best_kw(args[cur_arg]);
3077 if (best)
3078 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3079 args[0], args[1], args[cur_arg], best);
3080 else
3081 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3082 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003083 goto err;
3084 }
3085
3086
Willy Tarreau30836152023-01-12 19:10:17 +01003087 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003088 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003089 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003090
William Lallemande7361152018-10-26 14:47:36 +02003091 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18c20d22020-10-09 16:11:46 +02003092 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003093 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003094 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003095 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003096
William Lallemand21623b52022-09-24 15:51:27 +02003097 return bind_conf;
William Lallemande7361152018-10-26 14:47:36 +02003098
3099err:
3100 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003101 free(err);
3102 free(bind_conf);
William Lallemand21623b52022-09-24 15:51:27 +02003103 return NULL;
William Lallemande7361152018-10-26 14:47:36 +02003104
3105}
3106
3107/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003108 * Create a new CLI socket using a socketpair for a worker process
3109 * <mworker_proc> is the process structure, and <proc> is the process number
3110 */
3111int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3112{
3113 struct bind_conf *bind_conf;
3114 struct listener *l;
3115 char *path = NULL;
3116 char *err = NULL;
3117
3118 /* master pipe to ensure the master is still alive */
3119 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3120 ha_alert("Cannot create worker socketpair.\n");
3121 return -1;
3122 }
3123
3124 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003125 if (!global.cli_fe) {
3126 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003127 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003128 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003129 }
3130 }
3131
Willy Tarreau4975d142021-03-13 11:00:33 +01003132 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003133 if (!bind_conf)
3134 goto error;
3135
William Lallemandce83b4a2018-10-26 14:47:30 +02003136 bind_conf->level &= ~ACCESS_LVL_MASK;
3137 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003138 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003139
William Lallemandce83b4a2018-10-26 14:47:30 +02003140 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3141 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003142 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003143 }
3144
Willy Tarreau4975d142021-03-13 11:00:33 +01003145 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003146 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003147 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003148 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003149 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003150 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003151
Willy Tarreau30836152023-01-12 19:10:17 +01003152 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003153 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003154 bind_conf->options |= BC_O_UNLIMITED | BC_O_NOSTOP;
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003155
William Lallemandce83b4a2018-10-26 14:47:30 +02003156 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003157 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003158 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003159 l->rx.flags &= ~RX_F_INHERITED;
Willy Tarreau18215cb2019-02-27 16:25:28 +01003160 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003161 }
3162
3163 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003164
3165error:
3166 close(mworker_proc->ipc_fd[0]);
3167 close(mworker_proc->ipc_fd[1]);
3168 free(err);
3169
3170 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003171}
3172
William Lallemand74c24fb2016-11-21 17:18:36 +01003173static struct applet cli_applet = {
3174 .obj_type = OBJ_TYPE_APPLET,
3175 .name = "<CLI>", /* used for logging */
3176 .fct = cli_io_handler,
3177 .release = cli_release_handler,
3178};
3179
William Lallemand99e0bb92020-11-05 10:28:53 +01003180/* master CLI */
3181static struct applet mcli_applet = {
3182 .obj_type = OBJ_TYPE_APPLET,
3183 .name = "<MCLI>", /* used for logging */
3184 .fct = cli_io_handler,
3185 .release = cli_release_handler,
3186};
3187
Willy Tarreau0a739292016-11-22 20:21:23 +01003188/* register cli keywords */
3189static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003190 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3191 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3192 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3193 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003194 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3195 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003196 { { "mcli-debug-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER_ONLY }, // not listed
Amaury Denoyelledd3a33f2023-03-03 17:11:10 +01003197 { { "set", "anon", "on" }, "set anon on [value] : activate the anonymized mode", cli_parse_set_anon, NULL, NULL },
3198 { { "set", "anon", "off" }, "set anon off : deactivate the anonymized mode", cli_parse_set_anon, NULL, NULL },
Erwan Le Goasd7869312022-09-29 10:36:11 +02003199 { { "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 +02003200 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3201 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3202 { { "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 },
3203 { { "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 +02003204 { { "show", "anon", NULL }, "show anon : display the current state of anonymized mode", cli_parse_show_anon, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003205 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3206 { { "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 },
3207 { { "show", "cli", "level", NULL }, "show cli level : display the level of the current CLI session", cli_parse_show_lvl, NULL, NULL, NULL, ACCESS_MASTER},
Willy Tarreau1cb041a2023-03-31 16:33:53 +02003208 { { "show", "fd", NULL }, "show fd [-!plcfbsd]* [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 +01003209 { { "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 +02003210 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3211 { { "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 +01003212 {{},}
3213}};
3214
Willy Tarreau0108d902018-11-25 19:14:37 +01003215INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3216
William Lallemand74c24fb2016-11-21 17:18:36 +01003217static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003218 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003219 { 0, NULL, NULL },
3220}};
3221
Willy Tarreau0108d902018-11-25 19:14:37 +01003222INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3223
William Lallemand74c24fb2016-11-21 17:18:36 +01003224static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003225 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3226 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003227 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003228 { NULL, NULL, 0 },
3229}};
3230
Willy Tarreau0108d902018-11-25 19:14:37 +01003231INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003232
3233/*
3234 * Local variables:
3235 * c-indent-level: 8
3236 * c-basic-offset: 8
3237 * End:
3238 */