GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2011 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The management process' CLI handling
 */

#include "config.h"

#include <sys/types.h>
#include <sys/socket.h>

#include <fcntl.h>
#include <poll.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "mgt/mgt.h"
#include "common/heritage.h"

#include "vcli_serve.h"
#include "vev.h"
#include "vrnd.h"
#include "vsa.h"
#include "vss.h"
#include "vtcp.h"

#define CLI_CMD(U,l,s,h,d,m,M) \
const struct cli_cmd_desc CLICMD_##U[1] = {{ l, s, h, d, m, M }};
#include "tbl/cli_cmds.h"

static const struct cli_cmd_desc *cmds[] = {
#define CLI_CMD(U,l,s,h,d,m,M) CLICMD_##U,
#include "tbl/cli_cmds.h"
};

static const int ncmds = sizeof cmds / sizeof cmds[0];

static int              cli_i = -1, cli_o = -1;
struct VCLS             *mgt_cls;
static const char       *secret_file;

static struct vsb       *cli_buf = NULL;

/*--------------------------------------------------------------------*/

static void v_matchproto_(cli_func_t)
mcf_banner(struct cli *cli, const char *const *av, void *priv)
{

        (void)av;
        (void)priv;
        VCLI_Out(cli, "-----------------------------\n");
        VCLI_Out(cli, "Varnish Cache CLI 1.0\n");
        VCLI_Out(cli, "-----------------------------\n");
        VCLI_Out(cli, "%s\n", VSB_data(vident) + 1);
        VCLI_Out(cli, "%s\n", VCS_String("V"));
        VCLI_Out(cli, "\n");
        VCLI_Out(cli, "Type 'help' for command list.\n");
        VCLI_Out(cli, "Type 'quit' to close CLI session.\n");
        if (!MCH_Running())
                VCLI_Out(cli, "Type 'start' to launch worker process.\n");
        VCLI_SetResult(cli, CLIS_OK);
}

/*--------------------------------------------------------------------*/

static struct cli_proto cli_proto[] = {
        { CLICMD_BANNER,                "", mcf_banner },
        { NULL }
};

/*--------------------------------------------------------------------*/

static void v_noreturn_ v_matchproto_(cli_func_t)
mcf_panic(struct cli *cli, const char * const *av, void *priv)
{

        (void)cli;
        (void)av;
        (void)priv;
        v_gcov_flush();
        AZ(strcmp("", "You asked for it"));
        /* NOTREACHED */
        abort();
}

static struct cli_proto cli_debug[] = {
        { CLICMD_DEBUG_PANIC_MASTER,            "d", mcf_panic },
        { NULL }
};

/*--------------------------------------------------------------------*/

static void v_matchproto_(cli_func_t)
mcf_askchild(struct cli *cli, const char * const *av, void *priv)
{
        int i;
        char *q;
        unsigned u;

        (void)priv;
        /*
         * Command not recognized in master, try cacher if it is
         * running.
         */
        if (cli_o <= 0) {
                VCLI_SetResult(cli, CLIS_UNKNOWN);
                VCLI_Out(cli,
                    "Unknown request in manager process "
                    "(child not running).\n"
                    "Type 'help' for more info.");
                return;
        }
        VSB_clear(cli_buf);
        for (i = 1; av[i] != NULL; i++) {
                VSB_quote(cli_buf, av[i], strlen(av[i]), 0);
                VSB_putc(cli_buf, ' ');
        }
        VSB_putc(cli_buf, '\n');
        AZ(VSB_finish(cli_buf));
        if (VSB_tofile(cli_buf, cli_o)) {
                VCLI_SetResult(cli, CLIS_COMMS);
                VCLI_Out(cli, "CLI communication error");
                MCH_Cli_Fail();
                return;
        }
        if (VCLI_ReadResult(cli_i, &u, &q, mgt_param.cli_timeout))
                MCH_Cli_Fail();
        VCLI_SetResult(cli, u);
        VCLI_Out(cli, "%s", q);
        free(q);
}

static const struct cli_cmd_desc CLICMD_WILDCARD[1] =
    {{ "*", "<wild-card-entry>", "<fall through to cacher>", "", 0, 999 }};

static struct cli_proto cli_askchild[] = {
        { CLICMD_WILDCARD, "h*", mcf_askchild, mcf_askchild },
        { NULL }
};

/*--------------------------------------------------------------------
 * Ask the child something over CLI, return zero only if everything is
 * happy happy.
 */

