| /* |
| $Id: command.c,v 1.47 2005/04/25 16:26:42 paul Exp $ |
| |
| Command interpreter routine for virtual terminal [aka TeletYpe] |
| Copyright (C) 1997, 98, 99 Kunihiro Ishiguro |
| Copyright (C) 2010-2011 Holger Hans Peter Freyther <zecke@selfish.org> |
| Copyright (C) 2012 Sylvain Munaut <tnt@246tNt.com> |
| Copyright (C) 2013,2015 Harald Welte <laforge@gnumonks.org> |
| Copyright (C) 2013,2017 sysmocom - s.f.m.c. GmbH |
| |
| SPDX-License-Identifier: GPL-2.0+ |
| |
| This file is part of GNU Zebra. |
| |
| GNU Zebra is free software; you can redistribute it and/or modify |
| it under the terms of the GNU General Public License as published |
| by the Free Software Foundation; either version 2, or (at your |
| option) any later version. |
| |
| GNU Zebra is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| General Public License for more details. |
| |
| You should have received a copy of the GNU General Public License |
| along with GNU Zebra; see the file COPYING. If not, write to the |
| Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| Boston, MA 02110-1301, USA. */ |
| |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <string.h> |
| #include <stdbool.h> |
| #include <syslog.h> |
| #include <errno.h> |
| #define _XOPEN_SOURCE |
| #include <unistd.h> |
| #include <ctype.h> |
| #include <time.h> |
| #include <limits.h> |
| #include <signal.h> |
| #include <sys/time.h> |
| #include <sys/stat.h> |
| #include <sys/types.h> |
| |
| #include <osmocom/vty/vector.h> |
| #include <osmocom/vty/vty.h> |
| #include <osmocom/vty/command.h> |
| |
| #include <osmocom/core/logging.h> |
| #include <osmocom/core/talloc.h> |
| #include <osmocom/core/timer.h> |
| #include <osmocom/core/utils.h> |
| |
| #ifndef MAXPATHLEN |
| #define MAXPATHLEN 4096 |
| #endif |
| |
| |
| /*! \addtogroup command |
| * @{ |
| * VTY command handling |
| * |
| * \file command.c */ |
| |
| #define CONFIGFILE_MASK 022 |
| |
| void *tall_vty_cmd_ctx; |
| |
| /* Set by on_dso_load_starttime() for "show uptime". */ |
| static struct timespec starttime; |
| |
| /* Command vector which includes some level of command lists. Normally |
| each daemon maintains each own cmdvec. */ |
| vector cmdvec; |
| |
| /* Host information structure. */ |
| struct host host; |
| |
| /* Standard command node structures. */ |
| struct cmd_node auth_node = { |
| AUTH_NODE, |
| "Password: ", |
| .name = "auth", |
| }; |
| |
| struct cmd_node view_node = { |
| VIEW_NODE, |
| "%s> ", |
| .name = "view", |
| }; |
| |
| struct cmd_node auth_enable_node = { |
| AUTH_ENABLE_NODE, |
| "Password: ", |
| .name = "auth-enable", |
| }; |
| |
| struct cmd_node enable_node = { |
| ENABLE_NODE, |
| "%s# ", |
| .name = "enable", |
| }; |
| |
| struct cmd_node config_node = { |
| CONFIG_NODE, |
| "%s(config)# ", |
| 1 |
| }; |
| |
| /* Default motd string. */ |
| const char *default_motd = ""; |
| |
| /*! print the version (and optionally copyright) information |
| * |
| * This is called from main when a daemon is invoked with -v or --version. */ |
| void print_version(int print_copyright) |
| { |
| printf("%s version %s\n", host.app_info->name, host.app_info->version); |
| if (print_copyright) |
| printf("\n%s\n", host.app_info->copyright); |
| } |
| |
| /* Utility function to concatenate argv argument into a single string |
| with inserting ' ' character between each argument. */ |
| char *argv_concat(const char **argv, int argc, int shift) |
| { |
| int i; |
| size_t len; |
| char *str; |
| char *p; |
| |
| len = 0; |
| for (i = shift; i < argc; i++) |
| len += strlen(argv[i]) + 1; |
| if (!len) |
| return NULL; |
| p = str = _talloc_zero(tall_vty_cmd_ctx, len, "arvg_concat"); |
| for (i = shift; i < argc; i++) { |
| size_t arglen; |
| memcpy(p, argv[i], (arglen = strlen(argv[i]))); |
| p += arglen; |
| *p++ = ' '; |
| } |
| *(p - 1) = '\0'; |
| return str; |
| } |
| |
| /* Strip all characters from a string (prompt) except for alnum, '-' and '_'. |
| * For example used to derive a node->name from node->prompt if the user didn't provide a name; |
| * in turn, this name us used for XML IDs in 'show online-help'. */ |
| static const char *node_name_from_prompt(const char *prompt, char *name_buf, size_t name_buf_size) |
| { |
| const char *pos; |
| int dest = 0; |
| |
| if (!prompt || !*prompt) |
| return ""; |
| |
| for (pos = prompt; *pos && dest < (name_buf_size-1); pos++) { |
| if (pos[0] == '%' && pos[1]) { |
| /* skip "%s"; loop pos++ does the second one. */ |
| pos++; |
| continue; |
| } |
| if (!(isalnum(pos[0]) || pos[0] == '-' || pos[0] == '_')) |
| continue; |
| name_buf[dest] = pos[0]; |
| dest++; |
| } |
| name_buf[dest] = '\0'; |
| return name_buf; |
| } |
| |
| static void install_basic_node_commands(int node); |
| |
| /*! Install top node of command vector, without adding basic node commands. */ |
| static void install_node_bare(struct cmd_node *node, int (*func) (struct vty *)) |
| { |
| vector_set_index(cmdvec, node->node, node); |
| node->func = func; |
| node->cmd_vector = vector_init(VECTOR_MIN_SIZE); |
| if (!*node->name) |
| node_name_from_prompt(node->prompt, node->name, sizeof(node->name)); |
| } |
| |
| /*! Install top node of command vector. */ |
| void install_node(struct cmd_node *node, int (*func) (struct vty *)) |
| { |
| install_node_bare(node, func); |
| install_basic_node_commands(node->node); |
| } |
| |
| /* Compare two command's string. Used in sort_node (). */ |
| static int cmp_node(const void *p, const void *q) |
| { |
| struct cmd_element *a = *(struct cmd_element **)p; |
| struct cmd_element *b = *(struct cmd_element **)q; |
| |
| return strcmp(a->string, b->string); |
| } |
| |
| static int cmp_desc(const void *p, const void *q) |
| { |
| struct desc *a = *(struct desc **)p; |
| struct desc *b = *(struct desc **)q; |
| |
| return strcmp(a->cmd, b->cmd); |
| } |
| |
| /*! Sort each node's command element according to command string. */ |
| void sort_node(void) |
| { |
| unsigned int i, j; |
| struct cmd_node *cnode; |
| vector descvec; |
| struct cmd_element *cmd_element; |
| |
| for (i = 0; i < vector_active(cmdvec); i++) |
| if ((cnode = vector_slot(cmdvec, i)) != NULL) { |
| vector cmd_vector = cnode->cmd_vector; |
| qsort(cmd_vector->index, vector_active(cmd_vector), |
| sizeof(void *), cmp_node); |
| |
| for (j = 0; j < vector_active(cmd_vector); j++) |
| if ((cmd_element = |
| vector_slot(cmd_vector, j)) != NULL |
| && vector_active(cmd_element->strvec)) { |
| descvec = |
| vector_slot(cmd_element->strvec, |
| vector_active |
| (cmd_element->strvec) - |
| 1); |
| qsort(descvec->index, |
| vector_active(descvec), |
| sizeof(void *), cmp_desc); |
| } |
| } |
| } |
| |
| /*! Break up string in command tokens. Return leading indents. |
| * \param[in] string String to split. |
| * \param[out] indent If not NULL, return a talloc_strdup of indent characters. |
| * \param[out] strvec_p Returns vector of split tokens, must not be NULL. |
| * \returns CMD_SUCCESS or CMD_ERR_INVALID_INDENT |
| * |
| * If \a indent is passed non-NULL, only simple space ' ' indents are allowed, |
| * so that \a indent can simply return the count of leading spaces. |
| * Otherwise any isspace() characters are allowed for indenting (backwards compat). |
| */ |
| int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p) |
| { |
| const char *cp, *start; |
| char *token; |
| int strlen; |
| vector strvec; |
| |
| *strvec_p = NULL; |
| if (indent) |
| *indent = 0; |
| |
| if (string == NULL) |
| return CMD_SUCCESS; |
| |
| cp = string; |
| |
| /* Skip white spaces. */ |
| while (isspace((int)*cp) && *cp != '\0') { |
| /* if we're counting indents, we need to be strict about them */ |
| if (indent && (*cp != ' ') && (*cp != '\t')) { |
| /* Ignore blank lines, they appear as leading whitespace with line breaks. */ |
| if (*cp == '\n' || *cp == '\r') { |
| cp++; |
| string = cp; |
| continue; |
| } |
| return CMD_ERR_INVALID_INDENT; |
| } |
| cp++; |
| } |
| |
| if (indent) |
| *indent = talloc_strndup(tall_vty_cmd_ctx, string, cp - string); |
| |
| /* Return if there is only white spaces */ |
| if (*cp == '\0') |
| return CMD_SUCCESS; |
| |
| if (*cp == '!' || *cp == '#') |
| return CMD_SUCCESS; |
| |
| /* Prepare return vector. */ |
| strvec = vector_init(VECTOR_MIN_SIZE); |
| |
| /* Copy each command piece and set into vector. */ |
| while (1) { |
| start = cp; |
| while (!(isspace((int)*cp) || *cp == '\r' || *cp == '\n') && |
| *cp != '\0') |
| cp++; |
| strlen = cp - start; |
| token = _talloc_zero(tall_vty_cmd_ctx, strlen + 1, "make_strvec"); |
| memcpy(token, start, strlen); |
| *(token + strlen) = '\0'; |
| vector_set(strvec, token); |
| |
| while ((isspace((int)*cp) || *cp == '\n' || *cp == '\r') && |
| *cp != '\0') |
| cp++; |
| |
| if (*cp == '\0') |
| break; |
| } |
| |
| *strvec_p = strvec; |
| return CMD_SUCCESS; |
| } |
| |
| /*! Breaking up string into each command piece. I assume given |
| character is separated by a space character. Return value is a |
| vector which includes char ** data element. */ |
| vector cmd_make_strvec(const char *string) |
| { |
| vector strvec; |
| cmd_make_strvec2(string, NULL, &strvec); |
| return strvec; |
| } |
| |
| /*! Free allocated string vector. */ |
| void cmd_free_strvec(vector v) |
| { |
| unsigned int i; |
| char *cp; |
| |
| if (!v) |
| return; |
| |
| for (i = 0; i < vector_active(v); i++) |
| if ((cp = vector_slot(v, i)) != NULL) |
| talloc_free(cp); |
| |
| vector_free(v); |
| } |
| |
| /*! Fetch next description. Used in \ref cmd_make_descvec(). */ |
| static char *cmd_desc_str(const char **string) |
| { |
| const char *cp, *start; |
| char *token; |
| int strlen; |
| |
| cp = *string; |
| |
| if (cp == NULL) |
| return NULL; |
| |
| /* Skip white spaces. */ |
| while (isspace((int)*cp) && *cp != '\0') |
| cp++; |
| |
| /* Return if there is only white spaces */ |
| if (*cp == '\0') |
| return NULL; |
| |
| start = cp; |
| |
| while (!(*cp == '\r' || *cp == '\n') && *cp != '\0') |
| cp++; |
| |
| strlen = cp - start; |
| token = _talloc_zero(tall_vty_cmd_ctx, strlen + 1, "cmd_desc_str"); |
| memcpy(token, start, strlen); |
| *(token + strlen) = '\0'; |
| |
| *string = cp; |
| |
| return token; |
| } |
| |
| /*! New string vector. */ |
| static vector cmd_make_descvec(const char *string, const char *descstr) |
| { |
| int multiple = 0; |
| int optional_brace = 0; |
| const char *sp; |
| char *token; |
| int len; |
| const char *cp; |
| const char *dp; |
| vector allvec; |
| vector strvec = NULL; |
| struct desc *desc; |
| |
| cp = string; |
| dp = descstr; |
| |
| if (cp == NULL) |
| return NULL; |
| |
| allvec = vector_init(VECTOR_MIN_SIZE); |
| |
| while (1) { |
| while (isspace((int)*cp) && *cp != '\0') |
| cp++; |
| |
| /* Explicitly detect optional multi-choice braces like [(one|two)]. */ |
| if (cp[0] == '[' && cp[1] == '(') { |
| optional_brace = 1; |
| cp++; |
| } |
| |
| if (*cp == '(') { |
| multiple = 1; |
| cp++; |
| } |
| if (*cp == ')') { |
| multiple = 0; |
| cp++; |
| if (*cp == ']') |
| cp++; |
| optional_brace = 0; |
| } |
| if (*cp == '|') { |
| OSMO_ASSERT(multiple); |
| cp++; |
| } |
| |
| while (isspace((int)*cp) && *cp != '\0') |
| cp++; |
| |
| if (*cp == '(') { |
| multiple = 1; |
| cp++; |
| } |
| |
| if (*cp == '\0') |
| return allvec; |
| |
| sp = cp; |
| |
| while (! |
| (isspace((int)*cp) || *cp == '\r' || *cp == '\n' |
| || *cp == ')' || *cp == '|') && *cp != '\0') |
| cp++; |
| |
| len = cp - sp; |
| |
| token = _talloc_zero(tall_vty_cmd_ctx, len + (optional_brace? 2 : 0) + 1, "cmd_make_descvec"); |
| if (optional_brace) { |
| /* Place each individual multi-choice token in its own square braces */ |
| token[0] = '['; |
| memcpy(token + 1, sp, len); |
| token[1 + len] = ']'; |
| token[2 + len] = '\0'; |
| } else { |
| memcpy(token, sp, len); |
| *(token + len) = '\0'; |
| } |
| |
| desc = talloc_zero(tall_vty_cmd_ctx, struct desc); |
| desc->cmd = token; |
| desc->str = cmd_desc_str(&dp); |
| |
| if (multiple) { |
| if (multiple == 1) { |
| strvec = vector_init(VECTOR_MIN_SIZE); |
| vector_set(allvec, strvec); |
| } |
| multiple++; |
| } else { |
| strvec = vector_init(VECTOR_MIN_SIZE); |
| vector_set(allvec, strvec); |
| } |
| vector_set(strvec, desc); |
| } |
| } |
| |
| /* Count mandantory string vector size. This is to determine inputed |
| command has enough command length. */ |
| static int cmd_cmdsize(vector strvec) |
| { |
| unsigned int i; |
| int size = 0; |
| vector descvec; |
| struct desc *desc; |
| |
| for (i = 0; i < vector_active(strvec); i++) |
| if ((descvec = vector_slot(strvec, i)) != NULL) { |
| if ((vector_active(descvec)) >= 1 |
| && (desc = vector_slot(descvec, 0)) != NULL) { |
| if (desc->cmd == NULL || CMD_OPTION(desc->cmd)) |
| return size; |
| else |
| size++; |
| } else |
| size++; |
| } |
| return size; |
| } |
| |
| /*! Return prompt character of specified node. */ |
| const char *cmd_prompt(enum node_type node) |
| { |
| struct cmd_node *cnode; |
| |
| cnode = vector_slot(cmdvec, node); |
| return cnode->prompt; |
| } |
| |
| /*! |
| * escape all special asciidoc symbols |
| * \param unsafe string |
| * \return a new talloc char * |
| */ |
| char *osmo_asciidoc_escape(const char *inp) |
| { |
| int _strlen; |
| char *out, *out_ptr; |
| int len = 0, i; |
| |
| if (!inp) |
| return NULL; |
| _strlen = strlen(inp); |
| |
| for (i = 0; i < _strlen; ++i) { |
| switch (inp[i]) { |
| case '|': |
| len += 2; |
| break; |
| default: |
| len += 1; |
| break; |
| } |
| } |
| |
| out = talloc_size(tall_vty_cmd_ctx, len + 1); |
| if (!out) |
| return NULL; |
| |
| out_ptr = out; |
| |
| for (i = 0; i < _strlen; ++i) { |
| switch (inp[i]) { |
| case '|': |
| /* Prepend escape character "\": */ |
| *(out_ptr++) = '\\'; |
| /* fall through */ |
| default: |
| *(out_ptr++) = inp[i]; |
| break; |
| } |
| } |
| |
| out_ptr[0] = '\0'; |
| return out; |
| } |
| |
| static char *xml_escape(const char *inp) |
| { |
| int _strlen; |
| char *out, *out_ptr; |
| int len = 0, i, j; |
| |
| if (!inp) |
| return NULL; |
| _strlen = strlen(inp); |
| |
| for (i = 0; i < _strlen; ++i) { |
| switch (inp[i]) { |
| case '"': |
| len += 6; |
| break; |
| case '\'': |
| len += 6; |
| break; |
| case '<': |
| len += 4; |
| break; |
| case '>': |
| len += 4; |
| break; |
| case '&': |
| len += 5; |
| break; |
| default: |
| len += 1; |
| break; |
| } |
| } |
| |
| out = talloc_size(tall_vty_cmd_ctx, len + 1); |
| if (!out) |
| return NULL; |
| |
| out_ptr = out; |
| |
| #define ADD(out, str) \ |
| for (j = 0; j < strlen(str); ++j) \ |
| *(out++) = str[j]; |
| |
| for (i = 0; i < _strlen; ++i) { |
| switch (inp[i]) { |
| case '"': |
| ADD(out_ptr, """); |
| break; |
| case '\'': |
| ADD(out_ptr, "'"); |
| break; |
| case '<': |
| ADD(out_ptr, "<"); |
| break; |
| case '>': |
| ADD(out_ptr, ">"); |
| break; |
| case '&': |
| ADD(out_ptr, "&"); |
| break; |
| default: |
| *(out_ptr++) = inp[i]; |
| break; |
| } |
| } |
| |
| #undef ADD |
| |
| out_ptr[0] = '\0'; |
| return out; |
| } |
| |
| typedef int (*print_func_t)(void *data, const char *fmt, ...); |
| |
| static const struct value_string cmd_attr_desc[] = { |
| { CMD_ATTR_DEPRECATED, "This command is deprecated" }, |
| { CMD_ATTR_HIDDEN, "This command is hidden (check expert mode)" }, |
| { CMD_ATTR_IMMEDIATE, "This command applies immediately" }, |
| { CMD_ATTR_NODE_EXIT, "This command applies on VTY node exit" }, |
| /* CMD_ATTR_LIB_COMMAND is intentionally skipped */ |
| { 0, NULL } |
| }; |
| |
| /* Public attributes (to be printed in the VTY / XML reference) */ |
| #define CMD_ATTR_PUBLIC_MASK \ |
| (CMD_ATTR_HIDDEN | CMD_ATTR_IMMEDIATE | CMD_ATTR_NODE_EXIT) |
| |
| /* Get a flag character for a global VTY command attribute */ |
| static char cmd_attr_get_flag(unsigned int attr) |
| { |
| switch (attr) { |
| case CMD_ATTR_HIDDEN: |
| return '^'; |
| case CMD_ATTR_IMMEDIATE: |
| return '!'; |
| case CMD_ATTR_NODE_EXIT: |
| return '@'; |
| default: |
| return '.'; |
| } |
| } |
| |
| /* Description of attributes shared between the lib commands */ |
| static const char * const cmd_lib_attr_desc[32] = { |
| /* [OSMO_LIBNAME_LIB_ATTR_ATTRNAME] = \ |
| * "Brief but meaningful description", */ |
| [OSMO_SCCP_LIB_ATTR_RSTRT_ASP] = \ |
| "This command applies on ASP restart", |
| [OSMO_ABIS_LIB_ATTR_IPA_NEW_LNK] = \ |
| "This command applies on IPA link establishment", |
| [OSMO_ABIS_LIB_ATTR_LINE_UPD] = \ |
| "This command applies on E1 line update", |
| }; |
| |
| /* Flag letters of attributes shared between the lib commands. |
| * NOTE: uppercase letters only, the rest is reserved for applications. */ |
| static const char cmd_lib_attr_letters[32] = { |
| /* [OSMO_LIBNAME_LIB_ATTR_ATTRNAME] = 'X', */ |
| [OSMO_SCCP_LIB_ATTR_RSTRT_ASP] = 'A', |
| [OSMO_ABIS_LIB_ATTR_IPA_NEW_LNK] = 'I', |
| [OSMO_ABIS_LIB_ATTR_LINE_UPD] = 'L', |
| }; |
| |
| /* |
| * Write one cmd_element as XML via a print_func_t. |
| */ |
| static int vty_dump_element(const struct cmd_element *cmd, print_func_t print_func, |
| void *data, const char *newline) |
| { |
| char *xml_string = xml_escape(cmd->string); |
| unsigned int i; |
| |
| print_func(data, " <command id='%s'>%s", xml_string, newline); |
| |
| /* Print global attributes and their description */ |
| if (cmd->attr & CMD_ATTR_PUBLIC_MASK) { /* ... only public ones */ |
| print_func(data, " <attributes scope='global'>%s", newline); |
| |
| for (i = 0; i < ARRAY_SIZE(cmd_attr_desc) - 1; i++) { |
| char *xml_att_desc; |
| char flag; |
| |
| if (~cmd->attr & cmd_attr_desc[i].value) |
| continue; |
| |
| xml_att_desc = xml_escape(cmd_attr_desc[i].str); |
| print_func(data, " <attribute doc='%s'", |
| xml_att_desc, newline); |
| talloc_free(xml_att_desc); |
| |
| flag = cmd_attr_get_flag(cmd_attr_desc[i].value); |
| if (flag != '.') |
| print_func(data, " flag='%c'", flag); |
| print_func(data, " />%s", newline); |
| } |
| |
| print_func(data, " </attributes>%s", newline); |
| } |
| |
| /* Print application specific attributes and their description */ |
| if (cmd->usrattr != 0x00) { /* ... if at least one flag is set */ |
| const char * const *desc; |
| const char *letters; |
| |
| if (cmd->attr & CMD_ATTR_LIB_COMMAND) { |
| print_func(data, " <attributes scope='library'>%s", newline); |
| letters = &cmd_lib_attr_letters[0]; |
| desc = &cmd_lib_attr_desc[0]; |
| } else { |
| print_func(data, " <attributes scope='application'>%s", newline); |
| letters = &host.app_info->usr_attr_letters[0]; |
| desc = &host.app_info->usr_attr_desc[0]; |
| } |
| |
| for (i = 0; i < ARRAY_SIZE(host.app_info->usr_attr_desc); i++) { |
| char *xml_att_desc; |
| char flag; |
| |
| /* Skip attribute if *not* set */ |
| if (~cmd->usrattr & ((unsigned)1 << i)) |
| continue; |
| |
| xml_att_desc = xml_escape(desc[i]); |
| print_func(data, " <attribute doc='%s'", xml_att_desc); |
| talloc_free(xml_att_desc); |
| |
| if ((flag = letters[i]) != '\0') |
| print_func(data, " flag='%c'", flag); |
| print_func(data, " />%s", newline); |
| } |
| |
| print_func(data, " </attributes>%s", newline); |
| } |
| |
| print_func(data, " <params>%s", newline); |
| |
| for (i = 0; i < vector_count(cmd->strvec); ++i) { |
| vector descvec = vector_slot(cmd->strvec, i); |
| int j; |
| for (j = 0; j < vector_active(descvec); ++j) { |
| char *xml_param, *xml_doc; |
| struct desc *desc = vector_slot(descvec, j); |
| if (desc == NULL) |
| continue; |
| |
| xml_param = xml_escape(desc->cmd); |
| xml_doc = xml_escape(desc->str); |
| print_func(data, " <param name='%s' doc='%s' />%s", |
| xml_param, xml_doc, newline); |
| talloc_free(xml_param); |
| talloc_free(xml_doc); |
| } |
| } |
| |
| print_func(data, " </params>%s", newline); |
| print_func(data, " </command>%s", newline); |
| |
| talloc_free(xml_string); |
| return 0; |
| } |
| |
| static bool vty_command_is_common(const struct cmd_element *cmd); |
| |
| /* |
| * Dump all nodes and commands associated with a given node as XML via a print_func_t. |
| * |
| * (gflag_mask, match = false) - print only those commands with non-matching flags. |
| * (gflag_mask, match = true) - print only those commands with matching flags. |
| * |
| * Some examples: |
| * |
| * Print all commands except deprecated and hidden (default mode): |
| * (CMD_ATTR_DEPRECATED | CMD_ATTR_HIDDEN, false) |
| * Print only deprecated and hidden commands: |
| * (CMD_ATTR_DEPRECATED | CMD_ATTR_HIDDEN, true) |
| * Print all commands except deprecated (expert mode): |
| * (CMD_ATTR_DEPRECATED, false) |
| * Print only hidden commands: |
| * (CMD_ATTR_HIDDEN, true) |
| */ |
| static int vty_dump_nodes(print_func_t print_func, void *data, const char *newline, |
| unsigned char gflag_mask, bool match) |
| { |
| int i, j; |
| int same_name_count; |
| |
| print_func(data, "<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>%s", newline); |
| |
| /* Only once, list all common node commands. Use the CONFIG node to find common node commands. */ |
| print_func(data, " <node id='_common_cmds_'>%s", newline); |
| print_func(data, " <name>Common Commands</name>%s", newline); |
| print_func(data, " <description>These commands are available on all VTY nodes. They are listed" |
| " here only once, to unclutter the VTY reference.</description>%s", newline); |
| for (i = 0; i < vector_active(cmdvec); ++i) { |
| const struct cmd_node *cnode = vector_slot(cmdvec, i); |
| if (!cnode) |
| continue; |
| if (cnode->node != CONFIG_NODE) |
| continue; |
| |
| for (j = 0; j < vector_active(cnode->cmd_vector); ++j) { |
| const struct cmd_element *elem = vector_slot(cnode->cmd_vector, j); |
| if (!vty_command_is_common(elem)) |
| continue; |
| if (!match && (elem->attr & gflag_mask) != 0x00) |
| continue; |
| if (match && (elem->attr & gflag_mask) == 0x00) |
| continue; |
| vty_dump_element(elem, print_func, data, newline); |
| } |
| } |
| print_func(data, " </node>%s", newline); |
| |
| for (i = 0; i < vector_active(cmdvec); ++i) { |
| const struct cmd_node *cnode = vector_slot(cmdvec, i); |
| if (!cnode) |
| continue; |
| if (vector_active(cnode->cmd_vector) < 1) |
| continue; |
| |
| /* De-dup node IDs: how many times has this same name been used before? Count the first |
| * occurence as _1 and omit that first suffix, so that the first occurence is called |
| * 'name', the second becomes 'name_2', then 'name_3', ... */ |
| same_name_count = 1; |
| for (j = 0; j < i; ++j) { |
| const struct cmd_node *cnode2 = vector_slot(cmdvec, j); |
| if (!cnode2) |
| continue; |
| if (strcmp(cnode->name, cnode2->name) == 0) |
| same_name_count ++; |
| } |
| |
| print_func(data, " <node id='%s", cnode->name); |
| if (same_name_count > 1 || !*cnode->name) |
| print_func(data, "_%d", same_name_count); |
| print_func(data, "'>%s", newline); |
| print_func(data, " <name>%s</name>%s", cnode->name, newline); |
| |
| for (j = 0; j < vector_active(cnode->cmd_vector); ++j) { |
| const struct cmd_element *elem = vector_slot(cnode->cmd_vector, j); |
| if (vty_command_is_common(elem)) |
| continue; |
| if (!match && (elem->attr & gflag_mask) != 0x00) |
| continue; |
| if (match && (elem->attr & gflag_mask) == 0x00) |
| continue; |
| vty_dump_element(elem, print_func, data, newline); |
| } |
| |
| print_func(data, " </node>%s", newline); |
| } |
| |
| print_func(data, "</vtydoc>%s", newline); |
| |
| return 0; |
| } |
| |
| static int print_func_vty(void *data, const char *format, ...) |
| { |
| struct vty *vty = data; |
| va_list args; |
| int rc; |
| va_start(args, format); |
| rc = vty_out_va(vty, format, args); |
| va_end(args); |
| return rc; |
| } |
| |
| static int vty_dump_xml_ref_to_vty(struct vty *vty) |
| { |
| unsigned char gflag_mask = CMD_ATTR_DEPRECATED; |
| if (!vty->expert_mode) |
| gflag_mask |= CMD_ATTR_HIDDEN; |
| return vty_dump_nodes(print_func_vty, vty, VTY_NEWLINE, gflag_mask, false); |
| } |
| |
| static int print_func_stream(void *data, const char *format, ...) |
| { |
| va_list args; |
| int rc; |
| va_start(args, format); |
| rc = vfprintf((FILE*)data, format, args); |
| va_end(args); |
| return rc; |
| } |
| |
| const struct value_string vty_ref_gen_mode_names[] = { |
| { VTY_REF_GEN_MODE_DEFAULT, "default" }, |
| { VTY_REF_GEN_MODE_EXPERT, "expert" }, |
| { VTY_REF_GEN_MODE_HIDDEN, "hidden" }, |
| { 0, NULL } |
| }; |
| |
| const struct value_string vty_ref_gen_mode_desc[] = { |
| { VTY_REF_GEN_MODE_DEFAULT, "all commands except deprecated and hidden" }, |
| { VTY_REF_GEN_MODE_EXPERT, "all commands including hidden, excluding deprecated" }, |
| { VTY_REF_GEN_MODE_HIDDEN, "hidden commands only" }, |
| { 0, NULL } |
| }; |
| |
| /*! Print the XML reference of all VTY nodes to the given stream. |
| * \param[out] stream Output stream to print the XML reference to. |
| * \param[in] mode The XML reference generation mode. |
| * \returns always 0 for now, no errors possible. |
| */ |
| int vty_dump_xml_ref_mode(FILE *stream, enum vty_ref_gen_mode mode) |
| { |
| unsigned char gflag_mask; |
| bool match = false; |
| |
| switch (mode) { |
| case VTY_REF_GEN_MODE_EXPERT: |
| /* All commands except deprecated */ |
| gflag_mask = CMD_ATTR_DEPRECATED; |
| break; |
| case VTY_REF_GEN_MODE_HIDDEN: |
| /* Only hidden commands */ |
| gflag_mask = CMD_ATTR_HIDDEN; |
| match = true; |
| break; |
| case VTY_REF_GEN_MODE_DEFAULT: |
| default: |
| /* All commands except deprecated and hidden */ |
| gflag_mask = CMD_ATTR_DEPRECATED | CMD_ATTR_HIDDEN; |
| break; |
| } |
| |
| return vty_dump_nodes(print_func_stream, stream, "\n", gflag_mask, match); |
| } |
| |
| /*! Print the XML reference of all VTY nodes to the given stream. |
| * \param[out] stream Output stream to print the XML reference to. |
| * \returns always 0 for now, no errors possible. |
| * |
| * NOTE: this function is deprecated because it does not allow to |
| * specify the XML reference generation mode (default mode |
| * is hard-coded). Use vty_dump_xml_ref_mode() instead. |
| */ |
| int vty_dump_xml_ref(FILE *stream) |
| { |
| return vty_dump_xml_ref_mode(stream, VTY_REF_GEN_MODE_DEFAULT); |
| } |
| |
| /* Check if a command with given string exists at given node */ |
| static int check_element_exists(struct cmd_node *cnode, const char *cmdstring) |
| { |
| int i; |
| |
| for (i = 0; i < vector_active(cnode->cmd_vector); ++i) { |
| struct cmd_element *elem; |
| elem = vector_slot(cnode->cmd_vector, i); |
| if (!elem->string) |
| continue; |
| if (!strcmp(elem->string, cmdstring)) |
| return 1; |
| } |
| return 0; |
| } |
| |
| /*! Install a command into a node |
| * \param[in] ntype Node Type |
| * \param[cmd] element to be installed |
| */ |
| void install_element(int ntype, struct cmd_element *cmd) |
| { |
| struct cmd_node *cnode; |
| |
| cnode = vector_slot(cmdvec, ntype); |
| |
| OSMO_ASSERT(cnode); |
| /* ensure no _identical_ command has been registered at this |
| * node so far */ |
| OSMO_ASSERT(!check_element_exists(cnode, cmd->string)); |
| |
| vector_set(cnode->cmd_vector, cmd); |
| |
| cmd->strvec = cmd_make_descvec(cmd->string, cmd->doc); |
| cmd->cmdsize = cmd_cmdsize(cmd->strvec); |
| } |
| |
| /*! Install a library command into a node |
| * \param[in] ntype Node Type |
| * \param[in] cmd element to be installed |
| */ |
| void install_lib_element(int ntype, struct cmd_element *cmd) |
| { |
| cmd->attr |= CMD_ATTR_LIB_COMMAND; |
| install_element(ntype, cmd); |
| } |
| |
| /* Install a command into VIEW and ENABLE node */ |
| void install_element_ve(struct cmd_element *cmd) |
| { |
| install_element(VIEW_NODE, cmd); |
| install_element(ENABLE_NODE, cmd); |
| } |
| |
| /* Install a library command into VIEW and ENABLE node */ |
| void install_lib_element_ve(struct cmd_element *cmd) |
| { |
| cmd->attr |= CMD_ATTR_LIB_COMMAND; |
| install_element_ve(cmd); |
| } |
| |
| #ifdef VTY_CRYPT_PW |
| static unsigned char itoa64[] = |
| "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"; |
| |
| static void to64(char *s, long v, int n) |
| { |
| while (--n >= 0) { |
| *s++ = itoa64[v & 0x3f]; |
| v >>= 6; |
| } |
| } |
| |
| static char *zencrypt(const char *passwd) |
| { |
| char salt[6]; |
| struct timeval tv; |
| char *crypt(const char *, const char *); |
| |
| osmo_gettimeofday(&tv, 0); |
| |
| to64(&salt[0], random(), 3); |
| to64(&salt[3], tv.tv_usec, 3); |
| salt[5] = '\0'; |
| |
| return crypt(passwd, salt); |
| } |
| #endif |
| |
| /* This function write configuration of this host. */ |
| static int config_write_host(struct vty *vty) |
| { |
| if (host.name) |
| vty_out(vty, "hostname %s%s", host.name, VTY_NEWLINE); |
| |
| if (host.encrypt) { |
| if (host.password_encrypt) |
| vty_out(vty, "password 8 %s%s", host.password_encrypt, |
| VTY_NEWLINE); |
| if (host.enable_encrypt) |
| vty_out(vty, "enable password 8 %s%s", |
| host.enable_encrypt, VTY_NEWLINE); |
| } else { |
| if (host.password) |
| vty_out(vty, "password %s%s", host.password, |
| VTY_NEWLINE); |
| if (host.enable) |
| vty_out(vty, "enable password %s%s", host.enable, |
| VTY_NEWLINE); |
| } |
| |
| if (host.advanced) |
| vty_out(vty, "service advanced-vty%s", VTY_NEWLINE); |
| |
| if (host.encrypt) |
| vty_out(vty, "service password-encryption%s", VTY_NEWLINE); |
| |
| if (host.lines >= 0) |
| vty_out(vty, "service terminal-length %d%s", host.lines, |
| VTY_NEWLINE); |
| |
| if (host.motdfile) |
| vty_out(vty, "banner motd file %s%s", host.motdfile, |
| VTY_NEWLINE); |
| else if (!host.motd) |
| vty_out(vty, "no banner motd%s", VTY_NEWLINE); |
| |
| return 1; |
| } |
| |
| /* Utility function for getting command vector. */ |
| static vector cmd_node_vector(vector v, enum node_type ntype) |
| { |
| struct cmd_node *cnode = vector_slot(v, ntype); |
| return cnode->cmd_vector; |
| } |
| |
| /* Completion match types. */ |
| enum match_type { |
| NO_MATCH = 0, |
| ANY_MATCH, |
| EXTEND_MATCH, |
| IPV4_PREFIX_MATCH, |
| IPV4_MATCH, |
| IPV6_PREFIX_MATCH, |
| IPV6_MATCH, |
| RANGE_MATCH, |
| VARARG_MATCH, |
| PARTLY_MATCH, |
| EXACT_MATCH, |
| }; |
| |
| static enum match_type cmd_ipv4_match(const char *str) |
| { |
| const char *sp; |
| int dots = 0, nums = 0; |
| char buf[4]; |
| |
| if (str == NULL) |
| return PARTLY_MATCH; |
| |
| for (;;) { |
| memset(buf, 0, sizeof(buf)); |
| sp = str; |
| while (*str != '\0') { |
| if (*str == '.') { |
| if (dots >= 3) |
| return NO_MATCH; |
| |
| if (*(str + 1) == '.') |
| return NO_MATCH; |
| |
| if (*(str + 1) == '\0') |
| return PARTLY_MATCH; |
| |
| dots++; |
| break; |
| } |
| if (!isdigit((int)*str)) |
| return NO_MATCH; |
| |
| str++; |
| } |
| |
| if (str - sp > 3) |
| return NO_MATCH; |
| |
| strncpy(buf, sp, str - sp); |
| if (atoi(buf) > 255) |
| return NO_MATCH; |
| |
| nums++; |
| |
| if (*str == '\0') |
| break; |
| |
| str++; |
| } |
| |
| if (nums < 4) |
| return PARTLY_MATCH; |
| |
| return EXACT_MATCH; |
| } |
| |
| static enum match_type cmd_ipv4_prefix_match(const char *str) |
| { |
| const char *sp; |
| int dots = 0; |
| char buf[4]; |
| |
| if (str == NULL) |
| return PARTLY_MATCH; |
| |
| for (;;) { |
| memset(buf, 0, sizeof(buf)); |
| sp = str; |
| while (*str != '\0' && *str != '/') { |
| if (*str == '.') { |
| if (dots == 3) |
| return NO_MATCH; |
| |
| if (*(str + 1) == '.' || *(str + 1) == '/') |
| return NO_MATCH; |
| |
| if (*(str + 1) == '\0') |
| return PARTLY_MATCH; |
| |
| dots++; |
| break; |
| } |
| |
| if (!isdigit((int)*str)) |
| return NO_MATCH; |
| |
| str++; |
| } |
| |
| if (str - sp > 3) |
| return NO_MATCH; |
| |
| strncpy(buf, sp, str - sp); |
| if (atoi(buf) > 255) |
| return NO_MATCH; |
| |
| if (dots == 3) { |
| if (*str == '/') { |
| if (*(str + 1) == '\0') |
| return PARTLY_MATCH; |
| |
| str++; |
| break; |
| } else if (*str == '\0') |
| return PARTLY_MATCH; |
| } |
| |
| if (*str == '\0') |
| return PARTLY_MATCH; |
| |
| str++; |
| } |
| |
| sp = str; |
| while (*str != '\0') { |
| if (!isdigit((int)*str)) |
| return NO_MATCH; |
| |
| str++; |
| } |
| |
| if (atoi(sp) > 32) |
| return NO_MATCH; |
| |
| return EXACT_MATCH; |
| } |
| |
| #define IPV6_ADDR_STR "0123456789abcdefABCDEF:.%" |
| #define IPV6_PREFIX_STR "0123456789abcdefABCDEF:.%/" |
| #define STATE_START 1 |
| #define STATE_COLON 2 |
| #define STATE_DOUBLE 3 |
| #define STATE_ADDR 4 |
| #define STATE_DOT 5 |
| #define STATE_SLASH 6 |
| #define STATE_MASK 7 |
| |
| #ifdef HAVE_IPV6 |
| |
| static enum match_type cmd_ipv6_match(const char *str) |
| { |
| int state = STATE_START; |
| int colons = 0, nums = 0, double_colon = 0; |
| const char *sp = NULL; |
| struct sockaddr_in6 sin6_dummy; |
| int ret; |
| |
| if (str == NULL) |
| return PARTLY_MATCH; |
| |
| if (strspn(str, IPV6_ADDR_STR) != strlen(str)) |
| return NO_MATCH; |
| |
| /* use inet_pton that has a better support, |
| * for example inet_pton can support the automatic addresses: |
| * ::1.2.3.4 |
| */ |
| ret = inet_pton(AF_INET6, str, &sin6_dummy.sin6_addr); |
| |
| if (ret == 1) |
| return EXACT_MATCH; |
| |
| while (*str != '\0') { |
| switch (state) { |
| case STATE_START: |
| if (*str == ':') { |
| if (*(str + 1) != ':' && *(str + 1) != '\0') |
| return NO_MATCH; |
| colons--; |
| state = STATE_COLON; |
| } else { |
| sp = str; |
| state = STATE_ADDR; |
| } |
| |
| continue; |
| case STATE_COLON: |
| colons++; |
| if (*(str + 1) == ':') |
| state = STATE_DOUBLE; |
| else { |
| sp = str + 1; |
| state = STATE_ADDR; |
| } |
| break; |
| case STATE_DOUBLE: |
| if (double_colon) |
| return NO_MATCH; |
| |
| if (*(str + 1) == ':') |
| return NO_MATCH; |
| else { |
| if (*(str + 1) != '\0') |
| colons++; |
| sp = str + 1; |
| state = STATE_ADDR; |
| } |
| |
| double_colon++; |
| nums++; |
| break; |
| case STATE_ADDR: |
| if (*(str + 1) == ':' || *(str + 1) == '\0') { |
| if (str - sp > 3) |
| return NO_MATCH; |
| |
| nums++; |
| state = STATE_COLON; |
| } |
| if (*(str + 1) == '.') |
| state = STATE_DOT; |
| break; |
| case STATE_DOT: |
| state = STATE_ADDR; |
| break; |
| default: |
| break; |
| } |
| |
| if (nums > 8) |
| return NO_MATCH; |
| |
| if (colons > 7) |
| return NO_MATCH; |
| |
| str++; |
| } |
| |
| #if 0 |
| if (nums < 11) |
| return PARTLY_MATCH; |
| #endif /* 0 */ |
| |
| return EXACT_MATCH; |
| } |
| |
| static enum match_type cmd_ipv6_prefix_match(const char *str) |
| { |
| int state = STATE_START; |
| int colons = 0, nums = 0, double_colon = 0; |
| int mask; |
| const char *sp = NULL; |
| char *endptr = NULL; |
| |
| if (str == NULL) |
| return PARTLY_MATCH; |
| |
| if (strspn(str, IPV6_PREFIX_STR) != strlen(str)) |
| return NO_MATCH; |
| |
| while (*str != '\0' && state != STATE_MASK) { |
| switch (state) { |
| case STATE_START: |
| if (*str == ':') { |
| if (*(str + 1) != ':' && *(str + 1) != '\0') |
| return NO_MATCH; |
| colons--; |
| state = STATE_COLON; |
| } else { |
| sp = str; |
| state = STATE_ADDR; |
| } |
| |
| continue; |
| case STATE_COLON: |
| colons++; |
| if (*(str + 1) == '/') |
| return NO_MATCH; |
| else if (*(str + 1) == ':') |
| state = STATE_DOUBLE; |
| else { |
| sp = str + 1; |
| state = STATE_ADDR; |
| } |
| break; |
| case STATE_DOUBLE: |
| if (double_colon) |
| return NO_MATCH; |
| |
| if (*(str + 1) == ':') |
| return NO_MATCH; |
| else { |
| if (*(str + 1) != '\0' && *(str + 1) != '/') |
| colons++; |
| sp = str + 1; |
| |
| if (*(str + 1) == '/') |
| state = STATE_SLASH; |
| else |
| state = STATE_ADDR; |
| } |
| |
| double_colon++; |
| nums += 1; |
| break; |
| case STATE_ADDR: |
| if (*(str + 1) == ':' || *(str + 1) == '.' |
| || *(str + 1) == '\0' || *(str + 1) == '/') { |
| if (str - sp > 3) |
| return NO_MATCH; |
| |
| for (; sp <= str; sp++) |
| if (*sp == '/') |
| return NO_MATCH; |
| |
| nums++; |
| |
| if (*(str + 1) == ':') |
| state = STATE_COLON; |
| else if (*(str + 1) == '.') |
| state = STATE_DOT; |
| else if (*(str + 1) == '/') |
| state = STATE_SLASH; |
| } |
| break; |
| case STATE_DOT: |
| state = STATE_ADDR; |
| break; |
| case STATE_SLASH: |
| if (*(str + 1) == '\0') |
| return PARTLY_MATCH; |
| |
| state = STATE_MASK; |
| break; |
| default: |
| break; |
| } |
| |
| if (nums > 11) |
| return NO_MATCH; |
| |
| if (colons > 7) |
| return NO_MATCH; |
| |
| str++; |
| } |
| |
| if (state < STATE_MASK) |
| return PARTLY_MATCH; |
| |
| mask = strtol(str, &endptr, 10); |
| if (*endptr != '\0') |
| return NO_MATCH; |
| |
| if (mask < 0 || mask > 128) |
| return NO_MATCH; |
| |
| /* I don't know why mask < 13 makes command match partly. |
| Forgive me to make this comments. I Want to set static default route |
| because of lack of function to originate default in ospf6d; sorry |
| yasu |
| if (mask < 13) |
| return PARTLY_MATCH; |
| */ |
| |
| return EXACT_MATCH; |
| } |
| |
| #endif /* HAVE_IPV6 */ |
| |
| |
| #if ULONG_MAX == 18446744073709551615UL |
| #define DECIMAL_STRLEN_MAX_UNSIGNED 20 |
| #elif ULONG_MAX == 4294967295UL |
| #define DECIMAL_STRLEN_MAX_UNSIGNED 10 |
| #else |
| #error "ULONG_MAX not defined!" |
| #endif |
| |
| #if LONG_MAX == 9223372036854775807L |
| #define DECIMAL_STRLEN_MAX_SIGNED 19 |
| #elif LONG_MAX == 2147483647L |
| #define DECIMAL_STRLEN_MAX_SIGNED 10 |
| #else |
| #error "LONG_MAX not defined!" |
| #endif |
| |
| int vty_cmd_range_match(const char *range, const char *str) |
| { |
| char *p; |
| char buf[DECIMAL_STRLEN_MAX_UNSIGNED + 1]; |
| char *endptr = NULL; |
| |
| if (str == NULL) |
| return 1; |
| |
| if (range[1] == '-') { |
| signed long min = 0, max = 0, val; |
| |
| val = strtol(str, &endptr, 10); |
| if (*endptr != '\0') |
| return 0; |
| |
| range += 2; |
| p = strchr(range, '-'); |
| if (p == NULL) |
| return 0; |
| if (p - range > DECIMAL_STRLEN_MAX_SIGNED) |
| return 0; |
| strncpy(buf, range, p - range); |
| buf[p - range] = '\0'; |
| min = -strtol(buf, &endptr, 10); |
| if (*endptr != '\0') |
| return 0; |
| |
| range = p + 1; |
| p = strchr(range, '>'); |
| if (p == NULL) |
| return 0; |
| if (p - range > DECIMAL_STRLEN_MAX_SIGNED) |
| return 0; |
| strncpy(buf, range, p - range); |
| buf[p - range] = '\0'; |
| max = strtol(buf, &endptr, 10); |
| if (*endptr != '\0') |
| return 0; |
| |
| if (val < min || val > max) |
| return 0; |
| } else { |
| unsigned long min, max, val; |
| |
| if (str[0] == '-') |
| return 0; |
| |
| val = strtoul(str, &endptr, 10); |
| if (*endptr != '\0') |
| return 0; |
| |
| range++; |
| p = strchr(range, '-'); |
| if (p == NULL) |
| return 0; |
| if (p - range > DECIMAL_STRLEN_MAX_UNSIGNED) |
| return 0; |
| strncpy(buf, range, p - range); |
| buf[p - range] = '\0'; |
| min = strtoul(buf, &endptr, 10); |
| if (*endptr != '\0') |
| return 0; |
| |
| range = p + 1; |
| p = strchr(range, '>'); |
| if (p == NULL) |
| return 0; |
| if (p - range > DECIMAL_STRLEN_MAX_UNSIGNED) |
| return 0; |
| strncpy(buf, range, p - range); |
| buf[p - range] = '\0'; |
| max = strtoul(buf, &endptr, 10); |
| if (*endptr != '\0') |
| return 0; |
| |
| if (val < min || val > max) |
| return 0; |
| } |
| |
| return 1; |
| } |
| |
| /* helper to retrieve the 'real' argument string from an optional argument */ |
| static char *cmd_deopt(void *ctx, const char *str) |
| { |
| /* we've got "[blah]". We want to strip off the []s and redo the |
| * match check for "blah" |
| */ |
| size_t len = strlen(str); |
| |
| if (len < 3) |
| return NULL; |
| |
| return talloc_strndup(ctx, str + 1, len - 2); |
| } |
| |
| static enum match_type |
| cmd_match(const char *str, const char *command, |
| enum match_type min, bool recur) |
| { |
| |
| if (recur && CMD_OPTION(str)) |
| { |
| enum match_type ret; |
| char *tmp = cmd_deopt(tall_vty_cmd_ctx, str); |
| |
| /* this would be a bug in a command, however handle it gracefully |
| * as it we only discover it if a user tries to run it |
| */ |
| if (tmp == NULL) |
| return NO_MATCH; |
| |
| ret = cmd_match(tmp, command, min, false); |
| |
| talloc_free(tmp); |
| |
| return ret; |
| } |
| else if (CMD_VARARG(str)) |
| return VARARG_MATCH; |
| else if (CMD_RANGE(str)) |
| { |
| if (vty_cmd_range_match(str, command)) |
| return RANGE_MATCH; |
| } |
| #ifdef HAVE_IPV6 |
| else if (CMD_IPV6(str)) |
| { |
| if (cmd_ipv6_match(command) >= min) |
| return IPV6_MATCH; |
| } |
| else if (CMD_IPV6_PREFIX(str)) |
| { |
| if (cmd_ipv6_prefix_match(command) >= min) |
| return IPV6_PREFIX_MATCH; |
| } |
| #endif /* HAVE_IPV6 */ |
| else if (CMD_IPV4(str)) |
| { |
| if (cmd_ipv4_match(command) >= min) |
| return IPV4_MATCH; |
| } |
| else if (CMD_IPV4_PREFIX(str)) |
| { |
| if (cmd_ipv4_prefix_match(command) >= min) |
| return IPV4_PREFIX_MATCH; |
| } |
| else if (CMD_VARIABLE(str)) |
| return EXTEND_MATCH; |
| else if (strncmp(command, str, strlen(command)) == 0) |
| { |
| if (strcmp(command, str) == 0) |
| return EXACT_MATCH; |
| else if (PARTLY_MATCH >= min) |
| return PARTLY_MATCH; |
| } |
| |
| return NO_MATCH; |
| } |
| |
| /* Filter vector at the specified index and by the given command string, to |
| * the desired matching level (thus allowing part matches), and return match |
| * type flag. |
| */ |
| static enum match_type |
| cmd_filter(char *command, vector v, unsigned int index, enum match_type level) |
| { |
| unsigned int i; |
| struct cmd_element *cmd_element; |
| enum match_type match_type; |
| vector descvec; |
| struct desc *desc; |
| |
| match_type = NO_MATCH; |
| |
| /* If command and cmd_element string does not match set NULL to vector */ |
| for (i = 0; i < vector_active(v); i++) |
| if ((cmd_element = vector_slot(v, i)) != NULL) { |
| if (index >= vector_active(cmd_element->strvec)) |
| vector_slot(v, i) = NULL; |
| else { |
| unsigned int j; |
| int matched = 0; |
| |
| descvec = |
| vector_slot(cmd_element->strvec, index); |
| |
| for (j = 0; j < vector_active(descvec); j++) |
| if ((desc = vector_slot(descvec, j))) { |
| enum match_type ret; |
| |
| ret = cmd_match (desc->cmd, command, level, true); |
| |
| if (ret != NO_MATCH) |
| matched++; |
| |
| if (match_type < ret) |
| match_type = ret; |
| } |
| if (!matched) |
| vector_slot(v, i) = NULL; |
| } |
| } |
| |
| if (match_type == NO_MATCH) |
| return NO_MATCH; |
| |
| /* 2nd pass: We now know the 'strongest' match type for the index, so we |
| * go again and filter out commands whose argument (at this index) is |
| * 'weaker'. E.g., if we have 2 commands: |
| * |
| * foo bar <1-255> |
| * foo bar BLAH |
| * |
| * and the command string is 'foo bar 10', then we will get here with with |
| * 'RANGE_MATCH' being the strongest match. However, if 'BLAH' came |
| * earlier, it won't have been filtered out (as a CMD_VARIABLE allows "10"). |
| * |
| * If we don't do a 2nd pass and filter it out, the higher-layers will |
| * consider this to be ambiguous. |
| */ |
| for (i = 0; i < vector_active(v); i++) |
| if ((cmd_element = vector_slot(v, i)) != NULL) { |
| if (index >= vector_active(cmd_element->strvec)) |
| vector_slot(v, i) = NULL; |
| else { |
| unsigned int j; |
| int matched = 0; |
| |
| descvec = |
| vector_slot(cmd_element->strvec, index); |
| |
| for (j = 0; j < vector_active(descvec); j++) |
| if ((desc = vector_slot(descvec, j))) { |
| enum match_type ret; |
| |
| ret = cmd_match(desc->cmd, command, ANY_MATCH, true); |
| |
| if (ret >= match_type) |
| matched++; |
| } |
| if (!matched) |
| vector_slot(v, i) = NULL; |
| } |
| } |
| |
| return match_type; |
| } |
| |
| /* Check ambiguous match */ |
| static int |
| is_cmd_ambiguous(char *command, vector v, int index, enum match_type type) |
| { |
| int ret = 0; |
| unsigned int i; |
| unsigned int j; |
| struct cmd_element *cmd_element; |
| const char *matched = NULL; |
| vector descvec; |
| struct desc *desc; |
| |
| /* In this loop, when a match is found, 'matched' points to it. If on a later iteration, an |
| * identical match is found, the command is ambiguous. The trickiness is that a string may be |
| * enclosed in '[str]' square brackets, which get removed by a talloc_strndup(), via cmd_deopt(). |
| * Such a string is usually needed for one loop iteration, except when 'matched' points to it. In |
| * that case, the string must remain allocated until this function exits or another match comes |
| * around. This is sufficiently confusing to justify a separate talloc tree to store all of the |
| * odd allocations, and to free them all at the end. We are not expecting too many optional args |
| * or ambiguities to cause a noticeable memory footprint from keeping all allocations. */ |
| void *cmd_deopt_ctx = NULL; |
| |
| for (i = 0; i < vector_active(v); i++) { |
| cmd_element = vector_slot(v, i); |
| if (!cmd_element) |
| continue; |
| |
| int match = 0; |
| |
| descvec = vector_slot(cmd_element->strvec, index); |
| |
| for (j = 0; j < vector_active(descvec); j++) { |
| desc = vector_slot(descvec, j); |
| if (!desc) |
| continue; |
| |
| enum match_type mtype; |
| const char *str = desc->cmd; |
| |
| if (CMD_OPTION(str)) { |
| if (!cmd_deopt_ctx) |
| cmd_deopt_ctx = |
| talloc_named_const(tall_vty_cmd_ctx, 0, |
| __func__); |
| str = cmd_deopt(cmd_deopt_ctx, str); |
| if (str == NULL) |
| continue; |
| } |
| |
| switch (type) { |
| case EXACT_MATCH: |
| if (!(CMD_VARIABLE (str)) |
| && strcmp(command, str) == 0) |
| match++; |
| break; |
| case PARTLY_MATCH: |
| if (!(CMD_VARIABLE (str)) |
| && strncmp(command, str, strlen (command)) == 0) |
| { |
| if (matched |
| && strcmp(matched, |
| str) != 0) { |
| ret = 1; /* There is ambiguous match. */ |
| goto free_and_return; |
| } else |
| matched = str; |
| match++; |
| } |
| break; |
| case RANGE_MATCH: |
| if (vty_cmd_range_match |
| (str, command)) { |
| if (matched |
| && strcmp(matched, |
| str) != 0) { |
| ret = 1; |
| goto free_and_return; |
| } else |
| matched = str; |
| match++; |
| } |
| break; |
| #ifdef HAVE_IPV6 |
| case IPV6_MATCH: |
| if (CMD_IPV6(str)) |
| match++; |
| break; |
| case IPV6_PREFIX_MATCH: |
| if ((mtype = |
| cmd_ipv6_prefix_match |
| (command)) != NO_MATCH) { |
| if (mtype == PARTLY_MATCH) { |
| ret = 2; /* There is incomplete match. */ |
| goto free_and_return; |
| } |
| |
| match++; |
| } |
| break; |
| #endif /* HAVE_IPV6 */ |
| case IPV4_MATCH: |
| if (CMD_IPV4(str)) |
| match++; |
| break; |
| case IPV4_PREFIX_MATCH: |
| if ((mtype = |
| cmd_ipv4_prefix_match |
| (command)) != NO_MATCH) { |
| if (mtype == PARTLY_MATCH) { |
| ret = 2; /* There is incomplete match. */ |
| goto free_and_return; |
| } |
| |
| match++; |
| } |
| break; |
| case EXTEND_MATCH: |
| if (CMD_VARIABLE (str)) |
| match++; |
| break; |
| case NO_MATCH: |
| default: |
| break; |
| } |
| } |
| if (!match) |
| vector_slot(v, i) = NULL; |
| } |
| |
| free_and_return: |
| if (cmd_deopt_ctx) |
| talloc_free(cmd_deopt_ctx); |
| return ret; |
| } |
| |
| /* If src matches dst return dst string, otherwise return NULL */ |
| static const char *cmd_entry_function(const char *src, const char *dst) |
| { |
| /* Skip variable arguments. */ |
| if (CMD_OPTION(dst) || CMD_VARIABLE(dst) || CMD_VARARG(dst) || |
| CMD_IPV4(dst) || CMD_IPV4_PREFIX(dst) || CMD_RANGE(dst)) |
| return NULL; |
| |
| /* In case of 'command \t', given src is NULL string. */ |
| if (src == NULL) |
| return dst; |
| |
| /* Matched with input string. */ |
| if (strncmp(src, dst, strlen(src)) == 0) |
| return dst; |
| |
| return NULL; |
| } |
| |
| /* If src matches dst return dst string, otherwise return NULL */ |
| /* This version will return the dst string always if it is |
| CMD_VARIABLE for '?' key processing */ |
| static const char *cmd_entry_function_desc(const char *src, const char *dst) |
| { |
| if (CMD_VARARG(dst)) |
| return dst; |
| |
| if (CMD_RANGE(dst)) { |
| if (vty_cmd_range_match(dst, src)) |
| return dst; |
| else |
| return NULL; |
| } |
| #ifdef HAVE_IPV6 |
| if (CMD_IPV6(dst)) { |
| if (cmd_ipv6_match(src)) |
| return dst; |
| else |
| return NULL; |
| } |
| |
| if (CMD_IPV6_PREFIX(dst)) { |
| if (cmd_ipv6_prefix_match(src)) |
| return dst; |
| else |
| return NULL; |
| } |
| #endif /* HAVE_IPV6 */ |
| |
| if (CMD_IPV4(dst)) { |
| if (cmd_ipv4_match(src)) |
| return dst; |
| else |
| return NULL; |
| } |
| |
| if (CMD_IPV4_PREFIX(dst)) { |
| if (cmd_ipv4_prefix_match(src)) |
| return dst; |
| else |
| return NULL; |
| } |
| |
| /* Optional or variable commands always match on '?' */ |
| if (CMD_OPTION(dst) || CMD_VARIABLE(dst)) |
| return dst; |
| |
| /* In case of 'command \t', given src is NULL string. */ |
| if (src == NULL) |
| return dst; |
| |
| if (strncmp(src, dst, strlen(src)) == 0) |
| return dst; |
| else |
| return NULL; |
| } |
| |
| /* Check same string element existence. If it isn't there return |
| 1. */ |
| static int cmd_unique_string(vector v, const char *str) |
| { |
| unsigned int i; |
| char *match; |
| |
| for (i = 0; i < vector_active(v); i++) |
| if ((match = vector_slot(v, i)) != NULL) |
| if (strcmp(match, str) == 0) |
| return 0; |
| return 1; |
| } |
| |
| /* Compare string to description vector. If there is same string |
| return 1 else return 0. */ |
| static int desc_unique_string(vector v, const char *str) |
| { |
| unsigned int i; |
| struct desc *desc; |
| |
| for (i = 0; i < vector_active(v); i++) |
| if ((desc = vector_slot(v, i)) != NULL) |
| if (strcmp(desc->cmd, str) == 0) |
| return 1; |
| return 0; |
| } |
| |
| static int cmd_try_do_shortcut(enum node_type node, char *first_word) |
| { |
| if (first_word != NULL && |
| node != AUTH_NODE && |
| node != VIEW_NODE && |
| node != AUTH_ENABLE_NODE && |
| node != ENABLE_NODE && 0 == strcmp("do", first_word)) |
| return 1; |
| return 0; |
| } |
| |
| /* '?' describe command support. */ |
| static vector |
| cmd_describe_command_real(vector vline, struct vty *vty, int *status) |
| { |
| unsigned int i; |
| vector cmd_vector; |
| #define INIT_MATCHVEC_SIZE 10 |
| vector matchvec; |
| struct cmd_element *cmd_element; |
| unsigned int index; |
| int ret; |
| enum match_type match; |
| char *command; |
| static struct desc desc_cr = { "<cr>", "" }; |
| |
| /* Set index. */ |
| if (vector_active(vline) == 0) { |
| *status = CMD_ERR_NO_MATCH; |
| return NULL; |
| } else |
| index = vector_active(vline) - 1; |
| |
| /* Make copy vector of current node's command vector. */ |
| cmd_vector = vector_copy(cmd_node_vector(cmdvec, vty->node)); |
| |
| /* Prepare match vector */ |
| matchvec = vector_init(INIT_MATCHVEC_SIZE); |
| |
| /* Filter commands. */ |
| /* Only words precedes current word will be checked in this loop. */ |
| for (i = 0; i < index; i++) { |
| command = vector_slot(vline, i); |
| if (!command) |
| continue; |
| |
| match = cmd_filter(command, cmd_vector, i, ANY_MATCH); |
| |
| if (match == VARARG_MATCH) { |
| struct cmd_element *cmd_element; |
| vector descvec; |
| unsigned int j, k; |
| |
| for (j = 0; j < vector_active(cmd_vector); j++) |
| if ((cmd_element = |
| vector_slot(cmd_vector, j)) != NULL |
| && |
| (vector_active(cmd_element->strvec))) { |
| descvec = |
| vector_slot(cmd_element-> |
| strvec, |
| vector_active |
| (cmd_element-> |
| strvec) - 1); |
| for (k = 0; |
| k < vector_active(descvec); |
| k++) { |
| struct desc *desc = |
| vector_slot(descvec, |
| k); |
| vector_set(matchvec, |
| desc); |
| } |
| } |
| |
| vector_set(matchvec, &desc_cr); |
| vector_free(cmd_vector); |
| |
| return matchvec; |
| } |
| |
| if ((ret = is_cmd_ambiguous(command, cmd_vector, i, |
| match)) == 1) { |
| vector_free(cmd_vector); |
| vector_free(matchvec); |
| *status = CMD_ERR_AMBIGUOUS; |
| return NULL; |
| } else if (ret == 2) { |
| vector_free(cmd_vector); |
| vector_free(matchvec); |
| *status = CMD_ERR_NO_MATCH; |
| return NULL; |
| } |
| } |
| |
| /* Prepare match vector */ |
| /* matchvec = vector_init (INIT_MATCHVEC_SIZE); */ |
| |
| /* Make sure that cmd_vector is filtered based on current word */ |
| command = vector_slot(vline, index); |
| if (command) |
| cmd_filter(command, cmd_vector, index, ANY_MATCH); |
| |
| /* Make description vector. */ |
| for (i = 0; i < vector_active(cmd_vector); i++) { |
| const char *string = NULL; |
| vector strvec; |
| |
| cmd_element = vector_slot(cmd_vector, i); |
| if (!cmd_element) |
| continue; |
| |
| if (cmd_element->attr & CMD_ATTR_DEPRECATED) |
| continue; |
| if (!vty->expert_mode && (cmd_element->attr & CMD_ATTR_HIDDEN)) |
| continue; |
| |
| strvec = cmd_element->strvec; |
| |
| /* if command is NULL, index may be equal to vector_active */ |
| if (command && index >= vector_active(strvec)) |
| vector_slot(cmd_vector, i) = NULL; |
| else { |
| /* Check if command is completed. */ |
| if (command == NULL |
| && index == vector_active(strvec)) { |
| string = "<cr>"; |
| if (!desc_unique_string(matchvec, string)) |
| vector_set(matchvec, &desc_cr); |
| } else { |
| unsigned int j; |
| vector descvec = vector_slot(strvec, index); |
| struct desc *desc; |
| |
| for (j = 0; j < vector_active(descvec); j++) { |
| desc = vector_slot(descvec, j); |
| if (!desc) |
| continue; |
| string = cmd_entry_function_desc |
| (command, desc->cmd); |
| if (!string) |
| continue; |
| /* Uniqueness check */ |
| if (!desc_unique_string(matchvec, string)) |
| vector_set(matchvec, desc); |
| } |
| } |
| } |
| } |
| vector_free(cmd_vector); |
| |
| if (vector_slot(matchvec, 0) == NULL) { |
| vector_free(matchvec); |
| *status = CMD_ERR_NO_MATCH; |
| } else |
| *status = CMD_SUCCESS; |
| |
| return matchvec; |
| } |
| |
| vector cmd_describe_command(vector vline, struct vty * vty, int *status) |
| { |
| vector ret; |
| |
| if (cmd_try_do_shortcut(vty->node, vector_slot(vline, 0))) { |
| enum node_type onode; |
| vector shifted_vline; |
| unsigned int index; |
| |
| onode = vty->node; |
| vty->node = ENABLE_NODE; |
| /* We can try it on enable node, cos' the vty is authenticated */ |
| |
| shifted_vline = vector_init(vector_count(vline)); |
| /* use memcpy? */ |
| for (index = 1; index < vector_active(vline); index++) { |
| vector_set_index(shifted_vline, index - 1, |
| vector_lookup(vline, index)); |
| } |
| |
| ret = cmd_describe_command_real(shifted_vline, vty, status); |
| |
| vector_free(shifted_vline); |
| vty->node = onode; |
| return ret; |
| } |
| |
| return cmd_describe_command_real(vline, vty, status); |
| } |
| |
| /* Check LCD of matched command. */ |
| static int cmd_lcd(char **matched) |
| { |
| int i; |
| int j; |
| int lcd = -1; |
| char *s1, *s2; |
| char c1, c2; |
| |
| if (matched[0] == NULL || matched[1] == NULL) |
| return 0; |
| |
| for (i = 1; matched[i] != NULL; i++) { |
| s1 = matched[i - 1]; |
| s2 = matched[i]; |
| |
| for (j = 0; (c1 = s1[j]) && (c2 = s2[j]); j++) |
| if (c1 != c2) |
| break; |
| |
| if (lcd < 0) |
| lcd = j; |
| else { |
| if (lcd > j) |
| lcd = j; |
| } |
| } |
| return lcd; |
| } |
| |
| /* Command line completion support. */ |
| static char **cmd_complete_command_real(vector vline, struct vty *vty, |
| int *status) |
| { |
| unsigned int i; |
| vector cmd_vector = vector_copy(cmd_node_vector(cmdvec, vty->node)); |
| #define INIT_MATCHVEC_SIZE 10 |
| vector matchvec; |
| struct cmd_element *cmd_element; |
| unsigned int index; |
| char **match_str; |
| struct desc *desc; |
| vector descvec; |
| char *command; |
| int lcd; |
| |
| if (vector_active(vline) == 0) { |
| *status = CMD_ERR_NO_MATCH; |
| vector_free(cmd_vector); |
| return NULL; |
| } else |
| index = vector_active(vline) - 1; |
| |
| /* First, filter by preceeding command string */ |
| for (i = 0; i < index; i++) |
| if ((command = vector_slot(vline, i))) { |
| enum match_type match; |
| int ret; |
| |
| /* First try completion match, if there is exactly match return 1 */ |
| match = |
| cmd_filter(command, cmd_vector, i, ANY_MATCH); |
| |
| /* If there is exact match then filter ambiguous match else check |
| ambiguousness. */ |
| if ((ret = |
| is_cmd_ambiguous(command, cmd_vector, i, |
| match)) == 1) { |
| vector_free(cmd_vector); |
| *status = CMD_ERR_AMBIGUOUS; |
| return NULL; |
| } |
| /* |
| else if (ret == 2) |
| { |
| vector_free (cmd_vector); |
| *status = CMD_ERR_NO_MATCH; |
| return NULL; |
| } |
| */ |
| } |
| |
| /* Prepare match vector. */ |
| matchvec = vector_init(INIT_MATCHVEC_SIZE); |
| |
| /* Now we got into completion */ |
| for (i = 0; i < vector_active(cmd_vector); i++) |
| if ((cmd_element = vector_slot(cmd_vector, i))) { |
| const char *string; |
| vector strvec = cmd_element->strvec; |
| |
| /* Check field length */ |
| if (index >= vector_active(strvec)) |
| vector_slot(cmd_vector, i) = NULL; |
| else { |
| unsigned int j; |
| |
| descvec = vector_slot(strvec, index); |
| for (j = 0; j < vector_active(descvec); j++) |
| if ((desc = vector_slot(descvec, j))) { |
| const char *cmd = desc->cmd; |
| char *tmp = NULL; |
| |
| if (CMD_OPTION(desc->cmd)) { |
| tmp = cmd_deopt(tall_vty_cmd_ctx, desc->cmd); |
| cmd = tmp; |
| } |
| if ((string = cmd_entry_function(vector_slot(vline, index), cmd))) |
| if (cmd_unique_string (matchvec, string)) |
| vector_set (matchvec, talloc_strdup(tall_vty_cmd_ctx, string)); |
| if (tmp) |
| talloc_free(tmp); |
| } |
| } |
| } |
| |
| /* We don't need cmd_vector any more. */ |
| vector_free(cmd_vector); |
| |
| /* No matched command */ |
| if (vector_slot(matchvec, 0) == NULL) { |
| vector_free(matchvec); |
| |
| /* In case of 'command \t' pattern. Do you need '?' command at |
| the end of the line. */ |
| if (vector_slot(vline, index) == NULL) |
| *status = CMD_ERR_NOTHING_TODO; |
| else |
| *status = CMD_ERR_NO_MATCH; |
| return NULL; |
| } |
| |
| /* Only one matched */ |
| if (vector_slot(matchvec, 1) == NULL) { |
| match_str = (char **)matchvec->index; |
| vector_only_wrapper_free(matchvec); |
| *status = CMD_COMPLETE_FULL_MATCH; |
| return match_str; |
| } |
| /* Make it sure last element is NULL. */ |
| vector_set(matchvec, NULL); |
| |
| /* Check LCD of matched strings. */ |
| if (vector_slot(vline, index) != NULL) { |
| lcd = cmd_lcd((char **)matchvec->index); |
| |
| if (lcd) { |
| int len = strlen(vector_slot(vline, index)); |
| |
| if (len < lcd) { |
| char *lcdstr; |
| |
| lcdstr = _talloc_zero(tall_vty_cmd_ctx, lcd + 1, |
| "complete-lcdstr"); |
| memcpy(lcdstr, matchvec->index[0], lcd); |
| lcdstr[lcd] = '\0'; |
| |
| /* match_str = (char **) &lcdstr; */ |
| |
| /* Free matchvec. */ |
| for (i = 0; i < vector_active(matchvec); i++) { |
| if (vector_slot(matchvec, i)) |
| talloc_free(vector_slot(matchvec, i)); |
| } |
| vector_free(matchvec); |
| |
| /* Make new matchvec. */ |
| matchvec = vector_init(INIT_MATCHVEC_SIZE); |
| vector_set(matchvec, lcdstr); |
| match_str = (char **)matchvec->index; |
| vector_only_wrapper_free(matchvec); |
| |
| *status = CMD_COMPLETE_MATCH; |
| return match_str; |
| } |
| } |
| } |
| |
| match_str = (char **)matchvec->index; |
| vector_only_wrapper_free(matchvec); |
| *status = CMD_COMPLETE_LIST_MATCH; |
| return match_str; |
| } |
| |
| char **cmd_complete_command(vector vline, struct vty *vty, int *status) |
| { |
| char **ret; |
| |
| if (cmd_try_do_shortcut(vty->node, vector_slot(vline, 0))) { |
| enum node_type onode; |
| vector shifted_vline; |
| unsigned int index; |
| |
| onode = vty->node; |
| vty->node = ENABLE_NODE; |
| /* We can try it on enable node, cos' the vty is authenticated */ |
| |
| shifted_vline = vector_init(vector_count(vline)); |
| /* use memcpy? */ |
| for (index = 1; index < vector_active(vline); index++) { |
| vector_set_index(shifted_vline, index - 1, |
| vector_lookup(vline, index)); |
| } |
| |
| ret = cmd_complete_command_real(shifted_vline, vty, status); |
| |
| vector_free(shifted_vline); |
| vty->node = onode; |
| return ret; |
| } |
| |
| return cmd_complete_command_real(vline, vty, status); |
| } |
| |
| static struct vty_parent_node *vty_parent(struct vty *vty) |
| { |
| return llist_first_entry_or_null(&vty->parent_nodes, |
| struct vty_parent_node, |
| entry); |
| } |
| |
| static bool vty_pop_parent(struct vty *vty) |
| { |
| struct vty_parent_node *parent = vty_parent(vty); |
| if (!parent) |
| return false; |
| llist_del(&parent->entry); |
| vty->node = parent->node; |
| vty->priv = parent->priv; |
| if (vty->indent) |
| talloc_free(vty->indent); |
| vty->indent = parent->indent; |
| talloc_free(parent); |
| return true; |
| } |
| |
| static void vty_clear_parents(struct vty *vty) |
| { |
| while (vty_pop_parent(vty)); |
| } |
| |
| /* return parent node */ |
| /* |
| * This function MUST eventually converge on a node when called repeatedly, |
| * there must not be any cycles. |
| * All 'config' nodes shall converge on CONFIG_NODE. |
| * All other 'enable' nodes shall converge on ENABLE_NODE. |
| * All 'view' only nodes shall converge on VIEW_NODE. |
| * All other nodes shall converge on themselves or it must be ensured, |
| * that the user's rights are not extended anyhow by calling this function. |
| * |
| * Note that these requirements also apply to all functions that are used |
| * as go_parent_cb. |
| * Note also that this function relies on the is_config_child callback to |
| * recognize non-config nodes if go_parent_cb is not set. |
| */ |
| int vty_go_parent(struct vty *vty) |
| { |
| switch (vty->node) { |
| case AUTH_NODE: |
| case VIEW_NODE: |
| case ENABLE_NODE: |
| case CONFIG_NODE: |
| vty_clear_parents(vty); |
| break; |
| |
| case AUTH_ENABLE_NODE: |
| vty->node = VIEW_NODE; |
| vty_clear_parents(vty); |
| break; |
| |
| default: |
| if (host.app_info->go_parent_cb) |
| host.app_info->go_parent_cb(vty); |
| vty_pop_parent(vty); |
| break; |
| } |
| |
| return vty->node; |
| } |
| |
| /* Execute command by argument vline vector. */ |
| static int |
| cmd_execute_command_real(vector vline, struct vty *vty, |
| struct cmd_element **cmd) |
| { |
| unsigned int i, j; |
| unsigned int index; |
| vector cmd_vector; |
| struct cmd_element *cmd_element; |
| struct cmd_element *matched_element; |
| unsigned int matched_count, incomplete_count; |
| int argc; |
| const char *argv[CMD_ARGC_MAX]; |
| enum match_type match = 0; |
| int varflag; |
| char *command; |
| int rc; |
| /* Used for temporary storage of cmd_deopt() allocated arguments during |
| argv[] generation */ |
| void *cmd_deopt_ctx = NULL; |
| |
| /* Make copy of command elements. */ |
| cmd_vector = vector_copy(cmd_node_vector(cmdvec, vty->node)); |
| |
| for (index = 0; index < vector_active(vline); index++) { |
| if ((command = vector_slot(vline, index))) { |
| int ret; |
| |
| match = cmd_filter(command, cmd_vector, index, |
| ANY_MATCH); |
| |
| if (match == VARARG_MATCH) |
| break; |
| |
| ret = |
| is_cmd_ambiguous(command, cmd_vector, index, match); |
| |
| if (ret == 1) { |
| vector_free(cmd_vector); |
| return CMD_ERR_AMBIGUOUS; |
| } else if (ret == 2) { |
| vector_free(cmd_vector); |
| return CMD_ERR_NO_MATCH; |
| } |
| } |
| } |
| |
| /* Check matched count. */ |
| matched_element = NULL; |
| matched_count = 0; |
| incomplete_count = 0; |
| |
| for (i = 0; i < vector_active(cmd_vector); i++) { |
| if ((cmd_element = vector_slot(cmd_vector, i))) { |
| if (match == VARARG_MATCH |
| || index >= cmd_element->cmdsize) { |
| matched_element = cmd_element; |
| #if 0 |
| printf("DEBUG: %s\n", cmd_element->string); |
| #endif |
| matched_count++; |
| } else { |
| incomplete_count++; |
| } |
| } |
| } |
| |
| /* Finish of using cmd_vector. */ |
| vector_free(cmd_vector); |
| |
| /* To execute command, matched_count must be 1. */ |
| if (matched_count == 0) { |
| if (incomplete_count) |
| return CMD_ERR_INCOMPLETE; |
| else |
| return CMD_ERR_NO_MATCH; |
| } |
| |
| if (matched_count > 1) |
| return CMD_ERR_AMBIGUOUS; |
| |
| /* Argument treatment */ |
| varflag = 0; |
| argc = 0; |
| |
| cmd_deopt_ctx = talloc_named_const(tall_vty_cmd_ctx, 0, __func__); |
| |
| for (i = 0; i < vector_active(vline); i++) { |
| if (argc == CMD_ARGC_MAX) { |
| rc = CMD_ERR_EXEED_ARGC_MAX; |
| goto rc_free_deopt_ctx; |
| } |
| if (varflag) { |
| argv[argc++] = vector_slot(vline, i); |
| continue; |
| } |
| |
| vector descvec = vector_slot(matched_element->strvec, i); |
| const char *tmp_cmd; |
| |
| if (vector_active(descvec) == 1) { |
| /* Single coice argument, no "(...|...)". */ |
| struct desc *desc = vector_slot(descvec, 0); |
| |
| if (CMD_OPTION(desc->cmd)) { |
| /* we need to first remove the [] chars, then check to see what's inside (var or token) */ |
| tmp_cmd = cmd_deopt(cmd_deopt_ctx, desc->cmd); |
| } else { |
| tmp_cmd = desc->cmd; |
| } |
| |
| if (CMD_VARARG(tmp_cmd)) |
| varflag = 1; |
| if (varflag || CMD_VARIABLE(tmp_cmd)) |
| argv[argc++] = vector_slot(vline, i); |
| else if (CMD_OPTION(desc->cmd)) |
| argv[argc++] = tmp_cmd; |
| /* else : we don't want to add non-opt single-choice static args in argv[] */ |
| } else { |
| /* multi choice argument. look up which choice |
| the user meant (can only be one after |
| filtering and checking for ambigous). For instance, |
| if user typed "th" for "(two|three)" arg, we |
| want to pass "three" in argv[]. */ |
| for (j = 0; j < vector_active(descvec); j++) { |
| struct desc *desc = vector_slot(descvec, j); |
| if (!desc) |
| continue; |
| if (cmd_match(desc->cmd, vector_slot(vline, i), ANY_MATCH, true) == NO_MATCH) |
| continue; |
| if (CMD_OPTION(desc->cmd)) { |
| /* we need to first remove the [] chars, then check to see what's inside (var or token) */ |
| tmp_cmd = cmd_deopt(cmd_deopt_ctx, desc->cmd); |
| } else { |
| tmp_cmd = desc->cmd; |
| } |
| |
| if(CMD_VARIABLE(tmp_cmd)) { |
| argv[argc++] = vector_slot(vline, i); |
| } else { |
| argv[argc++] = tmp_cmd; |
| } |
| break; |
| } |
| } |
| } |
| |
| /* For vtysh execution. */ |
| if (cmd) |
| *cmd = matched_element; |
| |
| if (matched_element->daemon) |
| rc = CMD_SUCCESS_DAEMON; |
| else { |
| /* Execute matched command. */ |
| struct vty_parent_node this_node = { |
| .node = vty->node, |
| .priv = vty->priv, |
| .indent = vty->indent, |
| }; |
| struct vty_parent_node *parent = vty_parent(vty); |
| rc = (*matched_element->func) (matched_element, vty, argc, argv); |
| |
| /* If we have stepped down into a child node, push a parent frame. |
| * The causality is such: we don't expect every single node entry implementation to push |
| * a parent node entry onto vty->parent_nodes. Instead we expect vty_go_parent() to *pop* |
| * a parent node. Hence if the node changed without the parent node changing, we must |
| * have stepped into a child node. */ |
| if (vty->node != this_node.node && parent == vty_parent(vty) |
| && vty->node > CONFIG_NODE) { |
| /* Push the parent node. */ |
| parent = talloc_zero(vty, struct vty_parent_node); |
| *parent = this_node; |
| llist_add(&parent->entry, &vty->parent_nodes); |
| } |
| } |
| |
| rc_free_deopt_ctx: |
| /* Now after we called the command func, we can free temporary strings */ |
| talloc_free(cmd_deopt_ctx); |
| return rc; |
| } |
| |
| int |
| cmd_execute_command(vector vline, struct vty *vty, struct cmd_element **cmd, |
| int vtysh) |
| { |
| int ret; |
| enum node_type onode; |
| |
| onode = vty->node; |
| |
| if (cmd_try_do_shortcut(vty->node, vector_slot(vline, 0))) { |
| vector shifted_vline; |
| unsigned int index; |
| |
| vty->node = ENABLE_NODE; |
| /* We can try it on enable node, cos' the vty is authenticated */ |
| |
| shifted_vline = vector_init(vector_count(vline)); |
| /* use memcpy? */ |
| for (index = 1; index < vector_active(vline); index++) { |
| vector_set_index(shifted_vline, index - 1, |
| vector_lookup(vline, index)); |
| } |
| |
| ret = cmd_execute_command_real(shifted_vline, vty, cmd); |
| |
| vector_free(shifted_vline); |
| vty->node = onode; |
| return ret; |
| } |
| |
| return cmd_execute_command_real(vline, vty, cmd); |
| } |
| |
| /* Execute command by argument readline. */ |
| int |
| cmd_execute_command_strict(vector vline, struct vty *vty, |
| struct cmd_element **cmd) |
| { |
| unsigned int i; |
| unsigned int index; |
| vector cmd_vector; |
| struct cmd_element *cmd_element; |
| struct cmd_element *matched_element; |
| unsigned int matched_count, incomplete_count; |
| int argc; |
| const char *argv[CMD_ARGC_MAX]; |
| int varflag; |
| enum match_type match = 0; |
| char *command; |
| |
| /* Make copy of command element */ |
| cmd_vector = vector_copy(cmd_node_vector(cmdvec, vty->node)); |
| |
| for (index = 0; index < vector_active(vline); index++) |
| if ((command = vector_slot(vline, index))) { |
| int ret; |
| |
| match = cmd_filter(vector_slot(vline, index), |
| cmd_vector, index, EXACT_MATCH); |
| |
| /* If command meets '.VARARG' then finish matching. */ |
| if (match == VARARG_MATCH) |
| break; |
| |
| ret = |
| is_cmd_ambiguous(command, cmd_vector, index, match); |
| if (ret == 1) { |
| vector_free(cmd_vector); |
| return CMD_ERR_AMBIGUOUS; |
| } |
| if (ret == 2) { |
| vector_free(cmd_vector); |
| return CMD_ERR_NO_MATCH; |
| } |
| } |
| |
| /* Check matched count. */ |
| matched_element = NULL; |
| matched_count = 0; |
| incomplete_count = 0; |
| for (i = 0; i < vector_active(cmd_vector); i++) |
| if (vector_slot(cmd_vector, i) != NULL) { |
| cmd_element = vector_slot(cmd_vector, i); |
| |
| if (match == VARARG_MATCH |
| || index >= cmd_element->cmdsize) { |
| matched_element = cmd_element; |
| matched_count++; |
| } else |
| incomplete_count++; |
| } |
| |
| /* Finish of using cmd_vector. */ |
| vector_free(cmd_vector); |
| |
| /* To execute command, matched_count must be 1. */ |
| if (matched_count == 0) { |
| if (incomplete_count) |
| return CMD_ERR_INCOMPLETE; |
| else |
| return CMD_ERR_NO_MATCH; |
| } |
| |
| if (matched_count > 1) |
| return CMD_ERR_AMBIGUOUS; |
| |
| /* Argument treatment */ |
| varflag = 0; |
| argc = 0; |
| |
| for (i = 0; i < vector_active(vline); i++) { |
| if (argc == CMD_ARGC_MAX) |
| return CMD_ERR_EXEED_ARGC_MAX; |
| if (varflag) { |
| argv[argc++] = vector_slot(vline, i); |
| continue; |
| } |
| |
| vector descvec = vector_slot(matched_element->strvec, i); |
| |
| if (vector_active(descvec) == 1) { |
| struct desc *desc = vector_slot(descvec, 0); |
| |
| if (CMD_VARARG(desc->cmd)) |
| varflag = 1; |
| |
| if (varflag || CMD_VARIABLE(desc->cmd) |
| || CMD_OPTION(desc->cmd)) |
| argv[argc++] = vector_slot(vline, i); |
| } else { |
| argv[argc++] = vector_slot(vline, i); |
| } |
| } |
| |
| /* For vtysh execution. */ |
| if (cmd) |
| *cmd = matched_element; |
| |
| if (matched_element->daemon) |
| return CMD_SUCCESS_DAEMON; |
| |
| /* Now execute matched command */ |
| return (*matched_element->func) (matched_element, vty, argc, argv); |
| } |
| |
| static inline size_t len(const char *str) |
| { |
| return str? strlen(str) : 0; |
| } |
| |
| /*! Make sure the common length of strings a and b is identical, then compare their lengths. I.e., if a |
| * is longer than b, a must start with exactly b, and vice versa. |
| * \returns EINVAL on mismatch, -1 for a < b, 0 for a == b, 1 for a > b. |
| */ |
| static int indent_cmp(const char *a, const char *b) |
| { |
| size_t al, bl; |
| al = len(a); |
| bl = len(b); |
| if (al > bl) { |
| if (bl && strncmp(a, b, bl) != 0) |
| return EINVAL; |
| return 1; |
| } |
| /* al <= bl */ |
| if (al && strncmp(a, b, al) != 0) |
| return EINVAL; |
| return (al < bl)? -1 : 0; |
| } |
| |
| /* Configration make from file. */ |
| int config_from_file(struct vty *vty, FILE * fp) |
| { |
| int ret; |
| vector vline; |
| char *indent; |
| int cmp; |
| struct vty_parent_node this_node; |
| struct vty_parent_node *parent; |
| |
| while (fgets(vty->buf, VTY_BUFSIZ, fp)) { |
| indent = NULL; |
| vline = NULL; |
| ret = cmd_make_strvec2(vty->buf, &indent, &vline); |
| |
| if (ret != CMD_SUCCESS) |
| goto return_invalid_indent; |
| |
| /* In case of comment or empty line */ |
| if (vline == NULL) { |
| if (indent) { |
| talloc_free(indent); |
| indent = NULL; |
| } |
| continue; |
| } |
| |
| /* We have a nonempty line. */ |
| if (!vty->indent) { |
| /* We have just entered a node and expecting the first child to come up; but we |
| * may also skip right back to a parent or ancestor level. */ |
| parent = vty_parent(vty); |
| |
| /* If there is no parent, record any indentation we encounter. */ |
| cmp = parent ? indent_cmp(indent, parent->indent) : 1; |
| |
| if (cmp == EINVAL) |
| goto return_invalid_indent; |
| |
| if (cmp <= 0) { |
| /* We have gone right back to the parent level or higher, we are skipping |
| * this child node level entirely. Pop the parent to go back to a node |
| * that was actually there (to reinstate vty->indent) and re-use below |
| * go-parent while-loop to find an accurate match of indent in the node |
| * ancestry. */ |
| vty_go_parent(vty); |
| } else { |
| /* The indent is deeper than the just entered parent, record the new |
| * indentation characters. */ |
| vty->indent = talloc_strdup(vty, indent); |
| /* This *is* the new indentation. */ |
| cmp = 0; |
| } |
| } else { |
| /* There is a known indentation for this node level, validate and detect node |
| * exits. */ |
| cmp = indent_cmp(indent, vty->indent); |
| if (cmp == EINVAL) |
| goto return_invalid_indent; |
| } |
| |
| /* Less indent: go up the parent nodes to find matching amount of less indent. When this |
| * loop exits, we want to have found an exact match, i.e. cmp == 0. */ |
| while (cmp < 0) { |
| vty_go_parent(vty); |
| cmp = indent_cmp(indent, vty->indent); |
| if (cmp == EINVAL) |
| goto return_invalid_indent; |
| } |
| |
| /* More indent without having entered a child node level? Either the parent node's indent |
| * wasn't hit exactly (e.g. there's a space more than the parent level had further above) |
| * or the indentation increased even though the vty command didn't enter a child. */ |
| if (cmp > 0) |
| goto return_invalid_indent; |
| |
| /* Remember the current node before the command possibly changes it. */ |
| this_node = (struct vty_parent_node){ |
| .node = vty->node, |
| .priv = vty->priv, |
| .indent = vty->indent, |
| }; |
| |
| parent = vty_parent(vty); |
| ret = cmd_execute_command_strict(vline, vty, NULL); |
| cmd_free_strvec(vline); |
| |
| if (ret != CMD_SUCCESS && ret != CMD_ERR_NOTHING_TODO) { |
| if (indent) { |
| talloc_free(indent); |
| indent = NULL; |
| } |
| return ret; |
| } |
| |
| /* If we have stepped down into a child node, push a parent frame. |
| * The causality is such: we don't expect every single node entry implementation to push |
| * a parent node entry onto vty->parent_nodes. Instead we expect vty_go_parent() to *pop* |
| * a parent node. Hence if the node changed without the parent node changing, we must |
| * have stepped into a child node (and now expect a deeper indent). */ |
| if (vty->node != this_node.node && parent == vty_parent(vty)) { |
| /* Push the parent node. */ |
| parent = talloc_zero(vty, struct vty_parent_node); |
| *parent = this_node; |
| llist_add(&parent->entry, &vty->parent_nodes); |
| |
| /* The current talloc'ed vty->indent string will now be owned by this parent |
| * struct. Indicate that we don't know what deeper indent characters the user |
| * will choose. */ |
| vty->indent = NULL; |
| } |
| |
| if (indent) { |
| talloc_free(indent); |
| indent = NULL; |
| } |
| } |
| /* Make sure we call go_parent_cb for all remaining indent levels at the end of file */ |
| while (vty_parent(vty)) |
| vty_go_parent(vty); |
| |
| return CMD_SUCCESS; |
| |
| return_invalid_indent: |
| if (vline) |
| cmd_free_strvec(vline); |
| if (indent) { |
| talloc_free(indent); |
| indent = NULL; |
| } |
| return CMD_ERR_INVALID_INDENT; |
| } |
| |
| /* Configration from terminal */ |
| DEFUN(config_terminal, |
| config_terminal_cmd, |
| "configure terminal", |
| "Configuration from vty interface\n" "Configuration terminal\n") |
| { |
| if (vty_config_lock(vty)) |
| vty->node = CONFIG_NODE; |
| else { |
| vty_out(vty, "VTY configuration is locked by other VTY%s", |
| VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| return CMD_SUCCESS; |
| } |
| |
| /* Enable command */ |
| DEFUN(enable, config_enable_cmd, |
| "enable [expert-mode]", |
| "Turn on privileged mode command\n" |
| "Enable the expert mode (show hidden commands)\n") |
| { |
| /* If enable password is NULL, change to ENABLE_NODE */ |
| if ((host.enable == NULL && host.enable_encrypt == NULL) || |
| vty->type == VTY_SHELL_SERV) |
| vty->node = ENABLE_NODE; |
| else |
| vty->node = AUTH_ENABLE_NODE; |
| |
| vty->expert_mode = argc > 0; |
| |
| return CMD_SUCCESS; |
| } |
| |
| /* Disable command */ |
| DEFUN(disable, |
| config_disable_cmd, "disable", "Turn off privileged mode command\n") |
| { |
| if (vty->node == ENABLE_NODE) |
| vty->node = VIEW_NODE; |
| |
| vty->expert_mode = false; |
| |
| return CMD_SUCCESS; |
| } |
| |
| /* Down vty node level. */ |
| gDEFUN(config_exit, |
| config_exit_cmd, "exit", "Exit current mode and down to previous mode\n") |
| { |
| switch (vty->node) { |
| case AUTH_NODE: |
| case VIEW_NODE: |
| case ENABLE_NODE: |
| vty->status = VTY_CLOSE; |
| break; |
| case CONFIG_NODE: |
| vty->node = ENABLE_NODE; |
| vty_config_unlock(vty); |
| break; |
| default: |
| if (vty->node > CONFIG_NODE) |
| vty_go_parent (vty); |
| break; |
| } |
| return CMD_SUCCESS; |
| } |
| |
| /* End of configuration. */ |
| gDEFUN(config_end, |
| config_end_cmd, "end", "End current mode and change to enable mode.") |
| { |
| if (vty->node > ENABLE_NODE) { |
| int last_node = CONFIG_NODE; |
| |
| /* Repeatedly call go_parent until a top node is reached. */ |
| while (vty->node > CONFIG_NODE) { |
| if (vty->node == last_node) { |
| /* Ensure termination, this shouldn't happen. */ |
| break; |
| } |
| last_node = vty->node; |
| vty_go_parent(vty); |
| } |
| |
| vty_config_unlock(vty); |
| if (vty->node > ENABLE_NODE) |
| vty->node = ENABLE_NODE; |
| vty->index = NULL; |
| vty->index_sub = NULL; |
| } |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(shutdown, |
| shutdown_cmd, "shutdown", "Request a shutdown of the program\n") |
| { |
| LOGP(DLGLOBAL, LOGL_INFO, "Shutdown requested from telnet\n"); |
| vty_out(vty, "%s is shutting down. Bye!%s", host.app_info->name, VTY_NEWLINE); |
| |
| /* Same exit path as if it was killed by the service manager */ |
| kill(getpid(), SIGTERM); |
| |
| return CMD_SUCCESS; |
| } |
| |
| /* Show version. */ |
| DEFUN(show_version, |
| show_version_cmd, "show version", SHOW_STR "Displays program version\n") |
| { |
| vty_out(vty, "%s %s (%s).%s", host.app_info->name, |
| host.app_info->version, |
| host.app_info->name ? host.app_info->name : "", VTY_NEWLINE); |
| vty_out(vty, "%s%s", host.app_info->copyright, VTY_NEWLINE); |
| |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(show_online_help, |
| show_online_help_cmd, "show online-help", SHOW_STR "Online help\n") |
| { |
| vty_dump_xml_ref_to_vty(vty); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(show_pid, |
| show_pid_cmd, "show pid", SHOW_STR "Displays the process ID\n") |
| { |
| vty_out(vty, "%d%s", getpid(), VTY_NEWLINE); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(show_uptime, |
| show_uptime_cmd, "show uptime", SHOW_STR "Displays how long the program has been running\n") |
| { |
| struct timespec now; |
| osmo_clock_gettime(CLOCK_MONOTONIC, &now); |
| |
| time_t uptime = now.tv_sec - starttime.tv_sec; |
| int d = uptime / (3600 * 24); |
| int h = uptime / 3600 % 24; |
| int m = uptime / 60 % 60; |
| int s = uptime % 60; |
| |
| vty_out(vty, "%s has been running for %dd %dh %dm %ds%s", host.app_info->name, d, h, m, s, VTY_NEWLINE); |
| |
| return CMD_SUCCESS; |
| } |
| |
| /* Help display function for all node. */ |
| gDEFUN(config_help, |
| config_help_cmd, "help", "Description of the interactive help system\n") |
| { |
| vty_out(vty, "This VTY provides advanced help features. When you need help,%s" |
| "anytime at the command line please press '?'.%s%s" |
| "If nothing matches, the help list will be empty and you must backup%s" |
| " until entering a '?' shows the available options.%s" |
| "Two styles of help are provided:%s" |
| "1. Full help is available when you are ready to enter a%s" |
| "command argument (e.g. 'show ?') and describes each possible%s" |
| "argument.%s" |
| "2. Partial help is provided when an abbreviated argument is entered%s" |
| " and you want to know what arguments match the input%s" |
| " (e.g. 'show me?'.)%s%s", |
| VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, |
| VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, |
| VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, VTY_NEWLINE, |
| VTY_NEWLINE); |
| return CMD_SUCCESS; |
| } |
| |
| enum { |
| ATTR_TYPE_GLOBAL = (1 << 0), |
| ATTR_TYPE_LIB = (1 << 1), |
| ATTR_TYPE_APP = (1 << 2), |
| }; |
| |
| static void print_attr_list(struct vty *vty, unsigned int attr_mask) |
| { |
| const char *desc; |
| unsigned int i; |
| bool found; |
| char flag; |
| |
| if (attr_mask & ATTR_TYPE_GLOBAL) { |
| vty_out(vty, " Global attributes:%s", VTY_NEWLINE); |
| |
| for (i = 0; i < ARRAY_SIZE(cmd_attr_desc) - 1; i++) { |
| flag = cmd_attr_get_flag(cmd_attr_desc[i].value); |
| desc = cmd_attr_desc[i].str; |
| |
| /* Skip attributes without flags */ |
| if (flag != '.') |
| vty_out(vty, " %c %s%s", flag, desc, VTY_NEWLINE); |
| } |
| } |
| |
| if (attr_mask & ATTR_TYPE_LIB) { |
| vty_out(vty, " Library specific attributes:%s", VTY_NEWLINE); |
| |
| for (i = 0, found = false; i < _OSMO_CORE_LIB_ATTR_COUNT; i++) { |
| if ((desc = cmd_lib_attr_desc[i]) == NULL) |
| continue; |
| found = true; |
| |
| flag = cmd_lib_attr_letters[i]; |
| if (flag == '\0') |
| flag = '.'; |
| |
| vty_out(vty, " %c %s%s", flag, desc, VTY_NEWLINE); |
| } |
| |
| if (!found) |
| vty_out(vty, " (no attributes)%s", VTY_NEWLINE); |
| } |
| |
| if (attr_mask & ATTR_TYPE_APP) { |
| vty_out(vty, " Application specific attributes:%s", VTY_NEWLINE); |
| |
| for (i = 0, found = false; i < VTY_CMD_USR_ATTR_NUM; i++) { |
| if ((desc = host.app_info->usr_attr_desc[i]) == NULL) |
| continue; |
| found = true; |
| |
| flag = host.app_info->usr_attr_letters[i]; |
| if (flag == '\0') |
| flag = '.'; |
| |
| vty_out(vty, " %c %s%s", flag, desc, VTY_NEWLINE); |
| } |
| |
| if (!found) |
| vty_out(vty, " (no attributes)%s", VTY_NEWLINE); |
| } |
| } |
| |
| gDEFUN(show_vty_attr_all, show_vty_attr_all_cmd, |
| "show vty-attributes", |
| SHOW_STR "List of VTY attributes\n") |
| { |
| print_attr_list(vty, 0xff); |
| return CMD_SUCCESS; |
| } |
| |
| gDEFUN(show_vty_attr, show_vty_attr_cmd, |
| "show vty-attributes (application|library|global)", |
| SHOW_STR "List of VTY attributes\n" |
| "Application specific attributes only\n" |
| "Library specific attributes only\n" |
| "Global attributes only\n") |
| { |
| unsigned int attr_mask = 0; |
| |
| if (argv[0][0] == 'g') /* global */ |
| attr_mask |= ATTR_TYPE_GLOBAL; |
| else if (argv[0][0] == 'l') /* library */ |
| attr_mask |= ATTR_TYPE_LIB; |
| else if (argv[0][0] == 'a') /* application */ |
| attr_mask |= ATTR_TYPE_APP; |
| |
| print_attr_list(vty, attr_mask); |
| return CMD_SUCCESS; |
| } |
| |
| /* Compose flag bit-mask for all commands within the given node */ |
| static unsigned int node_flag_mask(const struct cmd_node *cnode, bool expert_mode) |
| { |
| unsigned int flag_mask = 0x00; |
| unsigned int f, i; |
| |
| for (f = 0; f < VTY_CMD_USR_ATTR_NUM; f++) { |
| for (i = 0; i < vector_active(cnode->cmd_vector); i++) { |
| const struct cmd_element *cmd; |
| char flag_letter; |
| |
| if ((cmd = vector_slot(cnode->cmd_vector, i)) == NULL) |
| continue; |
| if (cmd->attr & CMD_ATTR_DEPRECATED) |
| continue; |
| if (!expert_mode && (cmd->attr & CMD_ATTR_HIDDEN)) |
| continue; |
| if (~cmd->usrattr & ((unsigned)1 << f)) |
| continue; |
| |
| if (cmd->attr & CMD_ATTR_LIB_COMMAND) |
| flag_letter = cmd_lib_attr_letters[f]; |
| else |
| flag_letter = host.app_info->usr_attr_letters[f]; |
| |
| if (flag_letter == '\0') |
| continue; |
| |
| flag_mask |= (1 << f); |
| break; |
| } |
| } |
| |
| return flag_mask; |
| } |
| |
| /* Compose global flag char-mask for the given command (e.g. "!" or "@") */ |
| static const char *cmd_gflag_mask(const struct cmd_element *cmd) |
| { |
| static char char_mask[8 + 1]; |
| char *ptr = &char_mask[0]; |
| |
| /* Mutually exclusive global attributes */ |
| if (cmd->attr & CMD_ATTR_HIDDEN) |
| *(ptr++) = cmd_attr_get_flag(CMD_ATTR_HIDDEN); |
| else if (cmd->attr & CMD_ATTR_IMMEDIATE) |
| *(ptr++) = cmd_attr_get_flag(CMD_ATTR_IMMEDIATE); |
| else if (cmd->attr & CMD_ATTR_NODE_EXIT) |
| *(ptr++) = cmd_attr_get_flag(CMD_ATTR_NODE_EXIT); |
| else |
| *(ptr++) = '.'; |
| |
| *ptr = '\0'; |
| |
| return char_mask; |
| } |
| |
| /* Compose app / lib flag char-mask for the given command (e.g. ".F.OB..") */ |
| static const char *cmd_flag_mask(const struct cmd_element *cmd, |
| unsigned int flag_mask) |
| { |
| static char char_mask[VTY_CMD_USR_ATTR_NUM + 1]; |
| char *ptr = &char_mask[0]; |
| char flag_letter; |
| unsigned int f; |
| |
| for (f = 0; f < VTY_CMD_USR_ATTR_NUM; f++) { |
| if (~flag_mask & ((unsigned)1 << f)) |
| continue; |
| if (~cmd->usrattr & ((unsigned)1 << f)) { |
| *(ptr++) = '.'; |
| continue; |
| } |
| |
| if (cmd->attr & CMD_ATTR_LIB_COMMAND) |
| flag_letter = cmd_lib_attr_letters[f]; |
| else |
| flag_letter = host.app_info->usr_attr_letters[f]; |
| |
| *(ptr++) = flag_letter ? flag_letter : '.'; |
| } |
| |
| *ptr = '\0'; |
| |
| return char_mask; |
| } |
| |
| /* Help display function for all node. */ |
| gDEFUN(config_list, config_list_cmd, |
| "list [with-flags]", |
| "Print command list\n" |
| "Also print the VTY attribute flags\n") |
| { |
| unsigned int i; |
| struct cmd_node *cnode = vector_slot(cmdvec, vty->node); |
| unsigned int flag_mask = 0x00; |
| struct cmd_element *cmd; |
| |
| if (argc > 0) |
| flag_mask = node_flag_mask(cnode, vty->expert_mode); |
| |
| for (i = 0; i < vector_active(cnode->cmd_vector); i++) { |
| if ((cmd = vector_slot(cnode->cmd_vector, i)) == NULL) |
| continue; |
| if (cmd->attr & CMD_ATTR_DEPRECATED) |
| continue; |
| if (!vty->expert_mode && (cmd->attr & CMD_ATTR_HIDDEN)) |
| continue; |
| if (!argc) |
| vty_out(vty, " %s%s", cmd->string, VTY_NEWLINE); |
| else { |
| vty_out(vty, " %s %s %s%s", |
| cmd_gflag_mask(cmd), |
| cmd_flag_mask(cmd, flag_mask), |
| cmd->string, VTY_NEWLINE); |
| } |
| } |
| |
| return CMD_SUCCESS; |
| } |
| |
| static int write_config_file(const char *config_file, char **outpath) |
| { |
| unsigned int i; |
| int fd; |
| struct cmd_node *node; |
| char *config_file_tmp = NULL; |
| char *config_file_sav = NULL; |
| struct vty *file_vty; |
| struct stat st; |
| |
| *outpath = NULL; |
| |
| /* The string composition code here would be a case for talloc_asprintf(), but the pseudotalloc.c |
| * talloc_asprintf() implementation would truncate a too-long path with "[...]", so doing it |
| * manually instead. */ |
| |
| /* Check and see if we are operating under vtysh configuration */ |
| config_file_sav = |
| _talloc_zero(tall_vty_cmd_ctx, |
| strlen(config_file) + strlen(CONF_BACKUP_EXT) + 1, |
| "config_file_sav"); |
| if (!config_file_sav) |
| return -1; |
| strcpy(config_file_sav, config_file); |
| strcat(config_file_sav, CONF_BACKUP_EXT); |
| |
| config_file_tmp = _talloc_zero(tall_vty_cmd_ctx, strlen(config_file) + 8, |
| "config_file_tmp"); |
| if (!config_file_tmp) { |
| talloc_free(config_file_sav); |
| return -1; |
| } |
| sprintf(config_file_tmp, "%s.XXXXXX", config_file); |
| |
| /* Open file to configuration write. */ |
| fd = mkstemp(config_file_tmp); |
| if (fd < 0) { |
| *outpath = talloc_strdup(tall_vty_cmd_ctx, config_file_tmp); |
| talloc_free(config_file_tmp); |
| talloc_free(config_file_sav); |
| return -1; |
| } |
| |
| /* Make vty for configuration file. */ |
| file_vty = vty_new(); |
| file_vty->fd = fd; |
| file_vty->type = VTY_FILE; |
| |
| /* Config file header print. */ |
| vty_out(file_vty, "!\n! %s (%s) configuration saved from vty\n!", |
| host.app_info->name, host.app_info->version); |
| //vty_time_print (file_vty, 1); |
| vty_out(file_vty, "!\n"); |
| |
| for (i = 0; i < vector_active(cmdvec); i++) |
| if ((node = vector_slot(cmdvec, i)) && node->func) { |
| if ((*node->func) (file_vty)) |
| vty_out(file_vty, "!\n"); |
| } |
| vty_close(file_vty); |
| |
| if (unlink(config_file_sav) != 0) |
| if (errno != ENOENT) { |
| *outpath = talloc_strdup(tall_vty_cmd_ctx, config_file_sav); |
| talloc_free(config_file_sav); |
| talloc_free(config_file_tmp); |
| unlink(config_file_tmp); |
| return -2; |
| } |
| |
| /* Only link the .sav file if the original file exists */ |
| if (stat(config_file, &st) == 0) { |
| if (link(config_file, config_file_sav) != 0) { |
| *outpath = talloc_strdup(tall_vty_cmd_ctx, config_file_sav); |
| talloc_free(config_file_sav); |
| talloc_free(config_file_tmp); |
| unlink(config_file_tmp); |
| return -3; |
| } |
| sync(); |
| if (unlink(config_file) != 0) { |
| *outpath = talloc_strdup(tall_vty_cmd_ctx, config_file); |
| talloc_free(config_file_sav); |
| talloc_free(config_file_tmp); |
| unlink(config_file_tmp); |
| return -4; |
| } |
| } |
| if (link(config_file_tmp, config_file) != 0) { |
| *outpath = talloc_strdup(tall_vty_cmd_ctx, config_file); |
| talloc_free(config_file_sav); |
| talloc_free(config_file_tmp); |
| unlink(config_file_tmp); |
| return -5; |
| } |
| unlink(config_file_tmp); |
| sync(); |
| |
| talloc_free(config_file_sav); |
| talloc_free(config_file_tmp); |
| |
| if (chmod(config_file, 0666 & ~CONFIGFILE_MASK) != 0) { |
| *outpath = talloc_strdup(tall_vty_cmd_ctx, config_file); |
| return -6; |
| } |
| |
| return 0; |
| } |
| |
| |
| /* Write current configuration into file. */ |
| DEFUN(config_write_file, |
| config_write_file_cmd, |
| "write file [PATH]", |
| "Write running configuration to memory, network, or terminal\n" |
| "Write to configuration file\n" |
| "Set file path to store the config, or replace if already exists\n") |
| { |
| char *failed_file; |
| int rc; |
| |
| if (host.app_info->config_is_consistent) { |
| rc = host.app_info->config_is_consistent(vty); |
| if (!rc) { |
| vty_out(vty, "Configuration is not consistent%s", |
| VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| } |
| |
| if (argc == 1) |
| host_config_set(argv[0]); |
| |
| if (host.config == NULL) { |
| vty_out(vty, "Can't save to configuration file, using vtysh.%s", |
| VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| |
| rc = write_config_file(host.config, &failed_file); |
| switch (rc) { |
| case -1: |
| vty_out(vty, "Can't open configuration file %s.%s", |
| failed_file, VTY_NEWLINE); |
| rc = CMD_WARNING; |
| break; |
| case -2: |
| vty_out(vty, "Can't unlink backup configuration file %s.%s", |
| failed_file, VTY_NEWLINE); |
| rc = CMD_WARNING; |
| break; |
| case -3: |
| vty_out(vty, "Can't backup old configuration file %s.%s", |
| failed_file, VTY_NEWLINE); |
| rc = CMD_WARNING; |
| break; |
| case -4: |
| vty_out(vty, "Can't unlink configuration file %s.%s", |
| failed_file, VTY_NEWLINE); |
| rc = CMD_WARNING; |
| break; |
| case -5: |
| vty_out(vty, "Can't save configuration file %s.%s", failed_file, |
| VTY_NEWLINE); |
| rc = CMD_WARNING; |
| break; |
| case -6: |
| vty_out(vty, "Can't chmod configuration file %s: %s (%d).%s", |
| failed_file, strerror(errno), errno, VTY_NEWLINE); |
| rc = CMD_WARNING; |
| break; |
| default: |
| vty_out(vty, "Configuration saved to %s%s", host.config, VTY_NEWLINE); |
| rc = CMD_SUCCESS; |
| break; |
| } |
| |
| talloc_free(failed_file); |
| return rc; |
| } |
| |
| ALIAS(config_write_file, |
| config_write_cmd, |
| "write", "Write running configuration to memory, network, or terminal\n") |
| |
| ALIAS(config_write_file, |
| config_write_memory_cmd, |
| "write memory", |
| "Write running configuration to memory, network, or terminal\n" |
| "Write configuration to the file (same as write file)\n") |
| |
| ALIAS(config_write_file, |
| copy_runningconfig_startupconfig_cmd, |
| "copy running-config startup-config", |
| "Copy configuration\n" |
| "Copy running config to... \n" |
| "Copy running config to startup config (same as write file)\n") |
| |
| /* Write current configuration into the terminal. */ |
| DEFUN(config_write_terminal, |
| config_write_terminal_cmd, |
| "write terminal", |
| "Write running configuration to memory, network, or terminal\n" |
| "Write to terminal\n") |
| { |
| unsigned int i; |
| struct cmd_node *node; |
| |
| if (vty->type == VTY_SHELL_SERV) { |
| for (i = 0; i < vector_active(cmdvec); i++) |
| if ((node = vector_slot(cmdvec, i)) && node->func |
| && node->vtysh) { |
| if ((*node->func) (vty)) |
| vty_out(vty, "!%s", VTY_NEWLINE); |
| } |
| } else { |
| vty_out(vty, "%sCurrent configuration:%s", VTY_NEWLINE, |
| VTY_NEWLINE); |
| vty_out(vty, "!%s", VTY_NEWLINE); |
| |
| for (i = 0; i < vector_active(cmdvec); i++) |
| if ((node = vector_slot(cmdvec, i)) && node->func) { |
| if ((*node->func) (vty)) |
| vty_out(vty, "!%s", VTY_NEWLINE); |
| } |
| vty_out(vty, "end%s", VTY_NEWLINE); |
| } |
| return CMD_SUCCESS; |
| } |
| |
| /* Write current configuration into the terminal. */ |
| ALIAS(config_write_terminal, |
| show_running_config_cmd, |
| "show running-config", SHOW_STR "running configuration\n") |
| |
| /* Write startup configuration into the terminal. */ |
| DEFUN(show_startup_config, |
| show_startup_config_cmd, |
| "show startup-config", SHOW_STR "Contentes of startup configuration\n") |
| { |
| char buf[BUFSIZ]; |
| FILE *confp; |
| |
| confp = fopen(host.config, "r"); |
| if (confp == NULL) { |
| vty_out(vty, "Can't open configuration file [%s]%s", |
| host.config, VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| |
| while (fgets(buf, BUFSIZ, confp)) { |
| char *cp = buf; |
| |
| while (*cp != '\r' && *cp != '\n' && *cp != '\0') |
| cp++; |
| *cp = '\0'; |
| |
| vty_out(vty, "%s%s", buf, VTY_NEWLINE); |
| } |
| |
| fclose(confp); |
| |
| return CMD_SUCCESS; |
| } |
| |
| /* Hostname configuration */ |
| DEFUN(config_hostname, |
| hostname_cmd, |
| "hostname WORD", |
| "Set system's network name\n" "This system's network name\n") |
| { |
| if (!isalpha((int)*argv[0])) { |
| vty_out(vty, "Please specify string starting with alphabet%s", |
| VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| |
| if (host.name) |
| talloc_free(host.name); |
| |
| host.name = talloc_strdup(tall_vty_cmd_ctx, argv[0]); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_no_hostname, |
| no_hostname_cmd, |
| "no hostname [HOSTNAME]", |
| NO_STR "Reset system's network name\n" "Host name of this router\n") |
| { |
| if (host.name) |
| talloc_free(host.name); |
| host.name = NULL; |
| return CMD_SUCCESS; |
| } |
| |
| /* VTY interface password set. */ |
| DEFUN(config_password, password_cmd, |
| "password (8|) WORD", |
| "Assign the terminal connection password\n" |
| "Specifies a HIDDEN password will follow\n" |
| "dummy string \n" "The HIDDEN line password string\n") |
| { |
| /* Argument check. */ |
| if (argc == 0) { |
| vty_out(vty, "Please specify password.%s", VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| |
| if (argc == 2) { |
| if (*argv[0] == '8') { |
| if (host.password) |
| talloc_free(host.password); |
| host.password = NULL; |
| if (host.password_encrypt) |
| talloc_free(host.password_encrypt); |
| host.password_encrypt = talloc_strdup(tall_vty_cmd_ctx, argv[1]); |
| return CMD_SUCCESS; |
| } else { |
| vty_out(vty, "Unknown encryption type.%s", VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| } |
| |
| if (!isalnum((int)*argv[0])) { |
| vty_out(vty, |
| "Please specify string starting with alphanumeric%s", |
| VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| |
| if (host.password) |
| talloc_free(host.password); |
| host.password = NULL; |
| |
| #ifdef VTY_CRYPT_PW |
| if (host.encrypt) { |
| if (host.password_encrypt) |
| talloc_free(host.password_encrypt); |
| host.password_encrypt = talloc_strdup(tall_vty_cmd_ctx, zencrypt(argv[0])); |
| } else |
| #endif |
| host.password = talloc_strdup(tall_vty_cmd_ctx, argv[0]); |
| |
| return CMD_SUCCESS; |
| } |
| |
| ALIAS(config_password, password_text_cmd, |
| "password LINE", |
| "Assign the terminal connection password\n" |
| "The UNENCRYPTED (cleartext) line password\n") |
| |
| /* VTY enable password set. */ |
| DEFUN(config_enable_password, enable_password_cmd, |
| "enable password (8|) WORD", |
| "Modify enable password parameters\n" |
| "Assign the privileged level password\n" |
| "Specifies a HIDDEN password will follow\n" |
| "dummy string \n" "The HIDDEN 'enable' password string\n") |
| { |
| /* Argument check. */ |
| if (argc == 0) { |
| vty_out(vty, "Please specify password.%s", VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| |
| /* Crypt type is specified. */ |
| if (argc == 2) { |
| if (*argv[0] == '8') { |
| if (host.enable) |
| talloc_free(host.enable); |
| host.enable = NULL; |
| |
| if (host.enable_encrypt) |
| talloc_free(host.enable_encrypt); |
| host.enable_encrypt = talloc_strdup(tall_vty_cmd_ctx, argv[1]); |
| |
| return CMD_SUCCESS; |
| } else { |
| vty_out(vty, "Unknown encryption type.%s", VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| } |
| |
| if (!isalnum((int)*argv[0])) { |
| vty_out(vty, |
| "Please specify string starting with alphanumeric%s", |
| VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| |
| if (host.enable) |
| talloc_free(host.enable); |
| host.enable = NULL; |
| |
| /* Plain password input. */ |
| #ifdef VTY_CRYPT_PW |
| if (host.encrypt) { |
| if (host.enable_encrypt) |
| talloc_free(host.enable_encrypt); |
| host.enable_encrypt = talloc_strdup(tall_vty_cmd_ctx, zencrypt(argv[0])); |
| } else |
| #endif |
| host.enable = talloc_strdup(tall_vty_cmd_ctx, argv[0]); |
| |
| return CMD_SUCCESS; |
| } |
| |
| ALIAS(config_enable_password, |
| enable_password_text_cmd, |
| "enable password LINE", |
| "Modify enable password parameters\n" |
| "Assign the privileged level password\n" |
| "The UNENCRYPTED (cleartext) 'enable' password\n") |
| |
| /* VTY enable password delete. */ |
| DEFUN(no_config_enable_password, no_enable_password_cmd, |
| "no enable password", |
| NO_STR |
| "Modify enable password parameters\n" |
| "Assign the privileged level password\n") |
| { |
| if (host.enable) |
| talloc_free(host.enable); |
| host.enable = NULL; |
| |
| if (host.enable_encrypt) |
| talloc_free(host.enable_encrypt); |
| host.enable_encrypt = NULL; |
| |
| return CMD_SUCCESS; |
| } |
| |
| #ifdef VTY_CRYPT_PW |
| DEFUN(service_password_encrypt, |
| service_password_encrypt_cmd, |
| "service password-encryption", |
| "Set up miscellaneous service\n" "Enable encrypted passwords\n") |
| { |
| if (host.encrypt) |
| return CMD_SUCCESS; |
| |
| host.encrypt = 1; |
| |
| if (host.password) { |
| if (host.password_encrypt) |
| talloc_free(host.password_encrypt); |
| host.password_encrypt = talloc_strdup(tall_vty_cmd_ctx, zencrypt(host.password)); |
| } |
| if (host.enable) { |
| if (host.enable_encrypt) |
| talloc_free(host.enable_encrypt); |
| host.enable_encrypt = talloc_strdup(tall_vty_cmd_ctx, zencrypt(host.enable)); |
| } |
| |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_service_password_encrypt, |
| no_service_password_encrypt_cmd, |
| "no service password-encryption", |
| NO_STR "Set up miscellaneous service\n" "Enable encrypted passwords\n") |
| { |
| if (!host.encrypt) |
| return CMD_SUCCESS; |
| |
| host.encrypt = 0; |
| |
| if (host.password_encrypt) |
| talloc_free(host.password_encrypt); |
| host.password_encrypt = NULL; |
| |
| if (host.enable_encrypt) |
| talloc_free(host.enable_encrypt); |
| host.enable_encrypt = NULL; |
| |
| return CMD_SUCCESS; |
| } |
| #endif |
| |
| DEFUN(config_terminal_length, config_terminal_length_cmd, |
| "terminal length <0-512>", |
| "Set terminal line parameters\n" |
| "Set number of lines on a screen\n" |
| "Number of lines on screen (0 for no pausing)\n") |
| { |
| int lines; |
| char *endptr = NULL; |
| |
| lines = strtol(argv[0], &endptr, 10); |
| if (lines < 0 || lines > 512 || *endptr != '\0') { |
| vty_out(vty, "length is malformed%s", VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| vty->lines = lines; |
| |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_terminal_no_length, config_terminal_no_length_cmd, |
| "terminal no length", |
| "Set terminal line parameters\n" |
| NO_STR "Set number of lines on a screen\n") |
| { |
| vty->lines = -1; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(service_terminal_length, service_terminal_length_cmd, |
| "service terminal-length <0-512>", |
| "Set up miscellaneous service\n" |
| "System wide terminal length configuration\n" |
| "Number of lines of VTY (0 means no line control)\n") |
| { |
| int lines; |
| char *endptr = NULL; |
| |
| lines = strtol(argv[0], &endptr, 10); |
| if (lines < 0 || lines > 512 || *endptr != '\0') { |
| vty_out(vty, "length is malformed%s", VTY_NEWLINE); |
| return CMD_WARNING; |
| } |
| host.lines = lines; |
| |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_service_terminal_length, no_service_terminal_length_cmd, |
| "no service terminal-length [<0-512>]", |
| NO_STR |
| "Set up miscellaneous service\n" |
| "System wide terminal length configuration\n" |
| "Number of lines of VTY (0 means no line control)\n") |
| { |
| host.lines = -1; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN_HIDDEN(do_echo, |
| echo_cmd, |
| "echo .MESSAGE", |
| "Echo a message back to the vty\n" "The message to echo\n") |
| { |
| char *message; |
| |
| vty_out(vty, "%s%s", |
| ((message = |
| argv_concat(argv, argc, 0)) ? message : ""), VTY_NEWLINE); |
| if (message) |
| talloc_free(message); |
| return CMD_SUCCESS; |
| } |
| |
| #if 0 |
| DEFUN(config_logmsg, |
| config_logmsg_cmd, |
| "logmsg " LOG_LEVELS " .MESSAGE", |
| "Send a message to enabled logging destinations\n" |
| LOG_LEVEL_DESC "The message to send\n") |
| { |
| int level; |
| char *message; |
| |
| if ((level = level_match(argv[0])) == ZLOG_DISABLED) |
| return CMD_ERR_NO_MATCH; |
| |
| zlog(NULL, level, |
| ((message = argv_concat(argv, argc, 1)) ? message : "")); |
| if (message) |
| talloc_free(message); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(show_logging, |
| show_logging_cmd, |
| "show logging", SHOW_STR "Show current logging configuration\n") |
| { |
| struct zlog *zl = zlog_default; |
| |
| vty_out(vty, "Syslog logging: "); |
| if (zl->maxlvl[ZLOG_DEST_SYSLOG] == ZLOG_DISABLED) |
| vty_out(vty, "disabled"); |
| else |
| vty_out(vty, "level %s, facility %s, ident %s", |
| zlog_priority[zl->maxlvl[ZLOG_DEST_SYSLOG]], |
| facility_name(zl->facility), zl->ident); |
| vty_out(vty, "%s", VTY_NEWLINE); |
| |
| vty_out(vty, "Stdout logging: "); |
| if (zl->maxlvl[ZLOG_DEST_STDOUT] == ZLOG_DISABLED) |
| vty_out(vty, "disabled"); |
| else |
| vty_out(vty, "level %s", |
| zlog_priority[zl->maxlvl[ZLOG_DEST_STDOUT]]); |
| vty_out(vty, "%s", VTY_NEWLINE); |
| |
| vty_out(vty, "Monitor logging: "); |
| if (zl->maxlvl[ZLOG_DEST_MONITOR] == ZLOG_DISABLED) |
| vty_out(vty, "disabled"); |
| else |
| vty_out(vty, "level %s", |
| zlog_priority[zl->maxlvl[ZLOG_DEST_MONITOR]]); |
| vty_out(vty, "%s", VTY_NEWLINE); |
| |
| vty_out(vty, "File logging: "); |
| if ((zl->maxlvl[ZLOG_DEST_FILE] == ZLOG_DISABLED) || !zl->fp) |
| vty_out(vty, "disabled"); |
| else |
| vty_out(vty, "level %s, filename %s", |
| zlog_priority[zl->maxlvl[ZLOG_DEST_FILE]], |
| zl->filename); |
| vty_out(vty, "%s", VTY_NEWLINE); |
| |
| vty_out(vty, "Protocol name: %s%s", |
| zlog_proto_names[zl->protocol], VTY_NEWLINE); |
| vty_out(vty, "Record priority: %s%s", |
| (zl->record_priority ? "enabled" : "disabled"), VTY_NEWLINE); |
| |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_log_stdout, |
| config_log_stdout_cmd, |
| "log stdout", "Logging control\n" "Set stdout logging level\n") |
| { |
| zlog_set_level(NULL, ZLOG_DEST_STDOUT, zlog_default->default_lvl); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_log_stdout_level, |
| config_log_stdout_level_cmd, |
| "log stdout " LOG_LEVELS, |
| "Logging control\n" "Set stdout logging level\n" LOG_LEVEL_DESC) |
| { |
| int level; |
| |
| if ((level = level_match(argv[0])) == ZLOG_DISABLED) |
| return CMD_ERR_NO_MATCH; |
| zlog_set_level(NULL, ZLOG_DEST_STDOUT, level); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_config_log_stdout, |
| no_config_log_stdout_cmd, |
| "no log stdout [LEVEL]", |
| NO_STR "Logging control\n" "Cancel logging to stdout\n" "Logging level\n") |
| { |
| zlog_set_level(NULL, ZLOG_DEST_STDOUT, ZLOG_DISABLED); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_log_monitor, |
| config_log_monitor_cmd, |
| "log monitor", |
| "Logging control\n" "Set terminal line (monitor) logging level\n") |
| { |
| zlog_set_level(NULL, ZLOG_DEST_MONITOR, zlog_default->default_lvl); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_log_monitor_level, |
| config_log_monitor_level_cmd, |
| "log monitor " LOG_LEVELS, |
| "Logging control\n" |
| "Set terminal line (monitor) logging level\n" LOG_LEVEL_DESC) |
| { |
| int level; |
| |
| if ((level = level_match(argv[0])) == ZLOG_DISABLED) |
| return CMD_ERR_NO_MATCH; |
| zlog_set_level(NULL, ZLOG_DEST_MONITOR, level); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_config_log_monitor, |
| no_config_log_monitor_cmd, |
| "no log monitor [LEVEL]", |
| NO_STR |
| "Logging control\n" |
| "Disable terminal line (monitor) logging\n" "Logging level\n") |
| { |
| zlog_set_level(NULL, ZLOG_DEST_MONITOR, ZLOG_DISABLED); |
| return CMD_SUCCESS; |
| } |
| |
| static int set_log_file(struct vty *vty, const char *fname, int loglevel) |
| { |
| int ret; |
| char *p = NULL; |
| const char *fullpath; |
| |
| /* Path detection. */ |
| if (!IS_DIRECTORY_SEP(*fname)) { |
| char cwd[MAXPATHLEN + 1]; |
| cwd[MAXPATHLEN] = '\0'; |
| |
| if (getcwd(cwd, MAXPATHLEN) == NULL) { |
| zlog_err("config_log_file: Unable to alloc mem!"); |
| return CMD_WARNING; |
| } |
| |
| if ((p = _talloc_zero(tall_vcmd_ctx, |
| strlen(cwd) + strlen(fname) + 2), |
| "set_log_file") |
| == NULL) { |
| zlog_err("config_log_file: Unable to alloc mem!"); |
| return CMD_WARNING; |
| } |
| sprintf(p, "%s/%s", cwd, fname); |
| fullpath = p; |
| } else |
| fullpath = fname; |
| |
| ret = zlog_set_file(NULL, fullpath, loglevel); |
| |
| if (p) |
| talloc_free(p); |
| |
| if (!ret) { |
| vty_out(vty, "can't open logfile %s\n", fname); |
| return CMD_WARNING; |
| } |
| |
| if (host.logfile) |
| talloc_free(host.logfile); |
| |
| host.logfile = talloc_strdup(tall_vty_cmd_ctx, fname); |
| |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_log_file, |
| config_log_file_cmd, |
| "log file FILENAME", |
| "Logging control\n" "Logging to file\n" "Logging filename\n") |
| { |
| return set_log_file(vty, argv[0], zlog_default->default_lvl); |
| } |
| |
| DEFUN(config_log_file_level, |
| config_log_file_level_cmd, |
| "log file FILENAME " LOG_LEVELS, |
| "Logging control\n" |
| "Logging to file\n" "Logging filename\n" LOG_LEVEL_DESC) |
| { |
| int level; |
| |
| if ((level = level_match(argv[1])) == ZLOG_DISABLED) |
| return CMD_ERR_NO_MATCH; |
| return set_log_file(vty, argv[0], level); |
| } |
| |
| DEFUN(no_config_log_file, |
| no_config_log_file_cmd, |
| "no log file [FILENAME]", |
| NO_STR |
| "Logging control\n" "Cancel logging to file\n" "Logging file name\n") |
| { |
| zlog_reset_file(NULL); |
| |
| if (host.logfile) |
| talloc_free(host.logfile); |
| |
| host.logfile = NULL; |
| |
| return CMD_SUCCESS; |
| } |
| |
| ALIAS(no_config_log_file, |
| no_config_log_file_level_cmd, |
| "no log file FILENAME LEVEL", |
| NO_STR |
| "Logging control\n" |
| "Cancel logging to file\n" "Logging file name\n" "Logging level\n") |
| |
| DEFUN(config_log_syslog, |
| config_log_syslog_cmd, |
| "log syslog", "Logging control\n" "Set syslog logging level\n") |
| { |
| zlog_set_level(NULL, ZLOG_DEST_SYSLOG, zlog_default->default_lvl); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_log_syslog_level, |
| config_log_syslog_level_cmd, |
| "log syslog " LOG_LEVELS, |
| "Logging control\n" "Set syslog logging level\n" LOG_LEVEL_DESC) |
| { |
| int level; |
| |
| if ((level = level_match(argv[0])) == ZLOG_DISABLED) |
| return CMD_ERR_NO_MATCH; |
| zlog_set_level(NULL, ZLOG_DEST_SYSLOG, level); |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN_DEPRECATED(config_log_syslog_facility, |
| config_log_syslog_facility_cmd, |
| "log syslog facility " LOG_FACILITIES, |
| "Logging control\n" |
| "Logging goes to syslog\n" |
| "(Deprecated) Facility parameter for syslog messages\n" |
| LOG_FACILITY_DESC) |
| { |
| int facility; |
| |
| if ((facility = facility_match(argv[0])) < 0) |
| return CMD_ERR_NO_MATCH; |
| |
| zlog_set_level(NULL, ZLOG_DEST_SYSLOG, zlog_default->default_lvl); |
| zlog_default->facility = facility; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_config_log_syslog, |
| no_config_log_syslog_cmd, |
| "no log syslog [LEVEL]", |
| NO_STR "Logging control\n" "Cancel logging to syslog\n" "Logging level\n") |
| { |
| zlog_set_level(NULL, ZLOG_DEST_SYSLOG, ZLOG_DISABLED); |
| return CMD_SUCCESS; |
| } |
| |
| ALIAS(no_config_log_syslog, |
| no_config_log_syslog_facility_cmd, |
| "no log syslog facility " LOG_FACILITIES, |
| NO_STR |
| "Logging control\n" |
| "Logging goes to syslog\n" |
| "Facility parameter for syslog messages\n" LOG_FACILITY_DESC) |
| |
| DEFUN(config_log_facility, |
| config_log_facility_cmd, |
| "log facility " LOG_FACILITIES, |
| "Logging control\n" |
| "Facility parameter for syslog messages\n" LOG_FACILITY_DESC) |
| { |
| int facility; |
| |
| if ((facility = facility_match(argv[0])) < 0) |
| return CMD_ERR_NO_MATCH; |
| zlog_default->facility = facility; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_config_log_facility, |
| no_config_log_facility_cmd, |
| "no log facility [FACILITY]", |
| NO_STR |
| "Logging control\n" |
| "Reset syslog facility to default (daemon)\n" "Syslog facility\n") |
| { |
| zlog_default->facility = LOG_DAEMON; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN_DEPRECATED(config_log_trap, |
| config_log_trap_cmd, |
| "log trap " LOG_LEVELS, |
| "Logging control\n" |
| "(Deprecated) Set logging level and default for all destinations\n" |
| LOG_LEVEL_DESC) |
| { |
| int new_level; |
| int i; |
| |
| if ((new_level = level_match(argv[0])) == ZLOG_DISABLED) |
| return CMD_ERR_NO_MATCH; |
| |
| zlog_default->default_lvl = new_level; |
| for (i = 0; i < ZLOG_NUM_DESTS; i++) |
| if (zlog_default->maxlvl[i] != ZLOG_DISABLED) |
| zlog_default->maxlvl[i] = new_level; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN_DEPRECATED(no_config_log_trap, |
| no_config_log_trap_cmd, |
| "no log trap [LEVEL]", |
| NO_STR |
| "Logging control\n" |
| "Permit all logging information\n" "Logging level\n") |
| { |
| zlog_default->default_lvl = LOG_DEBUG; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(config_log_record_priority, |
| config_log_record_priority_cmd, |
| "log record-priority", |
| "Logging control\n" |
| "Log the priority of the message within the message\n") |
| { |
| zlog_default->record_priority = 1; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_config_log_record_priority, |
| no_config_log_record_priority_cmd, |
| "no log record-priority", |
| NO_STR |
| "Logging control\n" |
| "Do not log the priority of the message within the message\n") |
| { |
| zlog_default->record_priority = 0; |
| return CMD_SUCCESS; |
| } |
| #endif |
| |
| DEFUN(banner_motd_file, |
| banner_motd_file_cmd, |
| "banner motd file [FILE]", |
| "Set banner\n" "Banner for motd\n" "Banner from a file\n" "Filename\n") |
| { |
| if (host.motdfile) |
| talloc_free(host.motdfile); |
| host.motdfile = talloc_strdup(tall_vty_cmd_ctx, argv[0]); |
| |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(banner_motd_default, |
| banner_motd_default_cmd, |
| "banner motd default", |
| "Set banner string\n" "Strings for motd\n" "Default string\n") |
| { |
| host.motd = default_motd; |
| return CMD_SUCCESS; |
| } |
| |
| DEFUN(no_banner_motd, |
| no_banner_motd_cmd, |
| "no banner motd", NO_STR "Set banner string\n" "Strings for motd\n") |
| { |
| host.motd = NULL; |
| if (host.motdfile) |
| talloc_free(host.motdfile); |
| host.motdfile = NULL; |
| return CMD_SUCCESS; |
| } |
| |
| /* Set config filename. Called from vty.c */ |
| void host_config_set(const char *filename) |
| { |
| host.config = talloc_strdup(tall_vty_cmd_ctx, filename); |
| } |
| |
| const char *host_config_file(void) |
| { |
| return host.config; |
| } |
| |
| /*! Deprecated, now happens implicitly when calling install_node(). |
| * Users of the API may still attempt to call this function, hence |
| * leave it here as a no-op. */ |
| void install_default(int node) |
| { |
| } |
| |
| /*! Deprecated, now happens implicitly when calling install_node(). |
| * Users of the API may still attempt to call this function, hence |
| * leave it here as a no-op. */ |
| void vty_install_default(int node) |
| { |
| } |
| |
| /*! Install common commands like 'exit' and 'list'. */ |
| static void install_basic_node_commands(int node) |
| { |
| install_lib_element(node, &config_help_cmd); |
| install_lib_element(node, &config_list_cmd); |
| |
| install_lib_element(node, &show_vty_attr_all_cmd); |
| install_lib_element(node, &show_vty_attr_cmd); |
| |
| install_lib_element(node, &config_write_terminal_cmd); |
| install_lib_element(node, &config_write_file_cmd); |
| install_lib_element(node, &config_write_memory_cmd); |
| install_lib_element(node, &config_write_cmd); |
| install_lib_element(node, &show_running_config_cmd); |
| |
| install_lib_element(node, &config_exit_cmd); |
| |
| if (node >= CONFIG_NODE) { |
| /* It's not a top node. */ |
| install_lib_element(node, &config_end_cmd); |
| } |
| } |
| |
| /*! Return true if a node is installed by install_basic_node_commands(), so |
| * that we can avoid repeating them for each and every node during 'show |
| * running-config' */ |
| static bool vty_command_is_common(const struct cmd_element *cmd) |
| { |
| if (cmd == &config_help_cmd |
| || cmd == &show_vty_attr_all_cmd |
| || cmd == &show_vty_attr_cmd |
| || cmd == &config_list_cmd |
| || cmd == &config_write_terminal_cmd |
| || cmd == &config_write_file_cmd |
| || cmd == &config_write_memory_cmd |
| || cmd == &config_write_cmd |
| || cmd == &show_running_config_cmd |
| || cmd == &config_exit_cmd |
| || cmd == &config_end_cmd) |
| return true; |
| return false; |
| } |
| |
| /** |
| * Write the current running config to a given file |
| * \param[in] vty the vty of the code |
| * \param[in] filename where to store the file |
| * \return 0 in case of success. |
| * |
| * If the filename already exists create a filename.sav |
| * version with the current code. |
| * |
| */ |
| int osmo_vty_write_config_file(const char *filename) |
| { |
| char *failed_file; |
| int rc; |
| |
| rc = write_config_file(filename, &failed_file); |
| talloc_free(failed_file); |
| return rc; |
| } |
| |
| /** |
| * Save the current state to the config file |
| * \return 0 in case of success. |
| * |
| * If the filename already exists create a filename.sav |
| * version with the current code. |
| * |
| */ |
| int osmo_vty_save_config_file(void) |
| { |
| char *failed_file; |
| int rc; |
| |
| if (host.config == NULL) |
| return -7; |
| |
| rc = write_config_file(host.config, &failed_file); |
| talloc_free(failed_file); |
| return rc; |
| } |
| |
| /* Initialize command interface. Install basic nodes and commands. */ |
| void cmd_init(int terminal) |
| { |
| /* Allocate initial top vector of commands. */ |
| cmdvec = vector_init(VECTOR_MIN_SIZE); |
| |
| /* Default host value settings. */ |
| host.name = NULL; |
| host.password = NULL; |
| host.enable = NULL; |
| host.logfile = NULL; |
| host.config = NULL; |
| host.lines = -1; |
| host.motd = default_motd; |
| host.motdfile = NULL; |
| |
| /* Install top nodes. */ |
| install_node_bare(&view_node, NULL); |
| install_node(&enable_node, NULL); |
| install_node_bare(&auth_node, NULL); |
| install_node_bare(&auth_enable_node, NULL); |
| install_node(&config_node, config_write_host); |
| |
| /* Each node's basic commands. */ |
| install_lib_element(VIEW_NODE, &show_pid_cmd); |
| install_lib_element(VIEW_NODE, &show_uptime_cmd); |
| install_lib_element(VIEW_NODE, &show_version_cmd); |
| install_lib_element(VIEW_NODE, &show_online_help_cmd); |
| if (terminal) { |
| install_lib_element(VIEW_NODE, &config_list_cmd); |
| install_lib_element(VIEW_NODE, &config_exit_cmd); |
| install_lib_element(VIEW_NODE, &config_help_cmd); |
| install_lib_element(VIEW_NODE, &show_vty_attr_all_cmd); |
| install_lib_element(VIEW_NODE, &show_vty_attr_cmd); |
| install_lib_element(VIEW_NODE, &config_enable_cmd); |
| install_lib_element(VIEW_NODE, &config_terminal_length_cmd); |
| install_lib_element(VIEW_NODE, &config_terminal_no_length_cmd); |
| install_lib_element(VIEW_NODE, &echo_cmd); |
| } |
| |
| if (terminal) { |
| install_lib_element(ENABLE_NODE, &config_disable_cmd); |
| install_lib_element(ENABLE_NODE, &config_terminal_cmd); |
| install_lib_element(ENABLE_NODE, ©_runningconfig_startupconfig_cmd); |
| install_lib_element(ENABLE_NODE, &shutdown_cmd); |
| } |
| install_lib_element(ENABLE_NODE, &show_startup_config_cmd); |
| install_lib_element(ENABLE_NODE, &show_version_cmd); |
| install_lib_element(ENABLE_NODE, &show_online_help_cmd); |
| |
| if (terminal) { |
| install_lib_element(ENABLE_NODE, &config_terminal_length_cmd); |
| install_lib_element(ENABLE_NODE, &config_terminal_no_length_cmd); |
| install_lib_element(ENABLE_NODE, &echo_cmd); |
| } |
| |
| install_lib_element(CONFIG_NODE, &hostname_cmd); |
| install_lib_element(CONFIG_NODE, &no_hostname_cmd); |
| |
| if (terminal) { |
| install_lib_element(CONFIG_NODE, &password_cmd); |
| install_lib_element(CONFIG_NODE, &password_text_cmd); |
| install_lib_element(CONFIG_NODE, &enable_password_cmd); |
| install_lib_element(CONFIG_NODE, &enable_password_text_cmd); |
| install_lib_element(CONFIG_NODE, &no_enable_password_cmd); |
| |
| #ifdef VTY_CRYPT_PW |
| install_lib_element(CONFIG_NODE, &service_password_encrypt_cmd); |
| install_lib_element(CONFIG_NODE, &no_service_password_encrypt_cmd); |
| #endif |
| install_lib_element(CONFIG_NODE, &banner_motd_default_cmd); |
| install_lib_element(CONFIG_NODE, &banner_motd_file_cmd); |
| install_lib_element(CONFIG_NODE, &no_banner_motd_cmd); |
| install_lib_element(CONFIG_NODE, &service_terminal_length_cmd); |
| install_lib_element(CONFIG_NODE, &no_service_terminal_length_cmd); |
| |
| } |
| srand(time(NULL)); |
| } |
| |
| static __attribute__((constructor)) void on_dso_load_starttime(void) |
| { |
| osmo_clock_gettime(CLOCK_MONOTONIC, &starttime); |
| } |
| |
| /* FIXME: execute this section in the unit test instead */ |
| static __attribute__((constructor)) void on_dso_load(void) |
| { |
| unsigned int i, j; |
| |
| /* Check total number of the library specific attributes */ |
| OSMO_ASSERT(_OSMO_CORE_LIB_ATTR_COUNT < 32); |
| |
| /* Check for duplicates in the list of library specific flags */ |
| for (i = 0; i < _OSMO_CORE_LIB_ATTR_COUNT; i++) { |
| if (cmd_lib_attr_letters[i] == '\0') |
| continue; |
| |
| /* Some flag characters are reserved for global attributes */ |
| const char rafc[] = VTY_CMD_ATTR_FLAGS_RESERVED; |
| for (j = 0; j < ARRAY_SIZE(rafc); j++) |
| OSMO_ASSERT(cmd_lib_attr_letters[i] != rafc[j]); |
| |
| /* Only upper case flag letters are allowed for libraries */ |
| OSMO_ASSERT(cmd_lib_attr_letters[i] >= 'A'); |
| OSMO_ASSERT(cmd_lib_attr_letters[i] <= 'Z'); |
| |
| for (j = i + 1; j < _OSMO_CORE_LIB_ATTR_COUNT; j++) |
| OSMO_ASSERT(cmd_lib_attr_letters[i] != cmd_lib_attr_letters[j]); |
| } |
| } |
| |
| /*! @} */ |