blob: f1d5b5a1e820170c42e895a51090e2559cb6cac2 [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 Tarreaufe0ba0e2023-05-11 17:06:22 +020053#include <haproxy/quic_sock.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020054#include <haproxy/sample-t.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020055#include <haproxy/sc_strm.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020056#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020057#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020058#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020059#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020060#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020061#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020062#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020063#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020064#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020065#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020066#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010067
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020068#define PAYLOAD_PATTERN "<<"
69
William Lallemand74c24fb2016-11-21 17:18:36 +010070static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010071static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010072
Willy Tarreau4975d142021-03-13 11:00:33 +010073static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010074 "Permission denied\n"
75 "";
76
77
Christopher Faulet1bc04c72017-10-29 20:14:08 +010078static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010079
80/* List head of cli keywords */
81static struct cli_kw_list cli_keywords = {
82 .list = LIST_HEAD_INIT(cli_keywords.list)
83};
84
85extern const char *stat_status_codes[];
86
Eric Salama1b8dacc2021-03-16 15:12:17 +010087struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand56f73b22022-09-24 15:56:25 +020088struct bind_conf *mcli_reload_bind_conf;
William Lallemand8a022572018-10-26 14:47:35 +020089
Willy Tarreau307dbb32022-05-05 17:45:52 +020090/* CLI context for the "show env" command */
91struct show_env_ctx {
92 char **var; /* first variable to show */
93 int show_one; /* stop after showing the first one */
94};
95
Willy Tarreau741a5a92022-05-05 17:56:58 +020096/* CLI context for the "show fd" command */
Willy Tarreau1cb041a2023-03-31 16:33:53 +020097/* flags for show_fd_ctx->show_mask */
98#define CLI_SHOWFD_F_PI 0x00000001 /* pipes */
99#define CLI_SHOWFD_F_LI 0x00000002 /* listeners */
100#define CLI_SHOWFD_F_FE 0x00000004 /* frontend conns */
101#define CLI_SHOWFD_F_SV 0x00000010 /* server-only conns */
102#define CLI_SHOWFD_F_PX 0x00000020 /* proxy-only conns */
103#define CLI_SHOWFD_F_BE 0x00000030 /* backend: srv+px */
104#define CLI_SHOWFD_F_CO 0x00000034 /* conn: be+fe */
105#define CLI_SHOWFD_F_ANY 0x0000003f /* any type */
106
Willy Tarreau741a5a92022-05-05 17:56:58 +0200107struct show_fd_ctx {
108 int fd; /* first FD to show */
109 int show_one; /* stop after showing one FD */
Willy Tarreau1cb041a2023-03-31 16:33:53 +0200110 uint show_mask; /* CLI_SHOWFD_F_xxx */
Willy Tarreau741a5a92022-05-05 17:56:58 +0200111};
112
Willy Tarreaub128f492022-05-05 19:11:05 +0200113/* CLI context for the "show cli sockets" command */
114struct show_sock_ctx {
115 struct bind_conf *bind_conf;
116 struct listener *listener;
117};
118
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200119static int cmp_kw_entries(const void *a, const void *b)
120{
121 const struct cli_kw *l = *(const struct cli_kw **)a;
122 const struct cli_kw *r = *(const struct cli_kw **)b;
123
124 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
125}
126
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100127/* This will show the help message and list the commands supported at the
128 * current level that match all of the first words of <args> if args is not
129 * NULL, or all args if none matches or if args is null.
130 */
131static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100132{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200133 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100134 struct cli_kw_list *kw_list;
135 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200136 struct buffer *tmp = get_trash_chunk();
137 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100138 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100139 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200140 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100141 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200142 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100143
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100144 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100145
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200146 if (args && *args && strcmp(*args, "help") == 0) {
147 args++;
148 ishelp = 1;
149 }
150
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100151 /* first, let's measure the longest match */
152 list_for_each_entry(kw_list, &cli_keywords.list, list) {
153 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100154 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100155 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100156 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
157 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100158 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
159 continue;
160
161 /* OK this command is visible */
162 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
163 if (!kw->str_kw[idx])
164 break; // end of keyword
165 if (!args || !args[idx] || !*args[idx])
166 break; // end of command line
167 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
168 break;
169 if (idx + 1 > length)
170 length = idx + 1;
171 }
172 }
173 }
174
Willy Tarreaub7364582021-03-12 18:24:46 +0100175 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100176 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200177 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100178 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Abhijeet Rastogic8601502022-11-17 04:42:38 -0800179 else {
180 chunk_strcat(tmp, "Unknown command: '");
181 if (args && *args)
182 chunk_strcat(tmp, *args);
183 chunk_strcat(tmp, "'");
184
185 if (!length && (!args || !*args || !**args)) // no match
186 chunk_strcat(tmp, ". Please enter one of the following commands only:\n");
187 else // partial match
188 chunk_strcat(tmp, ", but maybe one of the following ones is a better match:\n");
189 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100190
Willy Tarreaub7364582021-03-12 18:24:46 +0100191 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
192 matches[idx].kw = NULL;
193 matches[idx].dist = INT_MAX;
194 }
195
196 /* In case of partial match we'll look for the best matching entries
197 * starting from position <length>
198 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100199 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100200 list_for_each_entry(kw_list, &cli_keywords.list, list) {
201 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100202 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100203 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100204 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
205 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
206 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100207 continue;
208
209 for (idx = 0; idx < length; idx++) {
210 if (!kw->str_kw[idx])
211 break; // end of keyword
212 if (!args || !args[idx] || !*args[idx])
213 break; // end of command line
214 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
215 break;
216 }
217
218 /* extra non-matching words are fuzzy-matched */
219 if (kw->usage && idx == length && args[idx] && *args[idx]) {
220 uint8_t word_sig[1024];
221 uint8_t list_sig[1024];
222 int dist = 0;
223 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100224 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100225
226 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100227 * on the remaining words. For this we're computing the signature
228 * of everything that remains and the cumulated length of the
229 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100230 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100231 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100232 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
233 update_word_fingerprint(word_sig, args[i]);
234 totlen += strlen(args[i]);
235 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100236
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100237 memset(list_sig, 0, sizeof(list_sig));
238 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
239 update_word_fingerprint(list_sig, kw->str_kw[i]);
240 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100241 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100242
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100243 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100244
245 /* insert this one at its place if relevant, in order to keep only
246 * the best matches.
247 */
248 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100249 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100250 matches[CLI_MAX_MATCHES-1] = swp;
251 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
252 if (matches[idx+1].dist >= matches[idx].dist)
253 break;
254 matches[idx+1] = matches[idx];
255 matches[idx] = swp;
256 }
257 }
258 }
259 }
260 }
261 }
262
Willy Tarreauec197e82021-03-15 10:35:04 +0100263 if (matches[0].kw) {
264 /* we have fuzzy matches, let's propose them */
265 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
266 kw = matches[idx].kw;
267 if (!kw)
268 break;
269
270 /* stop the dump if some words look very unlikely candidates */
271 if (matches[idx].dist > 5*matches[0].dist/2)
272 break;
273
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200274 if (help_entries < CLI_MAX_HELP_ENTRIES)
275 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100276 }
277 }
278
William Lallemand74c24fb2016-11-21 17:18:36 +0100279 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100280 /* no full dump if we've already found nice candidates */
281 if (matches[0].kw)
282 break;
283
Willy Tarreau91bc3592021-03-12 15:20:39 +0100284 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200285
Willy Tarreau91bc3592021-03-12 15:20:39 +0100286 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100287 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100288 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100289 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100290 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200291
William Lallemand2a171912022-02-02 11:43:20 +0100292 /* in master, if the CLI don't have the
293 * ACCESS_MCLI_DEBUG don't display commands that have
294 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100295 */
William Lallemand2a171912022-02-02 11:43:20 +0100296 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
297 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
298 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100299 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200300
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100301 for (idx = 0; idx < length; idx++) {
302 if (!kw->str_kw[idx])
303 break; // end of keyword
304 if (!args || !args[idx] || !*args[idx])
305 break; // end of command line
306 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
307 break;
308 }
309
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200310 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
311 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100312 }
313 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100314
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200315 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
316
317 for (idx = 0; idx < help_entries; idx++)
318 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
319
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100320 /* always show the prompt/help/quit commands */
321 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200322 " help [<command>] : list matching or all commands\n"
Willy Tarreau22555572023-05-04 14:22:36 +0200323 " prompt [timed] : toggle interactive mode with prompt\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200324 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100325
William Lallemand74c24fb2016-11-21 17:18:36 +0100326 chunk_init(&out, NULL, 0);
327 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200328 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200329
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200330 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100331 return dynamic_usage_msg;
332}
333
334struct cli_kw* cli_find_kw(char **args)
335{
336 struct cli_kw_list *kw_list;
337 struct cli_kw *kw;/* current cli_kw */
338 char **tmp_args;
339 const char **tmp_str_kw;
340 int found = 0;
341
342 if (LIST_ISEMPTY(&cli_keywords.list))
343 return NULL;
344
345 list_for_each_entry(kw_list, &cli_keywords.list, list) {
346 kw = &kw_list->kw[0];
347 while (*kw->str_kw) {
348 tmp_args = args;
349 tmp_str_kw = kw->str_kw;
350 while (*tmp_str_kw) {
351 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
352 found = 1;
353 } else {
354 found = 0;
355 break;
356 }
357 tmp_args++;
358 tmp_str_kw++;
359 }
360 if (found)
361 return (kw);
362 kw++;
363 }
364 }
365 return NULL;
366}
367
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100368struct cli_kw* cli_find_kw_exact(char **args)
369{
370 struct cli_kw_list *kw_list;
371 int found = 0;
372 int i;
373 int j;
374
375 if (LIST_ISEMPTY(&cli_keywords.list))
376 return NULL;
377
378 list_for_each_entry(kw_list, &cli_keywords.list, list) {
379 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
380 found = 1;
381 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
382 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
383 break;
384 }
385 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
386 found = 0;
387 break;
388 }
389 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
390 found = 0;
391 break;
392 }
393 }
394 if (found)
395 return &kw_list->kw[i];
396 }
397 }
398 return NULL;
399}
400
William Lallemand74c24fb2016-11-21 17:18:36 +0100401void cli_register_kw(struct cli_kw_list *kw_list)
402{
Willy Tarreau2b718102021-04-21 07:32:39 +0200403 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100404}
405
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200406/* list all known keywords on stdout, one per line */
407void cli_list_keywords(void)
408{
409 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200410 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200411 int idx;
412
Willy Tarreau44651712022-03-30 12:02:35 +0200413 for (kwn = kwp = NULL;; kwp = kwn) {
414 list_for_each_entry(kw_list, &cli_keywords.list, list) {
415 /* note: we sort based on the usage message when available,
416 * otherwise we fall back to the first keyword.
417 */
418 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
419 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
420 kw->usage ? kw->usage : kw->str_kw[0],
421 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
422 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200423 }
Willy Tarreau44651712022-03-30 12:02:35 +0200424 }
425
426 if (kwn == kwp)
427 break;
428
429 for (idx = 0; kwn->str_kw[idx]; idx++) {
430 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200431 }
Willy Tarreau44651712022-03-30 12:02:35 +0200432 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
433 printf("[MASTER] ");
434 if (!(kwn->level & ACCESS_MASTER_ONLY))
435 printf("[WORKER] ");
436 if (kwn->level & ACCESS_EXPERT)
437 printf("[EXPERT] ");
438 if (kwn->level & ACCESS_EXPERIMENTAL)
439 printf("[EXPERIM] ");
440 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200441 }
442}
William Lallemand74c24fb2016-11-21 17:18:36 +0100443
444/* allocate a new stats frontend named <name>, and return it
445 * (or NULL in case of lack of memory).
446 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100447static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100448{
449 struct proxy *fe;
450
451 fe = calloc(1, sizeof(*fe));
452 if (!fe)
453 return NULL;
454
455 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100456 fe->next = proxies_list;
457 proxies_list = fe;
Willy Tarreau69530f52023-04-28 09:16:15 +0200458 fe->last_change = ns_to_sec(now_ns);
William Lallemand74c24fb2016-11-21 17:18:36 +0100459 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200460 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100461 fe->maxconn = 10; /* default to 10 concurrent connections */
462 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
463 fe->conf.file = strdup(file);
464 fe->conf.line = line;
465 fe->accept = frontend_accept;
466 fe->default_target = &cli_applet.obj_type;
467
468 /* the stats frontend is the only one able to assign ID #0 */
469 fe->conf.id.key = fe->uuid = 0;
470 eb32_insert(&used_proxy_id, &fe->conf.id);
471 return fe;
472}
473
474/* This function parses a "stats" statement in the "global" section. It returns
475 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
476 * error message into the <err> buffer which will be preallocated. The trailing
477 * '\n' must not be written. The function must be called with <args> pointing to
478 * the first word after "stats".
479 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100480static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
481 const struct proxy *defpx, const char *file, int line,
482 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100483{
484 struct bind_conf *bind_conf;
485 struct listener *l;
486
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100487 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100488 int cur_arg;
489
490 if (*args[2] == 0) {
491 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
492 return -1;
493 }
494
Willy Tarreau4975d142021-03-13 11:00:33 +0100495 if (!global.cli_fe) {
496 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100497 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
498 return -1;
499 }
500 }
501
Willy Tarreau4975d142021-03-13 11:00:33 +0100502 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200503 if (!bind_conf) {
504 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
505 return -1;
506 }
William Lallemand07a62f72017-05-24 00:57:40 +0200507 bind_conf->level &= ~ACCESS_LVL_MASK;
508 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100509
Willy Tarreau4975d142021-03-13 11:00:33 +0100510 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100511 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
512 file, line, args[0], args[1], err && *err ? *err : "error");
513 return -1;
514 }
515
516 cur_arg = 3;
517 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100518 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100519 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100520 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100521
522 kw = bind_find_kw(args[cur_arg]);
523 if (kw) {
524 if (!kw->parse) {
525 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
526 args[0], args[1], args[cur_arg]);
527 return -1;
528 }
529
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100530 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
531
532 /* FIXME: this is ugly, we don't have a way to collect warnings,
533 * yet some important bind keywords may report warnings that we
534 * must display.
535 */
536 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
537 indent_msg(err, 2);
538 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
539 ha_free(err);
540 }
541
542 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100543 if (err && *err)
544 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
545 else
546 memprintf(err, "'%s %s' : error encountered while processing '%s'",
547 args[0], args[1], args[cur_arg]);
548 return -1;
549 }
550
551 cur_arg += 1 + kw->skip;
552 continue;
553 }
554
Willy Tarreau433b05f2021-03-12 10:14:07 +0100555 best = bind_find_best_kw(args[cur_arg]);
556 if (best)
557 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
558 args[0], args[1], args[cur_arg], best);
559 else
560 memprintf(err, "'%s %s' : unknown keyword '%s'.",
561 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100562 return -1;
563 }
564
Willy Tarreau30836152023-01-12 19:10:17 +0100565 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +0100566 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +0100567 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +0100568
William Lallemand74c24fb2016-11-21 17:18:36 +0100569 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18215cb2019-02-27 16:25:28 +0100570 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100571 }
572 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100573 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100574 unsigned timeout;
575 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
576
Willy Tarreau9faebe32019-06-07 19:00:37 +0200577 if (res == PARSE_TIME_OVER) {
578 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
579 args[2], args[0], args[1]);
580 return -1;
581 }
582 else if (res == PARSE_TIME_UNDER) {
583 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
584 args[2], args[0], args[1]);
585 return -1;
586 }
587 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100588 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
589 return -1;
590 }
591
592 if (!timeout) {
593 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
594 return -1;
595 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100596 if (!global.cli_fe) {
597 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100598 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
599 return -1;
600 }
601 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100602 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100603 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100604 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100605 int maxconn = atol(args[2]);
606
607 if (maxconn <= 0) {
608 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
609 return -1;
610 }
611
Willy Tarreau4975d142021-03-13 11:00:33 +0100612 if (!global.cli_fe) {
613 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100614 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
615 return -1;
616 }
617 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100618 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100619 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200620 else if (strcmp(args[1], "bind-process") == 0) {
Willy Tarreau023c3112023-04-23 09:40:56 +0200621 memprintf(err, "'%s %s' is not supported anymore.", args[0], args[1]);
Willy Tarreau94f763b2022-07-15 17:14:40 +0200622 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100623 }
624 else {
625 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
626 return -1;
627 }
628 return 0;
629}
630
William Lallemand33d29e22019-04-01 11:30:06 +0200631/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200632 * This function exports the bound addresses of a <frontend> in the environment
633 * variable <varname>. Those addresses are separated by semicolons and prefixed
634 * with their type (abns@, unix@, sockpair@ etc)
635 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200636 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200637int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200638{
639 struct buffer *trash = get_trash_chunk();
640 struct bind_conf *bind_conf;
641
William Lallemand9a37fd02019-04-12 16:09:24 +0200642 if (frontend) {
643 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200644 struct listener *l;
645
646 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
647 char addr[46];
648 char port[6];
649
William Lallemand620072b2019-04-12 16:09:25 +0200650 /* separate listener by semicolons */
651 if (trash->data)
652 chunk_appendf(trash, ";");
653
Willy Tarreau37159062020-08-27 07:48:42 +0200654 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200655 const struct sockaddr_un *un;
656
Willy Tarreau37159062020-08-27 07:48:42 +0200657 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200658 if (un->sun_path[0] == '\0') {
659 chunk_appendf(trash, "abns@%s", un->sun_path+1);
660 } else {
661 chunk_appendf(trash, "unix@%s", un->sun_path);
662 }
Willy Tarreau37159062020-08-27 07:48:42 +0200663 } else if (l->rx.addr.ss_family == AF_INET) {
664 addr_to_str(&l->rx.addr, addr, sizeof(addr));
665 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200666 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200667 } else if (l->rx.addr.ss_family == AF_INET6) {
668 addr_to_str(&l->rx.addr, addr, sizeof(addr));
669 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200670 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200671 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
672 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200673 }
William Lallemand33d29e22019-04-01 11:30:06 +0200674 }
675 }
676 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200677 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200678 return -1;
679 }
680
681 return 0;
682}
683
William Lallemand9a37fd02019-04-12 16:09:24 +0200684int cli_socket_setenv()
685{
Willy Tarreau4975d142021-03-13 11:00:33 +0100686 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200687 return -1;
688 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
689 return -1;
690
691 return 0;
692}
693
William Lallemand33d29e22019-04-01 11:30:06 +0200694REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
695
Willy Tarreaude57a572016-11-23 17:01:39 +0100696/* Verifies that the CLI at least has a level at least as high as <level>
697 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
698 * failure, an error message is prepared and the appctx's state is adjusted
699 * to print it so that a return 1 is enough to abort any processing.
700 */
701int cli_has_level(struct appctx *appctx, int level)
702{
Willy Tarreaude57a572016-11-23 17:01:39 +0100703
William Lallemandf630d012018-12-13 09:05:44 +0100704 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100705 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100706 return 0;
707 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100708 return 1;
709}
710
William Lallemandb7ea1412018-12-13 09:05:47 +0100711/* same as cli_has_level but for the CLI proxy and without error message */
712int pcli_has_level(struct stream *s, int level)
713{
714 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
715 return 0;
716 }
717 return 1;
718}
719
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200720/* Returns severity_output for the current session if set, or default for the socket */
721static int cli_get_severity_output(struct appctx *appctx)
722{
723 if (appctx->cli_severity_output)
724 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200725 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200726}
William Lallemand74c24fb2016-11-21 17:18:36 +0100727
Willy Tarreau41908562016-11-24 16:23:38 +0100728/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100729 * from the CLI's IO handler running in an appctx context. The function returns
730 * 1 if the request was understood, otherwise zero (in which case an error
731 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100732 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
733 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
734 * have its own I/O handler called again. Most of the time, parsers will only
735 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100736 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
737 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100738 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200739static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100740{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100741 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200742 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100743 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100744
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200745 p = appctx->chunk->area;
746 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100747
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200749 * Get pointers on words.
750 * One extra slot is reserved to store a pointer on a null byte.
751 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100752 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200753 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100754
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200755 /* skip leading spaces/tabs */
756 p += strspn(p, " \t");
757 if (!*p)
758 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200759
760 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
761 /* payload pattern recognized here, this is not an arg anymore,
762 * the payload starts at the first byte that follows the zero
763 * after the pattern.
764 */
765 payload = p + strlen(PAYLOAD_PATTERN) + 1;
766 break;
767 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100768
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200769 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200770 while (1) {
771 p += strcspn(p, " \t\\");
772 /* escaped chars using backlashes (\) */
773 if (*p == '\\') {
774 if (!*++p)
775 break;
776 if (!*++p)
777 break;
778 } else {
779 break;
780 }
781 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200782 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100783
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200784 /* unescape backslashes (\) */
785 for (j = 0, k = 0; args[i][k]; k++) {
786 if (args[i][k] == '\\') {
787 if (args[i][k + 1] == '\\')
788 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100789 else
790 continue;
791 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200792 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100793 j++;
794 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200795 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100796
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200797 i++;
798 }
799 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200800 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100801 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200802 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100803
Willy Tarreau21d71252023-05-11 16:32:56 +0200804 if (!**args)
805 return 0;
806
Willy Tarreau41908562016-11-24 16:23:38 +0100807 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100808 if (!kw ||
809 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100810 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
811 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100812 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100813 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100814 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100815 }
William Lallemand14721be2018-10-26 14:47:37 +0200816
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100817 /* don't handle expert mode commands if not in this mode. */
818 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
819 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200820 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100821 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200822
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100823 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
824 cli_err(appctx, "This command is restricted to experimental mode only.\n");
825 return 0;
826 }
827
Amaury Denoyellef4929922021-05-05 16:29:23 +0200828 if (kw->level == ACCESS_EXPERT)
829 mark_tainted(TAINTED_CLI_EXPERT_MODE);
830 else if (kw->level == ACCESS_EXPERIMENTAL)
831 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
832
Willy Tarreau41908562016-11-24 16:23:38 +0100833 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200834 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200835
836 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
837 goto fail;
838
839 /* kw->parse could set its own io_handler or io_release handler */
840 if (!appctx->io_handler)
841 goto fail;
842
843 appctx->st0 = CLI_ST_CALLBACK;
844 return 1;
845fail:
846 appctx->io_handler = NULL;
847 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100848 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100849}
850
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200851/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200852static int cli_output_msg(struct appctx *appctx, const char *msg, int severity, int severity_output)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200853{
Willy Tarreau83061a82018-07-13 11:56:34 +0200854 struct buffer *tmp;
Willy Tarreau0239f322024-02-08 18:15:23 +0100855 struct ist imsg;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200856
857 tmp = get_trash_chunk();
858 chunk_reset(tmp);
859
Willy Tarreau0239f322024-02-08 18:15:23 +0100860 if (likely(severity_output == CLI_SEVERITY_NONE))
861 goto send_it;
862
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200863 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100864 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200865 chunk_printf(tmp, "[%d]: ", severity);
866 }
867 else {
868 switch (severity_output) {
869 case CLI_SEVERITY_NUMBER:
870 chunk_printf(tmp, "[%d]: ", severity);
871 break;
872 case CLI_SEVERITY_STRING:
873 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
874 break;
875 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100876 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200877 }
878 }
Willy Tarreau0239f322024-02-08 18:15:23 +0100879 send_it:
880 /* the vast majority of messages have their trailing LF but a few are
881 * still missing it, and very rare ones might even have two. For this
882 * reason, we'll first delete the trailing LFs if present, then
883 * systematically append one.
884 */
885 for (imsg = ist(msg); imsg.len > 0 && imsg.ptr[imsg.len - 1] == '\n'; imsg.len--)
886 ;
887
888 chunk_istcat(tmp, imsg);
889 chunk_istcat(tmp, ist("\n"));
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200890
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200891 return applet_putchk(appctx, tmp);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200892}
893
Willy Tarreau4596fe22022-05-17 19:07:51 +0200894/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100895 * used to processes I/O from/to the stats unix socket. The system relies on a
896 * state machine handling requests and various responses. We read a request,
897 * then we process it and send the response, and we possibly display a prompt.
898 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100899 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100900 * or not.
901 */
902static void cli_io_handler(struct appctx *appctx)
903{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200904 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200905 struct channel *req = sc_oc(sc);
906 struct channel *res = sc_ic(sc);
907 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100908 int reql;
909 int len;
910
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200911 if (unlikely(se_fl_test(appctx->sedesc, (SE_FL_EOS|SE_FL_ERROR|SE_FL_SHR|SE_FL_SHW)))) {
912 co_skip(sc_oc(sc), co_data(sc_oc(sc)));
William Lallemand74c24fb2016-11-21 17:18:36 +0100913 goto out;
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200914 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100915
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800916 /* Check if the input buffer is available. */
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200917 if (!b_size(&res->buf)) {
Christopher Faulet7b3d38a2023-05-05 11:28:45 +0200918 sc_need_room(sc, 0);
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100919 goto out;
920 }
921
William Lallemand74c24fb2016-11-21 17:18:36 +0100922 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100923 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200924 /* reset severity to default at init */
925 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau1addf8b2022-08-18 18:04:37 +0200926 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100927 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100928 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100929 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100930 else if (appctx->st0 == CLI_ST_END) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200931 se_fl_set(appctx->sedesc, SE_FL_EOS);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200932 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200933 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100934 break;
935 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100936 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200937 char *str;
938
939 /* use a trash chunk to store received data */
940 if (!appctx->chunk) {
941 appctx->chunk = alloc_trash_chunk();
942 if (!appctx->chunk) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200943 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200944 appctx->st0 = CLI_ST_END;
945 continue;
946 }
947 }
948
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200949 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200950
William Lallemand74c24fb2016-11-21 17:18:36 +0100951 /* ensure we have some output room left in the event we
952 * would want to return some info right after parsing.
953 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200954 if (buffer_almost_full(sc_ib(sc))) {
Christopher Faulet7b3d38a2023-05-05 11:28:45 +0200955 sc_need_room(sc, b_size(&res->buf) / 2);
William Lallemand74c24fb2016-11-21 17:18:36 +0100956 break;
957 }
958
Willy Tarreau0011c252022-01-19 17:23:52 +0100959 /* payload doesn't take escapes nor does it end on semi-colons, so
960 * we use the regular getline. Normal mode however must stop on
961 * LFs and semi-colons that are not prefixed by a backslash. Note
962 * that we reserve one byte at the end to insert a trailing nul byte.
963 */
964
965 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200966 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100967 appctx->chunk->size - appctx->chunk->data - 1);
968 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200969 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100970 appctx->chunk->size - appctx->chunk->data - 1,
971 "\n;", '\\');
972
William Lallemand74c24fb2016-11-21 17:18:36 +0100973 if (reql <= 0) { /* closed or EOL not found */
974 if (reql == 0)
975 break;
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200976 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100977 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100978 continue;
979 }
980
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200981 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
982 /* seek for a possible unescaped semi-colon. If we find
983 * one, we replace it with an LF and skip only this part.
984 */
985 for (len = 0; len < reql; len++) {
986 if (str[len] == '\\') {
987 len++;
988 continue;
989 }
990 if (str[len] == ';') {
991 str[len] = '\n';
992 reql = len + 1;
993 break;
994 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100995 }
996 }
997
998 /* now it is time to check that we have a full line,
999 * remove the trailing \n and possibly \r, then cut the
1000 * line.
1001 */
1002 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001003 if (str[len] != '\n') {
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001004 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001005 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001006 continue;
1007 }
1008
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001009 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +01001010 len--;
1011
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001012 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001013 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001014
1015 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001016 appctx->chunk->area[appctx->chunk->data] = '\n';
1017 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1018 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001019 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001020
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001021 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001022
1023 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1024 /* empty line */
1025 if (!len) {
1026 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001027 appctx->chunk->data -= 2;
1028 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001029 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001030 chunk_reset(appctx->chunk);
1031 /* NB: cli_sock_parse_request() may have put
1032 * another CLI_ST_O_* into appctx->st0.
1033 */
1034
1035 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001036 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001037 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001038 else {
1039 /*
1040 * Look for the "payload start" pattern at the end of a line
1041 * Its location is not remembered here, this is just to switch
1042 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001043 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001044 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001045 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001046 appctx->chunk->data++; // keep the trailing \0 after '<<'
1047 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001048 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001049 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001050 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001051 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001052 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001053 }
1054
1055 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001056 co_skip(sc_oc(sc), reql);
Christopher Faulet9a790f62023-03-16 14:40:03 +01001057 sc_opposite(sc)->flags |= SC_FL_RCV_ONCE; /* we plan to read small requests */
William Lallemand74c24fb2016-11-21 17:18:36 +01001058 }
1059 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001060 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001061 const char *msg;
1062 int sev;
1063
William Lallemand74c24fb2016-11-21 17:18:36 +01001064 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001065 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001066 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001067 case CLI_ST_PRINT: /* print const message in msg */
1068 case CLI_ST_PRINT_ERR: /* print const error in msg */
1069 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001070 case CLI_ST_PRINT_DYNERR: /* print dyn error in err, free */
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001071 case CLI_ST_PRINT_UMSG: /* print usermsgs_ctx and reset it */
1072 case CLI_ST_PRINT_UMSGERR: /* print usermsgs_ctx as error and reset it */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001073 /* the message is in the svcctx */
1074 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001075 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1076 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001077 LOG_ERR : ctx->severity;
1078 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001079 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001080 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
1081 sev = appctx->st0 == CLI_ST_PRINT_DYNERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001082 LOG_ERR : ctx->severity;
1083 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001084 if (!msg) {
1085 sev = LOG_ERR;
1086 msg = "Out of memory.\n";
1087 }
1088 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001089 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1090 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1091 sev = appctx->st0 == CLI_ST_PRINT_UMSGERR ?
1092 LOG_ERR : ctx->severity;
1093 msg = usermsgs_str();
1094 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001095 else {
1096 sev = LOG_ERR;
1097 msg = "Internal error.\n";
1098 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001099
Christopher Faulete8ee27b2023-05-05 10:56:00 +02001100 if (cli_output_msg(appctx, msg, sev, cli_get_severity_output(appctx)) != -1) {
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001101 if (appctx->st0 == CLI_ST_PRINT_DYN ||
1102 appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001103 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001104 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001105 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1106 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1107 usermsgs_clr(NULL);
1108 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001109 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001110 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001111 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001112
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001113 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001114 if (appctx->io_handler)
1115 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001116 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001117 if (appctx->io_release) {
1118 appctx->io_release(appctx);
1119 appctx->io_release = NULL;
1120 }
1121 }
1122 break;
1123 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001124 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001125 break;
1126 }
1127
1128 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001129 if (appctx->st0 == CLI_ST_PROMPT) {
Willy Tarreau22555572023-05-04 14:22:36 +02001130 char prompt_buf[20];
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001131 const char *prompt = "";
1132
1133 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1134 /*
1135 * when entering a payload with interactive mode, change the prompt
1136 * to emphasize that more data can still be sent
1137 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001138 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001139 prompt = "+ ";
Willy Tarreau22555572023-05-04 14:22:36 +02001140 else if (appctx->st1 & APPCTX_CLI_ST1_TIMED) {
1141 uint up = ns_to_sec(now_ns - start_time_ns);
1142 snprintf(prompt_buf, sizeof(prompt_buf),
1143 "\n[%u:%02u:%02u:%02u]> ",
1144 (up / 86400), (up / 3600) % 24, (up / 60) % 60, up % 60);
1145 prompt = prompt_buf;
1146 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001147 else
1148 prompt = "\n> ";
1149 }
1150 else {
William Lallemandad032882019-07-01 10:56:15 +02001151 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001152 prompt = "\n";
1153 }
1154
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001155 if (applet_putstr(appctx, prompt) != -1) {
1156 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001157 appctx->st0 = CLI_ST_GETREQ;
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001158 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001159 }
1160
1161 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001162 if (appctx->st0 >= CLI_ST_OUTPUT) {
1163 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001164 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001165 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001166
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001167 /* Now we close the output if we're not in interactive
1168 * mode and the request buffer is empty. This still
1169 * allows pipelined requests to be sent in
1170 * non-interactive mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001171 */
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001172 if (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))) {
1173 se_fl_set(appctx->sedesc, SE_FL_EOI);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001174 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001175 continue;
1176 }
1177
1178 /* switch state back to GETREQ to read next requests */
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001179 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001180 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001181 applet_will_consume(appctx);
Christopher Faulet806c0d62023-09-06 09:17:33 +02001182 applet_expect_data(appctx);
Christopher Faulet4167e052022-06-01 17:25:42 +02001183
William Lallemandad032882019-07-01 10:56:15 +02001184 /* reactivate the \n at the end of the response for the next command */
1185 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001186
1187 /* this forces us to yield between pipelined commands and
1188 * avoid extremely long latencies (e.g. "del map" etc). In
1189 * addition this increases the likelihood that the stream
1190 * refills the buffer with new bytes in non-interactive
1191 * mode, avoiding to close on apparently empty commands.
1192 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001193 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001194 appctx_wakeup(appctx);
1195 goto out;
1196 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001197 }
1198 }
1199
William Lallemand74c24fb2016-11-21 17:18:36 +01001200 out:
Christopher Faulet845f7c42023-04-18 18:36:43 +02001201 return;
William Lallemand74c24fb2016-11-21 17:18:36 +01001202}
1203
Willy Tarreau4596fe22022-05-17 19:07:51 +02001204/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001205 * external abort, we won't call the i/o handler anymore so we may need to
1206 * remove back references to the stream currently being dumped.
1207 */
1208static void cli_release_handler(struct appctx *appctx)
1209{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001210 free_trash_chunk(appctx->chunk);
1211 appctx->chunk = NULL;
1212
William Lallemand74c24fb2016-11-21 17:18:36 +01001213 if (appctx->io_release) {
1214 appctx->io_release(appctx);
1215 appctx->io_release = NULL;
1216 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001217 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001218 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1219
1220 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001221 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001222 else if (appctx->st0 == CLI_ST_PRINT_UMSG || appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1223 usermsgs_clr(NULL);
1224 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001225}
1226
1227/* This function dumps all environmnent variables to the buffer. It returns 0
1228 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001229 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1230 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001231 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001232static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001233{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001234 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001235 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001236 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001237
Christopher Faulet87633c32023-04-03 18:32:50 +02001238 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001239 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
William Lallemand74c24fb2016-11-21 17:18:36 +01001240 return 1;
1241
1242 chunk_reset(&trash);
1243
1244 /* we have two inner loops here, one for the proxy, the other one for
1245 * the buffer.
1246 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001247 while (*var) {
1248 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001249
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001250 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001251 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001252
Willy Tarreau307dbb32022-05-05 17:45:52 +02001253 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001254 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001255 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001256 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001257 }
1258
1259 /* dump complete */
1260 return 1;
1261}
1262
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001263/* This function dumps all file descriptors states (or the requested one) to
1264 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001265 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1266 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1267 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001268 */
1269static int cli_io_handler_show_fd(struct appctx *appctx)
1270{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001271 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001272 struct show_fd_ctx *fdctx = appctx->svcctx;
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001273 uint match = fdctx->show_mask;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001274 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001275 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001276
Christopher Faulet87633c32023-04-03 18:32:50 +02001277 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001278 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001279 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001280
1281 chunk_reset(&trash);
1282
Willy Tarreauca1b1572018-12-18 15:45:11 +01001283 /* isolate the threads once per round. We're limited to a buffer worth
1284 * of output anyway, it cannot last very long.
1285 */
1286 thread_isolate();
1287
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001288 /* we have two inner loops here, one for the proxy, the other one for
1289 * the buffer.
1290 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001291 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001292 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001293 const struct listener *li = NULL;
1294 const struct server *sv = NULL;
1295 const struct proxy *px = NULL;
1296 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001297 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001298 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001299 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001300 const void *xprt_ctx = NULL;
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001301 const struct quic_conn *qc = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001302 uint32_t conn_flags = 0;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001303 uint8_t conn_err = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001304 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001305 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001306
1307 fdt = fdtab[fd];
1308
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001309 /* When DEBUG_FD is set, we also report closed FDs that have a
1310 * non-null event count to detect stuck ones.
1311 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001312 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001313#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001314 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001315#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001316 goto skip; // closed
1317 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001318 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001319 conn = (const struct connection *)fdt.owner;
1320 conn_flags = conn->flags;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001321 conn_err = conn->err_code;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001322 mux = conn->mux;
1323 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001324 xprt = conn->xprt;
1325 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001326 li = objt_listener(conn->target);
1327 sv = objt_server(conn->target);
1328 px = objt_proxy(conn->target);
1329 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001330 if (atleast2(fdt.thread_mask))
1331 suspicious = 1;
1332 if (conn->handle.fd != fd)
1333 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001334 }
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001335#if defined(USE_QUIC)
1336 else if (fdt.iocb == quic_conn_sock_fd_iocb) {
1337 qc = fdtab[fd].owner;
1338 li = qc ? qc->li : NULL;
1339 xprt_ctx = qc ? qc->xprt_ctx : NULL;
1340 conn = qc ? qc->conn : NULL;
1341 xprt = conn ? conn->xprt : NULL; // in fact it's &ssl_quic
1342 mux = conn ? conn->mux : NULL;
1343 /* quic_conns don't always have a connection but they
1344 * always have an xprt_ctx.
1345 */
1346 }
1347 else if (fdt.iocb == quic_lstnr_sock_fd_iocb) {
1348 li = objt_listener(fdtab[fd].owner);
1349 }
1350#endif
Willy Tarreaua74cb382020-10-15 21:29:49 +02001351 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001352 li = fdt.owner;
1353
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001354 if (!(((conn || xprt_ctx) &&
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001355 ((match & CLI_SHOWFD_F_SV && sv) ||
1356 (match & CLI_SHOWFD_F_PX && px) ||
1357 (match & CLI_SHOWFD_F_FE && li))) ||
1358 (!conn &&
1359 ((match & CLI_SHOWFD_F_LI && li) ||
1360 (match & CLI_SHOWFD_F_PI && !li /* only pipes match this */))))) {
1361 /* not a desired type */
1362 goto skip;
1363 }
1364
Willy Tarreaudacfde42021-01-21 09:07:29 +01001365 if (!fdt.thread_mask)
1366 suspicious = 1;
1367
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001368 chunk_printf(&trash,
Willy Tarreau677c0062023-03-02 15:05:31 +01001369 " %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 +02001370 fd,
1371 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001372 (fdt.state & FD_CLONED) ? 'C' : 'c',
1373 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001374 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1375 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1376 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1377 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1378 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001379 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1380 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1381 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1382 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1383 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1384 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001385 (fdt.refc_tgid >> 4) & 0xffff,
1386 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001387 fdt.thread_mask, fdt.update_mask,
Willy Tarreau677c0062023-03-02 15:05:31 +01001388 polled_mask[fd].poll_recv,
1389 polled_mask[fd].poll_send,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001390 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001391 fdt.iocb);
1392 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001393
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001394 if (!fdt.owner) {
1395 chunk_appendf(&trash, ")");
1396 }
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001397 else if (conn) {
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001398 chunk_appendf(&trash, ") back=%d cflg=0x%08x cerr=%d", is_back, conn_flags, conn_err);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001399
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001400 if (!(conn->flags & CO_FL_FDLESS) && conn->handle.fd != fd) {
Willy Tarreaudacfde42021-01-21 09:07:29 +01001401 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1402 suspicious = 1;
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001403 } else if ((conn->flags & CO_FL_FDLESS) && (qc != conn->handle.qc)) {
1404 chunk_appendf(&trash, " qc=%p(BOGUS)", conn->handle.qc);
1405 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001406 } else {
1407 struct sockaddr_storage sa;
1408 socklen_t salen;
1409
1410 salen = sizeof(sa);
1411 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1412 if (sa.ss_family == AF_INET)
1413 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1414 else if (sa.ss_family == AF_INET6)
1415 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1416 else if (sa.ss_family == AF_UNIX)
1417 chunk_appendf(&trash, " fam=unix");
1418 }
1419
1420 salen = sizeof(sa);
1421 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1422 if (sa.ss_family == AF_INET)
1423 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1424 else if (sa.ss_family == AF_INET6)
1425 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1426 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001427 }
1428
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001429 if (px)
1430 chunk_appendf(&trash, " px=%s", px->id);
1431 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001432 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001433 else if (li)
1434 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001435
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001436 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001437 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001438 if (!ctx && !qc)
Willy Tarreaudacfde42021-01-21 09:07:29 +01001439 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001440 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001441 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001442 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001443 else
1444 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001445
1446 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001447 if (xprt) {
1448 if (xprt_ctx || xprt->show_fd)
1449 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1450 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001451 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001452 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001453 }
Willy Tarreaufe0ba0e2023-05-11 17:06:22 +02001454 else if (li && !xprt_ctx) {
Willy Tarreaued989202021-02-05 10:54:52 +01001455 struct sockaddr_storage sa;
1456 socklen_t salen;
1457
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001458 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001459 listener_state_str(li),
1460 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001461
1462 salen = sizeof(sa);
1463 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1464 if (sa.ss_family == AF_INET)
1465 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1466 else if (sa.ss_family == AF_INET6)
1467 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1468 else if (sa.ss_family == AF_UNIX)
1469 chunk_appendf(&trash, " fam=unix");
1470 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001471 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001472 else
1473 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001474
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001475#ifdef DEBUG_FD
1476 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001477 if (fdtab[fd].event_count >= 1000000)
1478 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001479#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001480 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001481
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001482 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001483 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001484 ret = 0;
1485 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001486 }
1487 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001488 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001489 break;
1490
1491 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001492 }
1493
Willy Tarreauca1b1572018-12-18 15:45:11 +01001494 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001495 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001496
1497 thread_release();
1498 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001499}
1500
William Lallemandeceddf72016-12-15 18:06:44 +01001501/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001502 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001503 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1504 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001505 */
1506static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1507{
Willy Tarreaub128f492022-05-05 19:11:05 +02001508 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1509 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001510
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001511 if (!global.cli_fe)
1512 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001513
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001514 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001515
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001516 if (!bind_conf) {
1517 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001518 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001519 goto full;
1520 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1521 }
William Lallemandeceddf72016-12-15 18:06:44 +01001522
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001523 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001524 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001525
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001526 if (!l)
1527 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001528
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001529 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1530 char addr[46];
1531 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001532
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001533 if (l->rx.addr.ss_family == AF_UNIX) {
1534 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001535
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001536 un = (struct sockaddr_un *)&l->rx.addr;
1537 if (un->sun_path[0] == '\0') {
1538 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1539 } else {
1540 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1541 }
1542 } else if (l->rx.addr.ss_family == AF_INET) {
1543 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1544 port_to_str(&l->rx.addr, port, sizeof(port));
1545 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1546 } else if (l->rx.addr.ss_family == AF_INET6) {
1547 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1548 port_to_str(&l->rx.addr, port, sizeof(port));
1549 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1550 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1551 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1552 } else
1553 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001554
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001555 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1556 chunk_appendf(&trash, "admin ");
1557 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1558 chunk_appendf(&trash, "operator ");
1559 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1560 chunk_appendf(&trash, "user ");
1561 else
1562 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001563
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001564 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001565
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001566 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001567 ctx->bind_conf = bind_conf;
1568 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001569 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001570 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001571 }
William Lallemandeceddf72016-12-15 18:06:44 +01001572 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001573 done:
1574 return 1;
1575 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001576 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001577}
1578
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001579
Willy Tarreau0a739292016-11-22 20:21:23 +01001580/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001581 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1582 * be dumped as well as a flag if a single variable is requested, otherwise puts
1583 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001584 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001585static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001586{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001587 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001588 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001589 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001590
1591 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1592 return 1;
1593
Willy Tarreauf6710f82016-12-16 17:45:44 +01001594 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001595
1596 if (*args[2]) {
1597 int len = strlen(args[2]);
1598
Willy Tarreauf6710f82016-12-16 17:45:44 +01001599 for (; *var; var++) {
1600 if (strncmp(*var, args[2], len) == 0 &&
1601 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001602 break;
1603 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001604 if (!*var)
1605 return cli_err(appctx, "Variable not found\n");
1606
Willy Tarreau307dbb32022-05-05 17:45:52 +02001607 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001608 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001609 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001610 return 0;
1611}
1612
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001613/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001614 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1615 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001616 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001617static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001618{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001619 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001620 const char *c;
1621 int arg;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001622
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001623 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1624 return 1;
1625
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001626 arg = 2;
1627
1628 /* when starting with an inversion we preset every flag */
1629 if (*args[arg] == '!' || *args[arg] == '-')
1630 ctx->show_mask = CLI_SHOWFD_F_ANY;
1631
1632 while (*args[arg] && !isdigit((uchar)*args[arg])) {
1633 uint flag = 0, inv = 0;
1634 c = args[arg];
1635 while (*c) {
1636 switch (*c) {
1637 case '!': inv = !inv; break;
1638 case '-': inv = !inv; break;
1639 case 'p': flag = CLI_SHOWFD_F_PI; break;
1640 case 'l': flag = CLI_SHOWFD_F_LI; break;
1641 case 'c': flag = CLI_SHOWFD_F_CO; break;
1642 case 'f': flag = CLI_SHOWFD_F_FE; break;
1643 case 'b': flag = CLI_SHOWFD_F_BE; break;
1644 case 's': flag = CLI_SHOWFD_F_SV; break;
1645 case 'd': flag = CLI_SHOWFD_F_PX; break;
1646 default: return cli_err(appctx, "Invalid FD type\n");
1647 }
1648 c++;
1649 if (!inv)
1650 ctx->show_mask |= flag;
1651 else
1652 ctx->show_mask &= ~flag;
1653 }
1654 arg++;
1655 }
1656
1657 /* default mask is to show everything */
1658 if (!ctx->show_mask)
1659 ctx->show_mask = CLI_SHOWFD_F_ANY;
1660
1661 if (*args[arg]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001662 ctx->fd = atoi(args[2]);
1663 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001664 }
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001665
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001666 return 0;
1667}
1668
Willy Tarreau599852e2016-11-22 20:33:32 +01001669/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001670static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001671{
Willy Tarreau0698c802022-05-11 14:09:57 +02001672 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001673
1674 if (strcmp(args[2], "cli") == 0) {
1675 unsigned timeout;
1676 const char *res;
1677
Willy Tarreau9d008692019-08-09 11:21:01 +02001678 if (!*args[3])
1679 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001680
1681 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001682 if (res || timeout < 1)
1683 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001684
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01001685 s->scf->ioto = 1 + MS_TO_TICKS(timeout*1000);
Willy Tarreau599852e2016-11-22 20:33:32 +01001686 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1687 return 1;
1688 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001689
1690 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001691}
1692
Willy Tarreau2af99412016-11-23 11:10:59 +01001693/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001694static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001695{
1696 int v;
1697
1698 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1699 return 1;
1700
Willy Tarreau9d008692019-08-09 11:21:01 +02001701 if (!*args[3])
1702 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001703
1704 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001705 if (v > global.hardmaxconn)
1706 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001707
1708 /* check for unlimited values */
1709 if (v <= 0)
1710 v = global.hardmaxconn;
1711
1712 global.maxconn = v;
1713
1714 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001715 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001716
1717 return 1;
1718}
1719
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001720static int set_severity_output(int *target, char *argument)
1721{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001722 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001723 *target = CLI_SEVERITY_NONE;
1724 return 1;
1725 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001726 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001727 *target = CLI_SEVERITY_NUMBER;
1728 return 1;
1729 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001730 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001731 *target = CLI_SEVERITY_STRING;
1732 return 1;
1733 }
1734 return 0;
1735}
1736
1737/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001738static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001739{
William Lallemand74381812023-12-06 11:15:01 +01001740 /* this will ask the applet to not output a \n after the command */
1741 if (strcmp(args[3], "-") == 0)
1742 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1743
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001744 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1745 return 0;
1746
Willy Tarreau9d008692019-08-09 11:21:01 +02001747 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001748}
William Lallemandeceddf72016-12-15 18:06:44 +01001749
William Lallemand67a234f2018-12-13 09:05:45 +01001750
1751/* show the level of the current CLI session */
1752static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1753{
William Lallemand67a234f2018-12-13 09:05:45 +01001754 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001755 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001756 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001757 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001758 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001759 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001760 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001761 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001762}
1763
1764/* parse and set the CLI level dynamically */
1765static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1766{
William Lallemandad032882019-07-01 10:56:15 +02001767 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001768 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001769 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1770
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001771 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001772 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1773 return 1;
1774 }
1775 appctx->cli_level &= ~ACCESS_LVL_MASK;
1776 appctx->cli_level |= ACCESS_LVL_OPER;
1777
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001778 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001779 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1780 return 1;
1781 }
1782 appctx->cli_level &= ~ACCESS_LVL_MASK;
1783 appctx->cli_level |= ACCESS_LVL_USER;
1784 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001785 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001786 return 1;
1787}
1788
1789
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001790/* parse and set the CLI expert/experimental-mode dynamically */
1791static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001792{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001793 int level;
1794 char *level_str;
1795 char *output = NULL;
1796
William Lallemand7267f782022-02-01 16:08:50 +01001797 /* this will ask the applet to not output a \n after the command */
1798 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1799 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1800
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001801 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1802 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001803
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001804 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001805 level = ACCESS_EXPERT;
1806 level_str = "expert-mode";
1807 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001808 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001809 level = ACCESS_EXPERIMENTAL;
1810 level_str = "experimental-mode";
1811 }
William Lallemand2a171912022-02-02 11:43:20 +01001812 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1813 level = ACCESS_MCLI_DEBUG;
1814 level_str = "mcli-debug-mode";
1815 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001816 else {
1817 return 1;
1818 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001819
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001820 if (!*args[1]) {
1821 memprintf(&output, "%s is %s\n", level_str,
1822 (appctx->cli_level & level) ? "ON" : "OFF");
1823 return cli_dynmsg(appctx, LOG_INFO, output);
1824 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001825
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001826 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001827 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001828 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001829 return 1;
1830}
1831
William Lallemand740629e2021-12-14 15:22:29 +01001832/* shows HAProxy version */
1833static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1834{
1835 char *msg = NULL;
1836
1837 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1838}
1839
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001840int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001841{
1842 return 0;
1843}
1844
Erwan Le Goas54966df2022-09-14 17:24:22 +02001845/* enable or disable the anonymized mode, it returns 1 when it works or displays an error message if it doesn't. */
1846static int cli_parse_set_anon(char **args, char *payload, struct appctx *appctx, void *private)
1847{
1848 uint32_t tmp;
1849 long long key;
1850
1851 if (strcmp(args[2], "on") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001852
1853 if (*args[3]) {
1854 key = atoll(args[3]);
1855 if (key < 1 || key > UINT_MAX)
1856 return cli_err(appctx, "Value out of range (1 to 4294967295 expected).\n");
1857 appctx->cli_anon_key = key;
1858 }
Erwan Le Goas54966df2022-09-14 17:24:22 +02001859 else {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001860 tmp = HA_ATOMIC_LOAD(&global.anon_key);
1861 if (tmp != 0)
1862 appctx->cli_anon_key = tmp;
1863 else
1864 appctx->cli_anon_key = ha_random32();
Erwan Le Goas54966df2022-09-14 17:24:22 +02001865 }
1866 }
1867 else if (strcmp(args[2], "off") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001868
1869 if (*args[3]) {
Erwan Le Goas54966df2022-09-14 17:24:22 +02001870 return cli_err(appctx, "Key can't be added while disabling anonymized mode\n");
1871 }
1872 else {
1873 appctx->cli_anon_key = 0;
1874 }
1875 }
1876 else {
1877 return cli_err(appctx,
1878 "'set anon' only supports :\n"
1879 " - 'on' [key] to enable the anonymized mode\n"
1880 " - 'off' to disable the anonymized mode");
1881 }
1882 return 1;
1883}
1884
Erwan Le Goasfad9da82022-09-14 17:24:22 +02001885/* This function set the global anonyzing key, restricted to level 'admin' */
1886static int cli_parse_set_global_key(char **args, char *payload, struct appctx *appctx, void *private)
1887{
1888 long long key;
1889
1890 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1891 return cli_err(appctx, "Permission denied\n");
1892 if (!*args[2])
1893 return cli_err(appctx, "Expects an integer value.\n");
1894
1895 key = atoll(args[2]);
1896 if (key < 0 || key > UINT_MAX)
1897 return cli_err(appctx, "Value out of range (0 to 4294967295 expected).\n");
1898
1899 HA_ATOMIC_STORE(&global.anon_key, key);
1900 return 1;
1901}
1902
Erwan Le Goas54966df2022-09-14 17:24:22 +02001903/* shows the anonymized mode state to everyone, and the key except for users, it always returns 1. */
1904static int cli_parse_show_anon(char **args, char *payload, struct appctx *appctx, void *private)
1905{
1906 char *msg = NULL;
1907 char *anon_mode = NULL;
1908 uint32_t c_key = appctx->cli_anon_key;
1909
1910 if (!c_key)
1911 anon_mode = "Anonymized mode disabled";
1912 else
1913 anon_mode = "Anonymized mode enabled";
1914
1915 if ( !((appctx->cli_level & ACCESS_LVL_MASK) < ACCESS_LVL_OPER) && c_key != 0) {
1916 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\nKey : %u\n", anon_mode, c_key));
1917 }
1918 else {
1919 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", anon_mode));
1920 }
1921
1922 return 1;
1923}
1924
Willy Tarreau45c742b2016-11-24 14:51:17 +01001925/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001926static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001927{
1928 int v;
1929 int *res;
1930 int mul = 1;
1931
1932 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1933 return 1;
1934
1935 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1936 res = &global.cps_lim;
1937 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1938 res = &global.sps_lim;
1939#ifdef USE_OPENSSL
1940 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1941 res = &global.ssl_lim;
1942#endif
1943 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1944 res = &global.comp_rate_lim;
1945 mul = 1024;
1946 }
1947 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001948 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001949 "'set rate-limit' only supports :\n"
1950 " - 'connections global' to set the per-process maximum connection rate\n"
1951 " - 'sessions global' to set the per-process maximum session rate\n"
1952#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001953 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001954#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001955 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001956 }
1957
Willy Tarreau9d008692019-08-09 11:21:01 +02001958 if (!*args[4])
1959 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001960
1961 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001962 if (v < 0)
1963 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001964
1965 *res = v * mul;
1966
1967 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001968 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001969
1970 return 1;
1971}
1972
William Lallemandf6975e92017-05-26 17:42:10 +02001973/* parse the "expose-fd" argument on the bind lines */
1974static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1975{
1976 if (!*args[cur_arg + 1]) {
1977 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1978 return ERR_ALERT | ERR_FATAL;
1979 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001980 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001981 conf->level |= ACCESS_FD_LISTENERS;
1982 } else {
1983 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1984 args[cur_arg], args[cur_arg+1]);
1985 return ERR_ALERT | ERR_FATAL;
1986 }
1987
1988 return 0;
1989}
1990
William Lallemand74c24fb2016-11-21 17:18:36 +01001991/* parse the "level" argument on the bind lines */
1992static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1993{
1994 if (!*args[cur_arg + 1]) {
1995 memprintf(err, "'%s' : missing level", args[cur_arg]);
1996 return ERR_ALERT | ERR_FATAL;
1997 }
1998
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001999 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02002000 conf->level &= ~ACCESS_LVL_MASK;
2001 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002002 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02002003 conf->level &= ~ACCESS_LVL_MASK;
2004 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002005 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02002006 conf->level &= ~ACCESS_LVL_MASK;
2007 conf->level |= ACCESS_LVL_ADMIN;
2008 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01002009 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
2010 args[cur_arg], args[cur_arg+1]);
2011 return ERR_ALERT | ERR_FATAL;
2012 }
2013
2014 return 0;
2015}
2016
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02002017static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
2018{
2019 if (!*args[cur_arg + 1]) {
2020 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
2021 return ERR_ALERT | ERR_FATAL;
2022 }
2023
2024 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
2025 return 0;
2026 else {
2027 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
2028 args[cur_arg], args[cur_arg+1]);
2029 return ERR_ALERT | ERR_FATAL;
2030 }
2031}
2032
Olivier Houchardf886e342017-04-05 22:24:59 +02002033/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002034static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02002035{
William Lallemandb5d062d2022-07-28 15:33:41 +02002036 static int already_sent = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002037 char *cmsgbuf = NULL;
2038 unsigned char *tmpbuf = NULL;
2039 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02002040 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02002041 struct stream *s = __sc_strm(sc);
2042 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02002043 struct msghdr msghdr;
2044 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02002045 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002046 const char *ns_name, *if_name;
2047 unsigned char ns_nlen, if_nlen;
2048 int nb_queued;
2049 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002050 int *tmpfd;
2051 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002052 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002053 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002054 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002055 int ret;
2056
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002057 if (!remote) {
2058 ha_warning("Only works on real connections\n");
2059 goto out;
2060 }
2061
2062 fd = remote->handle.fd;
2063
Olivier Houchardf886e342017-04-05 22:24:59 +02002064 /* Temporary set the FD in blocking mode, that will make our life easier */
2065 old_fcntl = fcntl(fd, F_GETFL);
2066 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002067 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002068 goto out;
2069 }
2070 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2071 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002072 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002073 goto out;
2074 }
2075 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002076 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002077 goto out;
2078 }
Olivier Houchard54740872017-04-06 14:45:14 +02002079 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002080 iov.iov_base = &tot_fd_nb;
2081 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002082 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002083 goto out;
2084 memset(&msghdr, 0, sizeof(msghdr));
2085 /*
2086 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002087 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002088 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002089 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002090 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002091
William Lallemandb5d062d2022-07-28 15:33:41 +02002092 if (tot_fd_nb == 0) {
2093 if (already_sent)
2094 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 +02002095 goto out;
William Lallemandb5d062d2022-07-28 15:33:41 +02002096 }
Olivier Houchardf886e342017-04-05 22:24:59 +02002097
2098 /* First send the total number of file descriptors, so that the
2099 * receiving end knows what to expect.
2100 */
2101 msghdr.msg_iov = &iov;
2102 msghdr.msg_iovlen = 1;
2103 ret = sendmsg(fd, &msghdr, 0);
2104 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002105 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002106 goto out;
2107 }
2108
2109 /* Now send the fds */
2110 msghdr.msg_control = cmsgbuf;
2111 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2112 cmsg = CMSG_FIRSTHDR(&msghdr);
2113 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2114 cmsg->cmsg_level = SOL_SOCKET;
2115 cmsg->cmsg_type = SCM_RIGHTS;
2116 tmpfd = (int *)CMSG_DATA(cmsg);
2117
Olivier Houchardf886e342017-04-05 22:24:59 +02002118 /* For each socket, e message is sent, containing the following :
2119 * Size of the namespace name (or 0 if none), as an unsigned char.
2120 * The namespace name, if any
2121 * Size of the interface name (or 0 if none), as an unsigned char
2122 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002123 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002124 */
2125 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002126 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002127 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002128 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002129 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002130 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002131 goto out;
2132 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002133
2134 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002135 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002136 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002137 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002138 continue;
2139
2140 ns_name = if_name = "";
2141 ns_nlen = if_nlen = 0;
2142
2143 /* for now we can only retrieve namespaces and interfaces from
2144 * pure listeners.
2145 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002146 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002147 const struct listener *l = fdtab[cur_fd].owner;
2148
Willy Tarreau818a92e2020-09-03 07:50:19 +02002149 if (l->rx.settings->interface) {
2150 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002151 if_nlen = strlen(if_name);
2152 }
2153
2154#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002155 if (l->rx.settings->netns) {
2156 ns_name = l->rx.settings->netns->node.key;
2157 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002158 }
2159#endif
2160 }
2161
2162 /* put the FD into the CMSG_DATA */
2163 tmpfd[nb_queued++] = cur_fd;
2164
2165 /* first block is <ns_name_len> <ns_name> */
2166 tmpbuf[curoff++] = ns_nlen;
2167 if (ns_nlen)
2168 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2169 curoff += ns_nlen;
2170
2171 /* second block is <if_name_len> <if_name> */
2172 tmpbuf[curoff++] = if_nlen;
2173 if (if_nlen)
2174 memcpy(tmpbuf + curoff, if_name, if_nlen);
2175 curoff += if_nlen;
2176
2177 /* we used to send the listener options here before 2.3 */
2178 memset(tmpbuf + curoff, 0, sizeof(int));
2179 curoff += sizeof(int);
2180
2181 /* there's a limit to how many FDs may be sent at once */
2182 if (nb_queued == MAX_SEND_FD) {
2183 iov.iov_len = curoff;
2184 if (sendmsg(fd, &msghdr, 0) != curoff) {
2185 ha_warning("Failed to transfer sockets\n");
2186 return -1;
2187 }
2188
2189 /* Wait for an ack */
2190 do {
2191 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2192 } while (ret == -1 && errno == EINTR);
2193
2194 if (ret <= 0) {
2195 ha_warning("Unexpected error while transferring sockets\n");
2196 return -1;
2197 }
2198 curoff = 0;
2199 nb_queued = 0;
2200 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002201 }
2202
William Lallemandb5d062d2022-07-28 15:33:41 +02002203 already_sent = 1;
2204
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002205 /* flush pending stuff */
2206 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002207 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002208 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2209 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002210 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002211 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002212 goto out;
2213 }
2214 }
2215
2216out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002217 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002218 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002219 goto out;
2220 }
Christopher Faulet33af9962023-04-07 17:58:21 +02002221 se_fl_set(appctx->sedesc, SE_FL_EOI);
Olivier Houchardf886e342017-04-05 22:24:59 +02002222 appctx->st0 = CLI_ST_END;
2223 free(cmsgbuf);
2224 free(tmpbuf);
2225 return 1;
2226}
2227
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002228static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2229{
2230 if (*args[0] == 'h')
2231 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002232 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002233 else if (*args[0] == 'p')
2234 /* prompt */
Willy Tarreau22555572023-05-04 14:22:36 +02002235 if (strcmp(args[1], "timed") == 0) {
2236 appctx->st1 |= APPCTX_CLI_ST1_PROMPT;
2237 appctx->st1 ^= APPCTX_CLI_ST1_TIMED;
2238 }
2239 else
2240 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
Christopher Faulet33af9962023-04-07 17:58:21 +02002241 else if (*args[0] == 'q') {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002242 /* quit */
Christopher Faulet33af9962023-04-07 17:58:21 +02002243 se_fl_set(appctx->sedesc, SE_FL_EOI);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002244 appctx->st0 = CLI_ST_END;
Christopher Faulet33af9962023-04-07 17:58:21 +02002245 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002246
2247 return 1;
2248}
Olivier Houchardf886e342017-04-05 22:24:59 +02002249
William Lallemand2f4ce202018-10-26 14:47:47 +02002250void pcli_write_prompt(struct stream *s)
2251{
2252 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002253 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002254
William Lallemanddc12c2e2018-12-13 09:05:46 +01002255 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002256 return;
2257
William Lallemanddc12c2e2018-12-13 09:05:46 +01002258 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002259 chunk_appendf(msg, "+ ");
2260 } else {
Willy Tarreauea077152023-05-11 16:14:02 +02002261 if (s->pcli_next_pid == 0) {
2262 /* master's prompt */
2263 if (s->pcli_flags & PCLI_F_TIMED) {
2264 uint up = ns_to_sec(now_ns - start_time_ns);
2265 chunk_appendf(msg, "[%u:%02u:%02u:%02u] ",
2266 (up / 86400), (up / 3600) % 24, (up / 60) % 60, up % 60);
2267 }
2268
William Lallemanddae12c72022-02-02 14:13:54 +01002269 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002270 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
Willy Tarreauea077152023-05-11 16:14:02 +02002271 }
2272 else {
2273 /* worker's prompt */
2274 if (s->pcli_flags & PCLI_F_TIMED) {
2275 const struct mworker_proc *tmp, *proc;
2276 uint up;
2277
2278 /* set proc to the worker corresponding to pcli_next_pid or NULL */
2279 proc = NULL;
2280 list_for_each_entry(tmp, &proc_list, list) {
2281 if (!(tmp->options & PROC_O_TYPE_WORKER))
2282 continue;
2283 if (tmp->pid == s->pcli_next_pid) {
2284 proc = tmp;
2285 break;
2286 }
2287 }
2288
2289 if (!proc)
2290 chunk_appendf(msg, "[gone] ");
2291 else {
2292 up = date.tv_sec - proc->timestamp;
2293 if ((int)up < 0) /* must never be negative because of clock drift */
2294 up = 0;
2295 chunk_appendf(msg, "[%u:%02u:%02u:%02u] ",
2296 (up / 86400), (up / 3600) % 24, (up / 60) % 60, up % 60);
2297 }
2298 }
William Lallemanddae12c72022-02-02 14:13:54 +01002299 chunk_appendf(msg, "%d", s->pcli_next_pid);
Willy Tarreauea077152023-05-11 16:14:02 +02002300 }
William Lallemanddae12c72022-02-02 14:13:54 +01002301
2302 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2303 chunk_appendf(msg, "(");
2304
2305 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2306 chunk_appendf(msg, "x");
2307
2308 if (s->pcli_flags & ACCESS_EXPERT)
2309 chunk_appendf(msg, "e");
2310
2311 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2312 chunk_appendf(msg, "d");
2313
2314 chunk_appendf(msg, ")");
2315 }
2316
2317 chunk_appendf(msg, "> ");
2318
2319
William Lallemandebf61802018-12-11 16:10:57 +01002320 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002321 co_inject(oc, msg->area, msg->data);
2322}
2323
William Lallemandcf62f7e2018-10-26 14:47:40 +02002324/* The pcli_* functions are used for the CLI proxy in the master */
2325
William Lallemand1601eeb2023-05-14 18:36:00 +02002326
2327/* flush the input buffer and output an error */
2328void pcli_error(struct stream *s, const char *msg)
2329{
2330 struct buffer *buf = get_trash_chunk();
2331 struct channel *oc = &s->res;
2332 struct channel *ic = &s->req;
2333
2334 chunk_initstr(buf, msg);
2335
2336 if (likely(buf && buf->data))
2337 co_inject(oc, buf->area, buf->data);
2338
2339 channel_erase(ic);
2340
2341}
2342
2343/* flush the input buffer, output the error and close */
William Lallemanddeeaa592018-10-26 14:47:48 +02002344void pcli_reply_and_close(struct stream *s, const char *msg)
2345{
2346 struct buffer *buf = get_trash_chunk();
2347
2348 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002349 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002350}
2351
William Lallemand291810d2018-10-26 14:47:38 +02002352static enum obj_type *pcli_pid_to_server(int proc_pid)
2353{
2354 struct mworker_proc *child;
2355
William Lallemand99e0bb92020-11-05 10:28:53 +01002356 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002357 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002358 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002359
William Lallemand291810d2018-10-26 14:47:38 +02002360 list_for_each_entry(child, &proc_list, list) {
2361 if (child->pid == proc_pid){
2362 return &child->srv->obj_type;
2363 }
2364 }
2365 return NULL;
2366}
2367
2368/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2369 * Return:
2370 * 0: master
2371 * > 0: pid of a worker
2372 * < 0: didn't find a worker
2373 */
2374static int pcli_prefix_to_pid(const char *prefix)
2375{
2376 int proc_pid;
2377 struct mworker_proc *child;
2378 char *errtol = NULL;
2379
2380 if (*prefix != '@') /* not a prefix, should not happen */
2381 return -1;
2382
2383 prefix++;
2384 if (!*prefix) /* sent @ alone, return the master */
2385 return 0;
2386
2387 if (strcmp("master", prefix) == 0) {
2388 return 0;
2389 } else if (*prefix == '!') {
2390 prefix++;
2391 if (!*prefix)
2392 return -1;
2393
2394 proc_pid = strtol(prefix, &errtol, 10);
2395 if (*errtol != '\0')
2396 return -1;
2397 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002398 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002399 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002400 if (child->pid == proc_pid){
2401 return child->pid;
2402 }
2403 }
2404 } else {
2405 struct mworker_proc *chosen = NULL;
2406 /* this is a relative pid */
2407
2408 proc_pid = strtol(prefix, &errtol, 10);
2409 if (*errtol != '\0')
2410 return -1;
2411
2412 if (proc_pid == 0) /* return the master */
2413 return 0;
2414
William Lallemandbac3a822022-07-20 14:30:56 +02002415 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2416 return -1;
2417
William Lallemand291810d2018-10-26 14:47:38 +02002418 /* chose the right process, the current one is the one with the
2419 least number of reloads */
2420 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002421 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002422 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002423 if (child->reloads == 0)
2424 return child->pid;
2425 else if (chosen == NULL || child->reloads < chosen->reloads)
2426 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002427 }
2428 if (chosen)
2429 return chosen->pid;
2430 }
2431 return -1;
2432}
2433
William Lallemandbddd33a2018-12-11 16:10:53 +01002434/* Return::
2435 * >= 0 : number of words to escape
2436 * = -1 : error
2437 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002438int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2439{
2440 if (argl < 1)
2441 return 0;
2442
2443 /* there is a prefix */
2444 if (args[0][0] == '@') {
2445 int target_pid = pcli_prefix_to_pid(args[0]);
2446
2447 if (target_pid == -1) {
2448 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2449 return -1;
2450 }
2451
2452 /* if the prefix is alone, define a default target */
2453 if (argl == 1)
2454 s->pcli_next_pid = target_pid;
2455 else
2456 *next_pid = target_pid;
2457 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002458 } else if (strcmp("prompt", args[0]) == 0) {
Willy Tarreauea077152023-05-11 16:14:02 +02002459 if (argl >= 2 && strcmp(args[1], "timed") == 0) {
2460 s->pcli_flags |= PCLI_F_PROMPT;
2461 s->pcli_flags ^= PCLI_F_TIMED;
2462 }
2463 else
2464 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002465 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002466 } else if (strcmp("quit", args[0]) == 0) {
Christopher Faulet12762f02023-04-13 15:40:10 +02002467 sc_schedule_abort(s->scf);
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002468 sc_schedule_shutdown(s->scf);
William Lallemand5f610682018-12-11 16:10:55 +01002469 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002470 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002471 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2472 memprintf(errmsg, "Permission denied!\n");
2473 return -1;
2474 }
2475 s->pcli_flags &= ~ACCESS_LVL_MASK;
2476 s->pcli_flags |= ACCESS_LVL_OPER;
2477 return argl;
2478
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002479 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002480 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2481 memprintf(errmsg, "Permission denied!\n");
2482 return -1;
2483 }
2484 s->pcli_flags &= ~ACCESS_LVL_MASK;
2485 s->pcli_flags |= ACCESS_LVL_USER;
2486 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002487
2488 } else if (strcmp(args[0], "expert-mode") == 0) {
2489 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2490 memprintf(errmsg, "Permission denied!\n");
2491 return -1;
2492 }
2493
2494 s->pcli_flags &= ~ACCESS_EXPERT;
2495 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2496 s->pcli_flags |= ACCESS_EXPERT;
2497 return argl;
2498
2499 } else if (strcmp(args[0], "experimental-mode") == 0) {
2500 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2501 memprintf(errmsg, "Permission denied!\n");
2502 return -1;
2503 }
2504 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2505 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2506 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2507 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002508 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2509 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2510 memprintf(errmsg, "Permission denied!\n");
2511 return -1;
2512 }
2513 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2514 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2515 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2516 return argl;
William Lallemand74381812023-12-06 11:15:01 +01002517 } else if (strcmp(args[0], "set") == 0) {
2518 if ((argl > 1) && (strcmp(args[1], "severity-output") == 0)) {
2519 if ((argl > 2) &&strcmp(args[2], "none") == 0) {
2520 s->pcli_flags &= ~(ACCESS_MCLI_SEVERITY_NB|ACCESS_MCLI_SEVERITY_STR);
2521 } else if ((argl > 2) && strcmp(args[2], "string") == 0) {
2522 s->pcli_flags |= ACCESS_MCLI_SEVERITY_STR;
2523 } else if ((argl > 2) && strcmp(args[2], "number") == 0) {
2524 s->pcli_flags |= ACCESS_MCLI_SEVERITY_NB;
2525 } else {
2526 memprintf(errmsg, "one of 'none', 'number', 'string' is a required argument\n");
2527 return -1;
2528 }
2529 /* only skip argl if we have "set severity-output" not only "set" */
2530 return argl;
2531 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002532 }
2533
2534 return 0;
2535}
2536
2537/*
2538 * Parse the CLI request:
2539 * - It does basically the same as the cli_io_handler, but as a proxy
2540 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002541 *
2542 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002543 * - the number of characters to forward or
2544 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002545 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002546int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002547{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002548 char *str;
2549 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002550 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002551 int argl; /* number of args */
2552 char *p;
2553 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002554 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002555 int wtrim = 0; /* number of words to trim */
2556 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002557 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002558 int i = 0;
2559
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002560 /* we cannot deal with a wrapping buffer, so let's take care of this
2561 * first.
2562 */
2563 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2564 b_slow_realign(&req->buf, trash.area, co_data(req));
2565
2566 str = (char *)ci_head(req);
2567 end = (char *)ci_stop(req);
2568
William Lallemandbddd33a2018-12-11 16:10:53 +01002569 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002570
William Lallemanddc12c2e2018-12-13 09:05:46 +01002571 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002572
2573 /* Looks for the end of one command */
2574 while (p+reql < end) {
2575 /* handle escaping */
2576 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002577 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002578 continue;
2579 }
2580 if (p[reql] == ';' || p[reql] == '\n') {
2581 /* found the end of the command */
2582 p[reql] = '\n';
2583 reql++;
2584 break;
2585 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002586 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002587 }
William Lallemandebf61802018-12-11 16:10:57 +01002588 } else {
2589 while (p+reql < end) {
2590 if (p[reql] == '\n') {
2591 /* found the end of the line */
2592 reql++;
2593 break;
2594 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002595 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002596 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002597 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002598
William Lallemandbddd33a2018-12-11 16:10:53 +01002599 /* set end to first byte after the end of the command */
2600 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002601
William Lallemandbddd33a2018-12-11 16:10:53 +01002602 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002603 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002604 return -1;
2605 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002606
William Lallemand3301f3e2018-12-13 09:05:48 +01002607 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2608 if (reql == 1) /* last line of the payload */
2609 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002610 return reql;
2611 }
2612
William Lallemandbddd33a2018-12-11 16:10:53 +01002613 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002614
William Lallemandbddd33a2018-12-11 16:10:53 +01002615 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002616 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002617 /* skip leading spaces/tabs */
2618 p += strspn(p, " \t");
2619 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002620 break;
2621
William Lallemandbddd33a2018-12-11 16:10:53 +01002622 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002623 while (1) {
2624 p += strcspn(p, " \t\\");
2625 /* escaped chars using backlashes (\) */
2626 if (*p == '\\') {
2627 if (!*++p)
2628 break;
2629 if (!*++p)
2630 break;
2631 } else {
2632 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002633 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002634 }
William Lallemandfe249c32020-06-18 18:03:57 +02002635 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002636 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002637 }
2638
William Lallemandbddd33a2018-12-11 16:10:53 +01002639 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002640
Willy Tarreauf14c7572021-03-13 10:59:23 +01002641 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002642 args[i] = NULL;
2643
2644 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2645
2646 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002647 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002648 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002649 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002650 if (*p == '\0')
2651 *p = ' ';
2652 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002653 }
2654
William Lallemand3301f3e2018-12-13 09:05:48 +01002655 payload = strstr(str, PAYLOAD_PATTERN);
2656 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2657 /* if the payload pattern is at the end */
2658 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002659 }
2660
William Lallemandbddd33a2018-12-11 16:10:53 +01002661 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002662
William Lallemandbddd33a2018-12-11 16:10:53 +01002663 if (wtrim > 0) {
2664 trim = &args[wtrim][0];
2665 if (trim == NULL) /* if this was the last word in the table */
2666 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002667
William Lallemandbddd33a2018-12-11 16:10:53 +01002668 b_del(&req->buf, trim - str);
2669
William Lallemandb7ea1412018-12-13 09:05:47 +01002670 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002671 } else if (wtrim < 0) {
2672 /* parsing error */
2673 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002674 } else {
2675 /* the whole string */
2676 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002677 }
2678
William Lallemandb7ea1412018-12-13 09:05:47 +01002679 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002680
2681 /* the mcli-debug-mode is only sent to the applet of the master */
2682 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2683 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2684 ret += strlen("mcli-debug-mode on -") + 2;
2685 }
William Lallemand7267f782022-02-01 16:08:50 +01002686 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2687 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2688 ret += strlen("experimental-mode on -") + 2;
2689 }
2690 if (s->pcli_flags & ACCESS_EXPERT) {
2691 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2692 ret += strlen("expert-mode on -") + 2;
2693 }
William Lallemand74381812023-12-06 11:15:01 +01002694 if (s->pcli_flags & ACCESS_MCLI_SEVERITY_STR) {
2695 const char *cmd = "set severity-output string -";
2696 ci_insert_line2(req, 0, cmd, strlen(cmd));
2697 ret += strlen(cmd) + 2;
2698 }
2699 if (s->pcli_flags & ACCESS_MCLI_SEVERITY_NB) {
2700 const char *cmd = "set severity-output number -";
2701 ci_insert_line2(req, 0, cmd, strlen(cmd));
2702 ret += strlen(cmd) + 2;
2703 }
William Lallemand7267f782022-02-01 16:08:50 +01002704
William Lallemandb7ea1412018-12-13 09:05:47 +01002705 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2706 goto end;
2707 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002708 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2709 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002710 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002711 ci_insert_line2(req, 0, "user -", strlen("user -"));
2712 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002713 }
2714 }
2715end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002716
William Lallemandb7ea1412018-12-13 09:05:47 +01002717 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002718}
2719
2720int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2721{
William Lallemandbddd33a2018-12-11 16:10:53 +01002722 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002723 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002724 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002725
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002726 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002727 * current one. Just wait. At this stage, errors should be handled by
2728 * the response analyzer.
2729 */
2730 if (s->res.analysers & AN_RES_WAIT_CLI)
2731 return 0;
2732
William Lallemandb7ea1412018-12-13 09:05:47 +01002733 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2734 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2735
William Lallemand0a0512f2022-09-24 16:14:50 +02002736 /* stream that comes from the reload listener only responses the reload
2737 * status and quits */
2738 if (!(s->pcli_flags & PCLI_F_RELOAD)
2739 && strm_li(s)->bind_conf == mcli_reload_bind_conf)
2740 goto send_status;
2741
2742
William Lallemandcf62f7e2018-10-26 14:47:40 +02002743read_again:
2744 /* if the channel is closed for read, we won't receive any more data
2745 from the client, but we don't want to forward this close to the
2746 server */
2747 channel_dont_close(req);
2748
2749 /* We don't know yet to which server we will connect */
2750 channel_dont_connect(req);
2751
Christopher Faulet9a790f62023-03-16 14:40:03 +01002752 s->scf->flags |= SC_FL_RCV_ONCE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002753
2754 /* need more data */
2755 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002756 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002757
2758 /* If there is data available for analysis, log the end of the idle time. */
2759 if (c_data(req) && s->logs.t_idle == -1)
Willy Tarreau69530f52023-04-28 09:16:15 +02002760 s->logs.t_idle = ns_to_ms(now_ns - s->logs.accept_ts) - s->logs.t_handshake;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002761
William Lallemandbddd33a2018-12-11 16:10:53 +01002762 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002763 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002764 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002765 /* enough data */
2766
William Lallemandcf62f7e2018-10-26 14:47:40 +02002767 /* forward only 1 command */
2768 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002769
William Lallemanddc12c2e2018-12-13 09:05:46 +01002770 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002771 /* we send only 1 command per request, and we write close after it */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002772 sc_schedule_shutdown(s->scb);
William Lallemandebf61802018-12-11 16:10:57 +01002773 } else {
2774 pcli_write_prompt(s);
2775 }
2776
2777 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002778 s->res.analysers |= AN_RES_WAIT_CLI;
2779
William Lallemandebf61802018-12-11 16:10:57 +01002780 if (!(s->flags & SF_ASSIGNED)) {
2781 if (next_pid > -1)
2782 target_pid = next_pid;
2783 else
2784 target_pid = s->pcli_next_pid;
2785 /* we can connect now */
2786 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002787
William Lallemanddcbe7b92021-12-10 14:14:53 +01002788 if (!s->target)
2789 goto server_disconnect;
2790
William Lallemandebf61802018-12-11 16:10:57 +01002791 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2792 channel_auto_connect(req);
2793 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002794
2795 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002796 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002797 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002798 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002799 } else if (to_forward == -1) {
William Lallemand1601eeb2023-05-14 18:36:00 +02002800 if (!errmsg) /* no error means missing data */
2801 goto missing_data;
2802
2803 /* there was an error during the parsing */
2804 pcli_error(s, errmsg);
2805 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002806 }
2807
2808 return 0;
2809
2810send_help:
2811 b_reset(&req->buf);
2812 b_putblk(&req->buf, "help\n", 5);
2813 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002814
William Lallemand0a0512f2022-09-24 16:14:50 +02002815send_status:
2816 s->pcli_flags |= PCLI_F_RELOAD;
Willy Tarreaudd9f9212023-05-07 07:07:44 +02002817 /* don't use ci_putblk here because SHUT_DONE could have been sent */
William Lallemand0a0512f2022-09-24 16:14:50 +02002818 b_reset(&req->buf);
2819 b_putblk(&req->buf, "_loadstatus;quit\n", 17);
2820 goto read_again;
2821
Christopher Faulet0f727da2022-01-18 08:44:23 +01002822missing_data:
Christopher Fauletca5309a2023-04-17 16:17:32 +02002823 if (s->scf->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
Christopher Faulet0f727da2022-01-18 08:44:23 +01002824 /* There is no more request or a only a partial one and we
2825 * receive a close from the client, we can leave */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002826 sc_schedule_shutdown(s->scf);
Christopher Faulet0f727da2022-01-18 08:44:23 +01002827 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2828 return 1;
2829 }
2830 else if (channel_full(req, global.tune.maxrewrite)) {
2831 /* buffer is full and we didn't catch the end of a command */
2832 goto send_help;
2833 }
2834 return 0;
2835
William Lallemanddcbe7b92021-12-10 14:14:53 +01002836server_disconnect:
2837 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2838 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002839}
2840
2841int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2842{
2843 struct proxy *fe = strm_fe(s);
2844 struct proxy *be = s->be;
2845
Christopher Fauletd7bac882023-04-14 12:05:55 +02002846 if ((s->scb->flags & SC_FL_ERROR) || (rep->flags & (CF_READ_TIMEOUT|CF_WRITE_TIMEOUT)) ||
Christopher Faulet64350bb2023-04-13 16:37:37 +02002847 ((s->scf->flags & SC_FL_SHUT_DONE) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002848 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002849 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002850 s->res.analysers &= ~AN_RES_WAIT_CLI;
2851 return 0;
2852 }
Christopher Faulet9a790f62023-03-16 14:40:03 +01002853 s->scb->flags |= SC_FL_RCV_ONCE; /* try to get back here ASAP */
Christopher Faulet68ef2182023-03-17 15:38:18 +01002854 s->scf->flags |= SC_FL_SND_NEVERWAIT;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002855
2856 /* don't forward the close */
2857 channel_dont_close(&s->res);
2858 channel_dont_close(&s->req);
2859
William Lallemanddc12c2e2018-12-13 09:05:46 +01002860 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002861 s->res.analysers &= ~AN_RES_WAIT_CLI;
2862 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2863 return 0;
2864 }
2865
William Lallemandcf62f7e2018-10-26 14:47:40 +02002866 /* forward the data */
2867 if (ci_data(rep)) {
2868 c_adv(rep, ci_data(rep));
2869 return 0;
2870 }
2871
Christopher Fauletca5309a2023-04-17 16:17:32 +02002872 if (s->scb->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002873 /* stream cleanup */
2874
William Lallemand2f4ce202018-10-26 14:47:47 +02002875 pcli_write_prompt(s);
2876
Willy Tarreaucb041662022-05-17 19:44:42 +02002877 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Christopher Fauletcfc11c02023-04-13 16:10:23 +02002878 sc_abort(s->scb);
Christopher Fauletb2b1c3a2023-04-13 16:23:48 +02002879 sc_shutdown(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002880
2881 /*
2882 * starting from there this the same code as
2883 * http_end_txn_clean_session().
2884 *
2885 * It allows to do frontend keepalive while reconnecting to a
2886 * new server for each request.
2887 */
2888
2889 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002890 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002891 if (unlikely(s->srv_conn))
2892 sess_change_server(s, NULL);
2893 }
2894
Willy Tarreau69530f52023-04-28 09:16:15 +02002895 s->logs.t_close = ns_to_ms(now_ns - s->logs.accept_ts);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002896 stream_process_counters(s);
2897
2898 /* don't count other requests' data */
2899 s->logs.bytes_in -= ci_data(&s->req);
2900 s->logs.bytes_out -= ci_data(&s->res);
2901
2902 /* we may need to know the position in the queue */
2903 pendconn_free(s);
2904
2905 /* let's do a final log if we need it */
2906 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2907 !(s->flags & SF_MONITOR) &&
2908 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2909 s->do_log(s);
2910 }
2911
2912 /* stop tracking content-based counters */
2913 stream_stop_content_counters(s);
2914 stream_update_time_stats(s);
2915
2916 s->logs.accept_date = date; /* user-visible date for logging */
Willy Tarreau69530f52023-04-28 09:16:15 +02002917 s->logs.accept_ts = now_ns; /* corrected date for internal use */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002918 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2919 s->logs.t_idle = -1;
Willy Tarreauad5a5f62023-04-27 09:46:02 +02002920 s->logs.request_ts = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002921 s->logs.t_queue = -1;
2922 s->logs.t_connect = -1;
2923 s->logs.t_data = -1;
2924 s->logs.t_close = 0;
2925 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2926 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2927
2928 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2929 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2930
2931 stream_del_srv_conn(s);
2932 if (objt_server(s->target)) {
2933 if (s->flags & SF_CURR_SESS) {
2934 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002935 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002936 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002937 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002938 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002939 }
2940
2941 s->target = NULL;
2942
2943 /* only release our endpoint if we don't intend to reuse the
2944 * connection.
2945 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002946 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002947 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002948 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002949 if (!s->conn_err_type)
2950 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002951 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002952 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002953 return 1;
2954 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002955 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002956 }
2957
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002958 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002959
Willy Tarreau74568cf2022-05-27 09:03:30 +02002960 sc_set_state(s->scb, SC_ST_INI);
Christopher Fauleta1d14a72023-04-14 10:42:08 +02002961 s->scb->flags &= ~(SC_FL_ERROR|SC_FL_SHUT_DONE|SC_FL_SHUT_WANTED);
Willy Tarreaucb041662022-05-17 19:44:42 +02002962 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 +02002963
2964 s->req.flags &= ~(CF_AUTO_CONNECT|CF_STREAMER|CF_STREAMER_FAST|CF_WROTE_DATA);
2965 s->res.flags &= ~(CF_STREAMER|CF_STREAMER_FAST|CF_WRITE_EVENT|CF_WROTE_DATA|CF_READ_EVENT);
Willy Tarreau03bd3952022-05-02 16:36:47 +02002966 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002967 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2968 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002969 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002970 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002971 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002972 /* reinitialise the current rule list pointer to NULL. We are sure that
2973 * any rulelist match the NULL pointer.
2974 */
2975 s->current_rule_list = NULL;
2976
2977 s->be = strm_fe(s);
2978 s->logs.logwait = strm_fe(s)->to_log;
2979 s->logs.level = 0;
2980 stream_del_srv_conn(s);
2981 s->target = NULL;
2982 /* re-init store persistence */
2983 s->store_count = 0;
2984 s->uniq_id = global.req_count++;
2985
Christopher Fauletca5309a2023-04-17 16:17:32 +02002986 s->scf->flags &= ~(SC_FL_EOS|SC_FL_ERROR|SC_FL_ABRT_DONE|SC_FL_ABRT_WANTED);
Christopher Faulet68ef2182023-03-17 15:38:18 +01002987 s->scf->flags &= ~SC_FL_SND_NEVERWAIT;
Christopher Faulet9a790f62023-03-16 14:40:03 +01002988 s->scf->flags |= SC_FL_RCV_ONCE; /* one read is usually enough */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002989
2990 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2991
William Lallemandcf62f7e2018-10-26 14:47:40 +02002992 s->res.analysers &= ~AN_RES_WAIT_CLI;
2993
2994 /* We must trim any excess data from the response buffer, because we
2995 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002996 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002997 * we want those data to come along with next response. A typical
2998 * example of such data would be from a buggy server responding to
2999 * a HEAD with some data, or sending more than the advertised
3000 * content-length.
3001 */
3002 if (unlikely(ci_data(&s->res)))
3003 b_set_data(&s->res.buf, co_data(&s->res));
3004
3005 /* Now we can realign the response buffer */
3006 c_realign_if_empty(&s->res);
3007
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01003008 s->scf->ioto = strm_fe(s)->timeout.client;
3009 s->scb->ioto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02003010
William Lallemandcf62f7e2018-10-26 14:47:40 +02003011 s->req.analyse_exp = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02003012 s->res.analyse_exp = TICK_ETERNITY;
Christopher Faulet15315d62023-02-20 08:23:51 +01003013
William Lallemandcf62f7e2018-10-26 14:47:40 +02003014 /* we're removing the analysers, we MUST re-enable events detection.
3015 * We don't enable close on the response channel since it's either
3016 * already closed, or in keep-alive with an idle connection handler.
3017 */
3018 channel_auto_read(&s->req);
3019 channel_auto_close(&s->req);
3020 channel_auto_read(&s->res);
3021
3022
3023 return 1;
3024 }
3025 return 0;
3026}
3027
William Lallemand8a022572018-10-26 14:47:35 +02003028/*
3029 * The mworker functions are used to initialize the CLI in the master process
3030 */
3031
William Lallemand309dc9a2018-10-26 14:47:45 +02003032 /*
3033 * Stop the mworker proxy
3034 */
3035void mworker_cli_proxy_stop()
3036{
William Lallemand550db6d2018-11-06 17:37:12 +01003037 if (mworker_proxy)
3038 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02003039}
3040
William Lallemand8a022572018-10-26 14:47:35 +02003041/*
3042 * Create the mworker CLI proxy
3043 */
3044int mworker_cli_proxy_create()
3045{
3046 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01003047 char *msg = NULL;
3048 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02003049
William Lallemandae787ba2021-07-29 15:13:22 +02003050 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02003051 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02003052 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02003053
William Lallemandcf62f7e2018-10-26 14:47:40 +02003054 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02003055 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
3056 mworker_proxy->timeout.client = 0; /* no timeout */
3057 mworker_proxy->conf.file = strdup("MASTER");
3058 mworker_proxy->conf.line = 0;
3059 mworker_proxy->accept = frontend_accept;
3060 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
3061
3062 /* Does not init the default target the CLI applet, but must be done in
3063 * the request parsing code */
3064 mworker_proxy->default_target = NULL;
3065
William Lallemand8a022572018-10-26 14:47:35 +02003066 /* create all servers using the mworker_proc list */
3067 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02003068 struct server *newsrv = NULL;
3069 struct sockaddr_storage *sk;
3070 int port1, port2, port;
3071 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02003072
William Lallemanda31b09e2020-01-14 15:25:02 +01003073 /* only the workers support the master CLI */
3074 if (!(child->options & PROC_O_TYPE_WORKER))
3075 continue;
3076
William Lallemand8a022572018-10-26 14:47:35 +02003077 newsrv = new_server(mworker_proxy);
3078 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01003079 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02003080
3081 /* we don't know the new pid yet */
3082 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02003083 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02003084 else
3085 memprintf(&msg, "old-%d", child->pid);
3086
3087 newsrv->next = mworker_proxy->srv;
3088 mworker_proxy->srv = newsrv;
3089 newsrv->conf.file = strdup(msg);
3090 newsrv->id = strdup(msg);
3091 newsrv->conf.line = 0;
3092
3093 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02003094 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02003095 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01003096 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003097 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003098 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02003099
Willy Tarreau5fc93282020-09-16 18:25:03 +02003100 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01003101 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02003102 }
3103
3104 /* no port specified */
3105 newsrv->flags |= SRV_F_MAPPORTS;
3106 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02003107 /* don't let the server participate to load balancing */
3108 newsrv->iweight = 0;
3109 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02003110 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02003111
3112 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02003113 }
William Lallemandae787ba2021-07-29 15:13:22 +02003114
3115 mworker_proxy->next = proxies_list;
3116 proxies_list = mworker_proxy;
3117
William Lallemand8a022572018-10-26 14:47:35 +02003118 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003119
3120error:
William Lallemand744a0892018-11-22 16:46:51 +01003121
3122 list_for_each_entry(child, &proc_list, list) {
3123 free((char *)child->srv->conf.file); /* cast because of const char * */
3124 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003125 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01003126 }
William Lallemandae787ba2021-07-29 15:13:22 +02003127 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01003128 free(msg);
3129
William Lallemandae787ba2021-07-29 15:13:22 +02003130error_proxy:
3131 ha_alert("%s\n", errmsg);
3132 free(errmsg);
3133
William Lallemand744a0892018-11-22 16:46:51 +01003134 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02003135}
Olivier Houchardf886e342017-04-05 22:24:59 +02003136
William Lallemandce83b4a2018-10-26 14:47:30 +02003137/*
William Lallemande7361152018-10-26 14:47:36 +02003138 * Create a new listener for the master CLI proxy
3139 */
William Lallemand21623b52022-09-24 15:51:27 +02003140struct bind_conf *mworker_cli_proxy_new_listener(char *line)
William Lallemande7361152018-10-26 14:47:36 +02003141{
3142 struct bind_conf *bind_conf;
3143 struct listener *l;
3144 char *err = NULL;
3145 char *args[MAX_LINE_ARGS + 1];
3146 int arg;
3147 int cur_arg;
3148
William Lallemand2e945c82019-11-25 09:58:37 +01003149 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02003150 args[0] = line;
3151
3152 /* args is a bind configuration with spaces replaced by commas */
3153 while (*line && arg < MAX_LINE_ARGS) {
3154
3155 if (*line == ',') {
3156 *line++ = '\0';
3157 while (*line == ',')
3158 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01003159 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02003160 }
3161 line++;
3162 }
3163
William Lallemand2e945c82019-11-25 09:58:37 +01003164 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02003165
3166 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003167 if (!bind_conf)
3168 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003169
3170 bind_conf->level &= ~ACCESS_LVL_MASK;
3171 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003172 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003173
3174 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3175 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003176 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003177 }
3178
3179 cur_arg = 1;
3180
3181 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003182 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003183 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003184
3185 kw = bind_find_kw(args[cur_arg]);
3186 if (kw) {
3187 if (!kw->parse) {
3188 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3189 args[0], args[1], args[cur_arg]);
3190 goto err;
3191 }
3192
Willy Tarreau4975d142021-03-13 11:00:33 +01003193 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003194 if (err)
3195 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3196 else
3197 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3198 args[0], args[1], args[cur_arg]);
3199 goto err;
3200 }
3201
3202 cur_arg += 1 + kw->skip;
3203 continue;
3204 }
3205
Willy Tarreau433b05f2021-03-12 10:14:07 +01003206 best = bind_find_best_kw(args[cur_arg]);
3207 if (best)
3208 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3209 args[0], args[1], args[cur_arg], best);
3210 else
3211 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3212 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003213 goto err;
3214 }
3215
3216
Willy Tarreau30836152023-01-12 19:10:17 +01003217 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003218 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003219 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003220
Christopher Faulet8e64fdf2023-11-28 21:50:21 +01003221 /* Pin master CLI on the first thread of the first group only */
3222 thread_set_pin_grp1(&bind_conf->thread_set, 1);
3223
William Lallemande7361152018-10-26 14:47:36 +02003224 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18c20d22020-10-09 16:11:46 +02003225 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003226 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003227 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003228 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003229
William Lallemand21623b52022-09-24 15:51:27 +02003230 return bind_conf;
William Lallemande7361152018-10-26 14:47:36 +02003231
3232err:
3233 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003234 free(err);
3235 free(bind_conf);
William Lallemand21623b52022-09-24 15:51:27 +02003236 return NULL;
William Lallemande7361152018-10-26 14:47:36 +02003237
3238}
3239
3240/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003241 * Create a new CLI socket using a socketpair for a worker process
3242 * <mworker_proc> is the process structure, and <proc> is the process number
3243 */
3244int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3245{
3246 struct bind_conf *bind_conf;
3247 struct listener *l;
3248 char *path = NULL;
3249 char *err = NULL;
3250
3251 /* master pipe to ensure the master is still alive */
3252 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3253 ha_alert("Cannot create worker socketpair.\n");
3254 return -1;
3255 }
3256
3257 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003258 if (!global.cli_fe) {
3259 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003260 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003261 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003262 }
3263 }
3264
Willy Tarreau4975d142021-03-13 11:00:33 +01003265 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003266 if (!bind_conf)
3267 goto error;
3268
William Lallemandce83b4a2018-10-26 14:47:30 +02003269 bind_conf->level &= ~ACCESS_LVL_MASK;
3270 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003271 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003272
William Lallemandce83b4a2018-10-26 14:47:30 +02003273 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3274 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003275 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003276 }
3277
Willy Tarreau4975d142021-03-13 11:00:33 +01003278 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003279 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003280 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003281 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003282 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003283 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003284
Willy Tarreau30836152023-01-12 19:10:17 +01003285 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003286 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003287 bind_conf->options |= BC_O_UNLIMITED | BC_O_NOSTOP;
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003288
Christopher Faulet0df691a2023-09-13 10:13:30 +02003289 /* Pin master CLI on the first thread of the first group only */
3290 thread_set_pin_grp1(&bind_conf->thread_set, 1);
3291
William Lallemandce83b4a2018-10-26 14:47:30 +02003292 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003293 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003294 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003295 l->rx.flags &= ~RX_F_INHERITED;
Willy Tarreau18215cb2019-02-27 16:25:28 +01003296 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003297 }
3298
3299 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003300
3301error:
3302 close(mworker_proc->ipc_fd[0]);
3303 close(mworker_proc->ipc_fd[1]);
3304 free(err);
3305
3306 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003307}
3308
William Lallemand74c24fb2016-11-21 17:18:36 +01003309static struct applet cli_applet = {
3310 .obj_type = OBJ_TYPE_APPLET,
3311 .name = "<CLI>", /* used for logging */
3312 .fct = cli_io_handler,
3313 .release = cli_release_handler,
3314};
3315
William Lallemand99e0bb92020-11-05 10:28:53 +01003316/* master CLI */
3317static struct applet mcli_applet = {
3318 .obj_type = OBJ_TYPE_APPLET,
3319 .name = "<MCLI>", /* used for logging */
3320 .fct = cli_io_handler,
3321 .release = cli_release_handler,
3322};
3323
Willy Tarreau0a739292016-11-22 20:21:23 +01003324/* register cli keywords */
3325static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003326 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3327 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3328 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3329 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003330 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3331 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003332 { { "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 +01003333 { { "set", "anon", "on" }, "set anon on [value] : activate the anonymized mode", cli_parse_set_anon, NULL, NULL },
3334 { { "set", "anon", "off" }, "set anon off : deactivate the anonymized mode", cli_parse_set_anon, NULL, NULL },
Erwan Le Goasd7869312022-09-29 10:36:11 +02003335 { { "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 +02003336 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3337 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3338 { { "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 },
3339 { { "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 +02003340 { { "show", "anon", NULL }, "show anon : display the current state of anonymized mode", cli_parse_show_anon, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003341 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3342 { { "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 },
3343 { { "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 +02003344 { { "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 +01003345 { { "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 +02003346 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3347 { { "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 +01003348 {{},}
3349}};
3350
Willy Tarreau0108d902018-11-25 19:14:37 +01003351INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3352
William Lallemand74c24fb2016-11-21 17:18:36 +01003353static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003354 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003355 { 0, NULL, NULL },
3356}};
3357
Willy Tarreau0108d902018-11-25 19:14:37 +01003358INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3359
William Lallemand74c24fb2016-11-21 17:18:36 +01003360static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003361 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3362 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003363 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003364 { NULL, NULL, 0 },
3365}};
3366
Willy Tarreau0108d902018-11-25 19:14:37 +01003367INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003368
3369/*
3370 * Local variables:
3371 * c-indent-level: 8
3372 * c-basic-offset: 8
3373 * End:
3374 */