int
mgt_cli_askchild(unsigned *status, char **resp, const char *fmt, ...)
{
        int i;
        va_list ap;
        unsigned u;

        AN(status);
        VSB_clear(cli_buf);

        if (resp != NULL)
                *resp = NULL;
        *status = 0;
        if (cli_i < 0 || cli_o < 0) {
                *status = CLIS_CANT;
                return (CLIS_CANT);
        }
        va_start(ap, fmt);
        AZ(VSB_vprintf(cli_buf, fmt, ap));
        va_end(ap);
        AZ(VSB_finish(cli_buf));
        i = VSB_len(cli_buf);
        assert(i > 0 && VSB_data(cli_buf)[i - 1] == '\n');
        if (VSB_tofile(cli_buf, cli_o)) {
                *status = CLIS_COMMS;
                if (resp != NULL)
                        *resp = strdup("CLI communication error");
                MCH_Cli_Fail();
                return (CLIS_COMMS);
        }

        if (VCLI_ReadResult(cli_i, &u, resp, mgt_param.cli_timeout))
                MCH_Cli_Fail();
        *status = u;
        return (u == CLIS_OK || u == CLIS_TRUNCATED ? 0 : u);
}

/*--------------------------------------------------------------------*/

unsigned
mgt_cli_start_child(int fd, double tmo)
{
        unsigned u;

        cli_i = fd;
        cli_o = fd;
        if (VCLI_ReadResult(cli_i, &u, NULL, tmo)) {
                return (CLIS_COMMS);
        }
        return (u);
}

/*--------------------------------------------------------------------*/

void
mgt_cli_stop_child(void)
{

        cli_i = -1;
        cli_o = -1;
        /* XXX: kick any users */
}

/*--------------------------------------------------------------------
 * Generate a random challenge
 */

static void
mgt_cli_challenge(struct cli *cli)
{
        size_t z;
        uint8_t u;

        AZ(VRND_RandomCrypto(cli->challenge, sizeof cli->challenge - 2));
        for (z = 0; z < (sizeof cli->challenge) - 2; z++) {
                AZ(VRND_RandomCrypto(&u, sizeof u));
                cli->challenge[z] = (u % 26) + 'a';
        }
        cli->challenge[z++] = '\n';
        cli->challenge[z] = '\0';
        VCLI_Out(cli, "%s", cli->challenge);
        VCLI_Out(cli, "\nAuthentication required.\n");
        VCLI_SetResult(cli, CLIS_AUTH);
}

/*--------------------------------------------------------------------
 * Validate the authentication
 */

static void
mcf_auth(struct cli *cli, const char *const *av, void *priv)
{
        int fd;
        char buf[CLI_AUTH_RESPONSE_LEN + 1];

        AN(av[2]);
        (void)priv;
        if (secret_file == NULL) {
                VCLI_Out(cli, "Secret file not configured\n");
                VCLI_SetResult(cli, CLIS_CANT);
                return;
        }
        VJ_master(JAIL_MASTER_FILE);
        fd = open(secret_file, O_RDONLY);
        if (fd < 0) {
                VCLI_Out(cli, "Cannot open secret file (%s)\n",
                    VAS_errtxt(errno));
                VCLI_SetResult(cli, CLIS_CANT);
                VJ_master(JAIL_MASTER_LOW);
                return;
        }
        VJ_master(JAIL_MASTER_LOW);
        MCH_TrackHighFd(fd);
        VCLI_AuthResponse(fd, cli->challenge, buf);
        closefd(&fd);
        if (strcasecmp(buf, av[2])) {
                MGT_Complain(C_SECURITY,
                    "CLI Authentication failure from %s", cli->ident);
                VCLI_SetResult(cli, CLIS_CLOSE);
                return;
        }
        cli->auth = MCF_AUTH;
        memset(cli->challenge, 0, sizeof cli->challenge);
        VCLI_SetResult(cli, CLIS_OK);
        mcf_banner(cli, av, priv);
}

/*--------------------------------------------------------------------*/

static void v_matchproto_(cli_func_t)
mcf_help(struct cli *cli, const char * const *av, void *priv)
{
        if (cli_o <= 0)
                VCLS_func_help(cli, av, priv);
        else
                mcf_askchild(cli, av, priv);
}

static void v_matchproto_(cli_func_t)
mcf_help_json(struct cli *cli, const char * const *av, void *priv)
{
        if (cli_o <= 0)
                VCLS_func_help_json(cli, av, priv);
        else
                mcf_askchild(cli, av, priv);
}

static struct cli_proto cli_auth[] = {
        { CLICMD_HELP,          "", mcf_help, mcf_help_json },
        { CLICMD_PING,          "", VCLS_func_ping, VCLS_func_ping_json },
        { CLICMD_AUTH,          "", mcf_auth },
        { CLICMD_QUIT,          "", VCLS_func_close },
        { NULL }
};

/*--------------------------------------------------------------------*/

static void
mgt_cli_cb_before(const struct cli *cli)
{

        if (cli->priv == stderr)
                fprintf(stderr, "> %s\n", VSB_data(cli->cmd));
        MGT_Complain(C_CLI, "CLI %s Rd %s", cli->ident, VSB_data(cli->cmd));
}

static void
mgt_cli_cb_after(const struct cli *cli)
{

        MGT_Complain(C_CLI, "CLI %s Wr %03u %s",
            cli->ident, cli->result, VSB_data(cli->sb));
        if (cli->priv != stderr)
                return;
        if (cli->result == CLIS_TRUNCATED)
                ARGV_ERR("-I file had incomplete CLI command at the end\n");
        if (cli->result != CLIS_OK && *VSB_data(cli->cmd) != '-') {
                ARGV_ERR("-I file CLI command failed (%d)\n%s\n",
                    cli->result, VSB_data(cli->sb));
        }
}

