2 * Virtual terminal [aka TeletYpe] interface routine.
3 * Copyright (C) 1997, 98 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <lib/version.h>
25 #include <sys/types.h>
33 #include "sockunion.h"
43 #include "lib_errors.h"
44 #include "northbound_cli.h"
46 #include <arpa/telnet.h>
49 DEFINE_MTYPE_STATIC(LIB
, VTY
, "VTY")
50 DEFINE_MTYPE_STATIC(LIB
, VTY_OUT_BUF
, "VTY output buffer")
51 DEFINE_MTYPE_STATIC(LIB
, VTY_HIST
, "VTY history")
66 static void vty_event(enum event
, int, struct vty
*);
68 /* Extern host structure from command.c */
69 extern struct host host
;
71 /* Vector which store each vty structure. */
74 /* Vty timeout value. */
75 static unsigned long vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
77 /* Vty access-class command */
78 static char *vty_accesslist_name
= NULL
;
80 /* Vty access-calss for IPv6. */
81 static char *vty_ipv6_accesslist_name
= NULL
;
83 /* VTY server thread. */
84 static vector Vvty_serv_thread
;
86 /* Current directory. */
90 static int vty_config
;
91 static int vty_config_is_lockless
= 0;
93 /* Exclusive configuration lock. */
94 struct vty
*vty_exclusive_lock
;
96 /* Login password check. */
97 static int no_password_check
= 0;
99 /* Integrated configuration file path */
100 char integrate_default
[] = SYSCONFDIR INTEGRATE_DEFAULT_CONFIG
;
102 static int do_log_commands
= 0;
104 void vty_frame(struct vty
*vty
, const char *format
, ...)
108 va_start(args
, format
);
109 vsnprintf(vty
->frame
+ vty
->frame_pos
,
110 sizeof(vty
->frame
) - vty
->frame_pos
, format
, args
);
111 vty
->frame_pos
= strlen(vty
->frame
);
115 void vty_endframe(struct vty
*vty
, const char *endtext
)
117 if (vty
->frame_pos
== 0 && endtext
)
118 vty_out(vty
, "%s", endtext
);
122 bool vty_set_include(struct vty
*vty
, const char *regexp
)
130 regfree(&vty
->include
);
136 errcode
= regcomp(&vty
->include
, regexp
,
137 REG_EXTENDED
| REG_NEWLINE
| REG_NOSUB
);
140 regerror(ret
, &vty
->include
, errbuf
, sizeof(errbuf
));
141 vty_out(vty
, "%% Regex compilation error: %s", errbuf
);
149 /* VTY standard output function. */
150 int vty_out(struct vty
*vty
, const char *format
, ...)
159 if (vty
->frame_pos
) {
161 vty_out(vty
, "%s", vty
->frame
);
164 /* Try to write to initial buffer. */
165 va_start(args
, format
);
166 len
= vsnprintf(buf
, sizeof(buf
), format
, args
);
169 /* Initial buffer is not enough. */
170 if (len
< 0 || len
>= size
) {
177 p
= XREALLOC(MTYPE_VTY_OUT_BUF
, p
, size
);
181 va_start(args
, format
);
182 len
= vsnprintf(p
, size
, format
, args
);
185 if (len
> -1 && len
< size
)
190 /* When initial buffer is enough to store all output. */
196 vector lines
= frrstr_split_vec(p
, "\n");
198 /* Place first value in the cache */
199 char *firstline
= vector_slot(lines
, 0);
200 buffer_put(vty
->lbuf
, (uint8_t *) firstline
, strlen(firstline
));
202 /* If our split returned more than one entry, time to filter */
203 if (vector_active(lines
) > 1) {
205 * returned string is MTYPE_TMP so it matches the MTYPE
206 * of everything else in the vector
208 char *bstr
= buffer_getstr(vty
->lbuf
);
209 buffer_reset(vty
->lbuf
);
210 XFREE(MTYPE_TMP
, lines
->index
[0]);
211 vector_set_index(lines
, 0, bstr
);
212 frrstr_filter_vec(lines
, &vty
->include
);
213 vector_compact(lines
);
215 * Consider the string "foo\n". If the regex is an empty string
216 * and the line ended with a newline, then the vector will look
222 * If the regex isn't empty, the vector will look like:
226 * In this case we'd like to preserve the newline, so we add
227 * the empty string [1] as in the first example.
229 if (p
[strlen(p
) - 1] == '\n' && vector_active(lines
) > 0
230 && strlen(vector_slot(lines
, vector_active(lines
) - 1)))
231 vector_set(lines
, XSTRDUP(MTYPE_TMP
, ""));
233 filtered
= frrstr_join_vec(lines
, "\n");
239 frrstr_strvec_free(lines
);
250 /* print with crlf replacement */
251 buffer_put_crlf(vty
->obuf
, (uint8_t *)filtered
,
255 fprintf(vty
->of
, "%s", filtered
);
261 /* print without crlf replacement */
262 buffer_put(vty
->obuf
, (uint8_t *)filtered
, strlen(filtered
));
268 if (vty
->filter
&& filtered
)
269 XFREE(MTYPE_TMP
, filtered
);
271 /* If p is not different with buf, it is allocated buffer. */
273 XFREE(MTYPE_VTY_OUT_BUF
, p
);
278 static int vty_log_out(struct vty
*vty
, const char *level
,
279 const char *proto_str
, const char *format
,
280 struct timestamp_control
*ctl
, va_list va
)
286 if (!ctl
->already_rendered
) {
287 ctl
->len
= quagga_timestamp(ctl
->precision
, ctl
->buf
,
289 ctl
->already_rendered
= 1;
291 if (ctl
->len
+ 1 >= sizeof(buf
))
293 memcpy(buf
, ctl
->buf
, len
= ctl
->len
);
298 ret
= snprintf(buf
+ len
, sizeof(buf
) - len
, "%s: %s: ", level
,
301 ret
= snprintf(buf
+ len
, sizeof(buf
) - len
, "%s: ", proto_str
);
302 if ((ret
< 0) || ((size_t)(len
+= ret
) >= sizeof(buf
)))
305 if (((ret
= vsnprintf(buf
+ len
, sizeof(buf
) - len
, format
, va
)) < 0)
306 || ((size_t)((len
+= ret
) + 2) > sizeof(buf
)))
312 if (write(vty
->wfd
, buf
, len
) < 0) {
313 if (ERRNO_IO_RETRY(errno
))
314 /* Kernel buffer is full, probably too much debugging
316 drop the data and ignore. */
318 /* Fatal I/O error. */
320 0; /* disable monitoring to avoid infinite recursion */
321 flog_err(EC_LIB_SOCKET
,
322 "%s: write failed to vty client fd %d, closing: %s",
323 __func__
, vty
->fd
, safe_strerror(errno
));
324 buffer_reset(vty
->obuf
);
325 buffer_reset(vty
->lbuf
);
326 /* cannot call vty_close, because a parent routine may still try
327 to access the vty struct */
328 vty
->status
= VTY_CLOSE
;
329 shutdown(vty
->fd
, SHUT_RDWR
);
335 /* Output current time to the vty. */
336 void vty_time_print(struct vty
*vty
, int cr
)
338 char buf
[QUAGGA_TIMESTAMP_LEN
];
340 if (quagga_timestamp(0, buf
, sizeof(buf
)) == 0) {
341 zlog_info("quagga_timestamp error");
345 vty_out(vty
, "%s\n", buf
);
347 vty_out(vty
, "%s ", buf
);
352 /* Say hello to vty interface. */
353 void vty_hello(struct vty
*vty
)
359 f
= fopen(host
.motdfile
, "r");
361 while (fgets(buf
, sizeof(buf
), f
)) {
363 /* work backwards to ignore trailling isspace()
365 for (s
= buf
+ strlen(buf
);
366 (s
> buf
) && isspace((int)*(s
- 1)); s
--)
369 vty_out(vty
, "%s\n", buf
);
373 vty_out(vty
, "MOTD file not found\n");
374 } else if (host
.motd
)
375 vty_out(vty
, "%s", host
.motd
);
378 /* Put out prompt and wait input from user. */
379 static void vty_prompt(struct vty
*vty
)
381 if (vty
->type
== VTY_TERM
) {
382 vty_out(vty
, cmd_prompt(vty
->node
), cmd_hostname_get());
386 /* Send WILL TELOPT_ECHO to remote server. */
387 static void vty_will_echo(struct vty
*vty
)
389 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_ECHO
, '\0'};
390 vty_out(vty
, "%s", cmd
);
393 /* Make suppress Go-Ahead telnet option. */
394 static void vty_will_suppress_go_ahead(struct vty
*vty
)
396 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_SGA
, '\0'};
397 vty_out(vty
, "%s", cmd
);
400 /* Make don't use linemode over telnet. */
401 static void vty_dont_linemode(struct vty
*vty
)
403 unsigned char cmd
[] = {IAC
, DONT
, TELOPT_LINEMODE
, '\0'};
404 vty_out(vty
, "%s", cmd
);
407 /* Use window size. */
408 static void vty_do_window_size(struct vty
*vty
)
410 unsigned char cmd
[] = {IAC
, DO
, TELOPT_NAWS
, '\0'};
411 vty_out(vty
, "%s", cmd
);
414 #if 0 /* Currently not used. */
415 /* Make don't use lflow vty interface. */
417 vty_dont_lflow_ahead (struct vty
*vty
)
419 unsigned char cmd
[] = { IAC
, DONT
, TELOPT_LFLOW
, '\0' };
420 vty_out (vty
, "%s", cmd
);
424 /* Authentication of vty */
425 static void vty_auth(struct vty
*vty
, char *buf
)
428 enum node_type next_node
= 0;
430 char *crypt(const char *, const char *);
435 passwd
= host
.password_encrypt
;
437 passwd
= host
.password
;
439 next_node
= host
.enable
? VIEW_NODE
: ENABLE_NODE
;
441 next_node
= VIEW_NODE
;
443 case AUTH_ENABLE_NODE
:
445 passwd
= host
.enable_encrypt
;
447 passwd
= host
.enable
;
448 next_node
= ENABLE_NODE
;
454 fail
= strcmp(crypt(buf
, passwd
), passwd
);
456 fail
= strcmp(buf
, passwd
);
462 vty
->node
= next_node
; /* Success ! */
465 if (vty
->fail
>= 3) {
466 if (vty
->node
== AUTH_NODE
) {
468 "%% Bad passwords, too many failures!\n");
469 vty
->status
= VTY_CLOSE
;
471 /* AUTH_ENABLE_NODE */
474 "%% Bad enable passwords, too many failures!\n");
475 vty
->status
= VTY_CLOSE
;
481 /* Command execution over the vty interface. */
482 static int vty_command(struct vty
*vty
, char *buf
)
485 const char *protocolname
;
491 * Log non empty command lines
496 /* Skip white spaces. */
497 while (isspace((int)*cp
) && *cp
!= '\0')
500 if (cp
!= NULL
&& *cp
!= '\0') {
502 char vty_str
[VTY_BUFSIZ
];
503 char prompt_str
[VTY_BUFSIZ
];
505 /* format the base vty info */
506 snprintf(vty_str
, sizeof(vty_str
), "vty[??]@%s", vty
->address
);
508 for (i
= 0; i
< vector_active(vtyvec
); i
++)
509 if (vty
== vector_slot(vtyvec
, i
)) {
510 snprintf(vty_str
, sizeof(vty_str
), "vty[%d]@%s",
515 /* format the prompt */
516 snprintf(prompt_str
, sizeof(prompt_str
), cmd_prompt(vty
->node
),
519 /* now log the command */
520 zlog_notice("%s%s", prompt_str
, buf
);
523 #ifdef CONSUMED_TIME_CHECK
527 unsigned long realtime
, cputime
;
530 #endif /* CONSUMED_TIME_CHECK */
532 ret
= cmd_execute(vty
, buf
, NULL
, 0);
534 /* Get the name of the protocol if any */
535 protocolname
= frr_protoname
;
537 #ifdef CONSUMED_TIME_CHECK
539 if ((realtime
= thread_consumed_time(&after
, &before
, &cputime
))
540 > CONSUMED_TIME_CHECK
)
541 /* Warn about CPU hog that must be fixed. */
544 "SLOW COMMAND: command took %lums (cpu time %lums): %s",
545 realtime
/ 1000, cputime
/ 1000, buf
);
547 #endif /* CONSUMED_TIME_CHECK */
549 if (ret
!= CMD_SUCCESS
)
552 if (vty
->type
== VTY_FILE
)
553 vty_out(vty
, "Warning...\n");
555 case CMD_ERR_AMBIGUOUS
:
556 vty_out(vty
, "%% Ambiguous command.\n");
558 case CMD_ERR_NO_MATCH
:
559 vty_out(vty
, "%% [%s] Unknown command: %s\n",
562 case CMD_ERR_INCOMPLETE
:
563 vty_out(vty
, "%% Command incomplete.\n");
570 static const char telnet_backward_char
= 0x08;
571 static const char telnet_space_char
= ' ';
573 /* Basic function to write buffer to vty. */
574 static void vty_write(struct vty
*vty
, const char *buf
, size_t nbytes
)
576 if ((vty
->node
== AUTH_NODE
) || (vty
->node
== AUTH_ENABLE_NODE
))
579 /* Should we do buffering here ? And make vty_flush (vty) ? */
580 buffer_put(vty
->obuf
, buf
, nbytes
);
583 /* Basic function to insert character into vty. */
584 static void vty_self_insert(struct vty
*vty
, char c
)
589 if (vty
->length
+ 1 >= VTY_BUFSIZ
)
592 length
= vty
->length
- vty
->cp
;
593 memmove(&vty
->buf
[vty
->cp
+ 1], &vty
->buf
[vty
->cp
], length
);
594 vty
->buf
[vty
->cp
] = c
;
596 vty_write(vty
, &vty
->buf
[vty
->cp
], length
+ 1);
597 for (i
= 0; i
< length
; i
++)
598 vty_write(vty
, &telnet_backward_char
, 1);
603 vty
->buf
[vty
->length
] = '\0';
606 /* Self insert character 'c' in overwrite mode. */
607 static void vty_self_insert_overwrite(struct vty
*vty
, char c
)
609 if (vty
->cp
== vty
->length
) {
610 vty_self_insert(vty
, c
);
614 vty
->buf
[vty
->cp
++] = c
;
615 vty_write(vty
, &c
, 1);
619 * Insert a string into vty->buf at the current cursor position.
621 * If the resultant string would be larger than VTY_BUFSIZ it is
624 static void vty_insert_word_overwrite(struct vty
*vty
, char *str
)
626 if (vty
->cp
== VTY_BUFSIZ
)
629 size_t nwrite
= MIN((int)strlen(str
), VTY_BUFSIZ
- vty
->cp
- 1);
630 memcpy(&vty
->buf
[vty
->cp
], str
, nwrite
);
632 vty
->length
= MAX(vty
->cp
, vty
->length
);
633 vty
->buf
[vty
->length
] = '\0';
634 vty_write(vty
, str
, nwrite
);
637 /* Forward character. */
638 static void vty_forward_char(struct vty
*vty
)
640 if (vty
->cp
< vty
->length
) {
641 vty_write(vty
, &vty
->buf
[vty
->cp
], 1);
646 /* Backward character. */
647 static void vty_backward_char(struct vty
*vty
)
651 vty_write(vty
, &telnet_backward_char
, 1);
655 /* Move to the beginning of the line. */
656 static void vty_beginning_of_line(struct vty
*vty
)
659 vty_backward_char(vty
);
662 /* Move to the end of the line. */
663 static void vty_end_of_line(struct vty
*vty
)
665 while (vty
->cp
< vty
->length
)
666 vty_forward_char(vty
);
669 static void vty_kill_line_from_beginning(struct vty
*);
670 static void vty_redraw_line(struct vty
*);
672 /* Print command line history. This function is called from
673 vty_next_line and vty_previous_line. */
674 static void vty_history_print(struct vty
*vty
)
678 vty_kill_line_from_beginning(vty
);
680 /* Get previous line from history buffer */
681 length
= strlen(vty
->hist
[vty
->hp
]);
682 memcpy(vty
->buf
, vty
->hist
[vty
->hp
], length
);
683 vty
->cp
= vty
->length
= length
;
684 vty
->buf
[vty
->length
] = '\0';
686 /* Redraw current line */
687 vty_redraw_line(vty
);
690 /* Show next command line history. */
691 static void vty_next_line(struct vty
*vty
)
695 if (vty
->hp
== vty
->hindex
)
698 /* Try is there history exist or not. */
700 if (try_index
== (VTY_MAXHIST
- 1))
705 /* If there is not history return. */
706 if (vty
->hist
[try_index
] == NULL
)
711 vty_history_print(vty
);
714 /* Show previous command line history. */
715 static void vty_previous_line(struct vty
*vty
)
721 try_index
= VTY_MAXHIST
- 1;
725 if (vty
->hist
[try_index
] == NULL
)
730 vty_history_print(vty
);
733 /* This function redraw all of the command line character. */
734 static void vty_redraw_line(struct vty
*vty
)
736 vty_write(vty
, vty
->buf
, vty
->length
);
737 vty
->cp
= vty
->length
;
741 static void vty_forward_word(struct vty
*vty
)
743 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
744 vty_forward_char(vty
);
746 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
747 vty_forward_char(vty
);
750 /* Backward word without skipping training space. */
751 static void vty_backward_pure_word(struct vty
*vty
)
753 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
754 vty_backward_char(vty
);
758 static void vty_backward_word(struct vty
*vty
)
760 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
761 vty_backward_char(vty
);
763 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
764 vty_backward_char(vty
);
767 /* When '^D' is typed at the beginning of the line we move to the down
769 static void vty_down_level(struct vty
*vty
)
777 /* When '^Z' is received from vty, move down to the enable mode. */
778 static void vty_end_config(struct vty
*vty
)
797 case BGP_VRF_POLICY_NODE
:
798 case BGP_VNC_DEFAULTS_NODE
:
799 case BGP_VNC_NVE_GROUP_NODE
:
800 case BGP_VNC_L2_GROUP_NODE
:
815 case LDP_IPV4_IFACE_NODE
:
816 case LDP_IPV6_IFACE_NODE
:
818 case LDP_PSEUDOWIRE_NODE
:
820 case OPENFABRIC_NODE
:
822 case KEYCHAIN_KEY_NODE
:
824 case BGP_EVPN_VNI_NODE
:
827 vty_config_unlock(vty
);
828 vty
->node
= ENABLE_NODE
;
831 /* Unknown node, we have to ignore it. */
835 vty
->xpath_index
= 0;
841 /* Delete a charcter at the current point. */
842 static void vty_delete_char(struct vty
*vty
)
847 if (vty
->length
== 0) {
852 if (vty
->cp
== vty
->length
)
853 return; /* completion need here? */
855 size
= vty
->length
- vty
->cp
;
858 memmove(&vty
->buf
[vty
->cp
], &vty
->buf
[vty
->cp
+ 1], size
- 1);
859 vty
->buf
[vty
->length
] = '\0';
861 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
864 vty_write(vty
, &vty
->buf
[vty
->cp
], size
- 1);
865 vty_write(vty
, &telnet_space_char
, 1);
867 for (i
= 0; i
< size
; i
++)
868 vty_write(vty
, &telnet_backward_char
, 1);
871 /* Delete a character before the point. */
872 static void vty_delete_backward_char(struct vty
*vty
)
877 vty_backward_char(vty
);
878 vty_delete_char(vty
);
881 /* Kill rest of line from current point. */
882 static void vty_kill_line(struct vty
*vty
)
887 size
= vty
->length
- vty
->cp
;
892 for (i
= 0; i
< size
; i
++)
893 vty_write(vty
, &telnet_space_char
, 1);
894 for (i
= 0; i
< size
; i
++)
895 vty_write(vty
, &telnet_backward_char
, 1);
897 memset(&vty
->buf
[vty
->cp
], 0, size
);
898 vty
->length
= vty
->cp
;
901 /* Kill line from the beginning. */
902 static void vty_kill_line_from_beginning(struct vty
*vty
)
904 vty_beginning_of_line(vty
);
908 /* Delete a word before the point. */
909 static void vty_forward_kill_word(struct vty
*vty
)
911 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
912 vty_delete_char(vty
);
913 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
914 vty_delete_char(vty
);
917 /* Delete a word before the point. */
918 static void vty_backward_kill_word(struct vty
*vty
)
920 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
921 vty_delete_backward_char(vty
);
922 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
923 vty_delete_backward_char(vty
);
926 /* Transpose chars before or at the point. */
927 static void vty_transpose_chars(struct vty
*vty
)
931 /* If length is short or point is near by the beginning of line then
933 if (vty
->length
< 2 || vty
->cp
< 1)
936 /* In case of point is located at the end of the line. */
937 if (vty
->cp
== vty
->length
) {
938 c1
= vty
->buf
[vty
->cp
- 1];
939 c2
= vty
->buf
[vty
->cp
- 2];
941 vty_backward_char(vty
);
942 vty_backward_char(vty
);
943 vty_self_insert_overwrite(vty
, c1
);
944 vty_self_insert_overwrite(vty
, c2
);
946 c1
= vty
->buf
[vty
->cp
];
947 c2
= vty
->buf
[vty
->cp
- 1];
949 vty_backward_char(vty
);
950 vty_self_insert_overwrite(vty
, c1
);
951 vty_self_insert_overwrite(vty
, c2
);
955 /* Do completion at vty interface. */
956 static void vty_complete_command(struct vty
*vty
)
960 char **matched
= NULL
;
963 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
966 vline
= cmd_make_strvec(vty
->buf
);
970 /* In case of 'help \t'. */
971 if (isspace((int)vty
->buf
[vty
->length
- 1]))
972 vector_set(vline
, NULL
);
974 matched
= cmd_complete_command(vline
, vty
, &ret
);
976 cmd_free_strvec(vline
);
980 case CMD_ERR_AMBIGUOUS
:
981 vty_out(vty
, "%% Ambiguous command.\n");
983 vty_redraw_line(vty
);
985 case CMD_ERR_NO_MATCH
:
986 /* vty_out (vty, "%% There is no matched command.\n"); */
988 vty_redraw_line(vty
);
990 case CMD_COMPLETE_FULL_MATCH
:
992 /* 2016-11-28 equinox -- need to debug, SEGV here */
993 vty_out(vty
, "%% CLI BUG: FULL_MATCH with NULL str\n");
995 vty_redraw_line(vty
);
999 vty_redraw_line(vty
);
1000 vty_backward_pure_word(vty
);
1001 vty_insert_word_overwrite(vty
, matched
[0]);
1002 vty_self_insert(vty
, ' ');
1003 XFREE(MTYPE_COMPLETION
, matched
[0]);
1005 case CMD_COMPLETE_MATCH
:
1007 vty_redraw_line(vty
);
1008 vty_backward_pure_word(vty
);
1009 vty_insert_word_overwrite(vty
, matched
[0]);
1010 XFREE(MTYPE_COMPLETION
, matched
[0]);
1012 case CMD_COMPLETE_LIST_MATCH
:
1013 for (i
= 0; matched
[i
] != NULL
; i
++) {
1014 if (i
!= 0 && ((i
% 6) == 0))
1016 vty_out(vty
, "%-10s ", matched
[i
]);
1017 XFREE(MTYPE_COMPLETION
, matched
[i
]);
1022 vty_redraw_line(vty
);
1024 case CMD_ERR_NOTHING_TODO
:
1026 vty_redraw_line(vty
);
1032 XFREE(MTYPE_TMP
, matched
);
1035 static void vty_describe_fold(struct vty
*vty
, int cmd_width
,
1036 unsigned int desc_width
, struct cmd_token
*token
)
1039 const char *cmd
, *p
;
1044 if (desc_width
<= 0) {
1045 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, token
->desc
);
1049 buf
= XCALLOC(MTYPE_TMP
, strlen(token
->desc
) + 1);
1051 for (p
= token
->desc
; strlen(p
) > desc_width
; p
+= pos
+ 1) {
1052 for (pos
= desc_width
; pos
> 0; pos
--)
1053 if (*(p
+ pos
) == ' ')
1059 strncpy(buf
, p
, pos
);
1061 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, buf
);
1066 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, p
);
1068 XFREE(MTYPE_TMP
, buf
);
1071 /* Describe matched command function. */
1072 static void vty_describe_command(struct vty
*vty
)
1077 unsigned int i
, width
, desc_width
;
1078 struct cmd_token
*token
, *token_cr
= NULL
;
1080 vline
= cmd_make_strvec(vty
->buf
);
1082 /* In case of '> ?'. */
1083 if (vline
== NULL
) {
1084 vline
= vector_init(1);
1085 vector_set(vline
, NULL
);
1086 } else if (isspace((int)vty
->buf
[vty
->length
- 1]))
1087 vector_set(vline
, NULL
);
1089 describe
= cmd_describe_command(vline
, vty
, &ret
);
1093 /* Ambiguous error. */
1095 case CMD_ERR_AMBIGUOUS
:
1096 vty_out(vty
, "%% Ambiguous command.\n");
1099 case CMD_ERR_NO_MATCH
:
1100 vty_out(vty
, "%% There is no matched command.\n");
1105 /* Get width of command string. */
1107 for (i
= 0; i
< vector_active(describe
); i
++)
1108 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1111 if (token
->text
[0] == '\0')
1114 len
= strlen(token
->text
);
1120 /* Get width of description string. */
1121 desc_width
= vty
->width
- (width
+ 6);
1123 /* Print out description. */
1124 for (i
= 0; i
< vector_active(describe
); i
++)
1125 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1126 if (token
->text
[0] == '\0')
1129 if (strcmp(token
->text
, CMD_CR_TEXT
) == 0) {
1135 vty_out(vty
, " %-s\n", token
->text
);
1136 else if (desc_width
>= strlen(token
->desc
))
1137 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1140 vty_describe_fold(vty
, width
, desc_width
,
1143 if (IS_VARYING_TOKEN(token
->type
)) {
1144 const char *ref
= vector_slot(
1145 vline
, vector_active(vline
) - 1);
1147 vector varcomps
= vector_init(VECTOR_MIN_SIZE
);
1148 cmd_variable_complete(token
, ref
, varcomps
);
1150 if (vector_active(varcomps
) > 0) {
1151 char *ac
= cmd_variable_comp2str(
1152 varcomps
, vty
->width
);
1153 vty_out(vty
, "%s\n", ac
);
1154 XFREE(MTYPE_TMP
, ac
);
1157 vector_free(varcomps
);
1160 vty_out (vty
, " %-*s %s\n", width
1161 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1162 desc
->str
? desc
->str
: "");
1166 if ((token
= token_cr
)) {
1168 vty_out(vty
, " %-s\n", token
->text
);
1169 else if (desc_width
>= strlen(token
->desc
))
1170 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1173 vty_describe_fold(vty
, width
, desc_width
, token
);
1177 cmd_free_strvec(vline
);
1179 vector_free(describe
);
1182 vty_redraw_line(vty
);
1185 static void vty_clear_buf(struct vty
*vty
)
1187 memset(vty
->buf
, 0, vty
->max
);
1190 /* ^C stop current input and do not add command line to the history. */
1191 static void vty_stop_input(struct vty
*vty
)
1193 vty
->cp
= vty
->length
= 0;
1197 switch (vty
->node
) {
1200 /* Nothing to do. */
1203 case INTERFACE_NODE
:
1217 case LDP_IPV4_IFACE_NODE
:
1218 case LDP_IPV6_IFACE_NODE
:
1219 case LDP_L2VPN_NODE
:
1220 case LDP_PSEUDOWIRE_NODE
:
1222 case OPENFABRIC_NODE
:
1224 case KEYCHAIN_KEY_NODE
:
1228 vty_config_unlock(vty
);
1229 vty
->node
= ENABLE_NODE
;
1232 /* Unknown node, we have to ignore it. */
1237 /* Set history pointer to the latest one. */
1238 vty
->hp
= vty
->hindex
;
1241 /* Add current command line to the history buffer. */
1242 static void vty_hist_add(struct vty
*vty
)
1246 if (vty
->length
== 0)
1249 index
= vty
->hindex
? vty
->hindex
- 1 : VTY_MAXHIST
- 1;
1251 /* Ignore the same string as previous one. */
1252 if (vty
->hist
[index
])
1253 if (strcmp(vty
->buf
, vty
->hist
[index
]) == 0) {
1254 vty
->hp
= vty
->hindex
;
1258 /* Insert history entry. */
1259 if (vty
->hist
[vty
->hindex
])
1260 XFREE(MTYPE_VTY_HIST
, vty
->hist
[vty
->hindex
]);
1261 vty
->hist
[vty
->hindex
] = XSTRDUP(MTYPE_VTY_HIST
, vty
->buf
);
1263 /* History index rotation. */
1265 if (vty
->hindex
== VTY_MAXHIST
)
1268 vty
->hp
= vty
->hindex
;
1271 /* #define TELNET_OPTION_DEBUG */
1273 /* Get telnet window size. */
1274 static int vty_telnet_option(struct vty
*vty
, unsigned char *buf
, int nbytes
)
1276 #ifdef TELNET_OPTION_DEBUG
1279 for (i
= 0; i
< nbytes
; i
++) {
1282 vty_out(vty
, "IAC ");
1285 vty_out(vty
, "WILL ");
1288 vty_out(vty
, "WONT ");
1291 vty_out(vty
, "DO ");
1294 vty_out(vty
, "DONT ");
1297 vty_out(vty
, "SB ");
1300 vty_out(vty
, "SE ");
1303 vty_out(vty
, "TELOPT_ECHO \n");
1306 vty_out(vty
, "TELOPT_SGA \n");
1309 vty_out(vty
, "TELOPT_NAWS \n");
1312 vty_out(vty
, "%x ", buf
[i
]);
1318 #endif /* TELNET_OPTION_DEBUG */
1323 vty
->iac_sb_in_progress
= 1;
1327 if (!vty
->iac_sb_in_progress
)
1330 if ((vty
->sb_len
== 0) || (vty
->sb_buf
[0] == '\0')) {
1331 vty
->iac_sb_in_progress
= 0;
1334 switch (vty
->sb_buf
[0]) {
1336 if (vty
->sb_len
!= TELNET_NAWS_SB_LEN
)
1339 "RFC 1073 violation detected: telnet NAWS option "
1340 "should send %d characters, but we received %lu",
1342 (unsigned long)vty
->sb_len
);
1343 else if (sizeof(vty
->sb_buf
) < TELNET_NAWS_SB_LEN
)
1346 "Bug detected: sizeof(vty->sb_buf) %lu < %d, too small to handle the telnet NAWS option",
1347 (unsigned long)sizeof(vty
->sb_buf
),
1348 TELNET_NAWS_SB_LEN
);
1350 vty
->width
= ((vty
->sb_buf
[1] << 8)
1352 vty
->height
= ((vty
->sb_buf
[3] << 8)
1354 #ifdef TELNET_OPTION_DEBUG
1356 "TELNET NAWS window size negotiation completed: "
1357 "width %d, height %d\n",
1358 vty
->width
, vty
->height
);
1363 vty
->iac_sb_in_progress
= 0;
1373 /* Execute current command line. */
1374 static int vty_execute(struct vty
*vty
)
1380 switch (vty
->node
) {
1382 case AUTH_ENABLE_NODE
:
1383 vty_auth(vty
, vty
->buf
);
1386 ret
= vty_command(vty
, vty
->buf
);
1387 if (vty
->type
== VTY_TERM
)
1392 /* Clear command line buffer. */
1393 vty
->cp
= vty
->length
= 0;
1396 if (vty
->status
!= VTY_CLOSE
)
1402 #define CONTROL(X) ((X) - '@')
1403 #define VTY_NORMAL 0
1404 #define VTY_PRE_ESCAPE 1
1405 #define VTY_ESCAPE 2
1407 /* Escape character command map. */
1408 static void vty_escape_map(unsigned char c
, struct vty
*vty
)
1412 vty_previous_line(vty
);
1418 vty_forward_char(vty
);
1421 vty_backward_char(vty
);
1427 /* Go back to normal mode. */
1428 vty
->escape
= VTY_NORMAL
;
1431 /* Quit print out to the buffer. */
1432 static void vty_buffer_reset(struct vty
*vty
)
1434 buffer_reset(vty
->obuf
);
1435 buffer_reset(vty
->lbuf
);
1437 vty_redraw_line(vty
);
1440 /* Read data via vty socket. */
1441 static int vty_read(struct thread
*thread
)
1445 unsigned char buf
[VTY_READ_BUFSIZ
];
1447 int vty_sock
= THREAD_FD(thread
);
1448 struct vty
*vty
= THREAD_ARG(thread
);
1451 /* Read raw data from socket */
1452 if ((nbytes
= read(vty
->fd
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
1454 if (ERRNO_IO_RETRY(errno
)) {
1455 vty_event(VTY_READ
, vty_sock
, vty
);
1458 vty
->monitor
= 0; /* disable monitoring to avoid
1459 infinite recursion */
1462 "%s: read error on vty client fd %d, closing: %s",
1463 __func__
, vty
->fd
, safe_strerror(errno
));
1464 buffer_reset(vty
->obuf
);
1465 buffer_reset(vty
->lbuf
);
1467 vty
->status
= VTY_CLOSE
;
1470 for (i
= 0; i
< nbytes
; i
++) {
1471 if (buf
[i
] == IAC
) {
1480 if (vty
->iac_sb_in_progress
&& !vty
->iac
) {
1481 if (vty
->sb_len
< sizeof(vty
->sb_buf
))
1482 vty
->sb_buf
[vty
->sb_len
] = buf
[i
];
1488 /* In case of telnet command */
1490 ret
= vty_telnet_option(vty
, buf
+ i
, nbytes
- i
);
1497 if (vty
->status
== VTY_MORE
) {
1502 vty_buffer_reset(vty
);
1504 #if 0 /* More line does not work for "show ip bgp". */
1507 vty
->status
= VTY_MORELINE
;
1516 /* Escape character. */
1517 if (vty
->escape
== VTY_ESCAPE
) {
1518 vty_escape_map(buf
[i
], vty
);
1522 /* Pre-escape status. */
1523 if (vty
->escape
== VTY_PRE_ESCAPE
) {
1526 vty
->escape
= VTY_ESCAPE
;
1529 vty_backward_word(vty
);
1530 vty
->escape
= VTY_NORMAL
;
1533 vty_forward_word(vty
);
1534 vty
->escape
= VTY_NORMAL
;
1537 vty_forward_kill_word(vty
);
1538 vty
->escape
= VTY_NORMAL
;
1542 vty_backward_kill_word(vty
);
1543 vty
->escape
= VTY_NORMAL
;
1546 vty
->escape
= VTY_NORMAL
;
1554 vty_beginning_of_line(vty
);
1557 vty_backward_char(vty
);
1560 vty_stop_input(vty
);
1563 vty_delete_char(vty
);
1566 vty_end_of_line(vty
);
1569 vty_forward_char(vty
);
1573 vty_delete_backward_char(vty
);
1582 vty_previous_line(vty
);
1585 vty_transpose_chars(vty
);
1588 vty_kill_line_from_beginning(vty
);
1591 vty_backward_kill_word(vty
);
1594 vty_end_config(vty
);
1602 vty_complete_command(vty
);
1605 if (vty
->node
== AUTH_NODE
1606 || vty
->node
== AUTH_ENABLE_NODE
)
1607 vty_self_insert(vty
, buf
[i
]);
1609 vty_describe_command(vty
);
1612 if (i
+ 1 < nbytes
&& buf
[i
+ 1] == '[') {
1613 vty
->escape
= VTY_ESCAPE
;
1616 vty
->escape
= VTY_PRE_ESCAPE
;
1619 if (buf
[i
] > 31 && buf
[i
] < 127)
1620 vty_self_insert(vty
, buf
[i
]);
1626 if (vty
->status
== VTY_CLOSE
)
1629 vty_event(VTY_WRITE
, vty
->wfd
, vty
);
1630 vty_event(VTY_READ
, vty_sock
, vty
);
1635 /* Flush buffer to the vty. */
1636 static int vty_flush(struct thread
*thread
)
1639 buffer_status_t flushrc
;
1640 int vty_sock
= THREAD_FD(thread
);
1641 struct vty
*vty
= THREAD_ARG(thread
);
1643 vty
->t_write
= NULL
;
1645 /* Tempolary disable read thread. */
1646 if ((vty
->lines
== 0) && vty
->t_read
) {
1647 thread_cancel(vty
->t_read
);
1651 /* Function execution continue. */
1652 erase
= ((vty
->status
== VTY_MORE
|| vty
->status
== VTY_MORELINE
));
1654 /* N.B. if width is 0, that means we don't know the window size. */
1655 if ((vty
->lines
== 0) || (vty
->width
== 0) || (vty
->height
== 0))
1656 flushrc
= buffer_flush_available(vty
->obuf
, vty_sock
);
1657 else if (vty
->status
== VTY_MORELINE
)
1658 flushrc
= buffer_flush_window(vty
->obuf
, vty_sock
, vty
->width
,
1661 flushrc
= buffer_flush_window(
1662 vty
->obuf
, vty_sock
, vty
->width
,
1663 vty
->lines
>= 0 ? vty
->lines
: vty
->height
, erase
, 0);
1667 0; /* disable monitoring to avoid infinite recursion */
1668 zlog_info("buffer_flush failed on vty client fd %d, closing",
1670 buffer_reset(vty
->lbuf
);
1671 buffer_reset(vty
->obuf
);
1675 if (vty
->status
== VTY_CLOSE
)
1678 vty
->status
= VTY_NORMAL
;
1679 if (vty
->lines
== 0)
1680 vty_event(VTY_READ
, vty_sock
, vty
);
1683 case BUFFER_PENDING
:
1684 /* There is more data waiting to be written. */
1685 vty
->status
= VTY_MORE
;
1686 if (vty
->lines
== 0)
1687 vty_event(VTY_WRITE
, vty_sock
, vty
);
1694 /* Allocate new vty struct. */
1695 struct vty
*vty_new()
1697 struct vty
*new = XCALLOC(MTYPE_VTY
, sizeof(struct vty
));
1699 new->fd
= new->wfd
= -1;
1701 new->lbuf
= buffer_new(0);
1702 new->obuf
= buffer_new(0); /* Use default buffer size. */
1703 new->buf
= XCALLOC(MTYPE_VTY
, VTY_BUFSIZ
);
1704 new->max
= VTY_BUFSIZ
;
1710 /* allocate and initialise vty */
1711 static struct vty
*vty_new_init(int vty_sock
)
1717 vty
->wfd
= vty_sock
;
1718 vty
->type
= VTY_TERM
;
1719 vty
->node
= AUTH_NODE
;
1724 memset(vty
->hist
, 0, sizeof(vty
->hist
));
1727 vty
->xpath_index
= 0;
1728 memset(vty
->xpath
, 0, sizeof(vty
->xpath
));
1729 vty
->private_config
= false;
1730 vty
->candidate_config
= vty_shared_candidate_config
;
1731 vector_set_index(vtyvec
, vty_sock
, vty
);
1732 vty
->status
= VTY_NORMAL
;
1735 vty
->iac_sb_in_progress
= 0;
1741 /* Create new vty structure. */
1742 static struct vty
*vty_create(int vty_sock
, union sockunion
*su
)
1744 char buf
[SU_ADDRSTRLEN
];
1747 sockunion2str(su
, buf
, SU_ADDRSTRLEN
);
1749 /* Allocate new vty structure and set up default values. */
1750 vty
= vty_new_init(vty_sock
);
1752 /* configurable parameters not part of basic init */
1753 vty
->v_timeout
= vty_timeout_val
;
1754 strcpy(vty
->address
, buf
);
1755 if (no_password_check
) {
1757 vty
->node
= ENABLE_NODE
;
1759 vty
->node
= VIEW_NODE
;
1761 if (host
.lines
>= 0)
1762 vty
->lines
= host
.lines
;
1764 if (!no_password_check
) {
1765 /* Vty is not available if password isn't set. */
1766 if (host
.password
== NULL
&& host
.password_encrypt
== NULL
) {
1767 vty_out(vty
, "Vty password is not set.\n");
1768 vty
->status
= VTY_CLOSE
;
1774 /* Say hello to the world. */
1776 if (!no_password_check
)
1777 vty_out(vty
, "\nUser Access Verification\n\n");
1779 /* Setting up terminal. */
1781 vty_will_suppress_go_ahead(vty
);
1783 vty_dont_linemode(vty
);
1784 vty_do_window_size(vty
);
1785 /* vty_dont_lflow_ahead (vty); */
1789 /* Add read/write thread. */
1790 vty_event(VTY_WRITE
, vty_sock
, vty
);
1791 vty_event(VTY_READ
, vty_sock
, vty
);
1796 /* create vty for stdio */
1797 static struct termios stdio_orig_termios
;
1798 static struct vty
*stdio_vty
= NULL
;
1799 static bool stdio_termios
= false;
1800 static void (*stdio_vty_atclose
)(int isexit
);
1802 static void vty_stdio_reset(int isexit
)
1806 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1807 stdio_termios
= false;
1811 if (stdio_vty_atclose
)
1812 stdio_vty_atclose(isexit
);
1813 stdio_vty_atclose
= NULL
;
1817 static void vty_stdio_atexit(void)
1822 void vty_stdio_suspend(void)
1827 if (stdio_vty
->t_write
)
1828 thread_cancel(stdio_vty
->t_write
);
1829 if (stdio_vty
->t_read
)
1830 thread_cancel(stdio_vty
->t_read
);
1831 if (stdio_vty
->t_timeout
)
1832 thread_cancel(stdio_vty
->t_timeout
);
1835 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1836 stdio_termios
= false;
1839 void vty_stdio_resume(void)
1844 if (!tcgetattr(0, &stdio_orig_termios
)) {
1845 struct termios termios
;
1847 termios
= stdio_orig_termios
;
1848 termios
.c_iflag
&= ~(IGNBRK
| BRKINT
| PARMRK
| ISTRIP
| INLCR
1849 | IGNCR
| ICRNL
| IXON
);
1850 termios
.c_oflag
&= ~OPOST
;
1851 termios
.c_lflag
&= ~(ECHO
| ECHONL
| ICANON
| IEXTEN
);
1852 termios
.c_cflag
&= ~(CSIZE
| PARENB
);
1853 termios
.c_cflag
|= CS8
;
1854 tcsetattr(0, TCSANOW
, &termios
);
1855 stdio_termios
= true;
1858 vty_prompt(stdio_vty
);
1860 /* Add read/write thread. */
1861 vty_event(VTY_WRITE
, 1, stdio_vty
);
1862 vty_event(VTY_READ
, 0, stdio_vty
);
1865 void vty_stdio_close(void)
1869 vty_close(stdio_vty
);
1872 struct vty
*vty_stdio(void (*atclose
)(int isexit
))
1876 /* refuse creating two vtys on stdio */
1880 vty
= stdio_vty
= vty_new_init(0);
1881 stdio_vty_atclose
= atclose
;
1884 /* always have stdio vty in a known _unchangeable_ state, don't want
1886 * to have any effect here to make sure scripting this works as intended
1888 vty
->node
= ENABLE_NODE
;
1890 strcpy(vty
->address
, "console");
1896 /* Accept connection from the network. */
1897 static int vty_accept(struct thread
*thread
)
1905 struct access_list
*acl
= NULL
;
1906 char buf
[SU_ADDRSTRLEN
];
1908 accept_sock
= THREAD_FD(thread
);
1910 /* We continue hearing vty socket. */
1911 vty_event(VTY_SERV
, accept_sock
, NULL
);
1913 memset(&su
, 0, sizeof(union sockunion
));
1915 /* We can handle IPv4 or IPv6 socket. */
1916 vty_sock
= sockunion_accept(accept_sock
, &su
);
1918 flog_err(EC_LIB_SOCKET
, "can't accept vty socket : %s",
1919 safe_strerror(errno
));
1922 set_nonblocking(vty_sock
);
1923 set_cloexec(vty_sock
);
1925 sockunion2hostprefix(&su
, &p
);
1927 /* VTY's accesslist apply. */
1928 if (p
.family
== AF_INET
&& vty_accesslist_name
) {
1929 if ((acl
= access_list_lookup(AFI_IP
, vty_accesslist_name
))
1930 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1931 zlog_info("Vty connection refused from %s",
1932 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1935 /* continue accepting connections */
1936 vty_event(VTY_SERV
, accept_sock
, NULL
);
1942 /* VTY's ipv6 accesslist apply. */
1943 if (p
.family
== AF_INET6
&& vty_ipv6_accesslist_name
) {
1944 if ((acl
= access_list_lookup(AFI_IP6
,
1945 vty_ipv6_accesslist_name
))
1946 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1947 zlog_info("Vty connection refused from %s",
1948 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1951 /* continue accepting connections */
1952 vty_event(VTY_SERV
, accept_sock
, NULL
);
1959 ret
= setsockopt(vty_sock
, IPPROTO_TCP
, TCP_NODELAY
, (char *)&on
,
1962 zlog_info("can't set sockopt to vty_sock : %s",
1963 safe_strerror(errno
));
1965 zlog_info("Vty connection from %s",
1966 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1968 vty_create(vty_sock
, &su
);
1973 static void vty_serv_sock_addrinfo(const char *hostname
, unsigned short port
)
1976 struct addrinfo req
;
1977 struct addrinfo
*ainfo
;
1978 struct addrinfo
*ainfo_save
;
1980 char port_str
[BUFSIZ
];
1982 memset(&req
, 0, sizeof(struct addrinfo
));
1983 req
.ai_flags
= AI_PASSIVE
;
1984 req
.ai_family
= AF_UNSPEC
;
1985 req
.ai_socktype
= SOCK_STREAM
;
1986 sprintf(port_str
, "%d", port
);
1987 port_str
[sizeof(port_str
) - 1] = '\0';
1989 ret
= getaddrinfo(hostname
, port_str
, &req
, &ainfo
);
1992 flog_err_sys(EC_LIB_SYSTEM_CALL
, "getaddrinfo failed: %s",
2000 if (ainfo
->ai_family
!= AF_INET
&& ainfo
->ai_family
!= AF_INET6
)
2003 sock
= socket(ainfo
->ai_family
, ainfo
->ai_socktype
,
2004 ainfo
->ai_protocol
);
2008 sockopt_v6only(ainfo
->ai_family
, sock
);
2009 sockopt_reuseaddr(sock
);
2010 sockopt_reuseport(sock
);
2013 ret
= bind(sock
, ainfo
->ai_addr
, ainfo
->ai_addrlen
);
2015 close(sock
); /* Avoid sd leak. */
2019 ret
= listen(sock
, 3);
2021 close(sock
); /* Avoid sd leak. */
2025 vty_event(VTY_SERV
, sock
, NULL
);
2026 } while ((ainfo
= ainfo
->ai_next
) != NULL
);
2028 freeaddrinfo(ainfo_save
);
2032 /* For sockaddr_un. */
2035 /* VTY shell UNIX domain socket. */
2036 static void vty_serv_un(const char *path
)
2040 struct sockaddr_un serv
;
2042 struct zprivs_ids_t ids
;
2044 /* First of all, unlink existing socket */
2048 old_mask
= umask(0007);
2050 /* Make UNIX domain socket. */
2051 sock
= socket(AF_UNIX
, SOCK_STREAM
, 0);
2053 flog_err_sys(EC_LIB_SOCKET
,
2054 "Cannot create unix stream socket: %s",
2055 safe_strerror(errno
));
2059 /* Make server socket. */
2060 memset(&serv
, 0, sizeof(struct sockaddr_un
));
2061 serv
.sun_family
= AF_UNIX
;
2062 strlcpy(serv
.sun_path
, path
, sizeof(serv
.sun_path
));
2063 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
2064 len
= serv
.sun_len
= SUN_LEN(&serv
);
2066 len
= sizeof(serv
.sun_family
) + strlen(serv
.sun_path
);
2067 #endif /* HAVE_STRUCT_SOCKADDR_UN_SUN_LEN */
2071 ret
= bind(sock
, (struct sockaddr
*)&serv
, len
);
2073 flog_err_sys(EC_LIB_SOCKET
, "Cannot bind path %s: %s", path
,
2074 safe_strerror(errno
));
2075 close(sock
); /* Avoid sd leak. */
2079 ret
= listen(sock
, 5);
2081 flog_err_sys(EC_LIB_SOCKET
, "listen(fd %d) failed: %s", sock
,
2082 safe_strerror(errno
));
2083 close(sock
); /* Avoid sd leak. */
2089 zprivs_get_ids(&ids
);
2091 /* Hack: ids.gid_vty is actually a uint, but we stored -1 in it
2092 earlier for the case when we don't need to chown the file
2093 type casting it here to make a compare */
2094 if ((int)ids
.gid_vty
> 0) {
2095 /* set group of socket */
2096 if (chown(path
, -1, ids
.gid_vty
)) {
2097 flog_err_sys(EC_LIB_SYSTEM_CALL
,
2098 "vty_serv_un: could chown socket, %s",
2099 safe_strerror(errno
));
2103 vty_event(VTYSH_SERV
, sock
, NULL
);
2106 /* #define VTYSH_DEBUG 1 */
2108 static int vtysh_accept(struct thread
*thread
)
2113 struct sockaddr_un client
;
2116 accept_sock
= THREAD_FD(thread
);
2118 vty_event(VTYSH_SERV
, accept_sock
, NULL
);
2120 memset(&client
, 0, sizeof(struct sockaddr_un
));
2121 client_len
= sizeof(struct sockaddr_un
);
2123 sock
= accept(accept_sock
, (struct sockaddr
*)&client
,
2124 (socklen_t
*)&client_len
);
2127 flog_err(EC_LIB_SOCKET
, "can't accept vty socket : %s",
2128 safe_strerror(errno
));
2132 if (set_nonblocking(sock
) < 0) {
2135 "vtysh_accept: could not set vty socket %d to non-blocking, %s, closing",
2136 sock
, safe_strerror(errno
));
2143 printf("VTY shell accept\n");
2144 #endif /* VTYSH_DEBUG */
2149 vty
->type
= VTY_SHELL_SERV
;
2150 vty
->node
= VIEW_NODE
;
2152 vty_event(VTYSH_READ
, sock
, vty
);
2157 static int vtysh_flush(struct vty
*vty
)
2159 switch (buffer_flush_available(vty
->obuf
, vty
->wfd
)) {
2160 case BUFFER_PENDING
:
2161 vty_event(VTYSH_WRITE
, vty
->wfd
, vty
);
2165 0; /* disable monitoring to avoid infinite recursion */
2166 flog_err(EC_LIB_SOCKET
, "%s: write error to fd %d, closing",
2168 buffer_reset(vty
->lbuf
);
2169 buffer_reset(vty
->obuf
);
2179 static int vtysh_read(struct thread
*thread
)
2185 unsigned char buf
[VTY_READ_BUFSIZ
];
2187 uint8_t header
[4] = {0, 0, 0, 0};
2189 sock
= THREAD_FD(thread
);
2190 vty
= THREAD_ARG(thread
);
2193 if ((nbytes
= read(sock
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
2195 if (ERRNO_IO_RETRY(errno
)) {
2196 vty_event(VTYSH_READ
, sock
, vty
);
2199 vty
->monitor
= 0; /* disable monitoring to avoid
2200 infinite recursion */
2203 "%s: read failed on vtysh client fd %d, closing: %s",
2204 __func__
, sock
, safe_strerror(errno
));
2206 buffer_reset(vty
->lbuf
);
2207 buffer_reset(vty
->obuf
);
2210 printf("close vtysh\n");
2211 #endif /* VTYSH_DEBUG */
2216 printf("line: %.*s\n", nbytes
, buf
);
2217 #endif /* VTYSH_DEBUG */
2219 if (vty
->length
+ nbytes
>= VTY_BUFSIZ
) {
2220 /* Clear command line buffer. */
2221 vty
->cp
= vty
->length
= 0;
2223 vty_out(vty
, "%% Command is too long.\n");
2225 for (p
= buf
; p
< buf
+ nbytes
; p
++) {
2226 vty
->buf
[vty
->length
++] = *p
;
2228 /* Pass this line to parser. */
2229 ret
= vty_execute(vty
);
2230 /* Note that vty_execute clears the command buffer and resets
2231 vty->length to 0. */
2233 /* Return result. */
2235 printf("result: %d\n", ret
);
2236 printf("vtysh node: %d\n", vty
->node
);
2237 #endif /* VTYSH_DEBUG */
2239 /* hack for asynchronous "write integrated"
2240 * - other commands in "buf" will be ditched
2241 * - input during pending config-write is
2243 if (ret
== CMD_SUSPEND
)
2246 /* warning: watchfrr hardcodes this result write
2249 buffer_put(vty
->obuf
, header
, 4);
2251 if (!vty
->t_write
&& (vtysh_flush(vty
) < 0))
2252 /* Try to flush results; exit if a write
2259 if (vty
->status
== VTY_CLOSE
)
2262 vty_event(VTYSH_READ
, sock
, vty
);
2267 static int vtysh_write(struct thread
*thread
)
2269 struct vty
*vty
= THREAD_ARG(thread
);
2271 vty
->t_write
= NULL
;
2278 /* Determine address family to bind. */
2279 void vty_serv_sock(const char *addr
, unsigned short port
, const char *path
)
2281 /* If port is set to 0, do not listen on TCP/IP at all! */
2283 vty_serv_sock_addrinfo(addr
, port
);
2290 static void vty_error_delete(void *arg
)
2292 struct vty_error
*ve
= arg
;
2294 XFREE(MTYPE_TMP
, ve
);
2297 /* Close vty interface. Warning: call this only from functions that
2298 will be careful not to access the vty afterwards (since it has
2299 now been freed). This is safest from top-level functions (called
2300 directly by the thread dispatcher). */
2301 void vty_close(struct vty
*vty
)
2304 bool was_stdio
= false;
2306 /* Cancel threads.*/
2308 thread_cancel(vty
->t_read
);
2310 thread_cancel(vty
->t_write
);
2312 thread_cancel(vty
->t_timeout
);
2315 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2317 /* Free input buffer. */
2318 buffer_free(vty
->obuf
);
2319 buffer_free(vty
->lbuf
);
2321 /* Free command history. */
2322 for (i
= 0; i
< VTY_MAXHIST
; i
++)
2324 XFREE(MTYPE_VTY_HIST
, vty
->hist
[i
]);
2328 vector_unset(vtyvec
, vty
->fd
);
2330 if (vty
->wfd
> 0 && vty
->type
== VTY_FILE
)
2334 * note check is for fd > STDERR_FILENO, not fd != -1.
2335 * We never close stdin/stdout/stderr here, because we may be
2336 * running in foreground mode with logging to stdout. Also,
2337 * additionally, we'd need to replace these fds with /dev/null. */
2338 if (vty
->wfd
> STDERR_FILENO
&& vty
->wfd
!= vty
->fd
)
2340 if (vty
->fd
> STDERR_FILENO
)
2342 if (vty
->fd
== STDIN_FILENO
)
2346 XFREE(MTYPE_VTY
, vty
->buf
);
2349 vty
->error
->del
= vty_error_delete
;
2350 list_delete(&vty
->error
);
2353 /* Check configure. */
2354 vty_config_unlock(vty
);
2357 XFREE(MTYPE_VTY
, vty
);
2363 /* When time out occur output message then close connection. */
2364 static int vty_timeout(struct thread
*thread
)
2368 vty
= THREAD_ARG(thread
);
2369 vty
->t_timeout
= NULL
;
2373 buffer_reset(vty
->lbuf
);
2374 buffer_reset(vty
->obuf
);
2375 vty_out(vty
, "\nVty connection is timed out.\n");
2377 /* Close connection. */
2378 vty
->status
= VTY_CLOSE
;
2384 /* Read up configuration file from file_name. */
2385 static void vty_read_file(struct nb_config
*config
, FILE *confp
)
2389 struct vty_error
*ve
;
2390 struct listnode
*node
;
2391 unsigned int line_num
= 0;
2394 /* vty_close won't close stderr; if some config command prints
2395 * something it'll end up there. (not ideal; it'd be beter if output
2396 * from a file-load went to logging instead. Also note that if this
2397 * function is called after daemonizing, stderr will be /dev/null.)
2399 * vty->fd will be -1 from vty_new()
2401 vty
->wfd
= STDERR_FILENO
;
2402 vty
->type
= VTY_FILE
;
2403 vty
->node
= CONFIG_NODE
;
2405 vty
->candidate_config
= config
;
2407 vty
->private_config
= true;
2408 vty
->candidate_config
= nb_config_new(NULL
);
2411 /* Execute configuration file */
2412 ret
= config_from_file(vty
, confp
, &line_num
);
2414 /* Flush any previous errors before printing messages below */
2415 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2417 if (!((ret
== CMD_SUCCESS
) || (ret
== CMD_ERR_NOTHING_TODO
))) {
2418 const char *message
= NULL
;
2422 case CMD_ERR_AMBIGUOUS
:
2423 message
= "Ambiguous command";
2425 case CMD_ERR_NO_MATCH
:
2426 message
= "No such command";
2429 message
= "Command returned Warning";
2431 case CMD_WARNING_CONFIG_FAILED
:
2432 message
= "Command returned Warning Config Failed";
2434 case CMD_ERR_INCOMPLETE
:
2435 message
= "Command returned Incomplete";
2437 case CMD_ERR_EXEED_ARGC_MAX
:
2439 "Command exceeded maximum number of Arguments";
2442 message
= "Command returned unhandled error message";
2446 for (ALL_LIST_ELEMENTS_RO(vty
->error
, node
, ve
)) {
2447 nl
= strchr(ve
->error_buf
, '\n');
2450 flog_err(EC_LIB_VTY
, "ERROR: %s on config line %u: %s",
2451 message
, ve
->line_num
, ve
->error_buf
);
2456 * Automatically commit the candidate configuration after
2457 * reading the configuration file.
2459 if (config
== NULL
&& vty
->candidate_config
2460 && frr_get_cli_mode() == FRR_CLI_TRANSACTIONAL
) {
2461 ret
= nb_candidate_commit(vty
->candidate_config
, NB_CLIENT_CLI
,
2462 true, "Read configuration file",
2464 if (ret
!= NB_OK
&& ret
!= NB_ERR_NO_CHANGES
)
2465 zlog_err("%s: failed to read configuration file.",
2472 static FILE *vty_use_backup_config(const char *fullpath
)
2474 char *fullpath_sav
, *fullpath_tmp
;
2480 fullpath_sav
= malloc(strlen(fullpath
) + strlen(CONF_BACKUP_EXT
) + 1);
2481 strcpy(fullpath_sav
, fullpath
);
2482 strcat(fullpath_sav
, CONF_BACKUP_EXT
);
2484 sav
= open(fullpath_sav
, O_RDONLY
);
2490 fullpath_tmp
= malloc(strlen(fullpath
) + 8);
2491 sprintf(fullpath_tmp
, "%s.XXXXXX", fullpath
);
2493 /* Open file to configuration write. */
2494 tmp
= mkstemp(fullpath_tmp
);
2498 if (fchmod(tmp
, CONFIGFILE_MASK
) != 0)
2501 while ((c
= read(sav
, buffer
, 512)) > 0) {
2502 if (write(tmp
, buffer
, c
) <= 0)
2508 if (rename(fullpath_tmp
, fullpath
) == 0)
2509 ret
= fopen(fullpath
, "r");
2511 unlink(fullpath_tmp
);
2516 unlink(fullpath_tmp
);
2526 /* Read up configuration file from file_name. */
2527 bool vty_read_config(struct nb_config
*config
, const char *config_file
,
2528 char *config_default_dir
)
2530 char cwd
[MAXPATHLEN
];
2532 const char *fullpath
;
2534 bool read_success
= false;
2536 /* If -f flag specified. */
2537 if (config_file
!= NULL
) {
2538 if (!IS_DIRECTORY_SEP(config_file
[0])) {
2539 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
2542 "%s: failure to determine Current Working Directory %d!",
2544 goto tmp_free_and_out
;
2546 tmp
= XMALLOC(MTYPE_TMP
,
2547 strlen(cwd
) + strlen(config_file
) + 2);
2548 sprintf(tmp
, "%s/%s", cwd
, config_file
);
2551 fullpath
= config_file
;
2553 confp
= fopen(fullpath
, "r");
2555 if (confp
== NULL
) {
2557 EC_LIB_BACKUP_CONFIG
,
2558 "%s: failed to open configuration file %s: %s, checking backup",
2559 __func__
, fullpath
, safe_strerror(errno
));
2561 confp
= vty_use_backup_config(fullpath
);
2564 EC_LIB_BACKUP_CONFIG
,
2565 "WARNING: using backup configuration file!");
2569 "%s: can't open configuration file [%s]",
2570 __func__
, config_file
);
2571 goto tmp_free_and_out
;
2576 host_config_set(config_default_dir
);
2580 struct stat conf_stat
;
2582 /* !!!!PLEASE LEAVE!!!!
2583 * This is NEEDED for use with vtysh -b, or else you can get
2584 * a real configuration food fight with a lot garbage in the
2585 * merged configuration file it creates coming from the per
2586 * daemon configuration files. This also allows the daemons
2587 * to start if there default configuration file is not
2588 * present or ignore them, as needed when using vtysh -b to
2589 * configure the daemons at boot - MAG
2592 /* Stat for vtysh Zebra.conf, if found startup and wait for
2593 * boot configuration
2596 if (strstr(config_default_dir
, "vtysh") == NULL
) {
2597 ret
= stat(integrate_default
, &conf_stat
);
2599 read_success
= true;
2600 goto tmp_free_and_out
;
2604 confp
= fopen(config_default_dir
, "r");
2605 if (confp
== NULL
) {
2608 "%s: failed to open configuration file %s: %s, checking backup",
2609 __func__
, config_default_dir
,
2610 safe_strerror(errno
));
2612 confp
= vty_use_backup_config(config_default_dir
);
2615 EC_LIB_BACKUP_CONFIG
,
2616 "WARNING: using backup configuration file!");
2617 fullpath
= config_default_dir
;
2619 flog_err(EC_LIB_VTY
,
2620 "can't open configuration file [%s]",
2621 config_default_dir
);
2622 goto tmp_free_and_out
;
2625 fullpath
= config_default_dir
;
2628 vty_read_file(config
, confp
);
2629 read_success
= true;
2633 host_config_set(fullpath
);
2637 XFREE(MTYPE_TMP
, tmp
);
2639 return read_success
;
2642 /* Small utility function which output log to the VTY. */
2643 void vty_log(const char *level
, const char *proto_str
, const char *format
,
2644 struct timestamp_control
*ctl
, va_list va
)
2652 for (i
= 0; i
< vector_active(vtyvec
); i
++)
2653 if ((vty
= vector_slot(vtyvec
, i
)) != NULL
)
2657 vty_log_out(vty
, level
, proto_str
, format
, ctl
,
2663 /* Async-signal-safe version of vty_log for fixed strings. */
2664 void vty_log_fixed(char *buf
, size_t len
)
2667 struct iovec iov
[2];
2668 char crlf
[4] = "\r\n";
2670 /* vty may not have been initialised */
2674 iov
[0].iov_base
= buf
;
2675 iov
[0].iov_len
= len
;
2676 iov
[1].iov_base
= crlf
;
2679 for (i
= 0; i
< vector_active(vtyvec
); i
++) {
2681 if (((vty
= vector_slot(vtyvec
, i
)) != NULL
) && vty
->monitor
)
2682 /* N.B. We don't care about the return code, since
2684 most likely just about to die anyway. */
2685 if (writev(vty
->wfd
, iov
, 2) == -1) {
2686 fprintf(stderr
, "Failure to writev: %d\n",
2693 int vty_config_lock(struct vty
*vty
)
2695 if (vty_config_is_lockless
)
2697 if (vty_config
== 0) {
2704 int vty_config_unlock(struct vty
*vty
)
2706 vty_config_exclusive_unlock(vty
);
2708 if (vty
->candidate_config
) {
2709 if (vty
->private_config
)
2710 nb_config_free(vty
->candidate_config
);
2711 vty
->candidate_config
= NULL
;
2713 if (vty
->candidate_config_base
) {
2714 nb_config_free(vty
->candidate_config_base
);
2715 vty
->candidate_config_base
= NULL
;
2718 if (vty_config_is_lockless
)
2720 if (vty_config
== 1 && vty
->config
== 1) {
2727 void vty_config_lockless(void)
2729 vty_config_is_lockless
= 1;
2732 int vty_config_exclusive_lock(struct vty
*vty
)
2734 if (vty_exclusive_lock
== NULL
) {
2735 vty_exclusive_lock
= vty
;
2741 void vty_config_exclusive_unlock(struct vty
*vty
)
2743 if (vty_exclusive_lock
== vty
)
2744 vty_exclusive_lock
= NULL
;
2747 /* Master of the threads. */
2748 static struct thread_master
*vty_master
;
2750 static void vty_event(enum event event
, int sock
, struct vty
*vty
)
2752 struct thread
*vty_serv_thread
= NULL
;
2756 vty_serv_thread
= thread_add_read(vty_master
, vty_accept
, vty
,
2758 vector_set_index(Vvty_serv_thread
, sock
, vty_serv_thread
);
2762 vty_serv_thread
= thread_add_read(vty_master
, vtysh_accept
, vty
,
2764 vector_set_index(Vvty_serv_thread
, sock
, vty_serv_thread
);
2768 thread_add_read(vty_master
, vtysh_read
, vty
, sock
,
2772 vty
->t_write
= NULL
;
2773 thread_add_write(vty_master
, vtysh_write
, vty
, sock
,
2779 thread_add_read(vty_master
, vty_read
, vty
, sock
, &vty
->t_read
);
2781 /* Time out treatment. */
2782 if (vty
->v_timeout
) {
2784 thread_cancel(vty
->t_timeout
);
2785 vty
->t_timeout
= NULL
;
2786 thread_add_timer(vty_master
, vty_timeout
, vty
,
2787 vty
->v_timeout
, &vty
->t_timeout
);
2791 thread_add_write(vty_master
, vty_flush
, vty
, sock
,
2794 case VTY_TIMEOUT_RESET
:
2795 if (vty
->t_timeout
) {
2796 thread_cancel(vty
->t_timeout
);
2797 vty
->t_timeout
= NULL
;
2799 if (vty
->v_timeout
) {
2800 vty
->t_timeout
= NULL
;
2801 thread_add_timer(vty_master
, vty_timeout
, vty
,
2802 vty
->v_timeout
, &vty
->t_timeout
);
2808 DEFUN_NOSH (config_who
,
2811 "Display who is on vty\n")
2816 for (i
= 0; i
< vector_active(vtyvec
); i
++)
2817 if ((v
= vector_slot(vtyvec
, i
)) != NULL
)
2818 vty_out(vty
, "%svty[%d] connected from %s.\n",
2819 v
->config
? "*" : " ", i
, v
->address
);
2823 /* Move to vty configuration mode. */
2824 DEFUN_NOSH (line_vty
,
2827 "Configure a terminal line\n"
2828 "Virtual terminal\n")
2830 vty
->node
= VTY_NODE
;
2834 /* Set time out value. */
2835 static int exec_timeout(struct vty
*vty
, const char *min_str
,
2836 const char *sec_str
)
2838 unsigned long timeout
= 0;
2840 /* min_str and sec_str are already checked by parser. So it must be
2841 all digit string. */
2843 timeout
= strtol(min_str
, NULL
, 10);
2847 timeout
+= strtol(sec_str
, NULL
, 10);
2849 vty_timeout_val
= timeout
;
2850 vty
->v_timeout
= timeout
;
2851 vty_event(VTY_TIMEOUT_RESET
, 0, vty
);
2857 DEFUN (exec_timeout_min
,
2858 exec_timeout_min_cmd
,
2859 "exec-timeout (0-35791)",
2860 "Set timeout value\n"
2861 "Timeout value in minutes\n")
2864 return exec_timeout(vty
, argv
[idx_number
]->arg
, NULL
);
2867 DEFUN (exec_timeout_sec
,
2868 exec_timeout_sec_cmd
,
2869 "exec-timeout (0-35791) (0-2147483)",
2870 "Set the EXEC timeout\n"
2871 "Timeout in minutes\n"
2872 "Timeout in seconds\n")
2875 int idx_number_2
= 2;
2876 return exec_timeout(vty
, argv
[idx_number
]->arg
,
2877 argv
[idx_number_2
]->arg
);
2880 DEFUN (no_exec_timeout
,
2881 no_exec_timeout_cmd
,
2884 "Set the EXEC timeout\n")
2886 return exec_timeout(vty
, NULL
, NULL
);
2889 /* Set vty access class. */
2890 DEFUN (vty_access_class
,
2891 vty_access_class_cmd
,
2892 "access-class WORD",
2893 "Filter connections based on an IP access list\n"
2897 if (vty_accesslist_name
)
2898 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2900 vty_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2905 /* Clear vty access class. */
2906 DEFUN (no_vty_access_class
,
2907 no_vty_access_class_cmd
,
2908 "no access-class [WORD]",
2910 "Filter connections based on an IP access list\n"
2914 const char *accesslist
= (argc
== 3) ? argv
[idx_word
]->arg
: NULL
;
2915 if (!vty_accesslist_name
2916 || (argc
== 3 && strcmp(vty_accesslist_name
, accesslist
))) {
2917 vty_out(vty
, "Access-class is not currently applied to vty\n");
2918 return CMD_WARNING_CONFIG_FAILED
;
2921 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2923 vty_accesslist_name
= NULL
;
2928 /* Set vty access class. */
2929 DEFUN (vty_ipv6_access_class
,
2930 vty_ipv6_access_class_cmd
,
2931 "ipv6 access-class WORD",
2933 "Filter connections based on an IP access list\n"
2934 "IPv6 access list\n")
2937 if (vty_ipv6_accesslist_name
)
2938 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2940 vty_ipv6_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2945 /* Clear vty access class. */
2946 DEFUN (no_vty_ipv6_access_class
,
2947 no_vty_ipv6_access_class_cmd
,
2948 "no ipv6 access-class [WORD]",
2951 "Filter connections based on an IP access list\n"
2952 "IPv6 access list\n")
2955 const char *accesslist
= (argc
== 4) ? argv
[idx_word
]->arg
: NULL
;
2957 if (!vty_ipv6_accesslist_name
2958 || (argc
== 4 && strcmp(vty_ipv6_accesslist_name
, accesslist
))) {
2960 "IPv6 access-class is not currently applied to vty\n");
2961 return CMD_WARNING_CONFIG_FAILED
;
2964 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2966 vty_ipv6_accesslist_name
= NULL
;
2975 "Enable password checking\n")
2977 no_password_check
= 0;
2981 DEFUN (no_vty_login
,
2985 "Enable password checking\n")
2987 no_password_check
= 1;
2991 DEFUN (service_advanced_vty
,
2992 service_advanced_vty_cmd
,
2993 "service advanced-vty",
2994 "Set up miscellaneous service\n"
2995 "Enable advanced mode vty interface\n")
3001 DEFUN (no_service_advanced_vty
,
3002 no_service_advanced_vty_cmd
,
3003 "no service advanced-vty",
3005 "Set up miscellaneous service\n"
3006 "Enable advanced mode vty interface\n")
3012 DEFUN_NOSH (terminal_monitor
,
3013 terminal_monitor_cmd
,
3015 "Set terminal line parameters\n"
3016 "Copy debug output to the current terminal line\n")
3022 DEFUN_NOSH (terminal_no_monitor
,
3023 terminal_no_monitor_cmd
,
3024 "terminal no monitor",
3025 "Set terminal line parameters\n"
3027 "Copy debug output to the current terminal line\n")
3033 DEFUN_NOSH (no_terminal_monitor
,
3034 no_terminal_monitor_cmd
,
3035 "no terminal monitor",
3037 "Set terminal line parameters\n"
3038 "Copy debug output to the current terminal line\n")
3040 return terminal_no_monitor(self
, vty
, argc
, argv
);
3044 DEFUN_NOSH (show_history
,
3048 "Display the session command history\n")
3052 for (index
= vty
->hindex
+ 1; index
!= vty
->hindex
;) {
3053 if (index
== VTY_MAXHIST
) {
3058 if (vty
->hist
[index
] != NULL
)
3059 vty_out(vty
, " %s\n", vty
->hist
[index
]);
3068 DEFUN (log_commands
,
3072 "Log all commands (can't be unset without restart)\n")
3074 do_log_commands
= 1;
3078 /* Display current configuration. */
3079 static int vty_config_write(struct vty
*vty
)
3081 vty_out(vty
, "line vty\n");
3083 if (vty_accesslist_name
)
3084 vty_out(vty
, " access-class %s\n", vty_accesslist_name
);
3086 if (vty_ipv6_accesslist_name
)
3087 vty_out(vty
, " ipv6 access-class %s\n",
3088 vty_ipv6_accesslist_name
);
3091 if (vty_timeout_val
!= VTY_TIMEOUT_DEFAULT
)
3092 vty_out(vty
, " exec-timeout %ld %ld\n", vty_timeout_val
/ 60,
3093 vty_timeout_val
% 60);
3096 if (no_password_check
)
3097 vty_out(vty
, " no login\n");
3099 if (do_log_commands
)
3100 vty_out(vty
, "log commands\n");
3102 vty_out(vty
, "!\n");
3107 struct cmd_node vty_node
= {
3108 VTY_NODE
, "%s(config-line)# ", 1,
3111 /* Reset all VTY status. */
3116 struct thread
*vty_serv_thread
;
3118 for (i
= 0; i
< vector_active(vtyvec
); i
++)
3119 if ((vty
= vector_slot(vtyvec
, i
)) != NULL
) {
3120 buffer_reset(vty
->lbuf
);
3121 buffer_reset(vty
->obuf
);
3122 vty
->status
= VTY_CLOSE
;
3126 for (i
= 0; i
< vector_active(Vvty_serv_thread
); i
++)
3127 if ((vty_serv_thread
= vector_slot(Vvty_serv_thread
, i
))
3129 thread_cancel(vty_serv_thread
);
3130 vector_slot(Vvty_serv_thread
, i
) = NULL
;
3134 vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
3136 if (vty_accesslist_name
) {
3137 XFREE(MTYPE_VTY
, vty_accesslist_name
);
3138 vty_accesslist_name
= NULL
;
3141 if (vty_ipv6_accesslist_name
) {
3142 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
3143 vty_ipv6_accesslist_name
= NULL
;
3147 static void vty_save_cwd(void)
3149 char cwd
[MAXPATHLEN
];
3152 c
= getcwd(cwd
, MAXPATHLEN
);
3156 * At this point if these go wrong, more than likely
3157 * the whole world is coming down around us
3158 * Hence not worrying about it too much.
3160 if (!chdir(SYSCONFDIR
)) {
3161 flog_err_sys(EC_LIB_SYSTEM_CALL
,
3162 "Failure to chdir to %s, errno: %d",
3166 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
3167 flog_err_sys(EC_LIB_SYSTEM_CALL
,
3168 "Failure to getcwd, errno: %d", errno
);
3173 vty_cwd
= XMALLOC(MTYPE_TMP
, strlen(cwd
) + 1);
3174 strcpy(vty_cwd
, cwd
);
3182 int vty_shell(struct vty
*vty
)
3184 return vty
->type
== VTY_SHELL
? 1 : 0;
3187 int vty_shell_serv(struct vty
*vty
)
3189 return vty
->type
== VTY_SHELL_SERV
? 1 : 0;
3192 void vty_init_vtysh()
3194 vtyvec
= vector_init(VECTOR_MIN_SIZE
);
3197 /* Install vty's own commands like `who' command. */
3198 void vty_init(struct thread_master
*master_thread
)
3200 /* For further configuration read, preserve current directory. */
3203 vtyvec
= vector_init(VECTOR_MIN_SIZE
);
3205 vty_master
= master_thread
;
3207 atexit(vty_stdio_atexit
);
3209 /* Initilize server thread vector. */
3210 Vvty_serv_thread
= vector_init(VECTOR_MIN_SIZE
);
3212 /* Install bgp top node. */
3213 install_node(&vty_node
, vty_config_write
);
3215 install_element(VIEW_NODE
, &config_who_cmd
);
3216 install_element(VIEW_NODE
, &show_history_cmd
);
3217 install_element(CONFIG_NODE
, &line_vty_cmd
);
3218 install_element(CONFIG_NODE
, &service_advanced_vty_cmd
);
3219 install_element(CONFIG_NODE
, &no_service_advanced_vty_cmd
);
3220 install_element(CONFIG_NODE
, &show_history_cmd
);
3221 install_element(CONFIG_NODE
, &log_commands_cmd
);
3222 install_element(ENABLE_NODE
, &terminal_monitor_cmd
);
3223 install_element(ENABLE_NODE
, &terminal_no_monitor_cmd
);
3224 install_element(ENABLE_NODE
, &no_terminal_monitor_cmd
);
3226 install_default(VTY_NODE
);
3227 install_element(VTY_NODE
, &exec_timeout_min_cmd
);
3228 install_element(VTY_NODE
, &exec_timeout_sec_cmd
);
3229 install_element(VTY_NODE
, &no_exec_timeout_cmd
);
3230 install_element(VTY_NODE
, &vty_access_class_cmd
);
3231 install_element(VTY_NODE
, &no_vty_access_class_cmd
);
3232 install_element(VTY_NODE
, &vty_login_cmd
);
3233 install_element(VTY_NODE
, &no_vty_login_cmd
);
3234 install_element(VTY_NODE
, &vty_ipv6_access_class_cmd
);
3235 install_element(VTY_NODE
, &no_vty_ipv6_access_class_cmd
);
3238 void vty_terminate(void)
3241 XFREE(MTYPE_TMP
, vty_cwd
);
3243 if (vtyvec
&& Vvty_serv_thread
) {
3245 vector_free(vtyvec
);
3246 vector_free(Vvty_serv_thread
);
3248 Vvty_serv_thread
= NULL
;