vtysh/vtysh_config.c

   1 /* Configuration generator.
   2  * Copyright (C) 2000 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include <zebra.h>
  22
  23 #include "command.h"
  24 #include "linklist.h"
  25 #include "memory.h"
  26
  27 #include "vtysh/vtysh.h"
  28 #include "vtysh/vtysh_user.h"
  29
  30 DEFINE_MGROUP(MVTYSH, "vtysh")
  31 DEFINE_MTYPE_STATIC(MVTYSH, VTYSH_CONFIG, "Vtysh configuration")
  32 DEFINE_MTYPE_STATIC(MVTYSH, VTYSH_CONFIG_LINE, "Vtysh configuration line")
  33
  34 vector configvec;
  35
  36 struct config {
  37         /* Configuration node name. */
  38         char *name;
  39
  40         /* Configuration string line. */
  41         struct list *line;
  42
  43         /* Configuration can be nest. */
  44         struct config *config;
  45
  46         /* Index of this config. */
  47         u_int32_t index;
  48 };
  49
  50 struct list *config_top;
  51
  52 static int line_cmp(char *c1, char *c2)
  53 {
  54         return strcmp(c1, c2);
  55 }
  56
  57 static void line_del(char *line)
  58 {
  59         XFREE(MTYPE_VTYSH_CONFIG_LINE, line);
  60 }
  61
  62 static struct config *config_new(void)
  63 {
  64         struct config *config;
  65         config = XCALLOC(MTYPE_VTYSH_CONFIG, sizeof(struct config));
  66         return config;
  67 }
  68
  69 static int config_cmp(struct config *c1, struct config *c2)
  70 {
  71         return strcmp(c1->name, c2->name);
  72 }
  73
  74 static void config_del(struct config *config)
  75 {
  76         list_delete(config->line);
  77         if (config->name)
  78                 XFREE(MTYPE_VTYSH_CONFIG_LINE, config->name);
  79         XFREE(MTYPE_VTYSH_CONFIG, config);
  80 }
  81
  82 static struct config *config_get(int index, const char *line)
  83 {
  84         struct config *config;
  85         struct config *config_loop;
  86         struct list *master;
  87         struct listnode *node, *nnode;
  88
  89         config = config_loop = NULL;
  90
  91         master = vector_lookup_ensure(configvec, index);
  92
  93         if (!master) {
  94                 master = list_new();
  95                 master->del = (void (*)(void *))config_del;
  96                 master->cmp = (int (*)(void *, void *))config_cmp;
  97                 vector_set_index(configvec, index, master);
  98         }
  99
 100         for (ALL_LIST_ELEMENTS(master, node, nnode, config_loop)) {
 101                 if (strcmp(config_loop->name, line) == 0)
 102                         config = config_loop;
 103         }
 104
 105         if (!config) {
 106                 config = config_new();
 107                 config->line = list_new();
 108                 config->line->del = (void (*)(void *))line_del;
 109                 config->line->cmp = (int (*)(void *, void *))line_cmp;
 110                 config->name = XSTRDUP(MTYPE_VTYSH_CONFIG_LINE, line);
 111                 config->index = index;
 112                 listnode_add(master, config);
 113         }
 114         return config;
 115 }
 116
 117 void config_add_line(struct list *config, const char *line)
 118 {
 119         listnode_add(config, XSTRDUP(MTYPE_VTYSH_CONFIG_LINE, line));
 120 }
 121
 122 static void config_add_line_uniq(struct list *config, const char *line)
 123 {
 124         struct listnode *node, *nnode;
 125         char *pnt;
 126
 127         for (ALL_LIST_ELEMENTS(config, node, nnode, pnt)) {
 128                 if (strcmp(pnt, line) == 0)
 129                         return;
 130         }
 131         listnode_add_sort(config, XSTRDUP(MTYPE_VTYSH_CONFIG_LINE, line));
 132 }
 133
 134 void vtysh_config_parse_line(void *arg, const char *line)
 135 {
 136         char c;
 137         static struct config *config = NULL;
 138
 139         if (!line)
 140                 return;
 141
 142         c = line[0];
 143
 144         if (c == '\0')
 145                 return;
 146
 147         /* printf ("[%s]\n", line); */
 148
 149         switch (c) {
 150         /* Suppress exclamation points ! and commented lines. The !s are
 151          * generated
 152          * dynamically in vtysh_config_dump() */
 153         case '!':
 154         case '#':
 155                 break;
 156         case ' ':
 157                 /* Store line to current configuration. */
 158                 if (config) {
 159                         if (strncmp(line, " link-params",
 160                                     strlen(" link-params"))
 161                             == 0) {
 162                                 config_add_line(config->line, line);
 163                                 config->index = LINK_PARAMS_NODE;
 164                         } else if (config->index == LINK_PARAMS_NODE
 165                                    && strncmp(line, "  exit-link-params",
 166                                               strlen("  exit"))
 167                                               == 0) {
 168                                 config_add_line(config->line, line);
 169                                 config->index = INTERFACE_NODE;
 170                         } else if (config->index == RMAP_NODE
 171                                    || config->index == INTERFACE_NODE
 172                                    || config->index == NS_NODE
 173                                    || config->index == VTY_NODE
 174                                    || config->index == VRF_NODE)
 175                                 config_add_line_uniq(config->line, line);
 176                         else
 177                                 config_add_line(config->line, line);
 178                 } else
 179                         config_add_line(config_top, line);
 180                 break;
 181         default:
 182                 if (strncmp(line, "interface", strlen("interface")) == 0)
 183                         config = config_get(INTERFACE_NODE, line);
 184                 else if (strncmp(line, "pseudowire", strlen("pseudowire")) == 0)
 185                         config = config_get(PW_NODE, line);
 186                 else if (strncmp(line, "logical-router", strlen("ns")) == 0)
 187                         config = config_get(NS_NODE, line);
 188                 else if (strncmp(line, "vrf", strlen("vrf")) == 0)
 189                         config = config_get(VRF_NODE, line);
 190                 else if (strncmp(line, "router-id", strlen("router-id")) == 0)
 191                         config = config_get(ZEBRA_NODE, line);
 192                 else if (strncmp(line, "router rip", strlen("router rip")) == 0)
 193                         config = config_get(RIP_NODE, line);
 194                 else if (strncmp(line, "router ripng", strlen("router ripng"))
 195                          == 0)
 196                         config = config_get(RIPNG_NODE, line);
 197                 else if (strncmp(line, "router eigrp", strlen("router eigrp"))
 198                          == 0)
 199                         config = config_get(EIGRP_NODE, line);
 200                 else if (strncmp(line, "router babel", strlen("router babel"))
 201                          == 0)
 202                         config = config_get(BABEL_NODE, line);
 203                 else if (strncmp(line, "router ospf", strlen("router ospf"))
 204                          == 0)
 205                         config = config_get(OSPF_NODE, line);
 206                 else if (strncmp(line, "router ospf6", strlen("router ospf6"))
 207                          == 0)
 208                         config = config_get(OSPF6_NODE, line);
 209                 else if (strncmp(line, "mpls ldp", strlen("mpls ldp")) == 0)
 210                         config = config_get(LDP_NODE, line);
 211                 else if (strncmp(line, "l2vpn", strlen("l2vpn")) == 0)
 212                         config = config_get(LDP_L2VPN_NODE, line);
 213                 else if (strncmp(line, "router bgp", strlen("router bgp")) == 0)
 214                         config = config_get(BGP_NODE, line);
 215                 else if (strncmp(line, "router isis", strlen("router isis"))
 216                          == 0)
 217                         config = config_get(ISIS_NODE, line);
 218                 else if (strncmp(line, "route-map", strlen("route-map")) == 0)
 219                         config = config_get(RMAP_NODE, line);
 220                 else if (strncmp(line, "access-list", strlen("access-list"))
 221                          == 0)
 222                         config = config_get(ACCESS_NODE, line);
 223                 else if (strncmp(line, "ipv6 access-list",
 224                                  strlen("ipv6 access-list"))
 225                          == 0)
 226                         config = config_get(ACCESS_IPV6_NODE, line);
 227                 else if (strncmp(line, "ip prefix-list",
 228                                  strlen("ip prefix-list"))
 229                          == 0)
 230                         config = config_get(PREFIX_NODE, line);
 231                 else if (strncmp(line, "ipv6 prefix-list",
 232                                  strlen("ipv6 prefix-list"))
 233                          == 0)
 234                         config = config_get(PREFIX_IPV6_NODE, line);
 235                 else if (strncmp(line, "ip as-path access-list",
 236                                  strlen("ip as-path access-list"))
 237                          == 0)
 238                         config = config_get(AS_LIST_NODE, line);
 239                 else if (strncmp(line, "ip community-list",
 240                                  strlen("ip community-list"))
 241                                  == 0
 242                          || strncmp(line, "ip extcommunity-list",
 243                                     strlen("ip extcommunity-list"))
 244                                     == 0)
 245                         config = config_get(COMMUNITY_LIST_NODE, line);
 246                 else if (strncmp(line, "ip route", strlen("ip route")) == 0)
 247                         config = config_get(IP_NODE, line);
 248                 else if (strncmp(line, "ipv6 route", strlen("ipv6 route")) == 0)
 249                         config = config_get(IP_NODE, line);
 250                 else if (strncmp(line, "key", strlen("key")) == 0)
 251                         config = config_get(KEYCHAIN_NODE, line);
 252                 else if (strncmp(line, "line", strlen("line")) == 0)
 253                         config = config_get(VTY_NODE, line);
 254                 else if ((strncmp(line, "ipv6 forwarding",
 255                                   strlen("ipv6 forwarding"))
 256                           == 0)
 257                          || (strncmp(line, "ip forwarding",
 258                                      strlen("ip forwarding"))
 259                              == 0))
 260                         config = config_get(FORWARDING_NODE, line);
 261                 else if (strncmp(line, "service", strlen("service")) == 0)
 262                         config = config_get(SERVICE_NODE, line);
 263                 else if (strncmp(line, "debug vrf", strlen("debug vrf")) == 0)
 264                         config = config_get(VRF_DEBUG_NODE, line);
 265                 else if (strncmp(line, "debug", strlen("debug")) == 0)
 266                         config = config_get(DEBUG_NODE, line);
 267                 else if (strncmp(line, "password", strlen("password")) == 0
 268                          || strncmp(line, "enable password",
 269                                     strlen("enable password"))
 270                                     == 0)
 271                         config = config_get(AAA_NODE, line);
 272                 else if (strncmp(line, "ip protocol", strlen("ip protocol"))
 273                          == 0)
 274                         config = config_get(PROTOCOL_NODE, line);
 275                 else if (strncmp(line, "ipv6 protocol", strlen("ipv6 protocol"))
 276                          == 0)
 277                         config = config_get(PROTOCOL_NODE, line);
 278                 else if (strncmp(line, "ip nht", strlen("ip nht")) == 0)
 279                         config = config_get(PROTOCOL_NODE, line);
 280                 else if (strncmp(line, "ipv6 nht", strlen("ipv6 nht")) == 0)
 281                         config = config_get(PROTOCOL_NODE, line);
 282                 else if (strncmp(line, "mpls", strlen("mpls")) == 0)
 283                         config = config_get(MPLS_NODE, line);
 284                 else {
 285                         if (strncmp(line, "log", strlen("log")) == 0
 286                             || strncmp(line, "hostname", strlen("hostname"))
 287                                        == 0
 288                             || strncmp(line, "frr", strlen("frr")) == 0
 289                             || strncmp(line, "agentx", strlen("agentx")) == 0
 290                             || strncmp(line, "no log", strlen("no log")) == 0)
 291                                 config_add_line_uniq(config_top, line);
 292                         else
 293                                 config_add_line(config_top, line);
 294                         config = NULL;
 295                 }
 296                 break;
 297         }
 298 }
 299
 300 /* Macro to check delimiter is needed between each configuration line
 301  * or not. */
 302 #define NO_DELIMITER(I)                                                        \
 303         ((I) == ACCESS_NODE || (I) == PREFIX_NODE || (I) == IP_NODE            \
 304          || (I) == AS_LIST_NODE || (I) == COMMUNITY_LIST_NODE                  \
 305          || (I) == ACCESS_IPV6_NODE || (I) == PREFIX_IPV6_NODE                 \
 306          || (I) == SERVICE_NODE || (I) == FORWARDING_NODE || (I) == DEBUG_NODE \
 307          || (I) == AAA_NODE || (I) == VRF_DEBUG_NODE || (I) == MPLS_NODE)
 308
 309 /* Display configuration to file pointer. */
 310 void vtysh_config_dump(FILE *fp)
 311 {
 312         struct listnode *node, *nnode;
 313         struct listnode *mnode, *mnnode;
 314         struct config *config;
 315         struct list *master;
 316         char *line;
 317         unsigned int i;
 318
 319         for (ALL_LIST_ELEMENTS(config_top, node, nnode, line)) {
 320                 fprintf(fp, "%s\n", line);
 321                 fflush(fp);
 322         }
 323         fprintf(fp, "!\n");
 324         fflush(fp);
 325
 326         for (i = 0; i < vector_active(configvec); i++)
 327                 if ((master = vector_slot(configvec, i)) != NULL) {
 328                         for (ALL_LIST_ELEMENTS(master, node, nnode, config)) {
 329                                 /* Don't print empty sections for interface/vrf.
 330                                  * Route maps on the
 331                                  * other hand could have a legitimate empty
 332                                  * section at the end.
 333                                  */
 334                                 if ((config->index == INTERFACE_NODE
 335                                      || config->index == VRF_NODE)
 336                                     && list_isempty(config->line))
 337                                         continue;
 338
 339                                 fprintf(fp, "%s\n", config->name);
 340                                 fflush(fp);
 341
 342                                 for (ALL_LIST_ELEMENTS(config->line, mnode,
 343                                                        mnnode, line)) {
 344                                         fprintf(fp, "%s\n", line);
 345                                         fflush(fp);
 346                                 }
 347                                 if (!NO_DELIMITER(i)) {
 348                                         fprintf(fp, "!\n");
 349                                         fflush(fp);
 350                                 }
 351                         }
 352                         if (NO_DELIMITER(i)) {
 353                                 fprintf(fp, "!\n");
 354                                 fflush(fp);
 355                         }
 356                 }
 357
 358         for (i = 0; i < vector_active(configvec); i++)
 359                 if ((master = vector_slot(configvec, i)) != NULL) {
 360                         list_delete(master);
 361                         vector_slot(configvec, i) = NULL;
 362                 }
 363         list_delete_all_node(config_top);
 364 }
 365
 366 /* Read up configuration file from file_name. */
 367 static int vtysh_read_file(FILE *confp)
 368 {
 369         struct vty *vty;
 370         int ret;
 371
 372         vty = vty_new();
 373         vty->fd = 0; /* stdout */
 374         vty->type = VTY_TERM;
 375         vty->node = CONFIG_NODE;
 376
 377         vtysh_execute_no_pager("enable");
 378         vtysh_execute_no_pager("configure terminal");
 379
 380         /* Execute configuration file. */
 381         ret = vtysh_config_from_file(vty, confp);
 382
 383         vtysh_execute_no_pager("end");
 384         vtysh_execute_no_pager("disable");
 385
 386         vty_close(vty);
 387
 388         return (ret);
 389 }
 390
 391 /* Read up configuration file from config_default_dir. */
 392 int vtysh_read_config(const char *config_default_dir)
 393 {
 394         FILE *confp = NULL;
 395         int ret;
 396
 397         confp = fopen(config_default_dir, "r");
 398         if (confp == NULL) {
 399                 fprintf(stderr,
 400                         "%% Can't open configuration file %s due to '%s'.\n",
 401                         config_default_dir, safe_strerror(errno));
 402                 return (CMD_ERR_NO_FILE);
 403         }
 404
 405         ret = vtysh_read_file(confp);
 406         fclose(confp);
 407
 408         return (ret);
 409 }
 410
 411 /* We don't write vtysh specific into file from vtysh. vtysh.conf should
 412  * be edited by hand. So, we handle only "write terminal" case here and
 413  * integrate vtysh specific conf with conf from daemons.
 414  */
 415 void vtysh_config_write()
 416 {
 417         char line[81];
 418         extern struct host host;
 419
 420         if (host.name) {
 421                 sprintf(line, "hostname %s", host.name);
 422                 vtysh_config_parse_line(NULL, line);
 423         }
 424         if (vtysh_write_integrated == WRITE_INTEGRATED_NO)
 425                 vtysh_config_parse_line(NULL,
 426                                         "no service integrated-vtysh-config");
 427         if (vtysh_write_integrated == WRITE_INTEGRATED_YES)
 428                 vtysh_config_parse_line(NULL,
 429                                         "service integrated-vtysh-config");
 430
 431         user_config_write();
 432 }
 433
 434 void vtysh_config_init()
 435 {
 436         config_top = list_new();
 437         config_top->del = (void (*)(void *))line_del;
 438         configvec = vector_init(1);
 439 }