/*--------------------------------------------------------------------*/

void
mgt_cli_init_cls(void)
{

        mgt_cls = VCLS_New(NULL);
        AN(mgt_cls);
        VCLS_SetHooks(mgt_cls, mgt_cli_cb_before, mgt_cli_cb_after);
        VCLS_AddFunc(mgt_cls, MCF_NOAUTH, cli_auth);
        VCLS_AddFunc(mgt_cls, MCF_AUTH, cli_proto);
        VCLS_AddFunc(mgt_cls, MCF_AUTH, cli_debug);
        VCLS_AddFunc(mgt_cls, MCF_AUTH, cli_askchild);
        cli_buf = VSB_new_auto();
        AN(cli_buf);
}

/*--------------------------------------------------------------------
 * Get rid of all CLI sessions
 */

void
mgt_cli_close_all(void)
{

        VCLS_Destroy(&mgt_cls);
}

/*--------------------------------------------------------------------
 * Callback whenever something happens to the input fd of the session.
 */

static int
mgt_cli_callback2(const struct vev *e, int what)
{
        int i;

        (void)what;
        i = VCLS_Poll(mgt_cls, e->priv, 0);
        return (i);
}

/*--------------------------------------------------------------------*/

void
mgt_cli_setup(int fdi, int fdo, int auth, const char *ident,
    mgt_cli_close_f *closefunc, void *priv)
{
        struct cli *cli;
        struct vev *ev;

        cli = VCLS_AddFd(mgt_cls, fdi, fdo, closefunc, priv);

        REPLACE(cli->ident, ident);

        if (!auth && secret_file != NULL) {
                cli->auth = MCF_NOAUTH;
                mgt_cli_challenge(cli);
        } else {
                cli->auth = MCF_AUTH;
                mcf_banner(cli, NULL, NULL);
        }
        AZ(VSB_finish(cli->sb));
        (void)VCLI_WriteResult(fdo, cli->result, VSB_data(cli->sb));

        ev = VEV_Alloc();
        AN(ev);
        ev->name = cli->ident;
        ev->fd = fdi;
        ev->fd_flags = VEV__RD;
        ev->callback = mgt_cli_callback2;
        ev->priv = cli;
        AZ(VEV_Start(mgt_evb, ev));
}

/*--------------------------------------------------------------------*/

static struct vsb *
sock_id(const char *pfx, int fd)
{
        struct vsb *vsb;

        char abuf1[VTCP_ADDRBUFSIZE], abuf2[VTCP_ADDRBUFSIZE];
        char pbuf1[VTCP_PORTBUFSIZE], pbuf2[VTCP_PORTBUFSIZE];

        vsb = VSB_new_auto();
        AN(vsb);
        VTCP_myname(fd, abuf1, sizeof abuf1, pbuf1, sizeof pbuf1);
        VTCP_hisname(fd, abuf2, sizeof abuf2, pbuf2, sizeof pbuf2);
        VSB_printf(vsb, "%s %s %s %s %s", pfx, abuf2, pbuf2, abuf1, pbuf1);
        AZ(VSB_finish(vsb));
        return (vsb);
}

/*--------------------------------------------------------------------*/

static int
telnet_accept(const struct vev *ev, int what)
{
        struct vsb *vsb;
        int i;

        (void)what;
        i = accept(ev->fd, NULL, NULL);
        if (i < 0 && errno == EBADF)
                return (1);
        if (i < 0)
                return (0);

        MCH_TrackHighFd(i);
        vsb = sock_id("telnet", i);
        mgt_cli_setup(i, i, 0, VSB_data(vsb), NULL, NULL);
        VSB_destroy(&vsb);
        return (0);
}

void
mgt_cli_secret(const char *S_arg)
{
        int i, fd;
        char buf[BUFSIZ];

        /* Save in shmem */
        mgt_SHM_static_alloc(S_arg, strlen(S_arg) + 1L, "Arg", "-S");

        VJ_master(JAIL_MASTER_FILE);
        fd = open(S_arg, O_RDONLY);
        if (fd < 0) {
                fprintf(stderr, "Can not open secret-file \"%s\"\n", S_arg);
                exit(2);
        }
        VJ_master(JAIL_MASTER_LOW);
        MCH_TrackHighFd(fd);
        i = read(fd, buf, sizeof buf);
        if (i == 0) {
                fprintf(stderr, "Empty secret-file \"%s\"\n", S_arg);
                exit(2);
        }
        if (i < 0) {
                fprintf(stderr, "Can not read secret-file \"%s\"\n", S_arg);
                exit(2);
        }
        closefd(&fd);
        secret_file = S_arg;
}

