blob: 977e228695de5ee422a7422ecfbe0a3bafaf6ec3 [file] [log] [blame]
William Lallemand74c24fb2016-11-21 17:18:36 +01001/*
2 * Functions dedicated to statistics output and the stats socket
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 * Copyright 2007-2009 Krzysztof Piotr Oledzki <ole@ans.pl>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <ctype.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <stdio.h>
18#include <stdlib.h>
19#include <string.h>
20#include <pwd.h>
21#include <grp.h>
22
23#include <sys/socket.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26
Olivier Houchardf886e342017-04-05 22:24:59 +020027#include <net/if.h>
28
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020029#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020030#include <haproxy/applet.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/base64.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020032#include <haproxy/cfgparse.h>
Willy Tarreauf1d32c42020-06-04 21:07:02 +020033#include <haproxy/channel.h>
Willy Tarreau4aa573d2020-06-04 18:21:56 +020034#include <haproxy/check.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020035#include <haproxy/cli.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020036#include <haproxy/compression.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020037#include <haproxy/dns-t.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020038#include <haproxy/errors.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020039#include <haproxy/fd.h>
40#include <haproxy/freq_ctr.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020041#include <haproxy/frontend.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020042#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020043#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020044#include <haproxy/listener.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020045#include <haproxy/log.h>
William Lallemand3ba7c7b2021-11-10 10:57:18 +010046#include <haproxy/mworker.h>
Willy Tarreaub5abe5b2020-06-04 14:07:37 +020047#include <haproxy/mworker-t.h>
Willy Tarreau225a90a2020-06-04 15:06:28 +020048#include <haproxy/pattern-t.h>
Willy Tarreau3c2a7c22020-06-04 18:38:21 +020049#include <haproxy/peers.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020050#include <haproxy/pipe.h>
51#include <haproxy/protocol.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020052#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020053#include <haproxy/sample-t.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020054#include <haproxy/sc_strm.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020055#include <haproxy/server.h>
Willy Tarreau48d25b32020-06-04 18:58:52 +020056#include <haproxy/session.h>
Willy Tarreaua74cb382020-10-15 21:29:49 +020057#include <haproxy/sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020058#include <haproxy/stats-t.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020059#include <haproxy/stconn.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020060#include <haproxy/stream.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020061#include <haproxy/task.h>
Willy Tarreauc2f7c582020-06-02 18:15:32 +020062#include <haproxy/ticks.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020063#include <haproxy/time.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020064#include <haproxy/tools.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020065#include <haproxy/version.h>
William Lallemand74c24fb2016-11-21 17:18:36 +010066
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020067#define PAYLOAD_PATTERN "<<"
68
William Lallemand74c24fb2016-11-21 17:18:36 +010069static struct applet cli_applet;
William Lallemand99e0bb92020-11-05 10:28:53 +010070static struct applet mcli_applet;
William Lallemand74c24fb2016-11-21 17:18:36 +010071
Willy Tarreau4975d142021-03-13 11:00:33 +010072static const char cli_permission_denied_msg[] =
William Lallemand74c24fb2016-11-21 17:18:36 +010073 "Permission denied\n"
74 "";
75
76
Christopher Faulet1bc04c72017-10-29 20:14:08 +010077static THREAD_LOCAL char *dynamic_usage_msg = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +010078
79/* List head of cli keywords */
80static struct cli_kw_list cli_keywords = {
81 .list = LIST_HEAD_INIT(cli_keywords.list)
82};
83
84extern const char *stat_status_codes[];
85
Eric Salama1b8dacc2021-03-16 15:12:17 +010086struct proxy *mworker_proxy; /* CLI proxy of the master */
William Lallemand56f73b22022-09-24 15:56:25 +020087struct bind_conf *mcli_reload_bind_conf;
William Lallemand8a022572018-10-26 14:47:35 +020088
Willy Tarreau307dbb32022-05-05 17:45:52 +020089/* CLI context for the "show env" command */
90struct show_env_ctx {
91 char **var; /* first variable to show */
92 int show_one; /* stop after showing the first one */
93};
94
Willy Tarreau741a5a92022-05-05 17:56:58 +020095/* CLI context for the "show fd" command */
Willy Tarreau1cb041a2023-03-31 16:33:53 +020096/* flags for show_fd_ctx->show_mask */
97#define CLI_SHOWFD_F_PI 0x00000001 /* pipes */
98#define CLI_SHOWFD_F_LI 0x00000002 /* listeners */
99#define CLI_SHOWFD_F_FE 0x00000004 /* frontend conns */
100#define CLI_SHOWFD_F_SV 0x00000010 /* server-only conns */
101#define CLI_SHOWFD_F_PX 0x00000020 /* proxy-only conns */
102#define CLI_SHOWFD_F_BE 0x00000030 /* backend: srv+px */
103#define CLI_SHOWFD_F_CO 0x00000034 /* conn: be+fe */
104#define CLI_SHOWFD_F_ANY 0x0000003f /* any type */
105
Willy Tarreau741a5a92022-05-05 17:56:58 +0200106struct show_fd_ctx {
107 int fd; /* first FD to show */
108 int show_one; /* stop after showing one FD */
Willy Tarreau1cb041a2023-03-31 16:33:53 +0200109 uint show_mask; /* CLI_SHOWFD_F_xxx */
Willy Tarreau741a5a92022-05-05 17:56:58 +0200110};
111
Willy Tarreaub128f492022-05-05 19:11:05 +0200112/* CLI context for the "show cli sockets" command */
113struct show_sock_ctx {
114 struct bind_conf *bind_conf;
115 struct listener *listener;
116};
117
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200118static int cmp_kw_entries(const void *a, const void *b)
119{
120 const struct cli_kw *l = *(const struct cli_kw **)a;
121 const struct cli_kw *r = *(const struct cli_kw **)b;
122
123 return strcmp(l->usage ? l->usage : "", r->usage ? r->usage : "");
124}
125
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100126/* This will show the help message and list the commands supported at the
127 * current level that match all of the first words of <args> if args is not
128 * NULL, or all args if none matches or if args is null.
129 */
130static char *cli_gen_usage_msg(struct appctx *appctx, char * const *args)
William Lallemand74c24fb2016-11-21 17:18:36 +0100131{
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200132 struct cli_kw *entries[CLI_MAX_HELP_ENTRIES];
William Lallemand74c24fb2016-11-21 17:18:36 +0100133 struct cli_kw_list *kw_list;
134 struct cli_kw *kw;
Willy Tarreau83061a82018-07-13 11:56:34 +0200135 struct buffer *tmp = get_trash_chunk();
136 struct buffer out;
Willy Tarreaub7364582021-03-12 18:24:46 +0100137 struct { struct cli_kw *kw; int dist; } matches[CLI_MAX_MATCHES], swp;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100138 int idx;
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200139 int ishelp = 0;
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100140 int length = 0;
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200141 int help_entries = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100142
Willy Tarreau61cfdf42021-02-20 10:46:51 +0100143 ha_free(&dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100144
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200145 if (args && *args && strcmp(*args, "help") == 0) {
146 args++;
147 ishelp = 1;
148 }
149
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100150 /* first, let's measure the longest match */
151 list_for_each_entry(kw_list, &cli_keywords.list, list) {
152 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100153 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100154 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100155 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
156 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100157 (ACCESS_MASTER_ONLY|ACCESS_MASTER))
158 continue;
159
160 /* OK this command is visible */
161 for (idx = 0; idx < CLI_PREFIX_KW_NB; idx++) {
162 if (!kw->str_kw[idx])
163 break; // end of keyword
164 if (!args || !args[idx] || !*args[idx])
165 break; // end of command line
166 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
167 break;
168 if (idx + 1 > length)
169 length = idx + 1;
170 }
171 }
172 }
173
Willy Tarreaub7364582021-03-12 18:24:46 +0100174 /* now <length> equals the number of exactly matching words */
William Lallemand74c24fb2016-11-21 17:18:36 +0100175 chunk_reset(tmp);
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200176 if (ishelp) // this is the help message.
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100177 chunk_strcat(tmp, "The following commands are valid at this level:\n");
Abhijeet Rastogic8601502022-11-17 04:42:38 -0800178 else {
179 chunk_strcat(tmp, "Unknown command: '");
180 if (args && *args)
181 chunk_strcat(tmp, *args);
182 chunk_strcat(tmp, "'");
183
184 if (!length && (!args || !*args || !**args)) // no match
185 chunk_strcat(tmp, ". Please enter one of the following commands only:\n");
186 else // partial match
187 chunk_strcat(tmp, ", but maybe one of the following ones is a better match:\n");
188 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100189
Willy Tarreaub7364582021-03-12 18:24:46 +0100190 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
191 matches[idx].kw = NULL;
192 matches[idx].dist = INT_MAX;
193 }
194
195 /* In case of partial match we'll look for the best matching entries
196 * starting from position <length>
197 */
Willy Tarreau9c187472021-03-13 12:25:43 +0100198 if (args && args[length] && *args[length]) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100199 list_for_each_entry(kw_list, &cli_keywords.list, list) {
200 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100201 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreaub7364582021-03-12 18:24:46 +0100202 continue;
William Lallemand2a171912022-02-02 11:43:20 +0100203 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
204 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
205 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreaub7364582021-03-12 18:24:46 +0100206 continue;
207
208 for (idx = 0; idx < length; idx++) {
209 if (!kw->str_kw[idx])
210 break; // end of keyword
211 if (!args || !args[idx] || !*args[idx])
212 break; // end of command line
213 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
214 break;
215 }
216
217 /* extra non-matching words are fuzzy-matched */
218 if (kw->usage && idx == length && args[idx] && *args[idx]) {
219 uint8_t word_sig[1024];
220 uint8_t list_sig[1024];
221 int dist = 0;
222 int totlen = 0;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100223 int i;
Willy Tarreaub7364582021-03-12 18:24:46 +0100224
225 /* this one matches, let's compute the distance between the two
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100226 * on the remaining words. For this we're computing the signature
227 * of everything that remains and the cumulated length of the
228 * strings.
Willy Tarreaub7364582021-03-12 18:24:46 +0100229 */
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100230 memset(word_sig, 0, sizeof(word_sig));
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100231 for (i = idx; i < CLI_PREFIX_KW_NB && args[i] && *args[i]; i++) {
232 update_word_fingerprint(word_sig, args[i]);
233 totlen += strlen(args[i]);
234 }
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100235
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100236 memset(list_sig, 0, sizeof(list_sig));
237 for (i = idx; i < CLI_PREFIX_KW_NB && kw->str_kw[i]; i++) {
238 update_word_fingerprint(list_sig, kw->str_kw[i]);
239 totlen += strlen(kw->str_kw[i]);
Willy Tarreaub7364582021-03-12 18:24:46 +0100240 }
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100241
Willy Tarreauc57dcfe2021-03-12 19:01:59 +0100242 dist = word_fingerprint_distance(word_sig, list_sig);
Willy Tarreaub7364582021-03-12 18:24:46 +0100243
244 /* insert this one at its place if relevant, in order to keep only
245 * the best matches.
246 */
247 swp.kw = kw; swp.dist = dist;
Willy Tarreaua9aa6282021-03-15 10:00:29 +0100248 if (dist < 5*totlen/2 && dist < matches[CLI_MAX_MATCHES-1].dist) {
Willy Tarreaub7364582021-03-12 18:24:46 +0100249 matches[CLI_MAX_MATCHES-1] = swp;
250 for (idx = CLI_MAX_MATCHES - 1; --idx >= 0;) {
251 if (matches[idx+1].dist >= matches[idx].dist)
252 break;
253 matches[idx+1] = matches[idx];
254 matches[idx] = swp;
255 }
256 }
257 }
258 }
259 }
260 }
261
Willy Tarreauec197e82021-03-15 10:35:04 +0100262 if (matches[0].kw) {
263 /* we have fuzzy matches, let's propose them */
264 for (idx = 0; idx < CLI_MAX_MATCHES; idx++) {
265 kw = matches[idx].kw;
266 if (!kw)
267 break;
268
269 /* stop the dump if some words look very unlikely candidates */
270 if (matches[idx].dist > 5*matches[0].dist/2)
271 break;
272
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200273 if (help_entries < CLI_MAX_HELP_ENTRIES)
274 entries[help_entries++] = kw;
Willy Tarreauec197e82021-03-15 10:35:04 +0100275 }
276 }
277
William Lallemand74c24fb2016-11-21 17:18:36 +0100278 list_for_each_entry(kw_list, &cli_keywords.list, list) {
Willy Tarreauec197e82021-03-15 10:35:04 +0100279 /* no full dump if we've already found nice candidates */
280 if (matches[0].kw)
281 break;
282
Willy Tarreau91bc3592021-03-12 15:20:39 +0100283 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
William Lallemand14721be2018-10-26 14:47:37 +0200284
Willy Tarreau91bc3592021-03-12 15:20:39 +0100285 /* in a worker or normal process, don't display master-only commands
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100286 * nor expert/experimental mode commands if not in this mode.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100287 */
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100288 if (kw->level & ~appctx->cli_level & (ACCESS_MASTER_ONLY|ACCESS_EXPERT|ACCESS_EXPERIMENTAL))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100289 continue;
William Lallemand14721be2018-10-26 14:47:37 +0200290
William Lallemand2a171912022-02-02 11:43:20 +0100291 /* in master, if the CLI don't have the
292 * ACCESS_MCLI_DEBUG don't display commands that have
293 * neither the master bit nor the master-only bit.
Willy Tarreau91bc3592021-03-12 15:20:39 +0100294 */
William Lallemand2a171912022-02-02 11:43:20 +0100295 if (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
296 ((appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) ==
297 (ACCESS_MASTER_ONLY|ACCESS_MASTER)))
Willy Tarreau91bc3592021-03-12 15:20:39 +0100298 continue;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200299
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100300 for (idx = 0; idx < length; idx++) {
301 if (!kw->str_kw[idx])
302 break; // end of keyword
303 if (!args || !args[idx] || !*args[idx])
304 break; // end of command line
305 if (strcmp(kw->str_kw[idx], args[idx]) != 0)
306 break;
307 }
308
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200309 if (kw->usage && idx == length && help_entries < CLI_MAX_HELP_ENTRIES)
310 entries[help_entries++] = kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100311 }
312 }
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100313
Willy Tarreau92fbbcc2021-05-09 21:45:29 +0200314 qsort(entries, help_entries, sizeof(*entries), cmp_kw_entries);
315
316 for (idx = 0; idx < help_entries; idx++)
317 chunk_appendf(tmp, " %s\n", entries[idx]->usage);
318
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100319 /* always show the prompt/help/quit commands */
320 chunk_strcat(tmp,
Willy Tarreau0b1b8302021-05-09 20:59:23 +0200321 " help [<command>] : list matching or all commands\n"
Willy Tarreaub205bfd2021-05-07 11:38:37 +0200322 " prompt : toggle interactive mode with prompt\n"
323 " quit : disconnect\n");
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100324
William Lallemand74c24fb2016-11-21 17:18:36 +0100325 chunk_init(&out, NULL, 0);
326 chunk_dup(&out, tmp);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200327 dynamic_usage_msg = out.area;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200328
Willy Tarreau1c0715b2022-05-06 17:16:35 +0200329 cli_msg(appctx, LOG_INFO, dynamic_usage_msg);
William Lallemand74c24fb2016-11-21 17:18:36 +0100330 return dynamic_usage_msg;
331}
332
333struct cli_kw* cli_find_kw(char **args)
334{
335 struct cli_kw_list *kw_list;
336 struct cli_kw *kw;/* current cli_kw */
337 char **tmp_args;
338 const char **tmp_str_kw;
339 int found = 0;
340
341 if (LIST_ISEMPTY(&cli_keywords.list))
342 return NULL;
343
344 list_for_each_entry(kw_list, &cli_keywords.list, list) {
345 kw = &kw_list->kw[0];
346 while (*kw->str_kw) {
347 tmp_args = args;
348 tmp_str_kw = kw->str_kw;
349 while (*tmp_str_kw) {
350 if (strcmp(*tmp_str_kw, *tmp_args) == 0) {
351 found = 1;
352 } else {
353 found = 0;
354 break;
355 }
356 tmp_args++;
357 tmp_str_kw++;
358 }
359 if (found)
360 return (kw);
361 kw++;
362 }
363 }
364 return NULL;
365}
366
Thierry Fourniera51a1fd2020-11-28 20:10:08 +0100367struct cli_kw* cli_find_kw_exact(char **args)
368{
369 struct cli_kw_list *kw_list;
370 int found = 0;
371 int i;
372 int j;
373
374 if (LIST_ISEMPTY(&cli_keywords.list))
375 return NULL;
376
377 list_for_each_entry(kw_list, &cli_keywords.list, list) {
378 for (i = 0; kw_list->kw[i].str_kw[0]; i++) {
379 found = 1;
380 for (j = 0; j < CLI_PREFIX_KW_NB; j++) {
381 if (args[j] == NULL && kw_list->kw[i].str_kw[j] == NULL) {
382 break;
383 }
384 if (args[j] == NULL || kw_list->kw[i].str_kw[j] == NULL) {
385 found = 0;
386 break;
387 }
388 if (strcmp(args[j], kw_list->kw[i].str_kw[j]) != 0) {
389 found = 0;
390 break;
391 }
392 }
393 if (found)
394 return &kw_list->kw[i];
395 }
396 }
397 return NULL;
398}
399
William Lallemand74c24fb2016-11-21 17:18:36 +0100400void cli_register_kw(struct cli_kw_list *kw_list)
401{
Willy Tarreau2b718102021-04-21 07:32:39 +0200402 LIST_APPEND(&cli_keywords.list, &kw_list->list);
William Lallemand74c24fb2016-11-21 17:18:36 +0100403}
404
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200405/* list all known keywords on stdout, one per line */
406void cli_list_keywords(void)
407{
408 struct cli_kw_list *kw_list;
Willy Tarreau44651712022-03-30 12:02:35 +0200409 struct cli_kw *kwp, *kwn, *kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200410 int idx;
411
Willy Tarreau44651712022-03-30 12:02:35 +0200412 for (kwn = kwp = NULL;; kwp = kwn) {
413 list_for_each_entry(kw_list, &cli_keywords.list, list) {
414 /* note: we sort based on the usage message when available,
415 * otherwise we fall back to the first keyword.
416 */
417 for (kw = &kw_list->kw[0]; kw->str_kw[0]; kw++) {
418 if (strordered(kwp ? kwp->usage ? kwp->usage : kwp->str_kw[0] : NULL,
419 kw->usage ? kw->usage : kw->str_kw[0],
420 kwn != kwp ? kwn->usage ? kwn->usage : kwn->str_kw[0] : NULL))
421 kwn = kw;
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200422 }
Willy Tarreau44651712022-03-30 12:02:35 +0200423 }
424
425 if (kwn == kwp)
426 break;
427
428 for (idx = 0; kwn->str_kw[idx]; idx++) {
429 printf("%s ", kwn->str_kw[idx]);
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200430 }
Willy Tarreau44651712022-03-30 12:02:35 +0200431 if (kwn->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER))
432 printf("[MASTER] ");
433 if (!(kwn->level & ACCESS_MASTER_ONLY))
434 printf("[WORKER] ");
435 if (kwn->level & ACCESS_EXPERT)
436 printf("[EXPERT] ");
437 if (kwn->level & ACCESS_EXPERIMENTAL)
438 printf("[EXPERIM] ");
439 printf("\n");
Willy Tarreau06d0e2e2022-03-29 15:25:30 +0200440 }
441}
William Lallemand74c24fb2016-11-21 17:18:36 +0100442
443/* allocate a new stats frontend named <name>, and return it
444 * (or NULL in case of lack of memory).
445 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100446static struct proxy *cli_alloc_fe(const char *name, const char *file, int line)
William Lallemand74c24fb2016-11-21 17:18:36 +0100447{
448 struct proxy *fe;
449
450 fe = calloc(1, sizeof(*fe));
451 if (!fe)
452 return NULL;
453
454 init_new_proxy(fe);
Olivier Houchardfbc74e82017-11-24 16:54:05 +0100455 fe->next = proxies_list;
456 proxies_list = fe;
Willy Tarreau69530f52023-04-28 09:16:15 +0200457 fe->last_change = ns_to_sec(now_ns);
William Lallemand74c24fb2016-11-21 17:18:36 +0100458 fe->id = strdup("GLOBAL");
William Lallemand6640dbb2021-08-13 15:31:33 +0200459 fe->cap = PR_CAP_FE|PR_CAP_INT;
William Lallemand74c24fb2016-11-21 17:18:36 +0100460 fe->maxconn = 10; /* default to 10 concurrent connections */
461 fe->timeout.client = MS_TO_TICKS(10000); /* default timeout of 10 seconds */
462 fe->conf.file = strdup(file);
463 fe->conf.line = line;
464 fe->accept = frontend_accept;
465 fe->default_target = &cli_applet.obj_type;
466
467 /* the stats frontend is the only one able to assign ID #0 */
468 fe->conf.id.key = fe->uuid = 0;
469 eb32_insert(&used_proxy_id, &fe->conf.id);
470 return fe;
471}
472
473/* This function parses a "stats" statement in the "global" section. It returns
474 * -1 if there is any error, otherwise zero. If it returns -1, it will write an
475 * error message into the <err> buffer which will be preallocated. The trailing
476 * '\n' must not be written. The function must be called with <args> pointing to
477 * the first word after "stats".
478 */
Willy Tarreau4975d142021-03-13 11:00:33 +0100479static int cli_parse_global(char **args, int section_type, struct proxy *curpx,
480 const struct proxy *defpx, const char *file, int line,
481 char **err)
William Lallemand74c24fb2016-11-21 17:18:36 +0100482{
483 struct bind_conf *bind_conf;
484 struct listener *l;
485
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100486 if (strcmp(args[1], "socket") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100487 int cur_arg;
488
489 if (*args[2] == 0) {
490 memprintf(err, "'%s %s' in global section expects an address or a path to a UNIX socket", args[0], args[1]);
491 return -1;
492 }
493
Willy Tarreau4975d142021-03-13 11:00:33 +0100494 if (!global.cli_fe) {
495 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100496 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
497 return -1;
498 }
499 }
500
Willy Tarreau4975d142021-03-13 11:00:33 +0100501 bind_conf = bind_conf_alloc(global.cli_fe, file, line, args[2], xprt_get(XPRT_RAW));
Christopher Faulet0c6d1dc2021-04-12 16:56:37 +0200502 if (!bind_conf) {
503 memprintf(err, "'%s %s' : out of memory trying to allocate a bind_conf", args[0], args[1]);
504 return -1;
505 }
William Lallemand07a62f72017-05-24 00:57:40 +0200506 bind_conf->level &= ~ACCESS_LVL_MASK;
507 bind_conf->level |= ACCESS_LVL_OPER; /* default access level */
William Lallemand74c24fb2016-11-21 17:18:36 +0100508
Willy Tarreau4975d142021-03-13 11:00:33 +0100509 if (!str2listener(args[2], global.cli_fe, bind_conf, file, line, err)) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100510 memprintf(err, "parsing [%s:%d] : '%s %s' : %s\n",
511 file, line, args[0], args[1], err && *err ? *err : "error");
512 return -1;
513 }
514
515 cur_arg = 3;
516 while (*args[cur_arg]) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100517 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +0100518 const char *best;
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100519 int code;
William Lallemand74c24fb2016-11-21 17:18:36 +0100520
521 kw = bind_find_kw(args[cur_arg]);
522 if (kw) {
523 if (!kw->parse) {
524 memprintf(err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
525 args[0], args[1], args[cur_arg]);
526 return -1;
527 }
528
Willy Tarreau0a1e1cb2021-11-20 20:10:41 +0100529 code = kw->parse(args, cur_arg, global.cli_fe, bind_conf, err);
530
531 /* FIXME: this is ugly, we don't have a way to collect warnings,
532 * yet some important bind keywords may report warnings that we
533 * must display.
534 */
535 if (((code & (ERR_WARN|ERR_FATAL|ERR_ALERT)) == ERR_WARN) && err && *err) {
536 indent_msg(err, 2);
537 ha_warning("parsing [%s:%d] : '%s %s' : %s\n", file, line, args[0], args[1], *err);
538 ha_free(err);
539 }
540
541 if (code & ~ERR_WARN) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100542 if (err && *err)
543 memprintf(err, "'%s %s' : '%s'", args[0], args[1], *err);
544 else
545 memprintf(err, "'%s %s' : error encountered while processing '%s'",
546 args[0], args[1], args[cur_arg]);
547 return -1;
548 }
549
550 cur_arg += 1 + kw->skip;
551 continue;
552 }
553
Willy Tarreau433b05f2021-03-12 10:14:07 +0100554 best = bind_find_best_kw(args[cur_arg]);
555 if (best)
556 memprintf(err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
557 args[0], args[1], args[cur_arg], best);
558 else
559 memprintf(err, "'%s %s' : unknown keyword '%s'.",
560 args[0], args[1], args[cur_arg]);
William Lallemand74c24fb2016-11-21 17:18:36 +0100561 return -1;
562 }
563
Willy Tarreau30836152023-01-12 19:10:17 +0100564 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +0100565 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +0100566 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +0100567
William Lallemand74c24fb2016-11-21 17:18:36 +0100568 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18215cb2019-02-27 16:25:28 +0100569 global.maxsock++; /* for the listening socket */
William Lallemand74c24fb2016-11-21 17:18:36 +0100570 }
571 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100572 else if (strcmp(args[1], "timeout") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100573 unsigned timeout;
574 const char *res = parse_time_err(args[2], &timeout, TIME_UNIT_MS);
575
Willy Tarreau9faebe32019-06-07 19:00:37 +0200576 if (res == PARSE_TIME_OVER) {
577 memprintf(err, "timer overflow in argument '%s' to '%s %s' (maximum value is 2147483647 ms or ~24.8 days)",
578 args[2], args[0], args[1]);
579 return -1;
580 }
581 else if (res == PARSE_TIME_UNDER) {
582 memprintf(err, "timer underflow in argument '%s' to '%s %s' (minimum non-null value is 1 ms)",
583 args[2], args[0], args[1]);
584 return -1;
585 }
586 else if (res) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100587 memprintf(err, "'%s %s' : unexpected character '%c'", args[0], args[1], *res);
588 return -1;
589 }
590
591 if (!timeout) {
592 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
593 return -1;
594 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100595 if (!global.cli_fe) {
596 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100597 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
598 return -1;
599 }
600 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100601 global.cli_fe->timeout.client = MS_TO_TICKS(timeout);
William Lallemand74c24fb2016-11-21 17:18:36 +0100602 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100603 else if (strcmp(args[1], "maxconn") == 0) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100604 int maxconn = atol(args[2]);
605
606 if (maxconn <= 0) {
607 memprintf(err, "'%s %s' expects a positive value", args[0], args[1]);
608 return -1;
609 }
610
Willy Tarreau4975d142021-03-13 11:00:33 +0100611 if (!global.cli_fe) {
612 if ((global.cli_fe = cli_alloc_fe("GLOBAL", file, line)) == NULL) {
William Lallemand74c24fb2016-11-21 17:18:36 +0100613 memprintf(err, "'%s %s' : out of memory trying to allocate a frontend", args[0], args[1]);
614 return -1;
615 }
616 }
Willy Tarreau4975d142021-03-13 11:00:33 +0100617 global.cli_fe->maxconn = maxconn;
William Lallemand74c24fb2016-11-21 17:18:36 +0100618 }
Willy Tarreau94f763b2022-07-15 17:14:40 +0200619 else if (strcmp(args[1], "bind-process") == 0) {
Willy Tarreau023c3112023-04-23 09:40:56 +0200620 memprintf(err, "'%s %s' is not supported anymore.", args[0], args[1]);
Willy Tarreau94f763b2022-07-15 17:14:40 +0200621 return -1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100622 }
623 else {
624 memprintf(err, "'%s' only supports 'socket', 'maxconn', 'bind-process' and 'timeout' (got '%s')", args[0], args[1]);
625 return -1;
626 }
627 return 0;
628}
629
William Lallemand33d29e22019-04-01 11:30:06 +0200630/*
William Lallemand9a37fd02019-04-12 16:09:24 +0200631 * This function exports the bound addresses of a <frontend> in the environment
632 * variable <varname>. Those addresses are separated by semicolons and prefixed
633 * with their type (abns@, unix@, sockpair@ etc)
634 * Return -1 upon error, 0 otherwise
William Lallemand33d29e22019-04-01 11:30:06 +0200635 */
William Lallemand9a37fd02019-04-12 16:09:24 +0200636int listeners_setenv(struct proxy *frontend, const char *varname)
William Lallemand33d29e22019-04-01 11:30:06 +0200637{
638 struct buffer *trash = get_trash_chunk();
639 struct bind_conf *bind_conf;
640
William Lallemand9a37fd02019-04-12 16:09:24 +0200641 if (frontend) {
642 list_for_each_entry(bind_conf, &frontend->conf.bind, by_fe) {
William Lallemand33d29e22019-04-01 11:30:06 +0200643 struct listener *l;
644
645 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
646 char addr[46];
647 char port[6];
648
William Lallemand620072b2019-04-12 16:09:25 +0200649 /* separate listener by semicolons */
650 if (trash->data)
651 chunk_appendf(trash, ";");
652
Willy Tarreau37159062020-08-27 07:48:42 +0200653 if (l->rx.addr.ss_family == AF_UNIX) {
William Lallemand33d29e22019-04-01 11:30:06 +0200654 const struct sockaddr_un *un;
655
Willy Tarreau37159062020-08-27 07:48:42 +0200656 un = (struct sockaddr_un *)&l->rx.addr;
William Lallemand33d29e22019-04-01 11:30:06 +0200657 if (un->sun_path[0] == '\0') {
658 chunk_appendf(trash, "abns@%s", un->sun_path+1);
659 } else {
660 chunk_appendf(trash, "unix@%s", un->sun_path);
661 }
Willy Tarreau37159062020-08-27 07:48:42 +0200662 } else if (l->rx.addr.ss_family == AF_INET) {
663 addr_to_str(&l->rx.addr, addr, sizeof(addr));
664 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200665 chunk_appendf(trash, "ipv4@%s:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200666 } else if (l->rx.addr.ss_family == AF_INET6) {
667 addr_to_str(&l->rx.addr, addr, sizeof(addr));
668 port_to_str(&l->rx.addr, port, sizeof(port));
William Lallemand33d29e22019-04-01 11:30:06 +0200669 chunk_appendf(trash, "ipv6@[%s]:%s", addr, port);
Willy Tarreau37159062020-08-27 07:48:42 +0200670 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
671 chunk_appendf(trash, "sockpair@%d", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
William Lallemand33d29e22019-04-01 11:30:06 +0200672 }
William Lallemand33d29e22019-04-01 11:30:06 +0200673 }
674 }
675 trash->area[trash->data++] = '\0';
William Lallemand9a37fd02019-04-12 16:09:24 +0200676 if (setenv(varname, trash->area, 1) < 0)
William Lallemand33d29e22019-04-01 11:30:06 +0200677 return -1;
678 }
679
680 return 0;
681}
682
William Lallemand9a37fd02019-04-12 16:09:24 +0200683int cli_socket_setenv()
684{
Willy Tarreau4975d142021-03-13 11:00:33 +0100685 if (listeners_setenv(global.cli_fe, "HAPROXY_CLI") < 0)
William Lallemand9a37fd02019-04-12 16:09:24 +0200686 return -1;
687 if (listeners_setenv(mworker_proxy, "HAPROXY_MASTER_CLI") < 0)
688 return -1;
689
690 return 0;
691}
692
William Lallemand33d29e22019-04-01 11:30:06 +0200693REGISTER_CONFIG_POSTPARSER("cli", cli_socket_setenv);
694
Willy Tarreaude57a572016-11-23 17:01:39 +0100695/* Verifies that the CLI at least has a level at least as high as <level>
696 * (typically ACCESS_LVL_ADMIN). Returns 1 if OK, otherwise 0. In case of
697 * failure, an error message is prepared and the appctx's state is adjusted
698 * to print it so that a return 1 is enough to abort any processing.
699 */
700int cli_has_level(struct appctx *appctx, int level)
701{
Willy Tarreaude57a572016-11-23 17:01:39 +0100702
William Lallemandf630d012018-12-13 09:05:44 +0100703 if ((appctx->cli_level & ACCESS_LVL_MASK) < level) {
Willy Tarreau4975d142021-03-13 11:00:33 +0100704 cli_err(appctx, cli_permission_denied_msg);
Willy Tarreaude57a572016-11-23 17:01:39 +0100705 return 0;
706 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100707 return 1;
708}
709
William Lallemandb7ea1412018-12-13 09:05:47 +0100710/* same as cli_has_level but for the CLI proxy and without error message */
711int pcli_has_level(struct stream *s, int level)
712{
713 if ((s->pcli_flags & ACCESS_LVL_MASK) < level) {
714 return 0;
715 }
716 return 1;
717}
718
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200719/* Returns severity_output for the current session if set, or default for the socket */
720static int cli_get_severity_output(struct appctx *appctx)
721{
722 if (appctx->cli_severity_output)
723 return appctx->cli_severity_output;
Willy Tarreau0698c802022-05-11 14:09:57 +0200724 return strm_li(appctx_strm(appctx))->bind_conf->severity_output;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200725}
William Lallemand74c24fb2016-11-21 17:18:36 +0100726
Willy Tarreau41908562016-11-24 16:23:38 +0100727/* Processes the CLI interpreter on the stats socket. This function is called
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100728 * from the CLI's IO handler running in an appctx context. The function returns
729 * 1 if the request was understood, otherwise zero (in which case an error
730 * message will be displayed). It is called with appctx->st0
Willy Tarreau41908562016-11-24 16:23:38 +0100731 * set to CLI_ST_GETREQ and presets ->st2 to 0 so that parsers don't have to do
732 * it. It will possilbly leave st0 to CLI_ST_CALLBACK if the keyword needs to
733 * have its own I/O handler called again. Most of the time, parsers will only
734 * set st0 to CLI_ST_PRINT and put their message to be displayed into cli.msg.
Willy Tarreaueaffde32016-12-16 17:59:25 +0100735 * If a keyword parser is NULL and an I/O handler is declared, the I/O handler
736 * will automatically be used.
William Lallemand74c24fb2016-11-21 17:18:36 +0100737 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200738static int cli_parse_request(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +0100739{
Willy Tarreauf14c7572021-03-13 10:59:23 +0100740 char *args[MAX_CLI_ARGS + 1], *p, *end, *payload = NULL;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200741 int i = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100742 struct cli_kw *kw;
William Lallemand74c24fb2016-11-21 17:18:36 +0100743
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200744 p = appctx->chunk->area;
745 end = p + appctx->chunk->data;
William Lallemand74c24fb2016-11-21 17:18:36 +0100746
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200747 /*
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200748 * Get pointers on words.
749 * One extra slot is reserved to store a pointer on a null byte.
750 */
Willy Tarreauf14c7572021-03-13 10:59:23 +0100751 while (i < MAX_CLI_ARGS && p < end) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200752 int j, k;
William Lallemand74c24fb2016-11-21 17:18:36 +0100753
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200754 /* skip leading spaces/tabs */
755 p += strspn(p, " \t");
756 if (!*p)
757 break;
Willy Tarreauf2dda522021-09-17 11:07:45 +0200758
759 if (strcmp(p, PAYLOAD_PATTERN) == 0) {
760 /* payload pattern recognized here, this is not an arg anymore,
761 * the payload starts at the first byte that follows the zero
762 * after the pattern.
763 */
764 payload = p + strlen(PAYLOAD_PATTERN) + 1;
765 break;
766 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100767
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200768 args[i] = p;
Yves Lafonb08c6d02020-06-08 16:08:06 +0200769 while (1) {
770 p += strcspn(p, " \t\\");
771 /* escaped chars using backlashes (\) */
772 if (*p == '\\') {
773 if (!*++p)
774 break;
775 if (!*++p)
776 break;
777 } else {
778 break;
779 }
780 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200781 *p++ = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100782
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200783 /* unescape backslashes (\) */
784 for (j = 0, k = 0; args[i][k]; k++) {
785 if (args[i][k] == '\\') {
786 if (args[i][k + 1] == '\\')
787 k++;
Dragan Dosena1c35ab2016-11-24 11:33:12 +0100788 else
789 continue;
790 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200791 args[i][j] = args[i][k];
William Lallemand74c24fb2016-11-21 17:18:36 +0100792 j++;
793 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200794 args[i][j] = 0;
William Lallemand74c24fb2016-11-21 17:18:36 +0100795
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200796 i++;
797 }
798 /* fill unused slots */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200799 p = appctx->chunk->area + appctx->chunk->data;
Willy Tarreauf14c7572021-03-13 10:59:23 +0100800 for (; i < MAX_CLI_ARGS + 1; i++)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200801 args[i] = p;
Willy Tarreau41908562016-11-24 16:23:38 +0100802
803 kw = cli_find_kw(args);
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100804 if (!kw ||
805 (kw->level & ~appctx->cli_level & ACCESS_MASTER_ONLY) ||
William Lallemand2a171912022-02-02 11:43:20 +0100806 (!(appctx->cli_level & ACCESS_MCLI_DEBUG) &&
807 (appctx->cli_level & ~kw->level & (ACCESS_MASTER_ONLY|ACCESS_MASTER)) == (ACCESS_MASTER_ONLY|ACCESS_MASTER))) {
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100808 /* keyword not found in this mode */
Willy Tarreaub96a74c2021-03-12 17:13:28 +0100809 cli_gen_usage_msg(appctx, args);
Willy Tarreau41908562016-11-24 16:23:38 +0100810 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100811 }
William Lallemand14721be2018-10-26 14:47:37 +0200812
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100813 /* don't handle expert mode commands if not in this mode. */
814 if (kw->level & ~appctx->cli_level & ACCESS_EXPERT) {
815 cli_err(appctx, "This command is restricted to expert mode only.\n");
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200816 return 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +0100817 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +0200818
Amaury Denoyelle18487fb2021-03-18 15:32:53 +0100819 if (kw->level & ~appctx->cli_level & ACCESS_EXPERIMENTAL) {
820 cli_err(appctx, "This command is restricted to experimental mode only.\n");
821 return 0;
822 }
823
Amaury Denoyellef4929922021-05-05 16:29:23 +0200824 if (kw->level == ACCESS_EXPERT)
825 mark_tainted(TAINTED_CLI_EXPERT_MODE);
826 else if (kw->level == ACCESS_EXPERIMENTAL)
827 mark_tainted(TAINTED_CLI_EXPERIMENTAL_MODE);
828
Willy Tarreau41908562016-11-24 16:23:38 +0100829 appctx->io_handler = kw->io_handler;
Emeric Brund6871f72017-06-29 19:54:13 +0200830 appctx->io_release = kw->io_release;
William Lallemand90b098c2019-10-25 21:10:14 +0200831
832 if (kw->parse && kw->parse(args, payload, appctx, kw->private) != 0)
833 goto fail;
834
835 /* kw->parse could set its own io_handler or io_release handler */
836 if (!appctx->io_handler)
837 goto fail;
838
839 appctx->st0 = CLI_ST_CALLBACK;
840 return 1;
841fail:
842 appctx->io_handler = NULL;
843 appctx->io_release = NULL;
Willy Tarreau41908562016-11-24 16:23:38 +0100844 return 1;
William Lallemand74c24fb2016-11-21 17:18:36 +0100845}
846
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200847/* prepends then outputs the argument msg with a syslog-type severity depending on severity_output value */
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200848static int cli_output_msg(struct appctx *appctx, const char *msg, int severity, int severity_output)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200849{
Willy Tarreau83061a82018-07-13 11:56:34 +0200850 struct buffer *tmp;
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200851
852 if (likely(severity_output == CLI_SEVERITY_NONE))
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200853 return applet_putstr(appctx, msg);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200854
855 tmp = get_trash_chunk();
856 chunk_reset(tmp);
857
858 if (severity < 0 || severity > 7) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100859 ha_warning("socket command feedback with invalid severity %d", severity);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200860 chunk_printf(tmp, "[%d]: ", severity);
861 }
862 else {
863 switch (severity_output) {
864 case CLI_SEVERITY_NUMBER:
865 chunk_printf(tmp, "[%d]: ", severity);
866 break;
867 case CLI_SEVERITY_STRING:
868 chunk_printf(tmp, "[%s]: ", log_levels[severity]);
869 break;
870 default:
Christopher Faulet767a84b2017-11-24 16:50:31 +0100871 ha_warning("Unrecognized severity output %d", severity_output);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200872 }
873 }
874 chunk_appendf(tmp, "%s", msg);
875
Christopher Faulete8ee27b2023-05-05 10:56:00 +0200876 return applet_putchk(appctx, tmp);
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200877}
878
Willy Tarreau4596fe22022-05-17 19:07:51 +0200879/* This I/O handler runs as an applet embedded in a stream connector. It is
William Lallemand74c24fb2016-11-21 17:18:36 +0100880 * used to processes I/O from/to the stats unix socket. The system relies on a
881 * state machine handling requests and various responses. We read a request,
882 * then we process it and send the response, and we possibly display a prompt.
883 * Then we can read again. The state is stored in appctx->st0 and is one of the
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100884 * CLI_ST_* constants. appctx->st1 is used to indicate whether prompt is enabled
William Lallemand74c24fb2016-11-21 17:18:36 +0100885 * or not.
886 */
887static void cli_io_handler(struct appctx *appctx)
888{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200889 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +0200890 struct channel *req = sc_oc(sc);
891 struct channel *res = sc_ic(sc);
892 struct bind_conf *bind_conf = strm_li(__sc_strm(sc))->bind_conf;
William Lallemand74c24fb2016-11-21 17:18:36 +0100893 int reql;
894 int len;
895
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200896 if (unlikely(se_fl_test(appctx->sedesc, (SE_FL_EOS|SE_FL_ERROR|SE_FL_SHR|SE_FL_SHW)))) {
897 co_skip(sc_oc(sc), co_data(sc_oc(sc)));
William Lallemand74c24fb2016-11-21 17:18:36 +0100898 goto out;
Christopher Faulet1fb97e42023-04-07 18:07:51 +0200899 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100900
Joseph Herlant008b3ce2018-11-25 12:51:45 -0800901 /* Check if the input buffer is available. */
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200902 if (!b_size(&res->buf)) {
Christopher Faulet7b3d38a2023-05-05 11:28:45 +0200903 sc_need_room(sc, 0);
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100904 goto out;
905 }
906
William Lallemand74c24fb2016-11-21 17:18:36 +0100907 while (1) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100908 if (appctx->st0 == CLI_ST_INIT) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +0200909 /* reset severity to default at init */
910 appctx->cli_severity_output = bind_conf->severity_output;
Willy Tarreau1addf8b2022-08-18 18:04:37 +0200911 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100912 appctx->st0 = CLI_ST_GETREQ;
William Lallemandf630d012018-12-13 09:05:44 +0100913 appctx->cli_level = bind_conf->level;
William Lallemand74c24fb2016-11-21 17:18:36 +0100914 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100915 else if (appctx->st0 == CLI_ST_END) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200916 se_fl_set(appctx->sedesc, SE_FL_EOS);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200917 free_trash_chunk(appctx->chunk);
Willy Tarreau18b2a9d2021-05-04 16:27:45 +0200918 appctx->chunk = NULL;
William Lallemand74c24fb2016-11-21 17:18:36 +0100919 break;
920 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100921 else if (appctx->st0 == CLI_ST_GETREQ) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200922 char *str;
923
924 /* use a trash chunk to store received data */
925 if (!appctx->chunk) {
926 appctx->chunk = alloc_trash_chunk();
927 if (!appctx->chunk) {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200928 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200929 appctx->st0 = CLI_ST_END;
930 continue;
931 }
932 }
933
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200934 str = appctx->chunk->area + appctx->chunk->data;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200935
William Lallemand74c24fb2016-11-21 17:18:36 +0100936 /* ensure we have some output room left in the event we
937 * would want to return some info right after parsing.
938 */
Willy Tarreau475e4632022-05-27 10:26:46 +0200939 if (buffer_almost_full(sc_ib(sc))) {
Christopher Faulet7b3d38a2023-05-05 11:28:45 +0200940 sc_need_room(sc, b_size(&res->buf) / 2);
William Lallemand74c24fb2016-11-21 17:18:36 +0100941 break;
942 }
943
Willy Tarreau0011c252022-01-19 17:23:52 +0100944 /* payload doesn't take escapes nor does it end on semi-colons, so
945 * we use the regular getline. Normal mode however must stop on
946 * LFs and semi-colons that are not prefixed by a backslash. Note
947 * that we reserve one byte at the end to insert a trailing nul byte.
948 */
949
950 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Willy Tarreau475e4632022-05-27 10:26:46 +0200951 reql = co_getline(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100952 appctx->chunk->size - appctx->chunk->data - 1);
953 else
Willy Tarreau475e4632022-05-27 10:26:46 +0200954 reql = co_getdelim(sc_oc(sc), str,
Willy Tarreau0011c252022-01-19 17:23:52 +0100955 appctx->chunk->size - appctx->chunk->data - 1,
956 "\n;", '\\');
957
William Lallemand74c24fb2016-11-21 17:18:36 +0100958 if (reql <= 0) { /* closed or EOL not found */
959 if (reql == 0)
960 break;
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200961 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100962 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100963 continue;
964 }
965
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200966 if (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)) {
967 /* seek for a possible unescaped semi-colon. If we find
968 * one, we replace it with an LF and skip only this part.
969 */
970 for (len = 0; len < reql; len++) {
971 if (str[len] == '\\') {
972 len++;
973 continue;
974 }
975 if (str[len] == ';') {
976 str[len] = '\n';
977 reql = len + 1;
978 break;
979 }
William Lallemand74c24fb2016-11-21 17:18:36 +0100980 }
981 }
982
983 /* now it is time to check that we have a full line,
984 * remove the trailing \n and possibly \r, then cut the
985 * line.
986 */
987 len = reql - 1;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200988 if (str[len] != '\n') {
Christopher Faulet2fd0c762023-03-31 10:25:07 +0200989 se_fl_set(appctx->sedesc, SE_FL_ERROR);
Willy Tarreau3b6e5472016-11-24 15:53:53 +0100990 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +0100991 continue;
992 }
993
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200994 if (len && str[len-1] == '\r')
William Lallemand74c24fb2016-11-21 17:18:36 +0100995 len--;
996
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200997 str[len] = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200998 appctx->chunk->data += len;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +0200999
1000 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001001 appctx->chunk->area[appctx->chunk->data] = '\n';
1002 appctx->chunk->area[appctx->chunk->data + 1] = 0;
1003 appctx->chunk->data++;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001004 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001005
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001006 appctx->st0 = CLI_ST_PROMPT;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001007
1008 if (appctx->st1 & APPCTX_CLI_ST1_PAYLOAD) {
1009 /* empty line */
1010 if (!len) {
1011 /* remove the last two \n */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001012 appctx->chunk->data -= 2;
1013 appctx->chunk->area[appctx->chunk->data] = 0;
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001014 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001015 chunk_reset(appctx->chunk);
1016 /* NB: cli_sock_parse_request() may have put
1017 * another CLI_ST_O_* into appctx->st0.
1018 */
1019
1020 appctx->st1 &= ~APPCTX_CLI_ST1_PAYLOAD;
William Lallemand74c24fb2016-11-21 17:18:36 +01001021 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001022 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001023 else {
1024 /*
1025 * Look for the "payload start" pattern at the end of a line
1026 * Its location is not remembered here, this is just to switch
1027 * to a gathering mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001028 */
Willy Tarreauf2dda522021-09-17 11:07:45 +02001029 if (strcmp(appctx->chunk->area + appctx->chunk->data - strlen(PAYLOAD_PATTERN), PAYLOAD_PATTERN) == 0) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001030 appctx->st1 |= APPCTX_CLI_ST1_PAYLOAD;
Willy Tarreauf2dda522021-09-17 11:07:45 +02001031 appctx->chunk->data++; // keep the trailing \0 after '<<'
1032 }
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001033 else {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001034 /* no payload, the command is complete: parse the request */
Willy Tarreauf3697dd2021-03-12 15:57:47 +01001035 cli_parse_request(appctx);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001036 chunk_reset(appctx->chunk);
Andjelko Iharosc3680ec2017-07-20 16:49:14 +02001037 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001038 }
1039
1040 /* re-adjust req buffer */
Willy Tarreau475e4632022-05-27 10:26:46 +02001041 co_skip(sc_oc(sc), reql);
Christopher Faulet9a790f62023-03-16 14:40:03 +01001042 sc_opposite(sc)->flags |= SC_FL_RCV_ONCE; /* we plan to read small requests */
William Lallemand74c24fb2016-11-21 17:18:36 +01001043 }
1044 else { /* output functions */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001045 struct cli_print_ctx *ctx;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001046 const char *msg;
1047 int sev;
1048
William Lallemand74c24fb2016-11-21 17:18:36 +01001049 switch (appctx->st0) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001050 case CLI_ST_PROMPT:
William Lallemand74c24fb2016-11-21 17:18:36 +01001051 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001052 case CLI_ST_PRINT: /* print const message in msg */
1053 case CLI_ST_PRINT_ERR: /* print const error in msg */
1054 case CLI_ST_PRINT_DYN: /* print dyn message in msg, free */
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001055 case CLI_ST_PRINT_DYNERR: /* print dyn error in err, free */
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001056 case CLI_ST_PRINT_UMSG: /* print usermsgs_ctx and reset it */
1057 case CLI_ST_PRINT_UMSGERR: /* print usermsgs_ctx as error and reset it */
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001058 /* the message is in the svcctx */
1059 ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001060 if (appctx->st0 == CLI_ST_PRINT || appctx->st0 == CLI_ST_PRINT_ERR) {
1061 sev = appctx->st0 == CLI_ST_PRINT_ERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001062 LOG_ERR : ctx->severity;
1063 msg = ctx->msg;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001064 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001065 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
1066 sev = appctx->st0 == CLI_ST_PRINT_DYNERR ?
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001067 LOG_ERR : ctx->severity;
1068 msg = ctx->err;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001069 if (!msg) {
1070 sev = LOG_ERR;
1071 msg = "Out of memory.\n";
1072 }
1073 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001074 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1075 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1076 sev = appctx->st0 == CLI_ST_PRINT_UMSGERR ?
1077 LOG_ERR : ctx->severity;
1078 msg = usermsgs_str();
1079 }
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001080 else {
1081 sev = LOG_ERR;
1082 msg = "Internal error.\n";
1083 }
Aurélien Nephtalic511b7c2018-04-16 18:50:19 +02001084
Christopher Faulete8ee27b2023-05-05 10:56:00 +02001085 if (cli_output_msg(appctx, msg, sev, cli_get_severity_output(appctx)) != -1) {
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001086 if (appctx->st0 == CLI_ST_PRINT_DYN ||
1087 appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001088 ha_free(&ctx->err);
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001089 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001090 else if (appctx->st0 == CLI_ST_PRINT_UMSG ||
1091 appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1092 usermsgs_clr(NULL);
1093 }
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001094 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001095 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001096 break;
Willy Tarreaud50c7fe2019-08-09 09:57:36 +02001097
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001098 case CLI_ST_CALLBACK: /* use custom pointer */
William Lallemand74c24fb2016-11-21 17:18:36 +01001099 if (appctx->io_handler)
1100 if (appctx->io_handler(appctx)) {
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001101 appctx->st0 = CLI_ST_PROMPT;
William Lallemand74c24fb2016-11-21 17:18:36 +01001102 if (appctx->io_release) {
1103 appctx->io_release(appctx);
1104 appctx->io_release = NULL;
1105 }
1106 }
1107 break;
1108 default: /* abnormal state */
Willy Tarreaud869e132022-05-17 18:05:31 +02001109 se_fl_set(appctx->sedesc, SE_FL_ERROR);
William Lallemand74c24fb2016-11-21 17:18:36 +01001110 break;
1111 }
1112
1113 /* The post-command prompt is either LF alone or LF + '> ' in interactive mode */
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001114 if (appctx->st0 == CLI_ST_PROMPT) {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001115 const char *prompt = "";
1116
1117 if (appctx->st1 & APPCTX_CLI_ST1_PROMPT) {
1118 /*
1119 * when entering a payload with interactive mode, change the prompt
1120 * to emphasize that more data can still be sent
1121 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001122 if (appctx->chunk->data && appctx->st1 & APPCTX_CLI_ST1_PAYLOAD)
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001123 prompt = "+ ";
1124 else
1125 prompt = "\n> ";
1126 }
1127 else {
William Lallemandad032882019-07-01 10:56:15 +02001128 if (!(appctx->st1 & (APPCTX_CLI_ST1_PAYLOAD|APPCTX_CLI_ST1_NOLF)))
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001129 prompt = "\n";
1130 }
1131
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001132 if (applet_putstr(appctx, prompt) != -1) {
1133 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001134 appctx->st0 = CLI_ST_GETREQ;
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001135 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001136 }
1137
1138 /* If the output functions are still there, it means they require more room. */
Christopher Faulet4167e052022-06-01 17:25:42 +02001139 if (appctx->st0 >= CLI_ST_OUTPUT) {
1140 applet_wont_consume(appctx);
William Lallemand74c24fb2016-11-21 17:18:36 +01001141 break;
Christopher Faulet4167e052022-06-01 17:25:42 +02001142 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001143
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001144 /* Now we close the output if we're not in interactive
1145 * mode and the request buffer is empty. This still
1146 * allows pipelined requests to be sent in
1147 * non-interactive mode.
William Lallemand74c24fb2016-11-21 17:18:36 +01001148 */
Christopher Faulet2fd0c762023-03-31 10:25:07 +02001149 if (!(appctx->st1 & APPCTX_CLI_ST1_PROMPT) && !co_data(req) && (!(appctx->st1 & APPCTX_CLI_ST1_PAYLOAD))) {
1150 se_fl_set(appctx->sedesc, SE_FL_EOI);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001151 appctx->st0 = CLI_ST_END;
William Lallemand74c24fb2016-11-21 17:18:36 +01001152 continue;
1153 }
1154
1155 /* switch state back to GETREQ to read next requests */
Willy Tarreau1addf8b2022-08-18 18:04:37 +02001156 applet_reset_svcctx(appctx);
Willy Tarreau3b6e5472016-11-24 15:53:53 +01001157 appctx->st0 = CLI_ST_GETREQ;
Christopher Faulet4167e052022-06-01 17:25:42 +02001158 applet_will_consume(appctx);
1159
William Lallemandad032882019-07-01 10:56:15 +02001160 /* reactivate the \n at the end of the response for the next command */
1161 appctx->st1 &= ~APPCTX_CLI_ST1_NOLF;
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001162
1163 /* this forces us to yield between pipelined commands and
1164 * avoid extremely long latencies (e.g. "del map" etc). In
1165 * addition this increases the likelihood that the stream
1166 * refills the buffer with new bytes in non-interactive
1167 * mode, avoiding to close on apparently empty commands.
1168 */
Willy Tarreau475e4632022-05-27 10:26:46 +02001169 if (co_data(sc_oc(sc))) {
Willy Tarreaufa7b4f62022-01-19 17:11:36 +01001170 appctx_wakeup(appctx);
1171 goto out;
1172 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001173 }
1174 }
1175
William Lallemand74c24fb2016-11-21 17:18:36 +01001176 out:
Christopher Faulet845f7c42023-04-18 18:36:43 +02001177 return;
William Lallemand74c24fb2016-11-21 17:18:36 +01001178}
1179
Willy Tarreau4596fe22022-05-17 19:07:51 +02001180/* This is called when the stream connector is closed. For instance, upon an
William Lallemand74c24fb2016-11-21 17:18:36 +01001181 * external abort, we won't call the i/o handler anymore so we may need to
1182 * remove back references to the stream currently being dumped.
1183 */
1184static void cli_release_handler(struct appctx *appctx)
1185{
Willy Tarreau18b2a9d2021-05-04 16:27:45 +02001186 free_trash_chunk(appctx->chunk);
1187 appctx->chunk = NULL;
1188
William Lallemand74c24fb2016-11-21 17:18:36 +01001189 if (appctx->io_release) {
1190 appctx->io_release(appctx);
1191 appctx->io_release = NULL;
1192 }
Amaury Denoyelle56f50a02022-11-10 11:47:36 +01001193 else if (appctx->st0 == CLI_ST_PRINT_DYN || appctx->st0 == CLI_ST_PRINT_DYNERR) {
Willy Tarreau1c0715b2022-05-06 17:16:35 +02001194 struct cli_print_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1195
1196 ha_free(&ctx->err);
William Lallemand74c24fb2016-11-21 17:18:36 +01001197 }
Amaury Denoyelle24e99612022-11-10 14:24:51 +01001198 else if (appctx->st0 == CLI_ST_PRINT_UMSG || appctx->st0 == CLI_ST_PRINT_UMSGERR) {
1199 usermsgs_clr(NULL);
1200 }
William Lallemand74c24fb2016-11-21 17:18:36 +01001201}
1202
1203/* This function dumps all environmnent variables to the buffer. It returns 0
1204 * if the output buffer is full and it needs to be called again, otherwise
Willy Tarreau307dbb32022-05-05 17:45:52 +02001205 * non-zero. It takes its context from the show_env_ctx in svcctx, and will
1206 * start from ->var and dump only one variable if ->show_one is set.
William Lallemand74c24fb2016-11-21 17:18:36 +01001207 */
Willy Tarreau0a739292016-11-22 20:21:23 +01001208static int cli_io_handler_show_env(struct appctx *appctx)
William Lallemand74c24fb2016-11-21 17:18:36 +01001209{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001210 struct show_env_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001211 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau307dbb32022-05-05 17:45:52 +02001212 char **var = ctx->var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001213
Christopher Faulet87633c32023-04-03 18:32:50 +02001214 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001215 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
William Lallemand74c24fb2016-11-21 17:18:36 +01001216 return 1;
1217
1218 chunk_reset(&trash);
1219
1220 /* we have two inner loops here, one for the proxy, the other one for
1221 * the buffer.
1222 */
Willy Tarreauf6710f82016-12-16 17:45:44 +01001223 while (*var) {
1224 chunk_printf(&trash, "%s\n", *var);
William Lallemand74c24fb2016-11-21 17:18:36 +01001225
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001226 if (applet_putchk(appctx, &trash) == -1)
William Lallemand74c24fb2016-11-21 17:18:36 +01001227 return 0;
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001228
Willy Tarreau307dbb32022-05-05 17:45:52 +02001229 if (ctx->show_one)
William Lallemand74c24fb2016-11-21 17:18:36 +01001230 break;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001231 var++;
Willy Tarreau307dbb32022-05-05 17:45:52 +02001232 ctx->var = var;
William Lallemand74c24fb2016-11-21 17:18:36 +01001233 }
1234
1235 /* dump complete */
1236 return 1;
1237}
1238
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001239/* This function dumps all file descriptors states (or the requested one) to
1240 * the buffer. It returns 0 if the output buffer is full and it needs to be
Willy Tarreau741a5a92022-05-05 17:56:58 +02001241 * called again, otherwise non-zero. It takes its context from the show_fd_ctx
1242 * in svcctx, only dumps one entry if ->show_one is non-zero, and (re)starts
1243 * from ->fd.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001244 */
1245static int cli_io_handler_show_fd(struct appctx *appctx)
1246{
Willy Tarreauc12b3212022-05-27 11:08:15 +02001247 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau741a5a92022-05-05 17:56:58 +02001248 struct show_fd_ctx *fdctx = appctx->svcctx;
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001249 uint match = fdctx->show_mask;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001250 int fd = fdctx->fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001251 int ret = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001252
Christopher Faulet87633c32023-04-03 18:32:50 +02001253 /* FIXME: Don't watch the other side !*/
Christopher Faulet208c7122023-04-13 16:16:15 +02001254 if (unlikely(sc_opposite(sc)->flags & SC_FL_SHUT_DONE))
Willy Tarreauca1b1572018-12-18 15:45:11 +01001255 goto end;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001256
1257 chunk_reset(&trash);
1258
Willy Tarreauca1b1572018-12-18 15:45:11 +01001259 /* isolate the threads once per round. We're limited to a buffer worth
1260 * of output anyway, it cannot last very long.
1261 */
1262 thread_isolate();
1263
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001264 /* we have two inner loops here, one for the proxy, the other one for
1265 * the buffer.
1266 */
Aurélien Nephtali498a1152018-03-09 18:51:16 +01001267 while (fd >= 0 && fd < global.maxsock) {
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001268 struct fdtab fdt;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001269 const struct listener *li = NULL;
1270 const struct server *sv = NULL;
1271 const struct proxy *px = NULL;
1272 const struct connection *conn = NULL;
Willy Tarreaua833cd92018-03-29 13:19:37 +02001273 const struct mux_ops *mux = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001274 const struct xprt_ops *xprt = NULL;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001275 const void *ctx = NULL;
Willy Tarreau37be9532021-01-20 14:40:04 +01001276 const void *xprt_ctx = NULL;
Willy Tarreau286ec682017-08-09 16:35:44 +02001277 uint32_t conn_flags = 0;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001278 uint8_t conn_err = 0;
Willy Tarreaue9ca8072018-12-19 18:40:58 +01001279 int is_back = 0;
Willy Tarreau8050efe2021-01-21 08:26:06 +01001280 int suspicious = 0;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001281
1282 fdt = fdtab[fd];
1283
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001284 /* When DEBUG_FD is set, we also report closed FDs that have a
1285 * non-null event count to detect stuck ones.
1286 */
Willy Tarreau13c1a012020-06-29 14:23:31 +02001287 if (!fdt.owner) {
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001288#ifdef DEBUG_FD
Willy Tarreau13c1a012020-06-29 14:23:31 +02001289 if (!fdt.event_count)
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001290#endif
Willy Tarreau13c1a012020-06-29 14:23:31 +02001291 goto skip; // closed
1292 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001293 else if (fdt.iocb == sock_conn_iocb) {
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001294 conn = (const struct connection *)fdt.owner;
1295 conn_flags = conn->flags;
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001296 conn_err = conn->err_code;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001297 mux = conn->mux;
1298 ctx = conn->ctx;
Willy Tarreau37be9532021-01-20 14:40:04 +01001299 xprt = conn->xprt;
1300 xprt_ctx = conn->xprt_ctx;
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001301 li = objt_listener(conn->target);
1302 sv = objt_server(conn->target);
1303 px = objt_proxy(conn->target);
1304 is_back = conn_is_back(conn);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001305 if (atleast2(fdt.thread_mask))
1306 suspicious = 1;
1307 if (conn->handle.fd != fd)
1308 suspicious = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001309 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001310 else if (fdt.iocb == sock_accept_iocb)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001311 li = fdt.owner;
1312
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001313 if (!((conn &&
1314 ((match & CLI_SHOWFD_F_SV && sv) ||
1315 (match & CLI_SHOWFD_F_PX && px) ||
1316 (match & CLI_SHOWFD_F_FE && li))) ||
1317 (!conn &&
1318 ((match & CLI_SHOWFD_F_LI && li) ||
1319 (match & CLI_SHOWFD_F_PI && !li /* only pipes match this */))))) {
1320 /* not a desired type */
1321 goto skip;
1322 }
1323
Willy Tarreaudacfde42021-01-21 09:07:29 +01001324 if (!fdt.thread_mask)
1325 suspicious = 1;
1326
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001327 chunk_printf(&trash,
Willy Tarreau677c0062023-03-02 15:05:31 +01001328 " %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 +02001329 fd,
1330 fdt.state,
Willy Tarreau184b2122021-04-07 08:48:12 +02001331 (fdt.state & FD_CLONED) ? 'C' : 'c',
1332 (fdt.state & FD_LINGER_RISK) ? 'L' : 'l',
Willy Tarreauf5090652021-04-06 17:23:40 +02001333 (fdt.state & FD_POLL_HUP) ? 'H' : 'h',
1334 (fdt.state & FD_POLL_ERR) ? 'E' : 'e',
1335 (fdt.state & FD_POLL_OUT) ? 'O' : 'o',
1336 (fdt.state & FD_POLL_PRI) ? 'P' : 'p',
1337 (fdt.state & FD_POLL_IN) ? 'I' : 'i',
Willy Tarreau184b2122021-04-07 08:48:12 +02001338 (fdt.state & FD_EV_SHUT_W) ? 'S' : 's',
1339 (fdt.state & FD_EV_READY_W) ? 'R' : 'r',
1340 (fdt.state & FD_EV_ACTIVE_W) ? 'A' : 'a',
1341 (fdt.state & FD_EV_SHUT_R) ? 'S' : 's',
1342 (fdt.state & FD_EV_READY_R) ? 'R' : 'r',
1343 (fdt.state & FD_EV_ACTIVE_R) ? 'A' : 'a',
Willy Tarreauc2431822022-07-08 10:23:01 +02001344 (fdt.refc_tgid >> 4) & 0xffff,
1345 (fdt.refc_tgid) & 0xffff,
Willy Tarreauc754b342018-03-30 15:00:15 +02001346 fdt.thread_mask, fdt.update_mask,
Willy Tarreau677c0062023-03-02 15:05:31 +01001347 polled_mask[fd].poll_recv,
1348 polled_mask[fd].poll_send,
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001349 fdt.owner,
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001350 fdt.iocb);
1351 resolve_sym_name(&trash, NULL, fdt.iocb);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001352
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001353 if (!fdt.owner) {
1354 chunk_appendf(&trash, ")");
1355 }
Willy Tarreau586f71b2020-12-11 15:54:36 +01001356 else if (fdt.iocb == sock_conn_iocb) {
Christopher Fauletd52f2ad2023-03-14 15:48:06 +01001357 chunk_appendf(&trash, ") back=%d cflg=0x%08x cerr=%d", is_back, conn_flags, conn_err);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001358
1359 if (conn->handle.fd != fd) {
1360 chunk_appendf(&trash, " fd=%d(BOGUS)", conn->handle.fd);
1361 suspicious = 1;
Willy Tarreaued989202021-02-05 10:54:52 +01001362 } else {
1363 struct sockaddr_storage sa;
1364 socklen_t salen;
1365
1366 salen = sizeof(sa);
1367 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1368 if (sa.ss_family == AF_INET)
1369 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1370 else if (sa.ss_family == AF_INET6)
1371 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1372 else if (sa.ss_family == AF_UNIX)
1373 chunk_appendf(&trash, " fam=unix");
1374 }
1375
1376 salen = sizeof(sa);
1377 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1378 if (sa.ss_family == AF_INET)
1379 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1380 else if (sa.ss_family == AF_INET6)
1381 chunk_appendf(&trash, " rport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1382 }
Willy Tarreaudacfde42021-01-21 09:07:29 +01001383 }
1384
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001385 if (px)
1386 chunk_appendf(&trash, " px=%s", px->id);
1387 else if (sv)
Willy Tarreaudfb34a82021-07-06 11:41:10 +02001388 chunk_appendf(&trash, " sv=%s/%s", sv->proxy->id, sv->id);
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001389 else if (li)
1390 chunk_appendf(&trash, " fe=%s", li->bind_conf->frontend->id);
Willy Tarreau35b1b482018-03-28 18:41:30 +02001391
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001392 if (mux) {
Willy Tarreau3d2ee552018-12-19 14:12:10 +01001393 chunk_appendf(&trash, " mux=%s ctx=%p", mux->name, ctx);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001394 if (!ctx)
1395 suspicious = 1;
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001396 if (mux->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001397 suspicious |= mux->show_fd(&trash, fdt.owner);
Willy Tarreaub011d8f2018-03-30 14:41:19 +02001398 }
Willy Tarreau35b1b482018-03-28 18:41:30 +02001399 else
1400 chunk_appendf(&trash, " nomux");
Willy Tarreau37be9532021-01-20 14:40:04 +01001401
1402 chunk_appendf(&trash, " xprt=%s", xprt ? xprt->name : "");
Willy Tarreau108a2712021-01-20 15:30:56 +01001403 if (xprt) {
1404 if (xprt_ctx || xprt->show_fd)
1405 chunk_appendf(&trash, " xprt_ctx=%p", xprt_ctx);
1406 if (xprt->show_fd)
Willy Tarreau8050efe2021-01-21 08:26:06 +01001407 suspicious |= xprt->show_fd(&trash, conn, xprt_ctx);
Willy Tarreau108a2712021-01-20 15:30:56 +01001408 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001409 }
Willy Tarreaua74cb382020-10-15 21:29:49 +02001410 else if (fdt.iocb == sock_accept_iocb) {
Willy Tarreaued989202021-02-05 10:54:52 +01001411 struct sockaddr_storage sa;
1412 socklen_t salen;
1413
Willy Tarreaucf12f2e2020-03-03 17:29:58 +01001414 chunk_appendf(&trash, ") l.st=%s fe=%s",
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001415 listener_state_str(li),
1416 li->bind_conf->frontend->id);
Willy Tarreaued989202021-02-05 10:54:52 +01001417
1418 salen = sizeof(sa);
1419 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1420 if (sa.ss_family == AF_INET)
1421 chunk_appendf(&trash, " fam=ipv4 lport=%d", ntohs(((const struct sockaddr_in *)&sa)->sin_port));
1422 else if (sa.ss_family == AF_INET6)
1423 chunk_appendf(&trash, " fam=ipv6 lport=%d", ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port));
1424 else if (sa.ss_family == AF_UNIX)
1425 chunk_appendf(&trash, " fam=unix");
1426 }
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001427 }
Willy Tarreaueb0595d2021-01-20 14:13:46 +01001428 else
1429 chunk_appendf(&trash, ")");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001430
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001431#ifdef DEBUG_FD
1432 chunk_appendf(&trash, " evcnt=%u", fdtab[fd].event_count);
Willy Tarreaudacfde42021-01-21 09:07:29 +01001433 if (fdtab[fd].event_count >= 1000000)
1434 suspicious = 1;
Willy Tarreau38e8a1c2020-06-23 10:04:54 +02001435#endif
Willy Tarreau8050efe2021-01-21 08:26:06 +01001436 chunk_appendf(&trash, "%s\n", suspicious ? " !" : "");
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001437
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001438 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001439 fdctx->fd = fd;
Willy Tarreauca1b1572018-12-18 15:45:11 +01001440 ret = 0;
1441 break;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001442 }
1443 skip:
Willy Tarreau741a5a92022-05-05 17:56:58 +02001444 if (fdctx->show_one)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001445 break;
1446
1447 fd++;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001448 }
1449
Willy Tarreauca1b1572018-12-18 15:45:11 +01001450 end:
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001451 /* dump complete */
Willy Tarreauca1b1572018-12-18 15:45:11 +01001452
1453 thread_release();
1454 return ret;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001455}
1456
William Lallemandeceddf72016-12-15 18:06:44 +01001457/*
Willy Tarreau3af9d832016-12-16 12:58:09 +01001458 * CLI IO handler for `show cli sockets`.
Willy Tarreaub128f492022-05-05 19:11:05 +02001459 * Uses the svcctx as a show_sock_ctx to store/retrieve the bind_conf and the
1460 * listener pointers.
William Lallemandeceddf72016-12-15 18:06:44 +01001461 */
1462static int cli_io_handler_show_cli_sock(struct appctx *appctx)
1463{
Willy Tarreaub128f492022-05-05 19:11:05 +02001464 struct show_sock_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1465 struct bind_conf *bind_conf = ctx->bind_conf;
William Lallemandeceddf72016-12-15 18:06:44 +01001466
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001467 if (!global.cli_fe)
1468 goto done;
William Lallemandeceddf72016-12-15 18:06:44 +01001469
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001470 chunk_reset(&trash);
William Lallemandeceddf72016-12-15 18:06:44 +01001471
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001472 if (!bind_conf) {
1473 /* first call */
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001474 if (applet_putstr(appctx, "# socket lvl processes\n") == -1)
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001475 goto full;
1476 bind_conf = LIST_ELEM(global.cli_fe->conf.bind.n, typeof(bind_conf), by_fe);
1477 }
William Lallemandeceddf72016-12-15 18:06:44 +01001478
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001479 list_for_each_entry_from(bind_conf, &global.cli_fe->conf.bind, by_fe) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001480 struct listener *l = ctx->listener;
William Lallemandeceddf72016-12-15 18:06:44 +01001481
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001482 if (!l)
1483 l = LIST_ELEM(bind_conf->listeners.n, typeof(l), by_bind);
William Lallemandeceddf72016-12-15 18:06:44 +01001484
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001485 list_for_each_entry_from(l, &bind_conf->listeners, by_bind) {
1486 char addr[46];
1487 char port[6];
William Lallemandeceddf72016-12-15 18:06:44 +01001488
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001489 if (l->rx.addr.ss_family == AF_UNIX) {
1490 const struct sockaddr_un *un;
William Lallemandeceddf72016-12-15 18:06:44 +01001491
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001492 un = (struct sockaddr_un *)&l->rx.addr;
1493 if (un->sun_path[0] == '\0') {
1494 chunk_appendf(&trash, "abns@%s ", un->sun_path+1);
1495 } else {
1496 chunk_appendf(&trash, "unix@%s ", un->sun_path);
1497 }
1498 } else if (l->rx.addr.ss_family == AF_INET) {
1499 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1500 port_to_str(&l->rx.addr, port, sizeof(port));
1501 chunk_appendf(&trash, "ipv4@%s:%s ", addr, port);
1502 } else if (l->rx.addr.ss_family == AF_INET6) {
1503 addr_to_str(&l->rx.addr, addr, sizeof(addr));
1504 port_to_str(&l->rx.addr, port, sizeof(port));
1505 chunk_appendf(&trash, "ipv6@[%s]:%s ", addr, port);
1506 } else if (l->rx.addr.ss_family == AF_CUST_SOCKPAIR) {
1507 chunk_appendf(&trash, "sockpair@%d ", ((struct sockaddr_in *)&l->rx.addr)->sin_addr.s_addr);
1508 } else
1509 chunk_appendf(&trash, "unknown ");
William Lallemandeceddf72016-12-15 18:06:44 +01001510
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001511 if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
1512 chunk_appendf(&trash, "admin ");
1513 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
1514 chunk_appendf(&trash, "operator ");
1515 else if ((bind_conf->level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
1516 chunk_appendf(&trash, "user ");
1517 else
1518 chunk_appendf(&trash, " ");
William Lallemandeceddf72016-12-15 18:06:44 +01001519
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001520 chunk_appendf(&trash, "all\n");
William Lallemandeceddf72016-12-15 18:06:44 +01001521
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001522 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaub128f492022-05-05 19:11:05 +02001523 ctx->bind_conf = bind_conf;
1524 ctx->listener = l;
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001525 goto full;
William Lallemandeceddf72016-12-15 18:06:44 +01001526 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001527 }
William Lallemandeceddf72016-12-15 18:06:44 +01001528 }
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001529 done:
1530 return 1;
1531 full:
Willy Tarreau4df54eb2022-05-05 18:52:36 +02001532 return 0;
William Lallemandeceddf72016-12-15 18:06:44 +01001533}
1534
Willy Tarreau9a7fa902022-07-15 16:51:16 +02001535
Willy Tarreau0a739292016-11-22 20:21:23 +01001536/* parse a "show env" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau307dbb32022-05-05 17:45:52 +02001537 * wants to stop here. It reserves a sohw_env_ctx where it puts the variable to
1538 * be dumped as well as a flag if a single variable is requested, otherwise puts
1539 * environ there.
Willy Tarreau0a739292016-11-22 20:21:23 +01001540 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001541static int cli_parse_show_env(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau0a739292016-11-22 20:21:23 +01001542{
Willy Tarreau307dbb32022-05-05 17:45:52 +02001543 struct show_env_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau0a739292016-11-22 20:21:23 +01001544 extern char **environ;
Willy Tarreauf6710f82016-12-16 17:45:44 +01001545 char **var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001546
1547 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1548 return 1;
1549
Willy Tarreauf6710f82016-12-16 17:45:44 +01001550 var = environ;
Willy Tarreau0a739292016-11-22 20:21:23 +01001551
1552 if (*args[2]) {
1553 int len = strlen(args[2]);
1554
Willy Tarreauf6710f82016-12-16 17:45:44 +01001555 for (; *var; var++) {
1556 if (strncmp(*var, args[2], len) == 0 &&
1557 (*var)[len] == '=')
Willy Tarreau0a739292016-11-22 20:21:23 +01001558 break;
1559 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001560 if (!*var)
1561 return cli_err(appctx, "Variable not found\n");
1562
Willy Tarreau307dbb32022-05-05 17:45:52 +02001563 ctx->show_one = 1;
Willy Tarreau0a739292016-11-22 20:21:23 +01001564 }
Willy Tarreau307dbb32022-05-05 17:45:52 +02001565 ctx->var = var;
Willy Tarreau0a739292016-11-22 20:21:23 +01001566 return 0;
1567}
1568
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001569/* parse a "show fd" CLI request. Returns 0 if it needs to continue, 1 if it
Willy Tarreau741a5a92022-05-05 17:56:58 +02001570 * wants to stop here. It sets a show_fd_ctx context where, if a specific fd is
1571 * requested, it puts the FD number into ->fd and sets ->show_one to 1.
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001572 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001573static int cli_parse_show_fd(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001574{
Willy Tarreau741a5a92022-05-05 17:56:58 +02001575 struct show_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001576 const char *c;
1577 int arg;
Willy Tarreau741a5a92022-05-05 17:56:58 +02001578
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001579 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1580 return 1;
1581
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001582 arg = 2;
1583
1584 /* when starting with an inversion we preset every flag */
1585 if (*args[arg] == '!' || *args[arg] == '-')
1586 ctx->show_mask = CLI_SHOWFD_F_ANY;
1587
1588 while (*args[arg] && !isdigit((uchar)*args[arg])) {
1589 uint flag = 0, inv = 0;
1590 c = args[arg];
1591 while (*c) {
1592 switch (*c) {
1593 case '!': inv = !inv; break;
1594 case '-': inv = !inv; break;
1595 case 'p': flag = CLI_SHOWFD_F_PI; break;
1596 case 'l': flag = CLI_SHOWFD_F_LI; break;
1597 case 'c': flag = CLI_SHOWFD_F_CO; break;
1598 case 'f': flag = CLI_SHOWFD_F_FE; break;
1599 case 'b': flag = CLI_SHOWFD_F_BE; break;
1600 case 's': flag = CLI_SHOWFD_F_SV; break;
1601 case 'd': flag = CLI_SHOWFD_F_PX; break;
1602 default: return cli_err(appctx, "Invalid FD type\n");
1603 }
1604 c++;
1605 if (!inv)
1606 ctx->show_mask |= flag;
1607 else
1608 ctx->show_mask &= ~flag;
1609 }
1610 arg++;
1611 }
1612
1613 /* default mask is to show everything */
1614 if (!ctx->show_mask)
1615 ctx->show_mask = CLI_SHOWFD_F_ANY;
1616
1617 if (*args[arg]) {
Willy Tarreau741a5a92022-05-05 17:56:58 +02001618 ctx->fd = atoi(args[2]);
1619 ctx->show_one = 1;
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001620 }
Willy Tarreau1cb041a2023-03-31 16:33:53 +02001621
Willy Tarreau7a4a0ac2017-07-25 19:32:50 +02001622 return 0;
1623}
1624
Willy Tarreau599852e2016-11-22 20:33:32 +01001625/* parse a "set timeout" CLI request. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001626static int cli_parse_set_timeout(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau599852e2016-11-22 20:33:32 +01001627{
Willy Tarreau0698c802022-05-11 14:09:57 +02001628 struct stream *s = appctx_strm(appctx);
Willy Tarreau599852e2016-11-22 20:33:32 +01001629
1630 if (strcmp(args[2], "cli") == 0) {
1631 unsigned timeout;
1632 const char *res;
1633
Willy Tarreau9d008692019-08-09 11:21:01 +02001634 if (!*args[3])
1635 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001636
1637 res = parse_time_err(args[3], &timeout, TIME_UNIT_S);
Willy Tarreau9d008692019-08-09 11:21:01 +02001638 if (res || timeout < 1)
1639 return cli_err(appctx, "Invalid timeout value.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001640
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01001641 s->scf->ioto = 1 + MS_TO_TICKS(timeout*1000);
Willy Tarreau599852e2016-11-22 20:33:32 +01001642 task_wakeup(s->task, TASK_WOKEN_MSG); // recompute timeouts
1643 return 1;
1644 }
Willy Tarreau9d008692019-08-09 11:21:01 +02001645
1646 return cli_err(appctx, "'set timeout' only supports 'cli'.\n");
Willy Tarreau599852e2016-11-22 20:33:32 +01001647}
1648
Willy Tarreau2af99412016-11-23 11:10:59 +01001649/* parse a "set maxconn global" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001650static int cli_parse_set_maxconn_global(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau2af99412016-11-23 11:10:59 +01001651{
1652 int v;
1653
1654 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1655 return 1;
1656
Willy Tarreau9d008692019-08-09 11:21:01 +02001657 if (!*args[3])
1658 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001659
1660 v = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001661 if (v > global.hardmaxconn)
1662 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau2af99412016-11-23 11:10:59 +01001663
1664 /* check for unlimited values */
1665 if (v <= 0)
1666 v = global.hardmaxconn;
1667
1668 global.maxconn = v;
1669
1670 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001671 dequeue_all_listeners();
Willy Tarreau2af99412016-11-23 11:10:59 +01001672
1673 return 1;
1674}
1675
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001676static int set_severity_output(int *target, char *argument)
1677{
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001678 if (strcmp(argument, "none") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001679 *target = CLI_SEVERITY_NONE;
1680 return 1;
1681 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001682 else if (strcmp(argument, "number") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001683 *target = CLI_SEVERITY_NUMBER;
1684 return 1;
1685 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001686 else if (strcmp(argument, "string") == 0) {
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001687 *target = CLI_SEVERITY_STRING;
1688 return 1;
1689 }
1690 return 0;
1691}
1692
1693/* parse a "set severity-output" command. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001694static int cli_parse_set_severity_output(char **args, char *payload, struct appctx *appctx, void *private)
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001695{
1696 if (*args[2] && set_severity_output(&appctx->cli_severity_output, args[2]))
1697 return 0;
1698
Willy Tarreau9d008692019-08-09 11:21:01 +02001699 return cli_err(appctx, "one of 'none', 'number', 'string' is a required argument\n");
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001700}
William Lallemandeceddf72016-12-15 18:06:44 +01001701
William Lallemand67a234f2018-12-13 09:05:45 +01001702
1703/* show the level of the current CLI session */
1704static int cli_parse_show_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1705{
William Lallemand67a234f2018-12-13 09:05:45 +01001706 if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_ADMIN)
Willy Tarreau9d008692019-08-09 11:21:01 +02001707 return cli_msg(appctx, LOG_INFO, "admin\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001708 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_OPER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001709 return cli_msg(appctx, LOG_INFO, "operator\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001710 else if ((appctx->cli_level & ACCESS_LVL_MASK) == ACCESS_LVL_USER)
Willy Tarreau9d008692019-08-09 11:21:01 +02001711 return cli_msg(appctx, LOG_INFO, "user\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001712 else
Willy Tarreau9d008692019-08-09 11:21:01 +02001713 return cli_msg(appctx, LOG_INFO, "unknown\n");
William Lallemand67a234f2018-12-13 09:05:45 +01001714}
1715
1716/* parse and set the CLI level dynamically */
1717static int cli_parse_set_lvl(char **args, char *payload, struct appctx *appctx, void *private)
1718{
William Lallemandad032882019-07-01 10:56:15 +02001719 /* this will ask the applet to not output a \n after the command */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001720 if (strcmp(args[1], "-") == 0)
William Lallemandad032882019-07-01 10:56:15 +02001721 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1722
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001723 if (strcmp(args[0], "operator") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001724 if (!cli_has_level(appctx, ACCESS_LVL_OPER)) {
1725 return 1;
1726 }
1727 appctx->cli_level &= ~ACCESS_LVL_MASK;
1728 appctx->cli_level |= ACCESS_LVL_OPER;
1729
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001730 } else if (strcmp(args[0], "user") == 0) {
William Lallemand67a234f2018-12-13 09:05:45 +01001731 if (!cli_has_level(appctx, ACCESS_LVL_USER)) {
1732 return 1;
1733 }
1734 appctx->cli_level &= ~ACCESS_LVL_MASK;
1735 appctx->cli_level |= ACCESS_LVL_USER;
1736 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001737 appctx->cli_level &= ~(ACCESS_EXPERT|ACCESS_EXPERIMENTAL);
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001738 return 1;
1739}
1740
1741
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001742/* parse and set the CLI expert/experimental-mode dynamically */
1743static int cli_parse_expert_experimental_mode(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001744{
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001745 int level;
1746 char *level_str;
1747 char *output = NULL;
1748
William Lallemand7267f782022-02-01 16:08:50 +01001749 /* this will ask the applet to not output a \n after the command */
1750 if (*args[1] && *args[2] && strcmp(args[2], "-") == 0)
1751 appctx->st1 |= APPCTX_CLI_ST1_NOLF;
1752
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001753 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1754 return 1;
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001755
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001756 if (strcmp(args[0], "expert-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001757 level = ACCESS_EXPERT;
1758 level_str = "expert-mode";
1759 }
Tim Duesterhusc5aa1132021-10-16 17:48:15 +02001760 else if (strcmp(args[0], "experimental-mode") == 0) {
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001761 level = ACCESS_EXPERIMENTAL;
1762 level_str = "experimental-mode";
1763 }
William Lallemand2a171912022-02-02 11:43:20 +01001764 else if (strcmp(args[0], "mcli-debug-mode") == 0) {
1765 level = ACCESS_MCLI_DEBUG;
1766 level_str = "mcli-debug-mode";
1767 }
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001768 else {
1769 return 1;
1770 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001771
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001772 if (!*args[1]) {
1773 memprintf(&output, "%s is %s\n", level_str,
1774 (appctx->cli_level & level) ? "ON" : "OFF");
1775 return cli_dynmsg(appctx, LOG_INFO, output);
1776 }
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001777
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001778 appctx->cli_level &= ~level;
Willy Tarreauabb9f9b2019-10-24 17:55:53 +02001779 if (strcmp(args[1], "on") == 0)
Amaury Denoyelle18487fb2021-03-18 15:32:53 +01001780 appctx->cli_level |= level;
William Lallemand67a234f2018-12-13 09:05:45 +01001781 return 1;
1782}
1783
William Lallemand740629e2021-12-14 15:22:29 +01001784/* shows HAProxy version */
1785static int cli_parse_show_version(char **args, char *payload, struct appctx *appctx, void *private)
1786{
1787 char *msg = NULL;
1788
1789 return cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", haproxy_version));
1790}
1791
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001792int cli_parse_default(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemandeceddf72016-12-15 18:06:44 +01001793{
1794 return 0;
1795}
1796
Erwan Le Goas54966df2022-09-14 17:24:22 +02001797/* enable or disable the anonymized mode, it returns 1 when it works or displays an error message if it doesn't. */
1798static int cli_parse_set_anon(char **args, char *payload, struct appctx *appctx, void *private)
1799{
1800 uint32_t tmp;
1801 long long key;
1802
1803 if (strcmp(args[2], "on") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001804
1805 if (*args[3]) {
1806 key = atoll(args[3]);
1807 if (key < 1 || key > UINT_MAX)
1808 return cli_err(appctx, "Value out of range (1 to 4294967295 expected).\n");
1809 appctx->cli_anon_key = key;
1810 }
Erwan Le Goas54966df2022-09-14 17:24:22 +02001811 else {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001812 tmp = HA_ATOMIC_LOAD(&global.anon_key);
1813 if (tmp != 0)
1814 appctx->cli_anon_key = tmp;
1815 else
1816 appctx->cli_anon_key = ha_random32();
Erwan Le Goas54966df2022-09-14 17:24:22 +02001817 }
1818 }
1819 else if (strcmp(args[2], "off") == 0) {
Erwan Le Goas3f4ae612022-09-28 17:04:29 +02001820
1821 if (*args[3]) {
Erwan Le Goas54966df2022-09-14 17:24:22 +02001822 return cli_err(appctx, "Key can't be added while disabling anonymized mode\n");
1823 }
1824 else {
1825 appctx->cli_anon_key = 0;
1826 }
1827 }
1828 else {
1829 return cli_err(appctx,
1830 "'set anon' only supports :\n"
1831 " - 'on' [key] to enable the anonymized mode\n"
1832 " - 'off' to disable the anonymized mode");
1833 }
1834 return 1;
1835}
1836
Erwan Le Goasfad9da82022-09-14 17:24:22 +02001837/* This function set the global anonyzing key, restricted to level 'admin' */
1838static int cli_parse_set_global_key(char **args, char *payload, struct appctx *appctx, void *private)
1839{
1840 long long key;
1841
1842 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1843 return cli_err(appctx, "Permission denied\n");
1844 if (!*args[2])
1845 return cli_err(appctx, "Expects an integer value.\n");
1846
1847 key = atoll(args[2]);
1848 if (key < 0 || key > UINT_MAX)
1849 return cli_err(appctx, "Value out of range (0 to 4294967295 expected).\n");
1850
1851 HA_ATOMIC_STORE(&global.anon_key, key);
1852 return 1;
1853}
1854
Erwan Le Goas54966df2022-09-14 17:24:22 +02001855/* shows the anonymized mode state to everyone, and the key except for users, it always returns 1. */
1856static int cli_parse_show_anon(char **args, char *payload, struct appctx *appctx, void *private)
1857{
1858 char *msg = NULL;
1859 char *anon_mode = NULL;
1860 uint32_t c_key = appctx->cli_anon_key;
1861
1862 if (!c_key)
1863 anon_mode = "Anonymized mode disabled";
1864 else
1865 anon_mode = "Anonymized mode enabled";
1866
1867 if ( !((appctx->cli_level & ACCESS_LVL_MASK) < ACCESS_LVL_OPER) && c_key != 0) {
1868 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\nKey : %u\n", anon_mode, c_key));
1869 }
1870 else {
1871 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", anon_mode));
1872 }
1873
1874 return 1;
1875}
1876
Willy Tarreau45c742b2016-11-24 14:51:17 +01001877/* parse a "set rate-limit" command. It always returns 1. */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001878static int cli_parse_set_ratelimit(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau45c742b2016-11-24 14:51:17 +01001879{
1880 int v;
1881 int *res;
1882 int mul = 1;
1883
1884 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1885 return 1;
1886
1887 if (strcmp(args[2], "connections") == 0 && strcmp(args[3], "global") == 0)
1888 res = &global.cps_lim;
1889 else if (strcmp(args[2], "sessions") == 0 && strcmp(args[3], "global") == 0)
1890 res = &global.sps_lim;
1891#ifdef USE_OPENSSL
1892 else if (strcmp(args[2], "ssl-sessions") == 0 && strcmp(args[3], "global") == 0)
1893 res = &global.ssl_lim;
1894#endif
1895 else if (strcmp(args[2], "http-compression") == 0 && strcmp(args[3], "global") == 0) {
1896 res = &global.comp_rate_lim;
1897 mul = 1024;
1898 }
1899 else {
Willy Tarreau9d008692019-08-09 11:21:01 +02001900 return cli_err(appctx,
Willy Tarreau45c742b2016-11-24 14:51:17 +01001901 "'set rate-limit' only supports :\n"
1902 " - 'connections global' to set the per-process maximum connection rate\n"
1903 " - 'sessions global' to set the per-process maximum session rate\n"
1904#ifdef USE_OPENSSL
Aurélien Nephtalib53e2082018-03-11 16:55:02 +01001905 " - 'ssl-sessions global' to set the per-process maximum SSL session rate\n"
Willy Tarreau45c742b2016-11-24 14:51:17 +01001906#endif
Willy Tarreau9d008692019-08-09 11:21:01 +02001907 " - 'http-compression global' to set the per-process maximum compression speed in kB/s\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001908 }
1909
Willy Tarreau9d008692019-08-09 11:21:01 +02001910 if (!*args[4])
1911 return cli_err(appctx, "Expects an integer value.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001912
1913 v = atoi(args[4]);
Willy Tarreau9d008692019-08-09 11:21:01 +02001914 if (v < 0)
1915 return cli_err(appctx, "Value out of range.\n");
Willy Tarreau45c742b2016-11-24 14:51:17 +01001916
1917 *res = v * mul;
1918
1919 /* Dequeues all of the listeners waiting for a resource */
Willy Tarreau241797a2019-12-10 14:10:52 +01001920 dequeue_all_listeners();
Willy Tarreau45c742b2016-11-24 14:51:17 +01001921
1922 return 1;
1923}
1924
William Lallemandf6975e92017-05-26 17:42:10 +02001925/* parse the "expose-fd" argument on the bind lines */
1926static int bind_parse_expose_fd(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1927{
1928 if (!*args[cur_arg + 1]) {
1929 memprintf(err, "'%s' : missing fd type", args[cur_arg]);
1930 return ERR_ALERT | ERR_FATAL;
1931 }
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001932 if (strcmp(args[cur_arg + 1], "listeners") == 0) {
William Lallemandf6975e92017-05-26 17:42:10 +02001933 conf->level |= ACCESS_FD_LISTENERS;
1934 } else {
1935 memprintf(err, "'%s' only supports 'listeners' (got '%s')",
1936 args[cur_arg], args[cur_arg+1]);
1937 return ERR_ALERT | ERR_FATAL;
1938 }
1939
1940 return 0;
1941}
1942
William Lallemand74c24fb2016-11-21 17:18:36 +01001943/* parse the "level" argument on the bind lines */
1944static int bind_parse_level(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1945{
1946 if (!*args[cur_arg + 1]) {
1947 memprintf(err, "'%s' : missing level", args[cur_arg]);
1948 return ERR_ALERT | ERR_FATAL;
1949 }
1950
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001951 if (strcmp(args[cur_arg + 1], "user") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001952 conf->level &= ~ACCESS_LVL_MASK;
1953 conf->level |= ACCESS_LVL_USER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001954 } else if (strcmp(args[cur_arg + 1], "operator") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001955 conf->level &= ~ACCESS_LVL_MASK;
1956 conf->level |= ACCESS_LVL_OPER;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01001957 } else if (strcmp(args[cur_arg + 1], "admin") == 0) {
William Lallemand07a62f72017-05-24 00:57:40 +02001958 conf->level &= ~ACCESS_LVL_MASK;
1959 conf->level |= ACCESS_LVL_ADMIN;
1960 } else {
William Lallemand74c24fb2016-11-21 17:18:36 +01001961 memprintf(err, "'%s' only supports 'user', 'operator', and 'admin' (got '%s')",
1962 args[cur_arg], args[cur_arg+1]);
1963 return ERR_ALERT | ERR_FATAL;
1964 }
1965
1966 return 0;
1967}
1968
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02001969static int bind_parse_severity_output(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
1970{
1971 if (!*args[cur_arg + 1]) {
1972 memprintf(err, "'%s' : missing severity format", args[cur_arg]);
1973 return ERR_ALERT | ERR_FATAL;
1974 }
1975
1976 if (set_severity_output(&conf->severity_output, args[cur_arg+1]))
1977 return 0;
1978 else {
1979 memprintf(err, "'%s' only supports 'none', 'number', and 'string' (got '%s')",
1980 args[cur_arg], args[cur_arg+1]);
1981 return ERR_ALERT | ERR_FATAL;
1982 }
1983}
1984
Olivier Houchardf886e342017-04-05 22:24:59 +02001985/* Send all the bound sockets, always returns 1 */
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001986static int _getsocks(char **args, char *payload, struct appctx *appctx, void *private)
Olivier Houchardf886e342017-04-05 22:24:59 +02001987{
William Lallemandb5d062d2022-07-28 15:33:41 +02001988 static int already_sent = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02001989 char *cmsgbuf = NULL;
1990 unsigned char *tmpbuf = NULL;
1991 struct cmsghdr *cmsg;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001992 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau475e4632022-05-27 10:26:46 +02001993 struct stream *s = __sc_strm(sc);
1994 struct connection *remote = sc_conn(sc_opposite(sc));
Olivier Houchardf886e342017-04-05 22:24:59 +02001995 struct msghdr msghdr;
1996 struct iovec iov;
Olivier Houchard54740872017-04-06 14:45:14 +02001997 struct timeval tv = { .tv_sec = 1, .tv_usec = 0 };
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02001998 const char *ns_name, *if_name;
1999 unsigned char ns_nlen, if_nlen;
2000 int nb_queued;
2001 int cur_fd = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002002 int *tmpfd;
2003 int tot_fd_nb = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002004 int fd = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002005 int curoff = 0;
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002006 int old_fcntl = -1;
Olivier Houchardf886e342017-04-05 22:24:59 +02002007 int ret;
2008
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002009 if (!remote) {
2010 ha_warning("Only works on real connections\n");
2011 goto out;
2012 }
2013
2014 fd = remote->handle.fd;
2015
Olivier Houchardf886e342017-04-05 22:24:59 +02002016 /* Temporary set the FD in blocking mode, that will make our life easier */
2017 old_fcntl = fcntl(fd, F_GETFL);
2018 if (old_fcntl < 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002019 ha_warning("Couldn't get the flags for the unix socket\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002020 goto out;
2021 }
2022 cmsgbuf = malloc(CMSG_SPACE(sizeof(int) * MAX_SEND_FD));
2023 if (!cmsgbuf) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002024 ha_warning("Failed to allocate memory to send sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002025 goto out;
2026 }
2027 if (fcntl(fd, F_SETFL, old_fcntl &~ O_NONBLOCK) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002028 ha_warning("Cannot make the unix socket blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002029 goto out;
2030 }
Olivier Houchard54740872017-04-06 14:45:14 +02002031 setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (void *)&tv, sizeof(tv));
Olivier Houchardf886e342017-04-05 22:24:59 +02002032 iov.iov_base = &tot_fd_nb;
2033 iov.iov_len = sizeof(tot_fd_nb);
William Lallemandf6975e92017-05-26 17:42:10 +02002034 if (!(strm_li(s)->bind_conf->level & ACCESS_FD_LISTENERS))
Olivier Houchardf886e342017-04-05 22:24:59 +02002035 goto out;
2036 memset(&msghdr, 0, sizeof(msghdr));
2037 /*
2038 * First, calculates the total number of FD, so that we can let
Jackie Tapia749f74c2020-07-22 18:59:40 -05002039 * the caller know how much it should expect.
Olivier Houchardf886e342017-04-05 22:24:59 +02002040 */
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002041 for (cur_fd = 0;cur_fd < global.maxsock; cur_fd++)
Willy Tarreau9063a662021-04-06 18:09:06 +02002042 tot_fd_nb += !!(fdtab[cur_fd].state & FD_EXPORTED);
William Lallemand5fd3b282020-01-16 15:32:08 +01002043
William Lallemandb5d062d2022-07-28 15:33:41 +02002044 if (tot_fd_nb == 0) {
2045 if (already_sent)
2046 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 +02002047 goto out;
William Lallemandb5d062d2022-07-28 15:33:41 +02002048 }
Olivier Houchardf886e342017-04-05 22:24:59 +02002049
2050 /* First send the total number of file descriptors, so that the
2051 * receiving end knows what to expect.
2052 */
2053 msghdr.msg_iov = &iov;
2054 msghdr.msg_iovlen = 1;
2055 ret = sendmsg(fd, &msghdr, 0);
2056 if (ret != sizeof(tot_fd_nb)) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002057 ha_warning("Failed to send the number of sockets to send\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002058 goto out;
2059 }
2060
2061 /* Now send the fds */
2062 msghdr.msg_control = cmsgbuf;
2063 msghdr.msg_controllen = CMSG_SPACE(sizeof(int) * MAX_SEND_FD);
2064 cmsg = CMSG_FIRSTHDR(&msghdr);
2065 cmsg->cmsg_len = CMSG_LEN(MAX_SEND_FD * sizeof(int));
2066 cmsg->cmsg_level = SOL_SOCKET;
2067 cmsg->cmsg_type = SCM_RIGHTS;
2068 tmpfd = (int *)CMSG_DATA(cmsg);
2069
Olivier Houchardf886e342017-04-05 22:24:59 +02002070 /* For each socket, e message is sent, containing the following :
2071 * Size of the namespace name (or 0 if none), as an unsigned char.
2072 * The namespace name, if any
2073 * Size of the interface name (or 0 if none), as an unsigned char
2074 * The interface name, if any
Willy Tarreaucf1f1932020-08-26 10:30:09 +02002075 * 32 bits of zeroes (used to be listener options).
Olivier Houchardf886e342017-04-05 22:24:59 +02002076 */
2077 /* We will send sockets MAX_SEND_FD per MAX_SEND_FD, allocate a
Ilya Shipitsind4259502020-04-08 01:07:56 +05002078 * buffer big enough to store the socket information.
Olivier Houchardf886e342017-04-05 22:24:59 +02002079 */
Olivier Houchardf143b802017-11-04 15:13:01 +01002080 tmpbuf = malloc(MAX_SEND_FD * (1 + MAXPATHLEN + 1 + IFNAMSIZ + sizeof(int)));
Olivier Houchardf886e342017-04-05 22:24:59 +02002081 if (tmpbuf == NULL) {
Ilya Shipitsind4259502020-04-08 01:07:56 +05002082 ha_warning("Failed to allocate memory to transfer socket information\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002083 goto out;
2084 }
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002085
2086 nb_queued = 0;
Olivier Houchardf886e342017-04-05 22:24:59 +02002087 iov.iov_base = tmpbuf;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002088 for (cur_fd = 0; cur_fd < global.maxsock; cur_fd++) {
Willy Tarreau9063a662021-04-06 18:09:06 +02002089 if (!(fdtab[cur_fd].state & FD_EXPORTED))
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002090 continue;
2091
2092 ns_name = if_name = "";
2093 ns_nlen = if_nlen = 0;
2094
2095 /* for now we can only retrieve namespaces and interfaces from
2096 * pure listeners.
2097 */
Willy Tarreaua74cb382020-10-15 21:29:49 +02002098 if (fdtab[cur_fd].iocb == sock_accept_iocb) {
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002099 const struct listener *l = fdtab[cur_fd].owner;
2100
Willy Tarreau818a92e2020-09-03 07:50:19 +02002101 if (l->rx.settings->interface) {
2102 if_name = l->rx.settings->interface;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002103 if_nlen = strlen(if_name);
2104 }
2105
2106#ifdef USE_NS
Willy Tarreau818a92e2020-09-03 07:50:19 +02002107 if (l->rx.settings->netns) {
2108 ns_name = l->rx.settings->netns->node.key;
2109 ns_nlen = l->rx.settings->netns->name_len;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002110 }
2111#endif
2112 }
2113
2114 /* put the FD into the CMSG_DATA */
2115 tmpfd[nb_queued++] = cur_fd;
2116
2117 /* first block is <ns_name_len> <ns_name> */
2118 tmpbuf[curoff++] = ns_nlen;
2119 if (ns_nlen)
2120 memcpy(tmpbuf + curoff, ns_name, ns_nlen);
2121 curoff += ns_nlen;
2122
2123 /* second block is <if_name_len> <if_name> */
2124 tmpbuf[curoff++] = if_nlen;
2125 if (if_nlen)
2126 memcpy(tmpbuf + curoff, if_name, if_nlen);
2127 curoff += if_nlen;
2128
2129 /* we used to send the listener options here before 2.3 */
2130 memset(tmpbuf + curoff, 0, sizeof(int));
2131 curoff += sizeof(int);
2132
2133 /* there's a limit to how many FDs may be sent at once */
2134 if (nb_queued == MAX_SEND_FD) {
2135 iov.iov_len = curoff;
2136 if (sendmsg(fd, &msghdr, 0) != curoff) {
2137 ha_warning("Failed to transfer sockets\n");
2138 return -1;
2139 }
2140
2141 /* Wait for an ack */
2142 do {
2143 ret = recv(fd, &tot_fd_nb, sizeof(tot_fd_nb), 0);
2144 } while (ret == -1 && errno == EINTR);
2145
2146 if (ret <= 0) {
2147 ha_warning("Unexpected error while transferring sockets\n");
2148 return -1;
2149 }
2150 curoff = 0;
2151 nb_queued = 0;
2152 }
William Lallemand5fd3b282020-01-16 15:32:08 +01002153 }
2154
William Lallemandb5d062d2022-07-28 15:33:41 +02002155 already_sent = 1;
2156
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002157 /* flush pending stuff */
2158 if (nb_queued) {
Olivier Houchardf886e342017-04-05 22:24:59 +02002159 iov.iov_len = curoff;
Willy Tarreaub5a1f9e2020-08-19 17:03:55 +02002160 cmsg->cmsg_len = CMSG_LEN(nb_queued * sizeof(int));
2161 msghdr.msg_controllen = CMSG_SPACE(nb_queued * sizeof(int));
Olivier Houchardf886e342017-04-05 22:24:59 +02002162 if (sendmsg(fd, &msghdr, 0) != curoff) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002163 ha_warning("Failed to transfer sockets\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002164 goto out;
2165 }
2166 }
2167
2168out:
Willy Tarreauc2b7f802018-09-20 11:22:29 +02002169 if (fd >= 0 && old_fcntl >= 0 && fcntl(fd, F_SETFL, old_fcntl) == -1) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01002170 ha_warning("Cannot make the unix socket non-blocking\n");
Olivier Houchardf886e342017-04-05 22:24:59 +02002171 goto out;
2172 }
Christopher Faulet33af9962023-04-07 17:58:21 +02002173 se_fl_set(appctx->sedesc, SE_FL_EOI);
Olivier Houchardf886e342017-04-05 22:24:59 +02002174 appctx->st0 = CLI_ST_END;
2175 free(cmsgbuf);
2176 free(tmpbuf);
2177 return 1;
2178}
2179
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002180static int cli_parse_simple(char **args, char *payload, struct appctx *appctx, void *private)
2181{
2182 if (*args[0] == 'h')
2183 /* help */
Willy Tarreau0b1b8302021-05-09 20:59:23 +02002184 cli_gen_usage_msg(appctx, args);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002185 else if (*args[0] == 'p')
2186 /* prompt */
2187 appctx->st1 ^= APPCTX_CLI_ST1_PROMPT;
Christopher Faulet33af9962023-04-07 17:58:21 +02002188 else if (*args[0] == 'q') {
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002189 /* quit */
Christopher Faulet33af9962023-04-07 17:58:21 +02002190 se_fl_set(appctx->sedesc, SE_FL_EOI);
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002191 appctx->st0 = CLI_ST_END;
Christopher Faulet33af9962023-04-07 17:58:21 +02002192 }
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02002193
2194 return 1;
2195}
Olivier Houchardf886e342017-04-05 22:24:59 +02002196
William Lallemand2f4ce202018-10-26 14:47:47 +02002197void pcli_write_prompt(struct stream *s)
2198{
2199 struct buffer *msg = get_trash_chunk();
Willy Tarreau40a9c322022-05-18 15:55:18 +02002200 struct channel *oc = sc_oc(s->scf);
William Lallemand2f4ce202018-10-26 14:47:47 +02002201
William Lallemanddc12c2e2018-12-13 09:05:46 +01002202 if (!(s->pcli_flags & PCLI_F_PROMPT))
William Lallemand5b80fa22018-12-11 16:10:54 +01002203 return;
2204
William Lallemanddc12c2e2018-12-13 09:05:46 +01002205 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002206 chunk_appendf(msg, "+ ");
2207 } else {
2208 if (s->pcli_next_pid == 0)
William Lallemanddae12c72022-02-02 14:13:54 +01002209 chunk_appendf(msg, "master%s",
William Lallemand3ba7c7b2021-11-10 10:57:18 +01002210 (proc_self->failedreloads > 0) ? "[ReloadFailed]" : "");
William Lallemandebf61802018-12-11 16:10:57 +01002211 else
William Lallemanddae12c72022-02-02 14:13:54 +01002212 chunk_appendf(msg, "%d", s->pcli_next_pid);
2213
2214 if (s->pcli_flags & (ACCESS_EXPERIMENTAL|ACCESS_EXPERT|ACCESS_MCLI_DEBUG)) {
2215 chunk_appendf(msg, "(");
2216
2217 if (s->pcli_flags & ACCESS_EXPERIMENTAL)
2218 chunk_appendf(msg, "x");
2219
2220 if (s->pcli_flags & ACCESS_EXPERT)
2221 chunk_appendf(msg, "e");
2222
2223 if (s->pcli_flags & ACCESS_MCLI_DEBUG)
2224 chunk_appendf(msg, "d");
2225
2226 chunk_appendf(msg, ")");
2227 }
2228
2229 chunk_appendf(msg, "> ");
2230
2231
William Lallemandebf61802018-12-11 16:10:57 +01002232 }
William Lallemand2f4ce202018-10-26 14:47:47 +02002233 co_inject(oc, msg->area, msg->data);
2234}
2235
William Lallemand291810d2018-10-26 14:47:38 +02002236
William Lallemandcf62f7e2018-10-26 14:47:40 +02002237/* The pcli_* functions are used for the CLI proxy in the master */
2238
William Lallemanddeeaa592018-10-26 14:47:48 +02002239void pcli_reply_and_close(struct stream *s, const char *msg)
2240{
2241 struct buffer *buf = get_trash_chunk();
2242
2243 chunk_initstr(buf, msg);
Christopher Faulet9125f3c2022-03-31 09:47:24 +02002244 stream_retnclose(s, buf);
William Lallemanddeeaa592018-10-26 14:47:48 +02002245}
2246
William Lallemand291810d2018-10-26 14:47:38 +02002247static enum obj_type *pcli_pid_to_server(int proc_pid)
2248{
2249 struct mworker_proc *child;
2250
William Lallemand99e0bb92020-11-05 10:28:53 +01002251 /* return the mCLI applet of the master */
William Lallemandbddd33a2018-12-11 16:10:53 +01002252 if (proc_pid == 0)
William Lallemand99e0bb92020-11-05 10:28:53 +01002253 return &mcli_applet.obj_type;
William Lallemandbddd33a2018-12-11 16:10:53 +01002254
William Lallemand291810d2018-10-26 14:47:38 +02002255 list_for_each_entry(child, &proc_list, list) {
2256 if (child->pid == proc_pid){
2257 return &child->srv->obj_type;
2258 }
2259 }
2260 return NULL;
2261}
2262
2263/* Take a CLI prefix in argument (eg: @!1234 @master @1)
2264 * Return:
2265 * 0: master
2266 * > 0: pid of a worker
2267 * < 0: didn't find a worker
2268 */
2269static int pcli_prefix_to_pid(const char *prefix)
2270{
2271 int proc_pid;
2272 struct mworker_proc *child;
2273 char *errtol = NULL;
2274
2275 if (*prefix != '@') /* not a prefix, should not happen */
2276 return -1;
2277
2278 prefix++;
2279 if (!*prefix) /* sent @ alone, return the master */
2280 return 0;
2281
2282 if (strcmp("master", prefix) == 0) {
2283 return 0;
2284 } else if (*prefix == '!') {
2285 prefix++;
2286 if (!*prefix)
2287 return -1;
2288
2289 proc_pid = strtol(prefix, &errtol, 10);
2290 if (*errtol != '\0')
2291 return -1;
2292 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002293 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002294 continue;
William Lallemand291810d2018-10-26 14:47:38 +02002295 if (child->pid == proc_pid){
2296 return child->pid;
2297 }
2298 }
2299 } else {
2300 struct mworker_proc *chosen = NULL;
2301 /* this is a relative pid */
2302
2303 proc_pid = strtol(prefix, &errtol, 10);
2304 if (*errtol != '\0')
2305 return -1;
2306
2307 if (proc_pid == 0) /* return the master */
2308 return 0;
2309
William Lallemandbac3a822022-07-20 14:30:56 +02002310 if (proc_pid != 1) /* only the "@1" relative PID is supported */
2311 return -1;
2312
William Lallemand291810d2018-10-26 14:47:38 +02002313 /* chose the right process, the current one is the one with the
2314 least number of reloads */
2315 list_for_each_entry(child, &proc_list, list) {
William Lallemand8f7069a2019-04-12 16:09:23 +02002316 if (!(child->options & PROC_O_TYPE_WORKER))
William Lallemand16dd1b32018-11-19 18:46:18 +01002317 continue;
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002318 if (child->reloads == 0)
2319 return child->pid;
2320 else if (chosen == NULL || child->reloads < chosen->reloads)
2321 chosen = child;
William Lallemand291810d2018-10-26 14:47:38 +02002322 }
2323 if (chosen)
2324 return chosen->pid;
2325 }
2326 return -1;
2327}
2328
William Lallemandbddd33a2018-12-11 16:10:53 +01002329/* Return::
2330 * >= 0 : number of words to escape
2331 * = -1 : error
2332 */
2333
2334int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)
2335{
2336 if (argl < 1)
2337 return 0;
2338
2339 /* there is a prefix */
2340 if (args[0][0] == '@') {
2341 int target_pid = pcli_prefix_to_pid(args[0]);
2342
2343 if (target_pid == -1) {
2344 memprintf(errmsg, "Can't find the target PID matching the prefix '%s'\n", args[0]);
2345 return -1;
2346 }
2347
2348 /* if the prefix is alone, define a default target */
2349 if (argl == 1)
2350 s->pcli_next_pid = target_pid;
2351 else
2352 *next_pid = target_pid;
2353 return 1;
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002354 } else if (strcmp("prompt", args[0]) == 0) {
William Lallemanddc12c2e2018-12-13 09:05:46 +01002355 s->pcli_flags ^= PCLI_F_PROMPT;
William Lallemand5b80fa22018-12-11 16:10:54 +01002356 return argl; /* return the number of elements in the array */
William Lallemand5f610682018-12-11 16:10:55 +01002357
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002358 } else if (strcmp("quit", args[0]) == 0) {
Christopher Faulet12762f02023-04-13 15:40:10 +02002359 sc_schedule_abort(s->scf);
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002360 sc_schedule_shutdown(s->scf);
William Lallemand5f610682018-12-11 16:10:55 +01002361 return argl; /* return the number of elements in the array */
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002362 } else if (strcmp(args[0], "operator") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002363 if (!pcli_has_level(s, ACCESS_LVL_OPER)) {
2364 memprintf(errmsg, "Permission denied!\n");
2365 return -1;
2366 }
2367 s->pcli_flags &= ~ACCESS_LVL_MASK;
2368 s->pcli_flags |= ACCESS_LVL_OPER;
2369 return argl;
2370
Tim Duesterhuse5ff1412021-01-02 22:31:53 +01002371 } else if (strcmp(args[0], "user") == 0) {
William Lallemandb7ea1412018-12-13 09:05:47 +01002372 if (!pcli_has_level(s, ACCESS_LVL_USER)) {
2373 memprintf(errmsg, "Permission denied!\n");
2374 return -1;
2375 }
2376 s->pcli_flags &= ~ACCESS_LVL_MASK;
2377 s->pcli_flags |= ACCESS_LVL_USER;
2378 return argl;
William Lallemand7267f782022-02-01 16:08:50 +01002379
2380 } else if (strcmp(args[0], "expert-mode") == 0) {
2381 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2382 memprintf(errmsg, "Permission denied!\n");
2383 return -1;
2384 }
2385
2386 s->pcli_flags &= ~ACCESS_EXPERT;
2387 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2388 s->pcli_flags |= ACCESS_EXPERT;
2389 return argl;
2390
2391 } else if (strcmp(args[0], "experimental-mode") == 0) {
2392 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2393 memprintf(errmsg, "Permission denied!\n");
2394 return -1;
2395 }
2396 s->pcli_flags &= ~ACCESS_EXPERIMENTAL;
2397 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2398 s->pcli_flags |= ACCESS_EXPERIMENTAL;
2399 return argl;
William Lallemand2a171912022-02-02 11:43:20 +01002400 } else if (strcmp(args[0], "mcli-debug-mode") == 0) {
2401 if (!pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2402 memprintf(errmsg, "Permission denied!\n");
2403 return -1;
2404 }
2405 s->pcli_flags &= ~ACCESS_MCLI_DEBUG;
2406 if ((argl > 1) && (strcmp(args[1], "on") == 0))
2407 s->pcli_flags |= ACCESS_MCLI_DEBUG;
2408 return argl;
William Lallemandbddd33a2018-12-11 16:10:53 +01002409 }
2410
2411 return 0;
2412}
2413
2414/*
2415 * Parse the CLI request:
2416 * - It does basically the same as the cli_io_handler, but as a proxy
2417 * - It can exec a command and strip non forwardable commands
William Lallemandcf62f7e2018-10-26 14:47:40 +02002418 *
2419 * Return:
William Lallemandbddd33a2018-12-11 16:10:53 +01002420 * - the number of characters to forward or
2421 * - 1 if there is an error or not enough data
William Lallemandcf62f7e2018-10-26 14:47:40 +02002422 */
William Lallemandbddd33a2018-12-11 16:10:53 +01002423int pcli_parse_request(struct stream *s, struct channel *req, char **errmsg, int *next_pid)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002424{
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002425 char *str;
2426 char *end;
Willy Tarreauf14c7572021-03-13 10:59:23 +01002427 char *args[MAX_CLI_ARGS + 1]; /* +1 for storing a NULL */
William Lallemandbddd33a2018-12-11 16:10:53 +01002428 int argl; /* number of args */
2429 char *p;
2430 char *trim = NULL;
William Lallemandebf61802018-12-11 16:10:57 +01002431 char *payload = NULL;
William Lallemandbddd33a2018-12-11 16:10:53 +01002432 int wtrim = 0; /* number of words to trim */
2433 int reql = 0;
William Lallemandb7ea1412018-12-13 09:05:47 +01002434 int ret;
William Lallemandbddd33a2018-12-11 16:10:53 +01002435 int i = 0;
2436
Willy Tarreaua4e4d662022-01-20 08:47:35 +01002437 /* we cannot deal with a wrapping buffer, so let's take care of this
2438 * first.
2439 */
2440 if (b_head(&req->buf) + b_data(&req->buf) > b_wrap(&req->buf))
2441 b_slow_realign(&req->buf, trash.area, co_data(req));
2442
2443 str = (char *)ci_head(req);
2444 end = (char *)ci_stop(req);
2445
William Lallemandbddd33a2018-12-11 16:10:53 +01002446 p = str;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002447
William Lallemanddc12c2e2018-12-13 09:05:46 +01002448 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002449
2450 /* Looks for the end of one command */
2451 while (p+reql < end) {
2452 /* handle escaping */
2453 if (p[reql] == '\\') {
William Lallemand02c255e2020-06-18 18:45:04 +02002454 reql+=2;
William Lallemandebf61802018-12-11 16:10:57 +01002455 continue;
2456 }
2457 if (p[reql] == ';' || p[reql] == '\n') {
2458 /* found the end of the command */
2459 p[reql] = '\n';
2460 reql++;
2461 break;
2462 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002463 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002464 }
William Lallemandebf61802018-12-11 16:10:57 +01002465 } else {
2466 while (p+reql < end) {
2467 if (p[reql] == '\n') {
2468 /* found the end of the line */
2469 reql++;
2470 break;
2471 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002472 reql++;
William Lallemandbddd33a2018-12-11 16:10:53 +01002473 }
William Lallemandbddd33a2018-12-11 16:10:53 +01002474 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002475
William Lallemandbddd33a2018-12-11 16:10:53 +01002476 /* set end to first byte after the end of the command */
2477 end = p + reql;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002478
William Lallemandbddd33a2018-12-11 16:10:53 +01002479 /* there is no end to this command, need more to parse ! */
Willy Tarreau6cd93f52022-01-20 08:31:50 +01002480 if (!reql || *(end-1) != '\n') {
William Lallemandbddd33a2018-12-11 16:10:53 +01002481 return -1;
2482 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002483
William Lallemand3301f3e2018-12-13 09:05:48 +01002484 if (s->pcli_flags & PCLI_F_PAYLOAD) {
2485 if (reql == 1) /* last line of the payload */
2486 s->pcli_flags &= ~PCLI_F_PAYLOAD;
William Lallemandebf61802018-12-11 16:10:57 +01002487 return reql;
2488 }
2489
William Lallemandbddd33a2018-12-11 16:10:53 +01002490 *(end-1) = '\0';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002491
William Lallemandbddd33a2018-12-11 16:10:53 +01002492 /* splits the command in words */
Willy Tarreauf14c7572021-03-13 10:59:23 +01002493 while (i < MAX_CLI_ARGS && p < end) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002494 /* skip leading spaces/tabs */
2495 p += strspn(p, " \t");
2496 if (!*p)
William Lallemandcf62f7e2018-10-26 14:47:40 +02002497 break;
2498
William Lallemandbddd33a2018-12-11 16:10:53 +01002499 args[i] = p;
William Lallemandfe249c32020-06-18 18:03:57 +02002500 while (1) {
2501 p += strcspn(p, " \t\\");
2502 /* escaped chars using backlashes (\) */
2503 if (*p == '\\') {
2504 if (!*++p)
2505 break;
2506 if (!*++p)
2507 break;
2508 } else {
2509 break;
William Lallemandbddd33a2018-12-11 16:10:53 +01002510 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002511 }
William Lallemandfe249c32020-06-18 18:03:57 +02002512 *p++ = 0;
William Lallemandbddd33a2018-12-11 16:10:53 +01002513 i++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002514 }
2515
William Lallemandbddd33a2018-12-11 16:10:53 +01002516 argl = i;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002517
Willy Tarreauf14c7572021-03-13 10:59:23 +01002518 for (; i < MAX_CLI_ARGS + 1; i++)
William Lallemandbddd33a2018-12-11 16:10:53 +01002519 args[i] = NULL;
2520
2521 wtrim = pcli_find_and_exec_kw(s, args, argl, errmsg, next_pid);
2522
2523 /* End of words are ending by \0, we need to replace the \0s by spaces
William Lallemandfe618fb2022-02-02 14:07:08 +01002524 before forwarding them */
William Lallemandbddd33a2018-12-11 16:10:53 +01002525 p = str;
William Lallemand3301f3e2018-12-13 09:05:48 +01002526 while (p < end-1) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002527 if (*p == '\0')
2528 *p = ' ';
2529 p++;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002530 }
2531
William Lallemand3301f3e2018-12-13 09:05:48 +01002532 payload = strstr(str, PAYLOAD_PATTERN);
2533 if ((end - 1) == (payload + strlen(PAYLOAD_PATTERN))) {
2534 /* if the payload pattern is at the end */
2535 s->pcli_flags |= PCLI_F_PAYLOAD;
William Lallemand3301f3e2018-12-13 09:05:48 +01002536 }
2537
William Lallemandbddd33a2018-12-11 16:10:53 +01002538 *(end-1) = '\n';
William Lallemandcf62f7e2018-10-26 14:47:40 +02002539
William Lallemandbddd33a2018-12-11 16:10:53 +01002540 if (wtrim > 0) {
2541 trim = &args[wtrim][0];
2542 if (trim == NULL) /* if this was the last word in the table */
2543 trim = end;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002544
William Lallemandbddd33a2018-12-11 16:10:53 +01002545 b_del(&req->buf, trim - str);
2546
William Lallemandb7ea1412018-12-13 09:05:47 +01002547 ret = end - trim;
William Lallemandbddd33a2018-12-11 16:10:53 +01002548 } else if (wtrim < 0) {
2549 /* parsing error */
2550 return -1;
William Lallemandb7ea1412018-12-13 09:05:47 +01002551 } else {
2552 /* the whole string */
2553 ret = end - str;
William Lallemandbddd33a2018-12-11 16:10:53 +01002554 }
2555
William Lallemandb7ea1412018-12-13 09:05:47 +01002556 if (ret > 1) {
William Lallemand2a171912022-02-02 11:43:20 +01002557
2558 /* the mcli-debug-mode is only sent to the applet of the master */
2559 if ((s->pcli_flags & ACCESS_MCLI_DEBUG) && *next_pid <= 0) {
2560 ci_insert_line2(req, 0, "mcli-debug-mode on -", strlen("mcli-debug-mode on -"));
2561 ret += strlen("mcli-debug-mode on -") + 2;
2562 }
William Lallemand7267f782022-02-01 16:08:50 +01002563 if (s->pcli_flags & ACCESS_EXPERIMENTAL) {
2564 ci_insert_line2(req, 0, "experimental-mode on -", strlen("experimental-mode on -"));
2565 ret += strlen("experimental-mode on -") + 2;
2566 }
2567 if (s->pcli_flags & ACCESS_EXPERT) {
2568 ci_insert_line2(req, 0, "expert-mode on -", strlen("expert-mode on -"));
2569 ret += strlen("expert-mode on -") + 2;
2570 }
2571
William Lallemandb7ea1412018-12-13 09:05:47 +01002572 if (pcli_has_level(s, ACCESS_LVL_ADMIN)) {
2573 goto end;
2574 } else if (pcli_has_level(s, ACCESS_LVL_OPER)) {
William Lallemandad032882019-07-01 10:56:15 +02002575 ci_insert_line2(req, 0, "operator -", strlen("operator -"));
2576 ret += strlen("operator -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002577 } else if (pcli_has_level(s, ACCESS_LVL_USER)) {
William Lallemandad032882019-07-01 10:56:15 +02002578 ci_insert_line2(req, 0, "user -", strlen("user -"));
2579 ret += strlen("user -") + 2;
William Lallemandb7ea1412018-12-13 09:05:47 +01002580 }
2581 }
2582end:
William Lallemandbddd33a2018-12-11 16:10:53 +01002583
William Lallemandb7ea1412018-12-13 09:05:47 +01002584 return ret;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002585}
2586
2587int pcli_wait_for_request(struct stream *s, struct channel *req, int an_bit)
2588{
William Lallemandbddd33a2018-12-11 16:10:53 +01002589 int next_pid = -1;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002590 int to_forward;
William Lallemandbddd33a2018-12-11 16:10:53 +01002591 char *errmsg = NULL;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002592
Ilya Shipitsin5e87bcf2021-12-25 11:45:52 +05002593 /* Don't read the next command if still processing the response of the
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002594 * current one. Just wait. At this stage, errors should be handled by
2595 * the response analyzer.
2596 */
2597 if (s->res.analysers & AN_RES_WAIT_CLI)
2598 return 0;
2599
William Lallemandb7ea1412018-12-13 09:05:47 +01002600 if ((s->pcli_flags & ACCESS_LVL_MASK) == ACCESS_LVL_NONE)
2601 s->pcli_flags |= strm_li(s)->bind_conf->level & ACCESS_LVL_MASK;
2602
William Lallemand0a0512f2022-09-24 16:14:50 +02002603 /* stream that comes from the reload listener only responses the reload
2604 * status and quits */
2605 if (!(s->pcli_flags & PCLI_F_RELOAD)
2606 && strm_li(s)->bind_conf == mcli_reload_bind_conf)
2607 goto send_status;
2608
2609
William Lallemandcf62f7e2018-10-26 14:47:40 +02002610read_again:
2611 /* if the channel is closed for read, we won't receive any more data
2612 from the client, but we don't want to forward this close to the
2613 server */
2614 channel_dont_close(req);
2615
2616 /* We don't know yet to which server we will connect */
2617 channel_dont_connect(req);
2618
Christopher Faulet9a790f62023-03-16 14:40:03 +01002619 s->scf->flags |= SC_FL_RCV_ONCE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002620
2621 /* need more data */
2622 if (!ci_data(req))
Christopher Faulet0f727da2022-01-18 08:44:23 +01002623 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002624
2625 /* If there is data available for analysis, log the end of the idle time. */
2626 if (c_data(req) && s->logs.t_idle == -1)
Willy Tarreau69530f52023-04-28 09:16:15 +02002627 s->logs.t_idle = ns_to_ms(now_ns - s->logs.accept_ts) - s->logs.t_handshake;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002628
William Lallemandbddd33a2018-12-11 16:10:53 +01002629 to_forward = pcli_parse_request(s, req, &errmsg, &next_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002630 if (to_forward > 0) {
William Lallemandbddd33a2018-12-11 16:10:53 +01002631 int target_pid;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002632 /* enough data */
2633
William Lallemandcf62f7e2018-10-26 14:47:40 +02002634 /* forward only 1 command */
2635 channel_forward(req, to_forward);
William Lallemandebf61802018-12-11 16:10:57 +01002636
William Lallemanddc12c2e2018-12-13 09:05:46 +01002637 if (!(s->pcli_flags & PCLI_F_PAYLOAD)) {
William Lallemandebf61802018-12-11 16:10:57 +01002638 /* we send only 1 command per request, and we write close after it */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002639 sc_schedule_shutdown(s->scb);
William Lallemandebf61802018-12-11 16:10:57 +01002640 } else {
2641 pcli_write_prompt(s);
2642 }
2643
2644 s->res.flags |= CF_WAKE_ONCE; /* need to be called again */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002645 s->res.analysers |= AN_RES_WAIT_CLI;
2646
William Lallemandebf61802018-12-11 16:10:57 +01002647 if (!(s->flags & SF_ASSIGNED)) {
2648 if (next_pid > -1)
2649 target_pid = next_pid;
2650 else
2651 target_pid = s->pcli_next_pid;
2652 /* we can connect now */
2653 s->target = pcli_pid_to_server(target_pid);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002654
William Lallemanddcbe7b92021-12-10 14:14:53 +01002655 if (!s->target)
2656 goto server_disconnect;
2657
William Lallemandebf61802018-12-11 16:10:57 +01002658 s->flags |= (SF_DIRECT | SF_ASSIGNED);
2659 channel_auto_connect(req);
2660 }
William Lallemandcf62f7e2018-10-26 14:47:40 +02002661
2662 } else if (to_forward == 0) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002663 /* we trimmed things but we might have other commands to consume */
William Lallemandbddd33a2018-12-11 16:10:53 +01002664 pcli_write_prompt(s);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002665 goto read_again;
Christopher Faulet0f727da2022-01-18 08:44:23 +01002666 } else if (to_forward == -1) {
2667 if (errmsg) {
2668 /* there was an error during the parsing */
2669 pcli_reply_and_close(s, errmsg);
2670 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2671 return 0;
2672 }
2673 goto missing_data;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002674 }
2675
2676 return 0;
2677
2678send_help:
2679 b_reset(&req->buf);
2680 b_putblk(&req->buf, "help\n", 5);
2681 goto read_again;
William Lallemanddcbe7b92021-12-10 14:14:53 +01002682
William Lallemand0a0512f2022-09-24 16:14:50 +02002683send_status:
2684 s->pcli_flags |= PCLI_F_RELOAD;
Christopher Faulet208c7122023-04-13 16:16:15 +02002685 /* dont' use ci_putblk here because SHUT_DONE could have been sent */
William Lallemand0a0512f2022-09-24 16:14:50 +02002686 b_reset(&req->buf);
2687 b_putblk(&req->buf, "_loadstatus;quit\n", 17);
2688 goto read_again;
2689
Christopher Faulet0f727da2022-01-18 08:44:23 +01002690missing_data:
Christopher Fauletca5309a2023-04-17 16:17:32 +02002691 if (s->scf->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
Christopher Faulet0f727da2022-01-18 08:44:23 +01002692 /* There is no more request or a only a partial one and we
2693 * receive a close from the client, we can leave */
Christopher Fauletdf7cd712023-04-13 15:56:26 +02002694 sc_schedule_shutdown(s->scf);
Christopher Faulet0f727da2022-01-18 08:44:23 +01002695 s->req.analysers &= ~AN_REQ_WAIT_CLI;
2696 return 1;
2697 }
2698 else if (channel_full(req, global.tune.maxrewrite)) {
2699 /* buffer is full and we didn't catch the end of a command */
2700 goto send_help;
2701 }
2702 return 0;
2703
William Lallemanddcbe7b92021-12-10 14:14:53 +01002704server_disconnect:
2705 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
2706 return 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002707}
2708
2709int pcli_wait_for_response(struct stream *s, struct channel *rep, int an_bit)
2710{
2711 struct proxy *fe = strm_fe(s);
2712 struct proxy *be = s->be;
2713
Christopher Fauletd7bac882023-04-14 12:05:55 +02002714 if ((s->scb->flags & SC_FL_ERROR) || (rep->flags & (CF_READ_TIMEOUT|CF_WRITE_TIMEOUT)) ||
Christopher Faulet64350bb2023-04-13 16:37:37 +02002715 ((s->scf->flags & SC_FL_SHUT_DONE) && (rep->to_forward || co_data(rep)))) {
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002716 pcli_reply_and_close(s, "Can't connect to the target CLI!\n");
Christopher Fauletd98da3b2021-10-18 14:52:49 +02002717 s->req.analysers &= ~AN_REQ_WAIT_CLI;
William Lallemand6b7cd0a2018-11-06 17:37:11 +01002718 s->res.analysers &= ~AN_RES_WAIT_CLI;
2719 return 0;
2720 }
Christopher Faulet9a790f62023-03-16 14:40:03 +01002721 s->scb->flags |= SC_FL_RCV_ONCE; /* try to get back here ASAP */
Christopher Faulet68ef2182023-03-17 15:38:18 +01002722 s->scf->flags |= SC_FL_SND_NEVERWAIT;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002723
2724 /* don't forward the close */
2725 channel_dont_close(&s->res);
2726 channel_dont_close(&s->req);
2727
William Lallemanddc12c2e2018-12-13 09:05:46 +01002728 if (s->pcli_flags & PCLI_F_PAYLOAD) {
William Lallemandebf61802018-12-11 16:10:57 +01002729 s->res.analysers &= ~AN_RES_WAIT_CLI;
2730 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2731 return 0;
2732 }
2733
William Lallemandcf62f7e2018-10-26 14:47:40 +02002734 /* forward the data */
2735 if (ci_data(rep)) {
2736 c_adv(rep, ci_data(rep));
2737 return 0;
2738 }
2739
Christopher Fauletca5309a2023-04-17 16:17:32 +02002740 if (s->scb->flags & (SC_FL_ABRT_DONE|SC_FL_EOS)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002741 /* stream cleanup */
2742
William Lallemand2f4ce202018-10-26 14:47:47 +02002743 pcli_write_prompt(s);
2744
Willy Tarreaucb041662022-05-17 19:44:42 +02002745 s->scb->flags |= SC_FL_NOLINGER | SC_FL_NOHALF;
Christopher Fauletcfc11c02023-04-13 16:10:23 +02002746 sc_abort(s->scb);
Christopher Fauletb2b1c3a2023-04-13 16:23:48 +02002747 sc_shutdown(s->scb);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002748
2749 /*
2750 * starting from there this the same code as
2751 * http_end_txn_clean_session().
2752 *
2753 * It allows to do frontend keepalive while reconnecting to a
2754 * new server for each request.
2755 */
2756
2757 if (s->flags & SF_BE_ASSIGNED) {
Willy Tarreau4781b152021-04-06 13:53:36 +02002758 HA_ATOMIC_DEC(&be->beconn);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002759 if (unlikely(s->srv_conn))
2760 sess_change_server(s, NULL);
2761 }
2762
Willy Tarreau69530f52023-04-28 09:16:15 +02002763 s->logs.t_close = ns_to_ms(now_ns - s->logs.accept_ts);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002764 stream_process_counters(s);
2765
2766 /* don't count other requests' data */
2767 s->logs.bytes_in -= ci_data(&s->req);
2768 s->logs.bytes_out -= ci_data(&s->res);
2769
2770 /* we may need to know the position in the queue */
2771 pendconn_free(s);
2772
2773 /* let's do a final log if we need it */
2774 if (!LIST_ISEMPTY(&fe->logformat) && s->logs.logwait &&
2775 !(s->flags & SF_MONITOR) &&
2776 (!(fe->options & PR_O_NULLNOLOG) || s->req.total)) {
2777 s->do_log(s);
2778 }
2779
2780 /* stop tracking content-based counters */
2781 stream_stop_content_counters(s);
2782 stream_update_time_stats(s);
2783
2784 s->logs.accept_date = date; /* user-visible date for logging */
Willy Tarreau69530f52023-04-28 09:16:15 +02002785 s->logs.accept_ts = now_ns; /* corrected date for internal use */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002786 s->logs.t_handshake = 0; /* There are no handshake in keep alive connection. */
2787 s->logs.t_idle = -1;
Willy Tarreauad5a5f62023-04-27 09:46:02 +02002788 s->logs.request_ts = 0;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002789 s->logs.t_queue = -1;
2790 s->logs.t_connect = -1;
2791 s->logs.t_data = -1;
2792 s->logs.t_close = 0;
2793 s->logs.prx_queue_pos = 0; /* we get the number of pending conns before us */
2794 s->logs.srv_queue_pos = 0; /* we will get this number soon */
2795
2796 s->logs.bytes_in = s->req.total = ci_data(&s->req);
2797 s->logs.bytes_out = s->res.total = ci_data(&s->res);
2798
2799 stream_del_srv_conn(s);
2800 if (objt_server(s->target)) {
2801 if (s->flags & SF_CURR_SESS) {
2802 s->flags &= ~SF_CURR_SESS;
Willy Tarreau4781b152021-04-06 13:53:36 +02002803 HA_ATOMIC_DEC(&__objt_server(s->target)->cur_sess);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002804 }
Willy Tarreaub54c40a2018-12-02 19:28:41 +01002805 if (may_dequeue_tasks(__objt_server(s->target), be))
Willy Tarreau9ab78292021-06-22 18:47:51 +02002806 process_srv_queue(__objt_server(s->target));
William Lallemandcf62f7e2018-10-26 14:47:40 +02002807 }
2808
2809 s->target = NULL;
2810
2811 /* only release our endpoint if we don't intend to reuse the
2812 * connection.
2813 */
Willy Tarreau462b9892022-05-18 18:06:53 +02002814 if (!sc_conn_ready(s->scb)) {
William Lallemandcf62f7e2018-10-26 14:47:40 +02002815 s->srv_conn = NULL;
Willy Tarreau19c65a92022-05-27 08:49:24 +02002816 if (sc_reset_endp(s->scb) < 0) {
Christopher Faulet50264b42022-03-30 19:39:30 +02002817 if (!s->conn_err_type)
2818 s->conn_err_type = STRM_ET_CONN_OTHER;
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002819 if (s->srv_error)
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002820 s->srv_error(s, s->scb);
Christopher Faulet9ec2f4d2022-03-23 15:15:29 +01002821 return 1;
2822 }
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002823 se_fl_clr(s->scb->sedesc, ~SE_FL_DETACHED);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002824 }
2825
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +02002826 sockaddr_free(&s->scb->dst);
Willy Tarreau1c8d32b2019-07-18 15:47:45 +02002827
Willy Tarreau74568cf2022-05-27 09:03:30 +02002828 sc_set_state(s->scb, SC_ST_INI);
Christopher Fauleta1d14a72023-04-14 10:42:08 +02002829 s->scb->flags &= ~(SC_FL_ERROR|SC_FL_SHUT_DONE|SC_FL_SHUT_WANTED);
Willy Tarreaucb041662022-05-17 19:44:42 +02002830 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 +02002831
2832 s->req.flags &= ~(CF_AUTO_CONNECT|CF_STREAMER|CF_STREAMER_FAST|CF_WROTE_DATA);
2833 s->res.flags &= ~(CF_STREAMER|CF_STREAMER_FAST|CF_WRITE_EVENT|CF_WROTE_DATA|CF_READ_EVENT);
Willy Tarreau03bd3952022-05-02 16:36:47 +02002834 s->flags &= ~(SF_DIRECT|SF_ASSIGNED|SF_BE_ASSIGNED|SF_FORCE_PRST|SF_IGNORE_PRST);
William Lallemandcf62f7e2018-10-26 14:47:40 +02002835 s->flags &= ~(SF_CURR_SESS|SF_REDIRECTABLE|SF_SRV_REUSED);
2836 s->flags &= ~(SF_ERR_MASK|SF_FINST_MASK|SF_REDISP);
Christopher Faulet909f3182022-03-29 15:42:09 +02002837 s->conn_retries = 0; /* used for logging too */
Christopher Fauletae024ce2022-03-29 19:02:31 +02002838 s->conn_exp = TICK_ETERNITY;
Christopher Faulet50264b42022-03-30 19:39:30 +02002839 s->conn_err_type = STRM_ET_NONE;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002840 /* reinitialise the current rule list pointer to NULL. We are sure that
2841 * any rulelist match the NULL pointer.
2842 */
2843 s->current_rule_list = NULL;
2844
2845 s->be = strm_fe(s);
2846 s->logs.logwait = strm_fe(s)->to_log;
2847 s->logs.level = 0;
2848 stream_del_srv_conn(s);
2849 s->target = NULL;
2850 /* re-init store persistence */
2851 s->store_count = 0;
2852 s->uniq_id = global.req_count++;
2853
Christopher Fauletca5309a2023-04-17 16:17:32 +02002854 s->scf->flags &= ~(SC_FL_EOS|SC_FL_ERROR|SC_FL_ABRT_DONE|SC_FL_ABRT_WANTED);
Christopher Faulet68ef2182023-03-17 15:38:18 +01002855 s->scf->flags &= ~SC_FL_SND_NEVERWAIT;
Christopher Faulet9a790f62023-03-16 14:40:03 +01002856 s->scf->flags |= SC_FL_RCV_ONCE; /* one read is usually enough */
William Lallemandcf62f7e2018-10-26 14:47:40 +02002857
2858 s->req.flags |= CF_WAKE_ONCE; /* need to be called again if there is some command left in the request */
2859
William Lallemandcf62f7e2018-10-26 14:47:40 +02002860 s->res.analysers &= ~AN_RES_WAIT_CLI;
2861
2862 /* We must trim any excess data from the response buffer, because we
2863 * may have blocked an invalid response from a server that we don't
Ilya Shipitsind4259502020-04-08 01:07:56 +05002864 * want to accidentally forward once we disable the analysers, nor do
William Lallemandcf62f7e2018-10-26 14:47:40 +02002865 * we want those data to come along with next response. A typical
2866 * example of such data would be from a buggy server responding to
2867 * a HEAD with some data, or sending more than the advertised
2868 * content-length.
2869 */
2870 if (unlikely(ci_data(&s->res)))
2871 b_set_data(&s->res.buf, co_data(&s->res));
2872
2873 /* Now we can realign the response buffer */
2874 c_realign_if_empty(&s->res);
2875
Christopher Faulet5aaacfb2023-02-15 08:13:33 +01002876 s->scf->ioto = strm_fe(s)->timeout.client;
2877 s->scb->ioto = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002878
William Lallemandcf62f7e2018-10-26 14:47:40 +02002879 s->req.analyse_exp = TICK_ETERNITY;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002880 s->res.analyse_exp = TICK_ETERNITY;
Christopher Faulet15315d62023-02-20 08:23:51 +01002881
William Lallemandcf62f7e2018-10-26 14:47:40 +02002882 /* we're removing the analysers, we MUST re-enable events detection.
2883 * We don't enable close on the response channel since it's either
2884 * already closed, or in keep-alive with an idle connection handler.
2885 */
2886 channel_auto_read(&s->req);
2887 channel_auto_close(&s->req);
2888 channel_auto_read(&s->res);
2889
2890
2891 return 1;
2892 }
2893 return 0;
2894}
2895
William Lallemand8a022572018-10-26 14:47:35 +02002896/*
2897 * The mworker functions are used to initialize the CLI in the master process
2898 */
2899
William Lallemand309dc9a2018-10-26 14:47:45 +02002900 /*
2901 * Stop the mworker proxy
2902 */
2903void mworker_cli_proxy_stop()
2904{
William Lallemand550db6d2018-11-06 17:37:12 +01002905 if (mworker_proxy)
2906 stop_proxy(mworker_proxy);
William Lallemand309dc9a2018-10-26 14:47:45 +02002907}
2908
William Lallemand8a022572018-10-26 14:47:35 +02002909/*
2910 * Create the mworker CLI proxy
2911 */
2912int mworker_cli_proxy_create()
2913{
2914 struct mworker_proc *child;
William Lallemand744a0892018-11-22 16:46:51 +01002915 char *msg = NULL;
2916 char *errmsg = NULL;
William Lallemand8a022572018-10-26 14:47:35 +02002917
William Lallemandae787ba2021-07-29 15:13:22 +02002918 mworker_proxy = alloc_new_proxy("MASTER", PR_CAP_LISTEN|PR_CAP_INT, &errmsg);
William Lallemand8a022572018-10-26 14:47:35 +02002919 if (!mworker_proxy)
William Lallemandae787ba2021-07-29 15:13:22 +02002920 goto error_proxy;
William Lallemand8a022572018-10-26 14:47:35 +02002921
William Lallemandcf62f7e2018-10-26 14:47:40 +02002922 mworker_proxy->mode = PR_MODE_CLI;
William Lallemand8a022572018-10-26 14:47:35 +02002923 mworker_proxy->maxconn = 10; /* default to 10 concurrent connections */
2924 mworker_proxy->timeout.client = 0; /* no timeout */
2925 mworker_proxy->conf.file = strdup("MASTER");
2926 mworker_proxy->conf.line = 0;
2927 mworker_proxy->accept = frontend_accept;
2928 mworker_proxy-> lbprm.algo = BE_LB_ALGO_NONE;
2929
2930 /* Does not init the default target the CLI applet, but must be done in
2931 * the request parsing code */
2932 mworker_proxy->default_target = NULL;
2933
William Lallemand8a022572018-10-26 14:47:35 +02002934 /* create all servers using the mworker_proc list */
2935 list_for_each_entry(child, &proc_list, list) {
William Lallemand8a022572018-10-26 14:47:35 +02002936 struct server *newsrv = NULL;
2937 struct sockaddr_storage *sk;
2938 int port1, port2, port;
2939 struct protocol *proto;
William Lallemand8a022572018-10-26 14:47:35 +02002940
William Lallemanda31b09e2020-01-14 15:25:02 +01002941 /* only the workers support the master CLI */
2942 if (!(child->options & PROC_O_TYPE_WORKER))
2943 continue;
2944
William Lallemand8a022572018-10-26 14:47:35 +02002945 newsrv = new_server(mworker_proxy);
2946 if (!newsrv)
William Lallemand744a0892018-11-22 16:46:51 +01002947 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002948
2949 /* we don't know the new pid yet */
2950 if (child->pid == -1)
Willy Tarreaue8422bf2021-06-15 09:08:18 +02002951 memprintf(&msg, "cur-%d", 1);
William Lallemand8a022572018-10-26 14:47:35 +02002952 else
2953 memprintf(&msg, "old-%d", child->pid);
2954
2955 newsrv->next = mworker_proxy->srv;
2956 mworker_proxy->srv = newsrv;
2957 newsrv->conf.file = strdup(msg);
2958 newsrv->id = strdup(msg);
2959 newsrv->conf.line = 0;
2960
2961 memprintf(&msg, "sockpair@%d", child->ipc_fd[0]);
Willy Tarreau5fc93282020-09-16 18:25:03 +02002962 if ((sk = str2sa_range(msg, &port, &port1, &port2, NULL, &proto,
Willy Tarreaua93e5c72020-09-15 14:01:16 +02002963 &errmsg, NULL, NULL, PA_O_STREAM)) == 0) {
William Lallemand744a0892018-11-22 16:46:51 +01002964 goto error;
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01002965 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002966 ha_free(&msg);
William Lallemand8a022572018-10-26 14:47:35 +02002967
Willy Tarreau5fc93282020-09-16 18:25:03 +02002968 if (!proto->connect) {
William Lallemand744a0892018-11-22 16:46:51 +01002969 goto error;
William Lallemand8a022572018-10-26 14:47:35 +02002970 }
2971
2972 /* no port specified */
2973 newsrv->flags |= SRV_F_MAPPORTS;
2974 newsrv->addr = *sk;
William Lallemandcf62f7e2018-10-26 14:47:40 +02002975 /* don't let the server participate to load balancing */
2976 newsrv->iweight = 0;
2977 newsrv->uweight = 0;
William Lallemand8a022572018-10-26 14:47:35 +02002978 srv_lb_commit_status(newsrv);
William Lallemand291810d2018-10-26 14:47:38 +02002979
2980 child->srv = newsrv;
William Lallemand8a022572018-10-26 14:47:35 +02002981 }
William Lallemandae787ba2021-07-29 15:13:22 +02002982
2983 mworker_proxy->next = proxies_list;
2984 proxies_list = mworker_proxy;
2985
William Lallemand8a022572018-10-26 14:47:35 +02002986 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01002987
2988error:
William Lallemand744a0892018-11-22 16:46:51 +01002989
2990 list_for_each_entry(child, &proc_list, list) {
2991 free((char *)child->srv->conf.file); /* cast because of const char * */
2992 free(child->srv->id);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002993 ha_free(&child->srv);
William Lallemand744a0892018-11-22 16:46:51 +01002994 }
William Lallemandae787ba2021-07-29 15:13:22 +02002995 free_proxy(mworker_proxy);
William Lallemand744a0892018-11-22 16:46:51 +01002996 free(msg);
2997
William Lallemandae787ba2021-07-29 15:13:22 +02002998error_proxy:
2999 ha_alert("%s\n", errmsg);
3000 free(errmsg);
3001
William Lallemand744a0892018-11-22 16:46:51 +01003002 return -1;
William Lallemand8a022572018-10-26 14:47:35 +02003003}
Olivier Houchardf886e342017-04-05 22:24:59 +02003004
William Lallemandce83b4a2018-10-26 14:47:30 +02003005/*
William Lallemande7361152018-10-26 14:47:36 +02003006 * Create a new listener for the master CLI proxy
3007 */
William Lallemand21623b52022-09-24 15:51:27 +02003008struct bind_conf *mworker_cli_proxy_new_listener(char *line)
William Lallemande7361152018-10-26 14:47:36 +02003009{
3010 struct bind_conf *bind_conf;
3011 struct listener *l;
3012 char *err = NULL;
3013 char *args[MAX_LINE_ARGS + 1];
3014 int arg;
3015 int cur_arg;
3016
William Lallemand2e945c82019-11-25 09:58:37 +01003017 arg = 1;
William Lallemande7361152018-10-26 14:47:36 +02003018 args[0] = line;
3019
3020 /* args is a bind configuration with spaces replaced by commas */
3021 while (*line && arg < MAX_LINE_ARGS) {
3022
3023 if (*line == ',') {
3024 *line++ = '\0';
3025 while (*line == ',')
3026 line++;
William Lallemand2e945c82019-11-25 09:58:37 +01003027 args[arg++] = line;
William Lallemande7361152018-10-26 14:47:36 +02003028 }
3029 line++;
3030 }
3031
William Lallemand2e945c82019-11-25 09:58:37 +01003032 args[arg] = "\0";
William Lallemande7361152018-10-26 14:47:36 +02003033
3034 bind_conf = bind_conf_alloc(mworker_proxy, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003035 if (!bind_conf)
3036 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003037
3038 bind_conf->level &= ~ACCESS_LVL_MASK;
3039 bind_conf->level |= ACCESS_LVL_ADMIN;
Willy Tarreaue283ee62021-03-12 15:00:57 +01003040 bind_conf->level |= ACCESS_MASTER | ACCESS_MASTER_ONLY;
William Lallemande7361152018-10-26 14:47:36 +02003041
3042 if (!str2listener(args[0], mworker_proxy, bind_conf, "master-socket", 0, &err)) {
3043 ha_alert("Cannot create the listener of the master CLI\n");
William Lallemand744a0892018-11-22 16:46:51 +01003044 goto err;
William Lallemande7361152018-10-26 14:47:36 +02003045 }
3046
3047 cur_arg = 1;
3048
3049 while (*args[cur_arg]) {
William Lallemande7361152018-10-26 14:47:36 +02003050 struct bind_kw *kw;
Willy Tarreau433b05f2021-03-12 10:14:07 +01003051 const char *best;
William Lallemande7361152018-10-26 14:47:36 +02003052
3053 kw = bind_find_kw(args[cur_arg]);
3054 if (kw) {
3055 if (!kw->parse) {
3056 memprintf(&err, "'%s %s' : '%s' option is not implemented in this version (check build options).",
3057 args[0], args[1], args[cur_arg]);
3058 goto err;
3059 }
3060
Willy Tarreau4975d142021-03-13 11:00:33 +01003061 if (kw->parse(args, cur_arg, global.cli_fe, bind_conf, &err) != 0) {
William Lallemande7361152018-10-26 14:47:36 +02003062 if (err)
3063 memprintf(&err, "'%s %s' : '%s'", args[0], args[1], err);
3064 else
3065 memprintf(&err, "'%s %s' : error encountered while processing '%s'",
3066 args[0], args[1], args[cur_arg]);
3067 goto err;
3068 }
3069
3070 cur_arg += 1 + kw->skip;
3071 continue;
3072 }
3073
Willy Tarreau433b05f2021-03-12 10:14:07 +01003074 best = bind_find_best_kw(args[cur_arg]);
3075 if (best)
3076 memprintf(&err, "'%s %s' : unknown keyword '%s'. Did you mean '%s' maybe ?",
3077 args[0], args[1], args[cur_arg], best);
3078 else
3079 memprintf(&err, "'%s %s' : unknown keyword '%s'.",
3080 args[0], args[1], args[cur_arg]);
William Lallemande7361152018-10-26 14:47:36 +02003081 goto err;
3082 }
3083
3084
Willy Tarreau30836152023-01-12 19:10:17 +01003085 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003086 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003087 bind_conf->options |= BC_O_UNLIMITED; /* don't make the peers subject to global limits */
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003088
William Lallemande7361152018-10-26 14:47:36 +02003089 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau18c20d22020-10-09 16:11:46 +02003090 l->rx.flags |= RX_F_MWORKER; /* we are keeping this FD in the master */
Willy Tarreau18215cb2019-02-27 16:25:28 +01003091 global.maxsock++; /* for the listening socket */
William Lallemande7361152018-10-26 14:47:36 +02003092 }
Willy Tarreau18215cb2019-02-27 16:25:28 +01003093 global.maxsock += mworker_proxy->maxconn;
William Lallemande7361152018-10-26 14:47:36 +02003094
William Lallemand21623b52022-09-24 15:51:27 +02003095 return bind_conf;
William Lallemande7361152018-10-26 14:47:36 +02003096
3097err:
3098 ha_alert("%s\n", err);
William Lallemand744a0892018-11-22 16:46:51 +01003099 free(err);
3100 free(bind_conf);
William Lallemand21623b52022-09-24 15:51:27 +02003101 return NULL;
William Lallemande7361152018-10-26 14:47:36 +02003102
3103}
3104
3105/*
William Lallemandce83b4a2018-10-26 14:47:30 +02003106 * Create a new CLI socket using a socketpair for a worker process
3107 * <mworker_proc> is the process structure, and <proc> is the process number
3108 */
3109int mworker_cli_sockpair_new(struct mworker_proc *mworker_proc, int proc)
3110{
3111 struct bind_conf *bind_conf;
3112 struct listener *l;
3113 char *path = NULL;
3114 char *err = NULL;
3115
3116 /* master pipe to ensure the master is still alive */
3117 if (socketpair(AF_UNIX, SOCK_STREAM, 0, mworker_proc->ipc_fd) < 0) {
3118 ha_alert("Cannot create worker socketpair.\n");
3119 return -1;
3120 }
3121
3122 /* XXX: we might want to use a separate frontend at some point */
Willy Tarreau4975d142021-03-13 11:00:33 +01003123 if (!global.cli_fe) {
3124 if ((global.cli_fe = cli_alloc_fe("GLOBAL", "master-socket", 0)) == NULL) {
William Lallemandce83b4a2018-10-26 14:47:30 +02003125 ha_alert("out of memory trying to allocate the stats frontend");
William Lallemand744a0892018-11-22 16:46:51 +01003126 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003127 }
3128 }
3129
Willy Tarreau4975d142021-03-13 11:00:33 +01003130 bind_conf = bind_conf_alloc(global.cli_fe, "master-socket", 0, "", xprt_get(XPRT_RAW));
William Lallemand744a0892018-11-22 16:46:51 +01003131 if (!bind_conf)
3132 goto error;
3133
William Lallemandce83b4a2018-10-26 14:47:30 +02003134 bind_conf->level &= ~ACCESS_LVL_MASK;
3135 bind_conf->level |= ACCESS_LVL_ADMIN; /* TODO: need to lower the rights with a CLI keyword*/
William Lallemand2be557f2021-11-24 18:45:37 +01003136 bind_conf->level |= ACCESS_FD_LISTENERS;
William Lallemandce83b4a2018-10-26 14:47:30 +02003137
William Lallemandce83b4a2018-10-26 14:47:30 +02003138 if (!memprintf(&path, "sockpair@%d", mworker_proc->ipc_fd[1])) {
3139 ha_alert("Cannot allocate listener.\n");
William Lallemand744a0892018-11-22 16:46:51 +01003140 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003141 }
3142
Willy Tarreau4975d142021-03-13 11:00:33 +01003143 if (!str2listener(path, global.cli_fe, bind_conf, "master-socket", 0, &err)) {
Tim Duesterhus4cae3b22018-11-22 16:46:50 +01003144 free(path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003145 ha_alert("Cannot create a CLI sockpair listener for process #%d\n", proc);
William Lallemand744a0892018-11-22 16:46:51 +01003146 goto error;
William Lallemandce83b4a2018-10-26 14:47:30 +02003147 }
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003148 ha_free(&path);
William Lallemandce83b4a2018-10-26 14:47:30 +02003149
Willy Tarreau30836152023-01-12 19:10:17 +01003150 bind_conf->accept = session_accept_fd;
Willy Tarreau7dbd4182023-01-12 19:32:45 +01003151 bind_conf->nice = -64; /* we want to boost priority for local stats */
Willy Tarreau17146802023-01-12 19:58:42 +01003152 bind_conf->options |= BC_O_UNLIMITED | BC_O_NOSTOP;
Willy Tarreaud5983ce2023-01-12 19:18:34 +01003153
William Lallemandce83b4a2018-10-26 14:47:30 +02003154 list_for_each_entry(l, &bind_conf->listeners, by_bind) {
Willy Tarreau4781b152021-04-06 13:53:36 +02003155 HA_ATOMIC_INC(&unstoppable_jobs);
William Lallemandce83b4a2018-10-26 14:47:30 +02003156 /* it's a sockpair but we don't want to keep the fd in the master */
Willy Tarreau43046fa2020-09-01 15:41:59 +02003157 l->rx.flags &= ~RX_F_INHERITED;
Willy Tarreau18215cb2019-02-27 16:25:28 +01003158 global.maxsock++; /* for the listening socket */
William Lallemandce83b4a2018-10-26 14:47:30 +02003159 }
3160
3161 return 0;
William Lallemand744a0892018-11-22 16:46:51 +01003162
3163error:
3164 close(mworker_proc->ipc_fd[0]);
3165 close(mworker_proc->ipc_fd[1]);
3166 free(err);
3167
3168 return -1;
William Lallemandce83b4a2018-10-26 14:47:30 +02003169}
3170
William Lallemand74c24fb2016-11-21 17:18:36 +01003171static struct applet cli_applet = {
3172 .obj_type = OBJ_TYPE_APPLET,
3173 .name = "<CLI>", /* used for logging */
3174 .fct = cli_io_handler,
3175 .release = cli_release_handler,
3176};
3177
William Lallemand99e0bb92020-11-05 10:28:53 +01003178/* master CLI */
3179static struct applet mcli_applet = {
3180 .obj_type = OBJ_TYPE_APPLET,
3181 .name = "<MCLI>", /* used for logging */
3182 .fct = cli_io_handler,
3183 .release = cli_release_handler,
3184};
3185
Willy Tarreau0a739292016-11-22 20:21:23 +01003186/* register cli keywords */
3187static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003188 { { "help", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3189 { { "prompt", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3190 { { "quit", NULL }, NULL, cli_parse_simple, NULL, NULL, NULL, ACCESS_MASTER },
3191 { { "_getsocks", NULL }, NULL, _getsocks, NULL },
William Lallemandd9c28072022-02-02 11:23:58 +01003192 { { "expert-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
3193 { { "experimental-mode", NULL }, NULL, cli_parse_expert_experimental_mode, NULL, NULL, NULL, ACCESS_MASTER }, // not listed
William Lallemand2a171912022-02-02 11:43:20 +01003194 { { "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 +01003195 { { "set", "anon", "on" }, "set anon on [value] : activate the anonymized mode", cli_parse_set_anon, NULL, NULL },
3196 { { "set", "anon", "off" }, "set anon off : deactivate the anonymized mode", cli_parse_set_anon, NULL, NULL },
Erwan Le Goasd7869312022-09-29 10:36:11 +02003197 { { "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 +02003198 { { "set", "maxconn", "global", NULL }, "set maxconn global <value> : change the per-process maxconn setting", cli_parse_set_maxconn_global, NULL },
3199 { { "set", "rate-limit", NULL }, "set rate-limit <setting> <value> : change a rate limiting value", cli_parse_set_ratelimit, NULL },
3200 { { "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 },
3201 { { "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 +02003202 { { "show", "anon", NULL }, "show anon : display the current state of anonymized mode", cli_parse_show_anon, NULL },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02003203 { { "show", "env", NULL }, "show env [var] : dump environment variables known to the process", cli_parse_show_env, cli_io_handler_show_env, NULL },
3204 { { "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 },
3205 { { "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 +02003206 { { "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 +01003207 { { "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 +02003208 { { "operator", NULL }, "operator : lower the level of the current CLI session to operator", cli_parse_set_lvl, NULL, NULL, NULL, ACCESS_MASTER},
3209 { { "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 +01003210 {{},}
3211}};
3212
Willy Tarreau0108d902018-11-25 19:14:37 +01003213INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
3214
William Lallemand74c24fb2016-11-21 17:18:36 +01003215static struct cfg_kw_list cfg_kws = {ILH, {
Willy Tarreau4975d142021-03-13 11:00:33 +01003216 { CFG_GLOBAL, "stats", cli_parse_global },
William Lallemand74c24fb2016-11-21 17:18:36 +01003217 { 0, NULL, NULL },
3218}};
3219
Willy Tarreau0108d902018-11-25 19:14:37 +01003220INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
3221
William Lallemand74c24fb2016-11-21 17:18:36 +01003222static struct bind_kw_list bind_kws = { "STAT", { }, {
William Lallemandf6975e92017-05-26 17:42:10 +02003223 { "level", bind_parse_level, 1 }, /* set the unix socket admin level */
3224 { "expose-fd", bind_parse_expose_fd, 1 }, /* set the unix socket expose fd rights */
Andjelko Iharosc4df59e2017-07-20 11:59:48 +02003225 { "severity-output", bind_parse_severity_output, 1 }, /* set the severity output format */
William Lallemand74c24fb2016-11-21 17:18:36 +01003226 { NULL, NULL, 0 },
3227}};
3228
Willy Tarreau0108d902018-11-25 19:14:37 +01003229INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
William Lallemand74c24fb2016-11-21 17:18:36 +01003230
3231/*
3232 * Local variables:
3233 * c-indent-level: 8
3234 * c-basic-offset: 8
3235 * End:
3236 */