static int v_matchproto_(vss_resolved_f)
mct_callback(void *priv, const struct suckaddr *sa)
{
        int sock;
        struct vsb *vsb = priv;
        const char *err;
        char abuf[VTCP_ADDRBUFSIZE];
        char pbuf[VTCP_PORTBUFSIZE];
        struct vev *ev;

        VJ_master(JAIL_MASTER_PRIVPORT);
        sock = VTCP_listen(sa, 10, &err);
        VJ_master(JAIL_MASTER_LOW);
        assert(sock != 0);              // We know where stdin is
        if (sock > 0) {
                VTCP_myname(sock, abuf, sizeof abuf, pbuf, sizeof pbuf);
                VSB_printf(vsb, "%s %s\n", abuf, pbuf);
                ev = VEV_Alloc();
                AN(ev);
                ev->fd = sock;
                ev->fd_flags = POLLIN;
                ev->callback = telnet_accept;
                AZ(VEV_Start(mgt_evb, ev));
        }
        return (0);
}

void
mgt_cli_telnet(const char *T_arg)
{
        int error;
        const char *err;
        struct vsb *vsb;

        AN(T_arg);
        vsb = VSB_new_auto();
        AN(vsb);
        error = VSS_resolver(T_arg, NULL, mct_callback, vsb, &err);
        if (err != NULL)
                ARGV_ERR("Could not resolve -T argument to address\n\t%s\n",
                    err);
        AZ(error);
        AZ(VSB_finish(vsb));
        if (VSB_len(vsb) == 0)
                ARGV_ERR("-T %s could not be listened on.\n", T_arg);
        /* Save in shmem */
        mgt_SHM_static_alloc(VSB_data(vsb), VSB_len(vsb) + 1, "Arg", "-T");
        VSB_destroy(&vsb);
}

/* Reverse CLI ("Master") connections --------------------------------*/

struct m_addr {
        unsigned                magic;
#define M_ADDR_MAGIC            0xbc6217ed
        const struct suckaddr   *sa;
        VTAILQ_ENTRY(m_addr)    list;
};

static int M_fd = -1;
static struct vev *M_poker, *M_conn;
static double M_poll = 0.1;

static VTAILQ_HEAD(,m_addr)     m_addr_list =
    VTAILQ_HEAD_INITIALIZER(m_addr_list);

static int v_matchproto_(mgt_cli_close_f)
Marg_closer(void *priv)
{

        (void)priv;
        M_fd = -1;
        return (0);
}

static int v_matchproto_(vev_cb_f)
Marg_connect(const struct vev *e, int what)
{
        struct vsb *vsb;
        struct m_addr *ma;

        assert(e == M_conn);
        (void)what;

        M_fd = VTCP_connected(M_fd);
        if (M_fd < 0) {
                MGT_Complain(C_INFO, "Could not connect to CLI-master: %s",
                        VAS_errtxt(errno));
                ma = VTAILQ_FIRST(&m_addr_list);
                AN(ma);
                VTAILQ_REMOVE(&m_addr_list, ma, list);
                VTAILQ_INSERT_TAIL(&m_addr_list, ma, list);
                if (M_poll < 10)
                        M_poll++;
                return (1);
        }
        vsb = sock_id("master", M_fd);
        mgt_cli_setup(M_fd, M_fd, 0, VSB_data(vsb), Marg_closer, NULL);
        VSB_destroy(&vsb);
        M_poll = 1;
        return (1);
}

static int v_matchproto_(vev_cb_f)
Marg_poker(const struct vev *e, int what)
{
        int s;
        struct m_addr *ma;

        assert(e == M_poker);
        (void)what;

        M_poker->timeout = M_poll;      /* XXX nasty ? */
        if (M_fd > 0)
                return (0);

        ma = VTAILQ_FIRST(&m_addr_list);
        AN(ma);

        /* Try to connect asynchronously */
        s = VTCP_connect(ma->sa, -1);
        if (s < 0)
                return (0);

        MCH_TrackHighFd(s);

        M_conn = VEV_Alloc();
        AN(M_conn);
        M_conn->callback = Marg_connect;
        M_conn->name = "-M connector";
        M_conn->fd_flags = VEV__WR;
        M_conn->fd = s;
        M_fd = s;
        AZ(VEV_Start(mgt_evb, M_conn));
        return (0);
}

static int v_matchproto_(vss_resolved_f)
marg_cb(void *priv, const struct suckaddr *sa)
{
        struct m_addr *ma;

        (void)priv;
        ALLOC_OBJ(ma, M_ADDR_MAGIC);
        AN(ma);
        ma->sa = VSA_Clone(sa);
        VTAILQ_INSERT_TAIL(&m_addr_list, ma, list);
        return (0);
}

void
mgt_cli_master(const char *M_arg)
{
        const char *err;
        int error;

        AN(M_arg);

        error = VSS_resolver(M_arg, NULL, marg_cb, NULL, &err);
        if (err != NULL)
                ARGV_ERR("Could not resolve -M argument to address\n\t%s\n",
                    err);
        AZ(error);
        if (VTAILQ_EMPTY(&m_addr_list))
                ARGV_ERR("Could not resolve -M argument to address\n");
        AZ(M_poker);
        M_poker = VEV_Alloc();
        AN(M_poker);
        M_poker->timeout = M_poll;
        M_poker->callback = Marg_poker;
        M_poker->name = "-M poker";
        AZ(VEV_Start(mgt_evb, M_poker));
}

static int
cli_cmp(const void *a, const void *b)
{
        struct cli_cmd_desc * const * const aa = a;
        struct cli_cmd_desc * const * const bb = b;

        return (strcmp((*aa)->request, (*bb)->request));
}

void
mgt_DumpRstCli(void)
{
        const struct cli_cmd_desc *cp;
        const char *p;
        int z;
        size_t j;

        qsort(cmds, ncmds, sizeof cmds[0], cli_cmp);
        for (z = 0; z < ncmds; z++, cp++) {
                cp = cmds[z];
                if (!strncmp(cp->request, "debug.", 6))
                        continue;
                printf(".. _ref_cli_");
                for (p = cp->request; *p; p++)
                        fputc(*p == '.' ? '_' : *p, stdout);
                printf(":\n\n");
                printf("%s\n", cp->syntax);
                for (j = 0; j < strlen(cp->syntax); j++)
                        printf("~");
                printf("\n");
                printf("  %s\n", cp->help);
                if (*cp->doc != '\0')
                        printf("\n%s\n", cp->doc);

                printf("\n");
        }
}

		varnish-cache/bin/varnishd/mgt/mgt_cli.c
0		/*-
1		* Copyright (c) 2006 Verdens Gang AS
2		* Copyright (c) 2006-2011 Varnish Software AS
3		* All rights reserved.
4		*
5		* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6		*
7		* SPDX-License-Identifier: BSD-2-Clause
8		*
9		* Redistribution and use in source and binary forms, with or without
10		* modification, are permitted provided that the following conditions
11		* are met:
12		* 1. Redistributions of source code must retain the above copyright
13		* notice, this list of conditions and the following disclaimer.
14		* 2. Redistributions in binary form must reproduce the above copyright
15		* notice, this list of conditions and the following disclaimer in the
16		* documentation and/or other materials provided with the distribution.
17		*
18		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28		* SUCH DAMAGE.
29		*
30		* The management process' CLI handling
31		*/
32
33		#include "config.h"
34
35		#include <sys/types.h>
36		#include <sys/socket.h>
37
38		#include <fcntl.h>
39		#include <poll.h>
40		#include <stdarg.h>
41		#include <stdio.h>
42		#include <stdlib.h>
43		#include <string.h>
44		#include <unistd.h>
45
46		#include "mgt/mgt.h"
47		#include "common/heritage.h"
48
49		#include "vcli_serve.h"
50		#include "vev.h"
51		#include "vrnd.h"
52		#include "vsa.h"
53		#include "vss.h"
54		#include "vtcp.h"
55
56		#define CLI_CMD(U,l,s,h,d,m,M) \
57		const struct cli_cmd_desc CLICMD_##U[1] = {{ l, s, h, d, m, M }};
58		#include "tbl/cli_cmds.h"
59
60		static const struct cli_cmd_desc *cmds[] = {
61		#define CLI_CMD(U,l,s,h,d,m,M) CLICMD_##U,
62		#include "tbl/cli_cmds.h"
63		};
64
65		static const int ncmds = sizeof cmds / sizeof cmds[0];
66
67		static int cli_i = -1, cli_o = -1;
68		struct VCLS *mgt_cls;
69		static const char *secret_file;
70
71		static struct vsb *cli_buf = NULL;
72
73		/--------------------------------------------------------------------/
74
75		static void v_matchproto_(cli_func_t)
76	46425	mcf_banner(struct cli cli, const char const av, void priv)
77		{
78
79	46425	(void)av;
80	46425	(void)priv;
81	46425	VCLI_Out(cli, "-----------------------------\n");
82	46425	VCLI_Out(cli, "Varnish Cache CLI 1.0\n");
83	46425	VCLI_Out(cli, "-----------------------------\n");
84	46425	VCLI_Out(cli, "%s\n", VSB_data(vident) + 1);
85	46425	VCLI_Out(cli, "%s\n", VCS_String("V"));
86	46425	VCLI_Out(cli, "\n");
87	46425	VCLI_Out(cli, "Type 'help' for command list.\n");
88	46425	VCLI_Out(cli, "Type 'quit' to close CLI session.\n");
89	46425	if (!MCH_Running())
90	45650	VCLI_Out(cli, "Type 'start' to launch worker process.\n");
91	46425	VCLI_SetResult(cli, CLIS_OK);
92	46425	}
93
94		/--------------------------------------------------------------------/
95
96		static struct cli_proto cli_proto[] = {
97		{ CLICMD_BANNER, "", mcf_banner },
98		{ NULL }
99		};
100
101		/--------------------------------------------------------------------/
102
103		static void v_noreturn_ v_matchproto_(cli_func_t)
104	0	mcf_panic(struct cli cli, const char const av, void priv)
105		{
106
107	0	(void)cli;
108	0	(void)av;
109	0	(void)priv;
110	0	v_gcov_flush();
111	0	AZ(strcmp("", "You asked for it"));
112		/* NOTREACHED */
113	0	abort();
114		}
115
116		static struct cli_proto cli_debug[] = {
117		{ CLICMD_DEBUG_PANIC_MASTER, "d", mcf_panic },
118		{ NULL }
119		};
120
121		/--------------------------------------------------------------------/
122
123		static void v_matchproto_(cli_func_t)
124	97225	mcf_askchild(struct cli cli, const char const av, void priv)
125		{
126		int i;
127		char *q;
128		unsigned u;
129
130	97225	(void)priv;
131		/*
132		* Command not recognized in master, try cacher if it is
133		* running.
134		*/
135	97225	if (cli_o <= 0) {
136	1600	VCLI_SetResult(cli, CLIS_UNKNOWN);
137	1600	VCLI_Out(cli,
138		"Unknown request in manager process "
139		"(child not running).\n"
140		"Type 'help' for more info.");
141	1600	return;
142		}
143	95625	VSB_clear(cli_buf);
144	224775	for (i = 1; av[i] != NULL; i++) {
145	129150	VSB_quote(cli_buf, av[i], strlen(av[i]), 0);
146	129150	VSB_putc(cli_buf, ' ');
147	129150	}
148	95625	VSB_putc(cli_buf, '\n');
149	95625	AZ(VSB_finish(cli_buf));
150	95625	if (VSB_tofile(cli_buf, cli_o)) {
151	0	VCLI_SetResult(cli, CLIS_COMMS);
152	0	VCLI_Out(cli, "CLI communication error");
153	0	MCH_Cli_Fail();
154	0	return;
155		}
156	95625	if (VCLI_ReadResult(cli_i, &u, &q, mgt_param.cli_timeout))
157	25	MCH_Cli_Fail();
158	95625	VCLI_SetResult(cli, u);
159	95625	VCLI_Out(cli, "%s", q);
160	95625	free(q);
161	97225	}
162
163		static const struct cli_cmd_desc CLICMD_WILDCARD[1] =
164		{{ "*", "<wild-card-entry>", "<fall through to cacher>", "", 0, 999 }};
165
166		static struct cli_proto cli_askchild[] = {
167		{ CLICMD_WILDCARD, "h*", mcf_askchild, mcf_askchild },
168		{ NULL }
169		};
170
171		/*--------------------------------------------------------------------
172		* Ask the child something over CLI, return zero only if everything is
173		* happy happy.
174		*/
175
176		int
177	88226	mgt_cli_askchild(unsigned status, char resp, const char fmt, ...)
178		{
179		int i;
180		va_list ap;
181		unsigned u;
182
183	88226	AN(status);
184	88226	VSB_clear(cli_buf);
185
186	88226	if (resp != NULL)
187	88226	*resp = NULL;
188	88226	*status = 0;
189	88226	if (cli_i < 0 \|\| cli_o < 0) {
190	0	*status = CLIS_CANT;
191	0	return (CLIS_CANT);
192		}
193	88226	va_start(ap, fmt);
194	88226	AZ(VSB_vprintf(cli_buf, fmt, ap));
195	88226	va_end(ap);
196	88226	AZ(VSB_finish(cli_buf));
197	88226	i = VSB_len(cli_buf);
198	88226	assert(i > 0 && VSB_data(cli_buf)[i - 1] == '\n');
199	88226	if (VSB_tofile(cli_buf, cli_o)) {
200	0	*status = CLIS_COMMS;
201	0	if (resp != NULL)
202	0	*resp = strdup("CLI communication error");
203	0	MCH_Cli_Fail();
204	0	return (CLIS_COMMS);
205		}
206
207	88226	if (VCLI_ReadResult(cli_i, &u, resp, mgt_param.cli_timeout))
208	25	MCH_Cli_Fail();
209	88226	*status = u;
210	88226	return (u == CLIS_OK \|\| u == CLIS_TRUNCATED ? 0 : u);
211	88226	}
212
213		/--------------------------------------------------------------------/
214
215		unsigned
216	22775	mgt_cli_start_child(int fd, double tmo)
217		{
218		unsigned u;
219
220	22775	cli_i = fd;
221	22775	cli_o = fd;
222	22775	if (VCLI_ReadResult(cli_i, &u, NULL, tmo)) {
223	200	return (CLIS_COMMS);
224		}
225	22575	return (u);
226	22775	}
227
228		/--------------------------------------------------------------------/
229
230		void
231	22775	mgt_cli_stop_child(void)
232		{
233
234	22775	cli_i = -1;
235	22775	cli_o = -1;
236		/* XXX: kick any users */
237	22775	}
238
239		/*--------------------------------------------------------------------
240		* Generate a random challenge
241		*/
242
243		static void
244	23600	mgt_cli_challenge(struct cli *cli)
245		{
246		size_t z;
247		uint8_t u;
248
249	23600	AZ(VRND_RandomCrypto(cli->challenge, sizeof cli->challenge - 2));
250	778800	for (z = 0; z < (sizeof cli->challenge) - 2; z++) {
251	755200	AZ(VRND_RandomCrypto(&u, sizeof u));
252	755200	cli->challenge[z] = (u % 26) + 'a';
253	755200	}
254	23600	cli->challenge[z++] = '\n';
255	23600	cli->challenge[z] = '\0';
256	23600	VCLI_Out(cli, "%s", cli->challenge);
257	23600	VCLI_Out(cli, "\nAuthentication required.\n");
258	23600	VCLI_SetResult(cli, CLIS_AUTH);
259	23600	}
260
261		/*--------------------------------------------------------------------
262		* Validate the authentication
263		*/
264
265		static void
266	23600	mcf_auth(struct cli cli, const char const av, void priv)
267		{
268		int fd;
269		char buf[CLI_AUTH_RESPONSE_LEN + 1];
270
271	23600	AN(av[2]);
272	23600	(void)priv;
273	23600	if (secret_file == NULL) {
274	0	VCLI_Out(cli, "Secret file not configured\n");
275	0	VCLI_SetResult(cli, CLIS_CANT);
276	0	return;
277		}
278	23600	VJ_master(JAIL_MASTER_FILE);
279	23600	fd = open(secret_file, O_RDONLY);
280	23600	if (fd < 0) {
281	0	VCLI_Out(cli, "Cannot open secret file (%s)\n",
282	0	VAS_errtxt(errno));
283	0	VCLI_SetResult(cli, CLIS_CANT);
284	0	VJ_master(JAIL_MASTER_LOW);
285	0	return;
286		}
287	23600	VJ_master(JAIL_MASTER_LOW);
288	23600	MCH_TrackHighFd(fd);
289	23600	VCLI_AuthResponse(fd, cli->challenge, buf);
290	23600	closefd(&fd);
291	23600	if (strcasecmp(buf, av[2])) {
292	0	MGT_Complain(C_SECURITY,
293	0	"CLI Authentication failure from %s", cli->ident);
294	0	VCLI_SetResult(cli, CLIS_CLOSE);
295	0	return;
296		}
297	23600	cli->auth = MCF_AUTH;
298	23600	memset(cli->challenge, 0, sizeof cli->challenge);
299	23600	VCLI_SetResult(cli, CLIS_OK);
300	23600	mcf_banner(cli, av, priv);
301	23600	}
302
303		/--------------------------------------------------------------------/
304
305		static void v_matchproto_(cli_func_t)
306	500	mcf_help(struct cli cli, const char const av, void priv)
307		{
308	500	if (cli_o <= 0)
309	350	VCLS_func_help(cli, av, priv);
310		else
311	150	mcf_askchild(cli, av, priv);
312	500	}
313
314		static void v_matchproto_(cli_func_t)
315	175	mcf_help_json(struct cli cli, const char const av, void priv)
316		{
317	175	if (cli_o <= 0)
318	0	VCLS_func_help_json(cli, av, priv);
319		else
320	175	mcf_askchild(cli, av, priv);
321	175	}
322
323		static struct cli_proto cli_auth[] = {
324		{ CLICMD_HELP, "", mcf_help, mcf_help_json },
325		{ CLICMD_PING, "", VCLS_func_ping, VCLS_func_ping_json },
326		{ CLICMD_AUTH, "", mcf_auth },
327		{ CLICMD_QUIT, "", VCLS_func_close },
328		{ NULL }
329		};
330
331		/--------------------------------------------------------------------/
332
333		static void
334	322025	mgt_cli_cb_before(const struct cli *cli)
335		{
336
337	322025	if (cli->priv == stderr)
338	100	fprintf(stderr, "> %s\n", VSB_data(cli->cmd));
339	322025	MGT_Complain(C_CLI, "CLI %s Rd %s", cli->ident, VSB_data(cli->cmd));
340	322025	}
341
342		static void
343	322075	mgt_cli_cb_after(const struct cli *cli)
344		{
345
346	322075	MGT_Complain(C_CLI, "CLI %s Wr %03u %s",
347	322075	cli->ident, cli->result, VSB_data(cli->sb));
348	322075	if (cli->priv != stderr)
349	321925	return;
350	150	if (cli->result == CLIS_TRUNCATED)
351	50	ARGV_ERR("-I file had incomplete CLI command at the end\n");
352	100	if (cli->result != CLIS_OK && *VSB_data(cli->cmd) != '-') {
353	25	ARGV_ERR("-I file CLI command failed (%d)\n%s\n",
354		cli->result, VSB_data(cli->sb));
355	0	}
356	322000	}
357
358		/--------------------------------------------------------------------/
359
360		void
361	24800	mgt_cli_init_cls(void)
362		{
363
364	24800	mgt_cls = VCLS_New(NULL);
365	24800	AN(mgt_cls);
366	24800	VCLS_SetHooks(mgt_cls, mgt_cli_cb_before, mgt_cli_cb_after);
367	24800	VCLS_AddFunc(mgt_cls, MCF_NOAUTH, cli_auth);
368	24800	VCLS_AddFunc(mgt_cls, MCF_AUTH, cli_proto);
369	24800	VCLS_AddFunc(mgt_cls, MCF_AUTH, cli_debug);
370	24800	VCLS_AddFunc(mgt_cls, MCF_AUTH, cli_askchild);
371	24800	cli_buf = VSB_new_auto();
372	24800	AN(cli_buf);
373	24800	}
374
375		/*--------------------------------------------------------------------
376		* Get rid of all CLI sessions
377		*/
378
379		void
380	22700	mgt_cli_close_all(void)
381		{
382
383	22700	VCLS_Destroy(&mgt_cls);
384	22700	}
385
386		/*--------------------------------------------------------------------
387		* Callback whenever something happens to the input fd of the session.
388		*/
389
390		static int
391	661999	mgt_cli_callback2(const struct vev *e, int what)
392		{
393		int i;
394
395	661999	(void)what;
396	661999	i = VCLS_Poll(mgt_cls, e->priv, 0);
397	661999	return (i);
398		}
399
400		/--------------------------------------------------------------------/
401
402		void
403	46400	mgt_cli_setup(int fdi, int fdo, int auth, const char *ident,
404		mgt_cli_close_f closefunc, void priv)
405		{
406		struct cli *cli;
407		struct vev *ev;
408
409	46400	cli = VCLS_AddFd(mgt_cls, fdi, fdo, closefunc, priv);
410
411	46400	REPLACE(cli->ident, ident);
412
413	46400	if (!auth && secret_file != NULL) {
414	23600	cli->auth = MCF_NOAUTH;
415	23600	mgt_cli_challenge(cli);
416	23600	} else {
417	22800	cli->auth = MCF_AUTH;
418	22800	mcf_banner(cli, NULL, NULL);
419		}
420	46400	AZ(VSB_finish(cli->sb));
421	46400	(void)VCLI_WriteResult(fdo, cli->result, VSB_data(cli->sb));
422
423	46400	ev = VEV_Alloc();
424	46400	AN(ev);
425	46400	ev->name = cli->ident;
426	46400	ev->fd = fdi;
427	46400	ev->fd_flags = VEV__RD;
428	46400	ev->callback = mgt_cli_callback2;
429	46400	ev->priv = cli;
430	46400	AZ(VEV_Start(mgt_evb, ev));
431	46400	}
432
433		/--------------------------------------------------------------------/
434
435		static struct vsb *
436	23600	sock_id(const char *pfx, int fd)
437		{
438		struct vsb *vsb;
439
440		char abuf1[VTCP_ADDRBUFSIZE], abuf2[VTCP_ADDRBUFSIZE];
441		char pbuf1[VTCP_PORTBUFSIZE], pbuf2[VTCP_PORTBUFSIZE];
442
443	23600	vsb = VSB_new_auto();
444	23600	AN(vsb);
445	23600	VTCP_myname(fd, abuf1, sizeof abuf1, pbuf1, sizeof pbuf1);
446	23600	VTCP_hisname(fd, abuf2, sizeof abuf2, pbuf2, sizeof pbuf2);
447	23600	VSB_printf(vsb, "%s %s %s %s %s", pfx, abuf2, pbuf2, abuf1, pbuf1);
448	23600	AZ(VSB_finish(vsb));
449	23600	return (vsb);
450		}
451
452		/--------------------------------------------------------------------/
453
454		static int
455	975	telnet_accept(const struct vev *ev, int what)
456		{
457		struct vsb *vsb;
458		int i;
459
460	975	(void)what;
461	975	i = accept(ev->fd, NULL, NULL);
462	975	if (i < 0 && errno == EBADF)
463	0	return (1);
464	975	if (i < 0)
465	0	return (0);
466
467	975	MCH_TrackHighFd(i);
468	975	vsb = sock_id("telnet", i);
469	975	mgt_cli_setup(i, i, 0, VSB_data(vsb), NULL, NULL);
470	975	VSB_destroy(&vsb);
471	975	return (0);
472	975	}
473
474		void
475	22900	mgt_cli_secret(const char *S_arg)
476		{
477		int i, fd;
478		char buf[BUFSIZ];
479
480		/* Save in shmem */
481	22900	mgt_SHM_static_alloc(S_arg, strlen(S_arg) + 1L, "Arg", "-S");
482
483	22900	VJ_master(JAIL_MASTER_FILE);
484	22900	fd = open(S_arg, O_RDONLY);
485	22900	if (fd < 0) {
486	0	fprintf(stderr, "Can not open secret-file \"%s\"\n", S_arg);
487	0	exit(2);
488		}
489	22900	VJ_master(JAIL_MASTER_LOW);
490	22900	MCH_TrackHighFd(fd);
491	22900	i = read(fd, buf, sizeof buf);
492	22900	if (i == 0) {
493	0	fprintf(stderr, "Empty secret-file \"%s\"\n", S_arg);
494	0	exit(2);
495		}
496	22900	if (i < 0) {
497	0	fprintf(stderr, "Can not read secret-file \"%s\"\n", S_arg);
498	0	exit(2);
499		}