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>
26 #include <sys/types.h>
27 #ifdef HAVE_LIBPCRE2_POSIX
28 #ifndef _FRR_PCRE2_POSIX
29 #define _FRR_PCRE2_POSIX
30 #include <pcre2posix.h>
31 #endif /* _FRR_PCRE2_POSIX */
32 #elif defined(HAVE_LIBPCREPOSIX)
33 #include <pcreposix.h>
36 #endif /* HAVE_LIBPCRE2_POSIX */
43 #include "sockunion.h"
53 #include "lib_errors.h"
54 #include "northbound_cli.h"
58 #include <arpa/telnet.h>
61 #include "lib/vty_clippy.c"
63 DEFINE_MTYPE_STATIC(LIB
, VTY
, "VTY");
64 DEFINE_MTYPE_STATIC(LIB
, VTY_SERV
, "VTY server");
65 DEFINE_MTYPE_STATIC(LIB
, VTY_OUT_BUF
, "VTY output buffer");
66 DEFINE_MTYPE_STATIC(LIB
, VTY_HIST
, "VTY history");
68 DECLARE_DLIST(vtys
, struct vty
, itm
);
83 PREDECL_DLIST(vtyservs
);
86 struct vtyservs_item itm
;
91 struct thread
*t_accept
;
94 DECLARE_DLIST(vtyservs
, struct vty_serv
, itm
);
96 static void vty_event_serv(enum vty_event event
, struct vty_serv
*);
97 static void vty_event(enum vty_event
, struct vty
*);
99 /* Extern host structure from command.c */
100 extern struct host host
;
102 /* active listeners */
103 static struct vtyservs_head vty_servs
[1] = {INIT_DLIST(vty_servs
[0])};
105 /* active connections */
106 static struct vtys_head vty_sessions
[1] = {INIT_DLIST(vty_sessions
[0])};
107 static struct vtys_head vtysh_sessions
[1] = {INIT_DLIST(vtysh_sessions
[0])};
109 /* Vty timeout value. */
110 static unsigned long vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
112 /* Vty access-class command */
113 static char *vty_accesslist_name
= NULL
;
115 /* Vty access-calss for IPv6. */
116 static char *vty_ipv6_accesslist_name
= NULL
;
118 /* Current directory. */
119 static char vty_cwd
[MAXPATHLEN
];
121 /* Login password check. */
122 static int no_password_check
= 0;
124 /* Integrated configuration file path */
125 static char integrate_default
[] = SYSCONFDIR INTEGRATE_DEFAULT_CONFIG
;
127 static bool do_log_commands
;
128 static bool do_log_commands_perm
;
130 void vty_frame(struct vty
*vty
, const char *format
, ...)
134 va_start(args
, format
);
135 vsnprintfrr(vty
->frame
+ vty
->frame_pos
,
136 sizeof(vty
->frame
) - vty
->frame_pos
, format
, args
);
137 vty
->frame_pos
= strlen(vty
->frame
);
141 void vty_endframe(struct vty
*vty
, const char *endtext
)
143 if (vty
->frame_pos
== 0 && endtext
)
144 vty_out(vty
, "%s", endtext
);
148 bool vty_set_include(struct vty
*vty
, const char *regexp
)
156 regfree(&vty
->include
);
162 errcode
= regcomp(&vty
->include
, regexp
,
163 REG_EXTENDED
| REG_NEWLINE
| REG_NOSUB
);
166 regerror(errcode
, &vty
->include
, errbuf
, sizeof(errbuf
));
167 vty_out(vty
, "%% Regex compilation error: %s\n", errbuf
);
175 /* VTY standard output function. */
176 int vty_out(struct vty
*vty
, const char *format
, ...)
183 /* format string may contain %m, keep errno intact for printfrr */
184 int saved_errno
= errno
;
186 if (vty
->frame_pos
) {
188 vty_out(vty
, "%s", vty
->frame
);
191 va_start(args
, format
);
193 p
= vasnprintfrr(MTYPE_VTY_OUT_BUF
, buf
, sizeof(buf
), format
, args
);
200 vector lines
= frrstr_split_vec(p
, "\n");
202 /* Place first value in the cache */
203 char *firstline
= vector_slot(lines
, 0);
204 buffer_put(vty
->lbuf
, (uint8_t *) firstline
, strlen(firstline
));
206 /* If our split returned more than one entry, time to filter */
207 if (vector_active(lines
) > 1) {
209 * returned string is MTYPE_TMP so it matches the MTYPE
210 * of everything else in the vector
212 char *bstr
= buffer_getstr(vty
->lbuf
);
213 buffer_reset(vty
->lbuf
);
214 XFREE(MTYPE_TMP
, lines
->index
[0]);
215 vector_set_index(lines
, 0, bstr
);
216 frrstr_filter_vec(lines
, &vty
->include
);
217 vector_compact(lines
);
219 * Consider the string "foo\n". If the regex is an empty string
220 * and the line ended with a newline, then the vector will look
226 * If the regex isn't empty, the vector will look like:
230 * In this case we'd like to preserve the newline, so we add
231 * the empty string [1] as in the first example.
233 if (p
[strlen(p
) - 1] == '\n' && vector_active(lines
) > 0
234 && strlen(vector_slot(lines
, vector_active(lines
) - 1)))
235 vector_set(lines
, XSTRDUP(MTYPE_TMP
, ""));
237 filtered
= frrstr_join_vec(lines
, "\n");
243 frrstr_strvec_free(lines
);
254 /* print with crlf replacement */
255 buffer_put_crlf(vty
->obuf
, (uint8_t *)filtered
,
260 fprintf(vty
->of
, "%s", filtered
);
262 } else if (vty
->of_saved
) {
263 fprintf(vty
->of_saved
, "%s", filtered
);
264 fflush(vty
->of_saved
);
270 /* print without crlf replacement */
271 buffer_put(vty
->obuf
, (uint8_t *)filtered
, strlen(filtered
));
277 if (vty
->filter
&& filtered
)
278 XFREE(MTYPE_TMP
, filtered
);
280 /* If p is not different with buf, it is allocated buffer. */
282 XFREE(MTYPE_VTY_OUT_BUF
, p
);
287 int vty_json(struct vty
*vty
, struct json_object
*json
)
294 text
= json_object_to_json_string_ext(
295 json
, JSON_C_TO_STRING_PRETTY
| JSON_C_TO_STRING_NOSLASHESCAPE
);
296 vty_out(vty
, "%s\n", text
);
297 json_object_free(json
);
302 /* Output current time to the vty. */
303 void vty_time_print(struct vty
*vty
, int cr
)
305 char buf
[FRR_TIMESTAMP_LEN
];
307 if (frr_timestamp(0, buf
, sizeof(buf
)) == 0) {
308 zlog_info("frr_timestamp error");
312 vty_out(vty
, "%s\n", buf
);
314 vty_out(vty
, "%s ", buf
);
319 /* Say hello to vty interface. */
320 void vty_hello(struct vty
*vty
)
326 f
= fopen(host
.motdfile
, "r");
328 while (fgets(buf
, sizeof(buf
), f
)) {
330 /* work backwards to ignore trailling isspace()
332 for (s
= buf
+ strlen(buf
);
333 (s
> buf
) && isspace((unsigned char)s
[-1]);
337 vty_out(vty
, "%s\n", buf
);
341 vty_out(vty
, "MOTD file not found\n");
342 } else if (host
.motd
)
343 vty_out(vty
, "%s", host
.motd
);
346 /* Put out prompt and wait input from user. */
347 static void vty_prompt(struct vty
*vty
)
349 if (vty
->type
== VTY_TERM
) {
350 vty_out(vty
, cmd_prompt(vty
->node
), cmd_hostname_get());
354 /* Send WILL TELOPT_ECHO to remote server. */
355 static void vty_will_echo(struct vty
*vty
)
357 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_ECHO
, '\0'};
358 vty_out(vty
, "%s", cmd
);
361 /* Make suppress Go-Ahead telnet option. */
362 static void vty_will_suppress_go_ahead(struct vty
*vty
)
364 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_SGA
, '\0'};
365 vty_out(vty
, "%s", cmd
);
368 /* Make don't use linemode over telnet. */
369 static void vty_dont_linemode(struct vty
*vty
)
371 unsigned char cmd
[] = {IAC
, DONT
, TELOPT_LINEMODE
, '\0'};
372 vty_out(vty
, "%s", cmd
);
375 /* Use window size. */
376 static void vty_do_window_size(struct vty
*vty
)
378 unsigned char cmd
[] = {IAC
, DO
, TELOPT_NAWS
, '\0'};
379 vty_out(vty
, "%s", cmd
);
382 /* Authentication of vty */
383 static void vty_auth(struct vty
*vty
, char *buf
)
386 enum node_type next_node
= 0;
392 passwd
= host
.password_encrypt
;
394 passwd
= host
.password
;
396 next_node
= host
.enable
? VIEW_NODE
: ENABLE_NODE
;
398 next_node
= VIEW_NODE
;
400 case AUTH_ENABLE_NODE
:
402 passwd
= host
.enable_encrypt
;
404 passwd
= host
.enable
;
405 next_node
= ENABLE_NODE
;
411 fail
= strcmp(crypt(buf
, passwd
), passwd
);
413 fail
= strcmp(buf
, passwd
);
419 vty
->node
= next_node
; /* Success ! */
422 if (vty
->fail
>= 3) {
423 if (vty
->node
== AUTH_NODE
) {
425 "%% Bad passwords, too many failures!\n");
426 vty
->status
= VTY_CLOSE
;
428 /* AUTH_ENABLE_NODE */
431 "%% Bad enable passwords, too many failures!\n");
432 vty
->status
= VTY_CLOSE
;
438 /* Command execution over the vty interface. */
439 static int vty_command(struct vty
*vty
, char *buf
)
442 const char *protocolname
;
448 * Log non empty command lines
453 /* Skip white spaces. */
454 while (isspace((unsigned char)*cp
) && *cp
!= '\0')
457 if (cp
!= NULL
&& *cp
!= '\0') {
458 char vty_str
[VTY_BUFSIZ
];
459 char prompt_str
[VTY_BUFSIZ
];
461 /* format the base vty info */
462 snprintf(vty_str
, sizeof(vty_str
), "vty[%d]@%s", vty
->fd
,
465 /* format the prompt */
466 snprintf(prompt_str
, sizeof(prompt_str
), cmd_prompt(vty
->node
),
469 /* now log the command */
470 zlog_notice("%s%s", prompt_str
, buf
);
475 unsigned long walltime
, cputime
;
477 /* cmd_execute() may change cputime_enabled if we're executing the
478 * "service cputime-stats" command, which can result in nonsensical
479 * and very confusing warnings
481 bool cputime_enabled_here
= cputime_enabled
;
485 ret
= cmd_execute(vty
, buf
, NULL
, 0);
489 walltime
= thread_consumed_time(&after
, &before
, &cputime
);
491 if (cputime_enabled_here
&& cputime_enabled
&& cputime_threshold
492 && cputime
> cputime_threshold
)
493 /* Warn about CPU hog that must be fixed. */
494 flog_warn(EC_LIB_SLOW_THREAD_CPU
,
495 "CPU HOG: command took %lums (cpu time %lums): %s",
496 walltime
/ 1000, cputime
/ 1000, buf
);
497 else if (walltime_threshold
&& walltime
> walltime_threshold
)
498 flog_warn(EC_LIB_SLOW_THREAD_WALL
,
499 "STARVATION: command took %lums (cpu time %lums): %s",
500 walltime
/ 1000, cputime
/ 1000, buf
);
502 /* Get the name of the protocol if any */
503 protocolname
= frr_protoname
;
505 if (ret
!= CMD_SUCCESS
)
508 if (vty
->type
== VTY_FILE
)
509 vty_out(vty
, "Warning...\n");
511 case CMD_ERR_AMBIGUOUS
:
512 vty_out(vty
, "%% Ambiguous command.\n");
514 case CMD_ERR_NO_MATCH
:
515 vty_out(vty
, "%% [%s] Unknown command: %s\n",
518 case CMD_ERR_INCOMPLETE
:
519 vty_out(vty
, "%% Command incomplete.\n");
526 static const char telnet_backward_char
= 0x08;
527 static const char telnet_space_char
= ' ';
529 /* Basic function to write buffer to vty. */
530 static void vty_write(struct vty
*vty
, const char *buf
, size_t nbytes
)
532 if ((vty
->node
== AUTH_NODE
) || (vty
->node
== AUTH_ENABLE_NODE
))
535 /* Should we do buffering here ? And make vty_flush (vty) ? */
536 buffer_put(vty
->obuf
, buf
, nbytes
);
539 /* Basic function to insert character into vty. */
540 static void vty_self_insert(struct vty
*vty
, char c
)
545 if (vty
->length
+ 1 >= VTY_BUFSIZ
)
548 length
= vty
->length
- vty
->cp
;
549 memmove(&vty
->buf
[vty
->cp
+ 1], &vty
->buf
[vty
->cp
], length
);
550 vty
->buf
[vty
->cp
] = c
;
552 vty_write(vty
, &vty
->buf
[vty
->cp
], length
+ 1);
553 for (i
= 0; i
< length
; i
++)
554 vty_write(vty
, &telnet_backward_char
, 1);
559 vty
->buf
[vty
->length
] = '\0';
562 /* Self insert character 'c' in overwrite mode. */
563 static void vty_self_insert_overwrite(struct vty
*vty
, char c
)
565 if (vty
->cp
== vty
->length
) {
566 vty_self_insert(vty
, c
);
570 vty
->buf
[vty
->cp
++] = c
;
571 vty_write(vty
, &c
, 1);
575 * Insert a string into vty->buf at the current cursor position.
577 * If the resultant string would be larger than VTY_BUFSIZ it is
580 static void vty_insert_word_overwrite(struct vty
*vty
, char *str
)
582 if (vty
->cp
== VTY_BUFSIZ
)
585 size_t nwrite
= MIN((int)strlen(str
), VTY_BUFSIZ
- vty
->cp
- 1);
586 memcpy(&vty
->buf
[vty
->cp
], str
, nwrite
);
588 vty
->length
= MAX(vty
->cp
, vty
->length
);
589 vty
->buf
[vty
->length
] = '\0';
590 vty_write(vty
, str
, nwrite
);
593 /* Forward character. */
594 static void vty_forward_char(struct vty
*vty
)
596 if (vty
->cp
< vty
->length
) {
597 vty_write(vty
, &vty
->buf
[vty
->cp
], 1);
602 /* Backward character. */
603 static void vty_backward_char(struct vty
*vty
)
607 vty_write(vty
, &telnet_backward_char
, 1);
611 /* Move to the beginning of the line. */
612 static void vty_beginning_of_line(struct vty
*vty
)
615 vty_backward_char(vty
);
618 /* Move to the end of the line. */
619 static void vty_end_of_line(struct vty
*vty
)
621 while (vty
->cp
< vty
->length
)
622 vty_forward_char(vty
);
625 static void vty_kill_line_from_beginning(struct vty
*);
626 static void vty_redraw_line(struct vty
*);
628 /* Print command line history. This function is called from
629 vty_next_line and vty_previous_line. */
630 static void vty_history_print(struct vty
*vty
)
634 vty_kill_line_from_beginning(vty
);
636 /* Get previous line from history buffer */
637 length
= strlen(vty
->hist
[vty
->hp
]);
638 memcpy(vty
->buf
, vty
->hist
[vty
->hp
], length
);
639 vty
->cp
= vty
->length
= length
;
640 vty
->buf
[vty
->length
] = '\0';
642 /* Redraw current line */
643 vty_redraw_line(vty
);
646 /* Show next command line history. */
647 static void vty_next_line(struct vty
*vty
)
651 if (vty
->hp
== vty
->hindex
)
654 /* Try is there history exist or not. */
656 if (try_index
== (VTY_MAXHIST
- 1))
661 /* If there is not history return. */
662 if (vty
->hist
[try_index
] == NULL
)
667 vty_history_print(vty
);
670 /* Show previous command line history. */
671 static void vty_previous_line(struct vty
*vty
)
677 try_index
= VTY_MAXHIST
- 1;
681 if (vty
->hist
[try_index
] == NULL
)
686 vty_history_print(vty
);
689 /* This function redraw all of the command line character. */
690 static void vty_redraw_line(struct vty
*vty
)
692 vty_write(vty
, vty
->buf
, vty
->length
);
693 vty
->cp
= vty
->length
;
697 static void vty_forward_word(struct vty
*vty
)
699 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
700 vty_forward_char(vty
);
702 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
703 vty_forward_char(vty
);
706 /* Backward word without skipping training space. */
707 static void vty_backward_pure_word(struct vty
*vty
)
709 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
710 vty_backward_char(vty
);
714 static void vty_backward_word(struct vty
*vty
)
716 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
717 vty_backward_char(vty
);
719 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
720 vty_backward_char(vty
);
723 /* When '^D' is typed at the beginning of the line we move to the down
725 static void vty_down_level(struct vty
*vty
)
733 /* When '^Z' is received from vty, move down to the enable mode. */
734 static void vty_end_config(struct vty
*vty
)
739 vty_config_exit(vty
);
740 vty
->node
= ENABLE_NODE
;
747 /* Delete a character at the current point. */
748 static void vty_delete_char(struct vty
*vty
)
753 if (vty
->length
== 0) {
758 if (vty
->cp
== vty
->length
)
759 return; /* completion need here? */
761 size
= vty
->length
- vty
->cp
;
764 memmove(&vty
->buf
[vty
->cp
], &vty
->buf
[vty
->cp
+ 1], size
- 1);
765 vty
->buf
[vty
->length
] = '\0';
767 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
770 vty_write(vty
, &vty
->buf
[vty
->cp
], size
- 1);
771 vty_write(vty
, &telnet_space_char
, 1);
773 for (i
= 0; i
< size
; i
++)
774 vty_write(vty
, &telnet_backward_char
, 1);
777 /* Delete a character before the point. */
778 static void vty_delete_backward_char(struct vty
*vty
)
783 vty_backward_char(vty
);
784 vty_delete_char(vty
);
787 /* Kill rest of line from current point. */
788 static void vty_kill_line(struct vty
*vty
)
793 size
= vty
->length
- vty
->cp
;
798 for (i
= 0; i
< size
; i
++)
799 vty_write(vty
, &telnet_space_char
, 1);
800 for (i
= 0; i
< size
; i
++)
801 vty_write(vty
, &telnet_backward_char
, 1);
803 memset(&vty
->buf
[vty
->cp
], 0, size
);
804 vty
->length
= vty
->cp
;
807 /* Kill line from the beginning. */
808 static void vty_kill_line_from_beginning(struct vty
*vty
)
810 vty_beginning_of_line(vty
);
814 /* Delete a word before the point. */
815 static void vty_forward_kill_word(struct vty
*vty
)
817 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
818 vty_delete_char(vty
);
819 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
820 vty_delete_char(vty
);
823 /* Delete a word before the point. */
824 static void vty_backward_kill_word(struct vty
*vty
)
826 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
827 vty_delete_backward_char(vty
);
828 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
829 vty_delete_backward_char(vty
);
832 /* Transpose chars before or at the point. */
833 static void vty_transpose_chars(struct vty
*vty
)
837 /* If length is short or point is near by the beginning of line then
839 if (vty
->length
< 2 || vty
->cp
< 1)
842 /* In case of point is located at the end of the line. */
843 if (vty
->cp
== vty
->length
) {
844 c1
= vty
->buf
[vty
->cp
- 1];
845 c2
= vty
->buf
[vty
->cp
- 2];
847 vty_backward_char(vty
);
848 vty_backward_char(vty
);
849 vty_self_insert_overwrite(vty
, c1
);
850 vty_self_insert_overwrite(vty
, c2
);
852 c1
= vty
->buf
[vty
->cp
];
853 c2
= vty
->buf
[vty
->cp
- 1];
855 vty_backward_char(vty
);
856 vty_self_insert_overwrite(vty
, c1
);
857 vty_self_insert_overwrite(vty
, c2
);
861 /* Do completion at vty interface. */
862 static void vty_complete_command(struct vty
*vty
)
866 char **matched
= NULL
;
869 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
872 vline
= cmd_make_strvec(vty
->buf
);
876 /* In case of 'help \t'. */
877 if (isspace((unsigned char)vty
->buf
[vty
->length
- 1]))
878 vector_set(vline
, NULL
);
880 matched
= cmd_complete_command(vline
, vty
, &ret
);
882 cmd_free_strvec(vline
);
886 case CMD_ERR_AMBIGUOUS
:
887 vty_out(vty
, "%% Ambiguous command.\n");
889 vty_redraw_line(vty
);
891 case CMD_ERR_NO_MATCH
:
892 /* vty_out (vty, "%% There is no matched command.\n"); */
894 vty_redraw_line(vty
);
896 case CMD_COMPLETE_FULL_MATCH
:
898 /* 2016-11-28 equinox -- need to debug, SEGV here */
899 vty_out(vty
, "%% CLI BUG: FULL_MATCH with NULL str\n");
901 vty_redraw_line(vty
);
905 vty_redraw_line(vty
);
906 vty_backward_pure_word(vty
);
907 vty_insert_word_overwrite(vty
, matched
[0]);
908 vty_self_insert(vty
, ' ');
909 XFREE(MTYPE_COMPLETION
, matched
[0]);
911 case CMD_COMPLETE_MATCH
:
913 vty_redraw_line(vty
);
914 vty_backward_pure_word(vty
);
915 vty_insert_word_overwrite(vty
, matched
[0]);
916 XFREE(MTYPE_COMPLETION
, matched
[0]);
918 case CMD_COMPLETE_LIST_MATCH
:
919 for (i
= 0; matched
[i
] != NULL
; i
++) {
920 if (i
!= 0 && ((i
% 6) == 0))
922 vty_out(vty
, "%-10s ", matched
[i
]);
923 XFREE(MTYPE_COMPLETION
, matched
[i
]);
928 vty_redraw_line(vty
);
930 case CMD_ERR_NOTHING_TODO
:
932 vty_redraw_line(vty
);
937 XFREE(MTYPE_TMP
, matched
);
940 static void vty_describe_fold(struct vty
*vty
, int cmd_width
,
941 unsigned int desc_width
, struct cmd_token
*token
)
949 if (desc_width
<= 0) {
950 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, token
->desc
);
954 buf
= XCALLOC(MTYPE_TMP
, strlen(token
->desc
) + 1);
956 for (p
= token
->desc
; strlen(p
) > desc_width
; p
+= pos
+ 1) {
957 for (pos
= desc_width
; pos
> 0; pos
--)
958 if (*(p
+ pos
) == ' ')
966 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, buf
);
971 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, p
);
973 XFREE(MTYPE_TMP
, buf
);
976 /* Describe matched command function. */
977 static void vty_describe_command(struct vty
*vty
)
982 unsigned int i
, width
, desc_width
;
983 struct cmd_token
*token
, *token_cr
= NULL
;
985 vline
= cmd_make_strvec(vty
->buf
);
987 /* In case of '> ?'. */
989 vline
= vector_init(1);
990 vector_set(vline
, NULL
);
991 } else if (isspace((unsigned char)vty
->buf
[vty
->length
- 1]))
992 vector_set(vline
, NULL
);
994 describe
= cmd_describe_command(vline
, vty
, &ret
);
998 /* Ambiguous error. */
1000 case CMD_ERR_AMBIGUOUS
:
1001 vty_out(vty
, "%% Ambiguous command.\n");
1004 case CMD_ERR_NO_MATCH
:
1005 vty_out(vty
, "%% There is no matched command.\n");
1010 /* Get width of command string. */
1012 for (i
= 0; i
< vector_active(describe
); i
++)
1013 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1016 if (token
->text
[0] == '\0')
1019 len
= strlen(token
->text
);
1025 /* Get width of description string. */
1026 desc_width
= vty
->width
- (width
+ 6);
1028 /* Print out description. */
1029 for (i
= 0; i
< vector_active(describe
); i
++)
1030 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1031 if (token
->text
[0] == '\0')
1034 if (strcmp(token
->text
, CMD_CR_TEXT
) == 0) {
1040 vty_out(vty
, " %-s\n", token
->text
);
1041 else if (desc_width
>= strlen(token
->desc
))
1042 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1045 vty_describe_fold(vty
, width
, desc_width
,
1048 if (IS_VARYING_TOKEN(token
->type
)) {
1049 const char *ref
= vector_slot(
1050 vline
, vector_active(vline
) - 1);
1052 vector varcomps
= vector_init(VECTOR_MIN_SIZE
);
1053 cmd_variable_complete(token
, ref
, varcomps
);
1055 if (vector_active(varcomps
) > 0) {
1056 char *ac
= cmd_variable_comp2str(
1057 varcomps
, vty
->width
);
1058 vty_out(vty
, "%s\n", ac
);
1059 XFREE(MTYPE_TMP
, ac
);
1062 vector_free(varcomps
);
1066 if ((token
= token_cr
)) {
1068 vty_out(vty
, " %-s\n", token
->text
);
1069 else if (desc_width
>= strlen(token
->desc
))
1070 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1073 vty_describe_fold(vty
, width
, desc_width
, token
);
1077 cmd_free_strvec(vline
);
1079 vector_free(describe
);
1082 vty_redraw_line(vty
);
1085 static void vty_clear_buf(struct vty
*vty
)
1087 memset(vty
->buf
, 0, vty
->max
);
1090 /* ^C stop current input and do not add command line to the history. */
1091 static void vty_stop_input(struct vty
*vty
)
1093 vty
->cp
= vty
->length
= 0;
1098 vty_config_exit(vty
);
1099 vty
->node
= ENABLE_NODE
;
1104 /* Set history pointer to the latest one. */
1105 vty
->hp
= vty
->hindex
;
1108 /* Add current command line to the history buffer. */
1109 static void vty_hist_add(struct vty
*vty
)
1113 if (vty
->length
== 0)
1116 index
= vty
->hindex
? vty
->hindex
- 1 : VTY_MAXHIST
- 1;
1118 /* Ignore the same string as previous one. */
1119 if (vty
->hist
[index
])
1120 if (strcmp(vty
->buf
, vty
->hist
[index
]) == 0) {
1121 vty
->hp
= vty
->hindex
;
1125 /* Insert history entry. */
1126 XFREE(MTYPE_VTY_HIST
, vty
->hist
[vty
->hindex
]);
1127 vty
->hist
[vty
->hindex
] = XSTRDUP(MTYPE_VTY_HIST
, vty
->buf
);
1129 /* History index rotation. */
1131 if (vty
->hindex
== VTY_MAXHIST
)
1134 vty
->hp
= vty
->hindex
;
1137 /* #define TELNET_OPTION_DEBUG */
1139 /* Get telnet window size. */
1140 static int vty_telnet_option(struct vty
*vty
, unsigned char *buf
, int nbytes
)
1142 #ifdef TELNET_OPTION_DEBUG
1145 for (i
= 0; i
< nbytes
; i
++) {
1148 vty_out(vty
, "IAC ");
1151 vty_out(vty
, "WILL ");
1154 vty_out(vty
, "WONT ");
1157 vty_out(vty
, "DO ");
1160 vty_out(vty
, "DONT ");
1163 vty_out(vty
, "SB ");
1166 vty_out(vty
, "SE ");
1169 vty_out(vty
, "TELOPT_ECHO \n");
1172 vty_out(vty
, "TELOPT_SGA \n");
1175 vty_out(vty
, "TELOPT_NAWS \n");
1178 vty_out(vty
, "%x ", buf
[i
]);
1184 #endif /* TELNET_OPTION_DEBUG */
1189 vty
->iac_sb_in_progress
= 1;
1192 if (!vty
->iac_sb_in_progress
)
1195 if ((vty
->sb_len
== 0) || (vty
->sb_buf
[0] == '\0')) {
1196 vty
->iac_sb_in_progress
= 0;
1199 switch (vty
->sb_buf
[0]) {
1201 if (vty
->sb_len
!= TELNET_NAWS_SB_LEN
)
1204 "RFC 1073 violation detected: telnet NAWS option should send %d characters, but we received %lu",
1206 (unsigned long)vty
->sb_len
);
1207 else if (sizeof(vty
->sb_buf
) < TELNET_NAWS_SB_LEN
)
1210 "Bug detected: sizeof(vty->sb_buf) %lu < %d, too small to handle the telnet NAWS option",
1211 (unsigned long)sizeof(vty
->sb_buf
),
1212 TELNET_NAWS_SB_LEN
);
1214 vty
->width
= ((vty
->sb_buf
[1] << 8)
1216 vty
->height
= ((vty
->sb_buf
[3] << 8)
1218 #ifdef TELNET_OPTION_DEBUG
1220 "TELNET NAWS window size negotiation completed: width %d, height %d\n",
1221 vty
->width
, vty
->height
);
1226 vty
->iac_sb_in_progress
= 0;
1235 /* Execute current command line. */
1236 static int vty_execute(struct vty
*vty
)
1242 switch (vty
->node
) {
1244 case AUTH_ENABLE_NODE
:
1245 vty_auth(vty
, vty
->buf
);
1248 ret
= vty_command(vty
, vty
->buf
);
1249 if (vty
->type
== VTY_TERM
)
1254 /* Clear command line buffer. */
1255 vty
->cp
= vty
->length
= 0;
1258 if (vty
->status
!= VTY_CLOSE
)
1264 #define CONTROL(X) ((X) - '@')
1265 #define VTY_NORMAL 0
1266 #define VTY_PRE_ESCAPE 1
1267 #define VTY_ESCAPE 2
1270 /* Escape character command map. */
1271 static void vty_escape_map(unsigned char c
, struct vty
*vty
)
1275 vty_previous_line(vty
);
1281 vty_forward_char(vty
);
1284 vty_backward_char(vty
);
1290 /* Go back to normal mode. */
1291 vty
->escape
= VTY_NORMAL
;
1294 /* Quit print out to the buffer. */
1295 static void vty_buffer_reset(struct vty
*vty
)
1297 buffer_reset(vty
->obuf
);
1298 buffer_reset(vty
->lbuf
);
1300 vty_redraw_line(vty
);
1303 /* Read data via vty socket. */
1304 static void vty_read(struct thread
*thread
)
1308 unsigned char buf
[VTY_READ_BUFSIZ
];
1310 struct vty
*vty
= THREAD_ARG(thread
);
1312 /* Read raw data from socket */
1313 if ((nbytes
= read(vty
->fd
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
1315 if (ERRNO_IO_RETRY(errno
)) {
1316 vty_event(VTY_READ
, vty
);
1321 "%s: read error on vty client fd %d, closing: %s",
1322 __func__
, vty
->fd
, safe_strerror(errno
));
1323 buffer_reset(vty
->obuf
);
1324 buffer_reset(vty
->lbuf
);
1326 vty
->status
= VTY_CLOSE
;
1329 for (i
= 0; i
< nbytes
; i
++) {
1330 if (buf
[i
] == IAC
) {
1339 if (vty
->iac_sb_in_progress
&& !vty
->iac
) {
1340 if (vty
->sb_len
< sizeof(vty
->sb_buf
))
1341 vty
->sb_buf
[vty
->sb_len
] = buf
[i
];
1347 /* In case of telnet command */
1349 ret
= vty_telnet_option(vty
, buf
+ i
, nbytes
- i
);
1356 if (vty
->status
== VTY_MORE
) {
1361 vty_buffer_reset(vty
);
1369 /* Escape character. */
1370 if (vty
->escape
== VTY_ESCAPE
) {
1371 vty_escape_map(buf
[i
], vty
);
1375 /* Pre-escape status. */
1376 if (vty
->escape
== VTY_PRE_ESCAPE
) {
1379 vty
->escape
= VTY_ESCAPE
;
1382 vty_backward_word(vty
);
1383 vty
->escape
= VTY_NORMAL
;
1386 vty_forward_word(vty
);
1387 vty
->escape
= VTY_NORMAL
;
1390 vty_forward_kill_word(vty
);
1391 vty
->escape
= VTY_NORMAL
;
1395 vty_backward_kill_word(vty
);
1396 vty
->escape
= VTY_NORMAL
;
1399 vty
->escape
= VTY_NORMAL
;
1405 if (vty
->escape
== VTY_CR
) {
1406 /* if we get CR+NL, the NL results in an extra empty
1407 * prompt line being printed without this; just drop
1408 * the NL if it immediately follows CR.
1410 vty
->escape
= VTY_NORMAL
;
1418 vty_beginning_of_line(vty
);
1421 vty_backward_char(vty
);
1424 vty_stop_input(vty
);
1427 vty_delete_char(vty
);
1430 vty_end_of_line(vty
);
1433 vty_forward_char(vty
);
1437 vty_delete_backward_char(vty
);
1446 vty_previous_line(vty
);
1449 vty_transpose_chars(vty
);
1452 vty_kill_line_from_beginning(vty
);
1455 vty_backward_kill_word(vty
);
1458 vty_end_config(vty
);
1461 vty
->escape
= VTY_CR
;
1465 buffer_flush_available(vty
->obuf
, vty
->wfd
);
1468 if (vty
->pass_fd
!= -1) {
1469 close(vty
->pass_fd
);
1474 vty_complete_command(vty
);
1477 if (vty
->node
== AUTH_NODE
1478 || vty
->node
== AUTH_ENABLE_NODE
)
1479 vty_self_insert(vty
, buf
[i
]);
1481 vty_describe_command(vty
);
1484 if (i
+ 1 < nbytes
&& buf
[i
+ 1] == '[') {
1485 vty
->escape
= VTY_ESCAPE
;
1488 vty
->escape
= VTY_PRE_ESCAPE
;
1491 if (buf
[i
] > 31 && buf
[i
] < 127)
1492 vty_self_insert(vty
, buf
[i
]);
1498 if (vty
->status
== VTY_CLOSE
)
1501 vty_event(VTY_WRITE
, vty
);
1502 vty_event(VTY_READ
, vty
);
1506 /* Flush buffer to the vty. */
1507 static void vty_flush(struct thread
*thread
)
1510 buffer_status_t flushrc
;
1511 struct vty
*vty
= THREAD_ARG(thread
);
1513 /* Tempolary disable read thread. */
1514 if (vty
->lines
== 0)
1515 THREAD_OFF(vty
->t_read
);
1517 /* Function execution continue. */
1518 erase
= ((vty
->status
== VTY_MORE
|| vty
->status
== VTY_MORELINE
));
1520 /* N.B. if width is 0, that means we don't know the window size. */
1521 if ((vty
->lines
== 0) || (vty
->width
== 0) || (vty
->height
== 0))
1522 flushrc
= buffer_flush_available(vty
->obuf
, vty
->wfd
);
1523 else if (vty
->status
== VTY_MORELINE
)
1524 flushrc
= buffer_flush_window(vty
->obuf
, vty
->wfd
, vty
->width
,
1527 flushrc
= buffer_flush_window(
1528 vty
->obuf
, vty
->wfd
, vty
->width
,
1529 vty
->lines
>= 0 ? vty
->lines
: vty
->height
, erase
, 0);
1532 zlog_info("buffer_flush failed on vty client fd %d/%d, closing",
1534 buffer_reset(vty
->lbuf
);
1535 buffer_reset(vty
->obuf
);
1539 if (vty
->status
== VTY_CLOSE
)
1542 vty
->status
= VTY_NORMAL
;
1543 if (vty
->lines
== 0)
1544 vty_event(VTY_READ
, vty
);
1547 case BUFFER_PENDING
:
1548 /* There is more data waiting to be written. */
1549 vty
->status
= VTY_MORE
;
1550 if (vty
->lines
== 0)
1551 vty_event(VTY_WRITE
, vty
);
1556 /* Allocate new vty struct. */
1557 struct vty
*vty_new(void)
1559 struct vty
*new = XCALLOC(MTYPE_VTY
, sizeof(struct vty
));
1561 new->fd
= new->wfd
= -1;
1563 new->lbuf
= buffer_new(0);
1564 new->obuf
= buffer_new(0); /* Use default buffer size. */
1565 new->buf
= XCALLOC(MTYPE_VTY
, VTY_BUFSIZ
);
1566 new->max
= VTY_BUFSIZ
;
1573 /* allocate and initialise vty */
1574 static struct vty
*vty_new_init(int vty_sock
)
1580 vty
->wfd
= vty_sock
;
1581 vty
->type
= VTY_TERM
;
1582 vty
->node
= AUTH_NODE
;
1587 memset(vty
->hist
, 0, sizeof(vty
->hist
));
1590 vty
->xpath_index
= 0;
1591 memset(vty
->xpath
, 0, sizeof(vty
->xpath
));
1592 vty
->private_config
= false;
1593 vty
->candidate_config
= vty_shared_candidate_config
;
1594 vty
->status
= VTY_NORMAL
;
1597 vty
->iac_sb_in_progress
= 0;
1600 vtys_add_tail(vty_sessions
, vty
);
1605 /* Create new vty structure. */
1606 static struct vty
*vty_create(int vty_sock
, union sockunion
*su
)
1608 char buf
[SU_ADDRSTRLEN
];
1611 sockunion2str(su
, buf
, SU_ADDRSTRLEN
);
1613 /* Allocate new vty structure and set up default values. */
1614 vty
= vty_new_init(vty_sock
);
1616 /* configurable parameters not part of basic init */
1617 vty
->v_timeout
= vty_timeout_val
;
1618 strlcpy(vty
->address
, buf
, sizeof(vty
->address
));
1619 if (no_password_check
) {
1621 vty
->node
= ENABLE_NODE
;
1623 vty
->node
= VIEW_NODE
;
1625 if (host
.lines
>= 0)
1626 vty
->lines
= host
.lines
;
1628 if (!no_password_check
) {
1629 /* Vty is not available if password isn't set. */
1630 if (host
.password
== NULL
&& host
.password_encrypt
== NULL
) {
1631 vty_out(vty
, "Vty password is not set.\n");
1632 vty
->status
= VTY_CLOSE
;
1638 /* Say hello to the world. */
1640 if (!no_password_check
)
1641 vty_out(vty
, "\nUser Access Verification\n\n");
1643 /* Setting up terminal. */
1645 vty_will_suppress_go_ahead(vty
);
1647 vty_dont_linemode(vty
);
1648 vty_do_window_size(vty
);
1649 /* vty_dont_lflow_ahead (vty); */
1653 /* Add read/write thread. */
1654 vty_event(VTY_WRITE
, vty
);
1655 vty_event(VTY_READ
, vty
);
1660 /* create vty for stdio */
1661 static struct termios stdio_orig_termios
;
1662 static struct vty
*stdio_vty
= NULL
;
1663 static bool stdio_termios
= false;
1664 static void (*stdio_vty_atclose
)(int isexit
);
1666 static void vty_stdio_reset(int isexit
)
1670 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1671 stdio_termios
= false;
1675 if (stdio_vty_atclose
)
1676 stdio_vty_atclose(isexit
);
1677 stdio_vty_atclose
= NULL
;
1681 static void vty_stdio_atexit(void)
1686 void vty_stdio_suspend(void)
1691 THREAD_OFF(stdio_vty
->t_write
);
1692 THREAD_OFF(stdio_vty
->t_read
);
1693 THREAD_OFF(stdio_vty
->t_timeout
);
1696 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1697 stdio_termios
= false;
1700 void vty_stdio_resume(void)
1705 if (!tcgetattr(0, &stdio_orig_termios
)) {
1706 struct termios termios
;
1708 termios
= stdio_orig_termios
;
1709 termios
.c_iflag
&= ~(IGNBRK
| BRKINT
| PARMRK
| ISTRIP
| INLCR
1710 | IGNCR
| ICRNL
| IXON
);
1711 termios
.c_lflag
&= ~(ECHO
| ECHONL
| ICANON
| IEXTEN
);
1712 termios
.c_cflag
&= ~(CSIZE
| PARENB
);
1713 termios
.c_cflag
|= CS8
;
1714 tcsetattr(0, TCSANOW
, &termios
);
1715 stdio_termios
= true;
1718 vty_prompt(stdio_vty
);
1720 /* Add read/write thread. */
1721 vty_event(VTY_WRITE
, stdio_vty
);
1722 vty_event(VTY_READ
, stdio_vty
);
1725 void vty_stdio_close(void)
1729 vty_close(stdio_vty
);
1732 struct vty
*vty_stdio(void (*atclose
)(int isexit
))
1736 /* refuse creating two vtys on stdio */
1740 vty
= stdio_vty
= vty_new_init(0);
1741 stdio_vty_atclose
= atclose
;
1744 /* always have stdio vty in a known _unchangeable_ state, don't want
1746 * to have any effect here to make sure scripting this works as intended
1748 vty
->node
= ENABLE_NODE
;
1750 strlcpy(vty
->address
, "console", sizeof(vty
->address
));
1756 /* Accept connection from the network. */
1757 static void vty_accept(struct thread
*thread
)
1759 struct vty_serv
*vtyserv
= THREAD_ARG(thread
);
1764 int accept_sock
= vtyserv
->sock
;
1766 struct access_list
*acl
= NULL
;
1768 /* We continue hearing vty socket. */
1769 vty_event_serv(VTY_SERV
, vtyserv
);
1771 memset(&su
, 0, sizeof(union sockunion
));
1773 /* We can handle IPv4 or IPv6 socket. */
1774 vty_sock
= sockunion_accept(accept_sock
, &su
);
1776 flog_err(EC_LIB_SOCKET
, "can't accept vty socket : %s",
1777 safe_strerror(errno
));
1780 set_nonblocking(vty_sock
);
1781 set_cloexec(vty_sock
);
1783 if (!sockunion2hostprefix(&su
, &p
)) {
1785 zlog_info("Vty unable to convert prefix from sockunion %pSU",
1790 /* VTY's accesslist apply. */
1791 if (p
.family
== AF_INET
&& vty_accesslist_name
) {
1792 if ((acl
= access_list_lookup(AFI_IP
, vty_accesslist_name
))
1793 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1794 zlog_info("Vty connection refused from %pSU", &su
);
1800 /* VTY's ipv6 accesslist apply. */
1801 if (p
.family
== AF_INET6
&& vty_ipv6_accesslist_name
) {
1802 if ((acl
= access_list_lookup(AFI_IP6
,
1803 vty_ipv6_accesslist_name
))
1804 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1805 zlog_info("Vty connection refused from %pSU", &su
);
1812 ret
= setsockopt(vty_sock
, IPPROTO_TCP
, TCP_NODELAY
, (char *)&on
,
1815 zlog_info("can't set sockopt to vty_sock : %s",
1816 safe_strerror(errno
));
1818 zlog_info("Vty connection from %pSU", &su
);
1820 vty_create(vty_sock
, &su
);
1823 static void vty_serv_sock_addrinfo(const char *hostname
, unsigned short port
)
1826 struct addrinfo req
;
1827 struct addrinfo
*ainfo
;
1828 struct addrinfo
*ainfo_save
;
1830 char port_str
[BUFSIZ
];
1832 memset(&req
, 0, sizeof(req
));
1833 req
.ai_flags
= AI_PASSIVE
;
1834 req
.ai_family
= AF_UNSPEC
;
1835 req
.ai_socktype
= SOCK_STREAM
;
1836 snprintf(port_str
, sizeof(port_str
), "%d", port
);
1837 port_str
[sizeof(port_str
) - 1] = '\0';
1839 ret
= getaddrinfo(hostname
, port_str
, &req
, &ainfo
);
1842 flog_err_sys(EC_LIB_SYSTEM_CALL
, "getaddrinfo failed: %s",
1850 struct vty_serv
*vtyserv
;
1852 if (ainfo
->ai_family
!= AF_INET
&& ainfo
->ai_family
!= AF_INET6
)
1855 sock
= socket(ainfo
->ai_family
, ainfo
->ai_socktype
,
1856 ainfo
->ai_protocol
);
1860 sockopt_v6only(ainfo
->ai_family
, sock
);
1861 sockopt_reuseaddr(sock
);
1862 sockopt_reuseport(sock
);
1865 ret
= bind(sock
, ainfo
->ai_addr
, ainfo
->ai_addrlen
);
1867 close(sock
); /* Avoid sd leak. */
1871 ret
= listen(sock
, 3);
1873 close(sock
); /* Avoid sd leak. */
1877 vtyserv
= XCALLOC(MTYPE_VTY_SERV
, sizeof(*vtyserv
));
1878 vtyserv
->sock
= sock
;
1879 vtyservs_add_tail(vty_servs
, vtyserv
);
1881 vty_event_serv(VTY_SERV
, vtyserv
);
1882 } while ((ainfo
= ainfo
->ai_next
) != NULL
);
1884 freeaddrinfo(ainfo_save
);
1888 /* For sockaddr_un. */
1891 /* VTY shell UNIX domain socket. */
1892 static void vty_serv_un(const char *path
)
1894 struct vty_serv
*vtyserv
;
1897 struct sockaddr_un serv
;
1899 struct zprivs_ids_t ids
;
1901 /* First of all, unlink existing socket */
1905 old_mask
= umask(0007);
1907 /* Make UNIX domain socket. */
1908 sock
= socket(AF_UNIX
, SOCK_STREAM
, 0);
1910 flog_err_sys(EC_LIB_SOCKET
,
1911 "Cannot create unix stream socket: %s",
1912 safe_strerror(errno
));
1916 /* Make server socket. */
1917 memset(&serv
, 0, sizeof(serv
));
1918 serv
.sun_family
= AF_UNIX
;
1919 strlcpy(serv
.sun_path
, path
, sizeof(serv
.sun_path
));
1920 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
1921 len
= serv
.sun_len
= SUN_LEN(&serv
);
1923 len
= sizeof(serv
.sun_family
) + strlen(serv
.sun_path
);
1924 #endif /* HAVE_STRUCT_SOCKADDR_UN_SUN_LEN */
1928 ret
= bind(sock
, (struct sockaddr
*)&serv
, len
);
1930 flog_err_sys(EC_LIB_SOCKET
, "Cannot bind path %s: %s", path
,
1931 safe_strerror(errno
));
1932 close(sock
); /* Avoid sd leak. */
1936 ret
= listen(sock
, 5);
1938 flog_err_sys(EC_LIB_SOCKET
, "listen(fd %d) failed: %s", sock
,
1939 safe_strerror(errno
));
1940 close(sock
); /* Avoid sd leak. */
1946 zprivs_get_ids(&ids
);
1948 /* Hack: ids.gid_vty is actually a uint, but we stored -1 in it
1949 earlier for the case when we don't need to chown the file
1950 type casting it here to make a compare */
1951 if ((int)ids
.gid_vty
> 0) {
1952 /* set group of socket */
1953 if (chown(path
, -1, ids
.gid_vty
)) {
1954 flog_err_sys(EC_LIB_SYSTEM_CALL
,
1955 "vty_serv_un: could chown socket, %s",
1956 safe_strerror(errno
));
1960 vtyserv
= XCALLOC(MTYPE_VTY_SERV
, sizeof(*vtyserv
));
1961 vtyserv
->sock
= sock
;
1962 vtyserv
->vtysh
= true;
1963 vtyservs_add_tail(vty_servs
, vtyserv
);
1965 vty_event_serv(VTYSH_SERV
, vtyserv
);
1968 /* #define VTYSH_DEBUG 1 */
1970 static void vtysh_accept(struct thread
*thread
)
1972 struct vty_serv
*vtyserv
= THREAD_ARG(thread
);
1973 int accept_sock
= vtyserv
->sock
;
1976 struct sockaddr_un client
;
1979 vty_event_serv(VTYSH_SERV
, vtyserv
);
1981 memset(&client
, 0, sizeof(client
));
1982 client_len
= sizeof(struct sockaddr_un
);
1984 sock
= accept(accept_sock
, (struct sockaddr
*)&client
,
1985 (socklen_t
*)&client_len
);
1988 flog_err(EC_LIB_SOCKET
, "can't accept vty socket : %s",
1989 safe_strerror(errno
));
1993 if (set_nonblocking(sock
) < 0) {
1996 "vtysh_accept: could not set vty socket %d to non-blocking, %s, closing",
1997 sock
, safe_strerror(errno
));
2004 printf("VTY shell accept\n");
2005 #endif /* VTYSH_DEBUG */
2010 vty
->type
= VTY_SHELL_SERV
;
2011 vty
->node
= VIEW_NODE
;
2012 vtys_add_tail(vtysh_sessions
, vty
);
2014 vty_event(VTYSH_READ
, vty
);
2017 static int vtysh_do_pass_fd(struct vty
*vty
)
2019 struct iovec iov
[1] = {
2021 .iov_base
= vty
->pass_fd_status
,
2022 .iov_len
= sizeof(vty
->pass_fd_status
),
2026 uint8_t buf
[CMSG_SPACE(sizeof(int))];
2027 struct cmsghdr align
;
2029 struct msghdr mh
= {
2031 .msg_iovlen
= array_size(iov
),
2032 .msg_control
= u
.buf
,
2033 .msg_controllen
= sizeof(u
.buf
),
2035 struct cmsghdr
*cmh
= CMSG_FIRSTHDR(&mh
);
2038 memset(&u
.buf
, 0, sizeof(u
.buf
));
2039 cmh
->cmsg_level
= SOL_SOCKET
;
2040 cmh
->cmsg_type
= SCM_RIGHTS
;
2041 cmh
->cmsg_len
= CMSG_LEN(sizeof(int));
2042 memcpy(CMSG_DATA(cmh
), &vty
->pass_fd
, sizeof(int));
2044 ret
= sendmsg(vty
->wfd
, &mh
, 0);
2045 if (ret
< 0 && ERRNO_IO_RETRY(errno
))
2046 return BUFFER_PENDING
;
2048 close(vty
->pass_fd
);
2050 vty
->status
= VTY_NORMAL
;
2053 return BUFFER_ERROR
;
2055 /* resume accepting commands (suspended in vtysh_read) */
2056 vty_event(VTYSH_READ
, vty
);
2058 if ((size_t)ret
< sizeof(vty
->pass_fd_status
)) {
2059 size_t remains
= sizeof(vty
->pass_fd_status
) - ret
;
2061 buffer_put(vty
->obuf
, vty
->pass_fd_status
+ ret
, remains
);
2062 return BUFFER_PENDING
;
2064 return BUFFER_EMPTY
;
2067 static int vtysh_flush(struct vty
*vty
)
2071 ret
= buffer_flush_available(vty
->obuf
, vty
->wfd
);
2072 if (ret
== BUFFER_EMPTY
&& vty
->status
== VTY_PASSFD
)
2073 ret
= vtysh_do_pass_fd(vty
);
2076 case BUFFER_PENDING
:
2077 vty_event(VTYSH_WRITE
, vty
);
2080 flog_err(EC_LIB_SOCKET
, "%s: write error to fd %d, closing",
2082 buffer_reset(vty
->lbuf
);
2083 buffer_reset(vty
->obuf
);
2092 void vty_pass_fd(struct vty
*vty
, int fd
)
2094 if (vty
->pass_fd
!= -1)
2095 close(vty
->pass_fd
);
2100 static void vtysh_read(struct thread
*thread
)
2106 unsigned char buf
[VTY_READ_BUFSIZ
];
2108 uint8_t header
[4] = {0, 0, 0, 0};
2110 sock
= THREAD_FD(thread
);
2111 vty
= THREAD_ARG(thread
);
2113 if ((nbytes
= read(sock
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
2115 if (ERRNO_IO_RETRY(errno
)) {
2116 vty_event(VTYSH_READ
, vty
);
2121 "%s: read failed on vtysh client fd %d, closing: %s",
2122 __func__
, sock
, safe_strerror(errno
));
2124 buffer_reset(vty
->lbuf
);
2125 buffer_reset(vty
->obuf
);
2128 printf("close vtysh\n");
2129 #endif /* VTYSH_DEBUG */
2134 printf("line: %.*s\n", nbytes
, buf
);
2135 #endif /* VTYSH_DEBUG */
2137 if (vty
->length
+ nbytes
>= VTY_BUFSIZ
) {
2138 /* Clear command line buffer. */
2139 vty
->cp
= vty
->length
= 0;
2141 vty_out(vty
, "%% Command is too long.\n");
2143 for (p
= buf
; p
< buf
+ nbytes
; p
++) {
2144 vty
->buf
[vty
->length
++] = *p
;
2146 /* Pass this line to parser. */
2147 ret
= vty_execute(vty
);
2148 /* Note that vty_execute clears the command buffer and resets
2149 vty->length to 0. */
2151 /* Return result. */
2153 printf("result: %d\n", ret
);
2154 printf("vtysh node: %d\n", vty
->node
);
2155 #endif /* VTYSH_DEBUG */
2157 if (vty
->pass_fd
!= -1) {
2158 memset(vty
->pass_fd_status
, 0, 4);
2159 vty
->pass_fd_status
[3] = ret
;
2160 vty
->status
= VTY_PASSFD
;
2163 vty_event(VTYSH_WRITE
, vty
);
2165 /* this introduces a "sequence point"
2166 * command output is written normally,
2167 * read processing is suspended until
2169 * then retcode + FD is written
2170 * then normal processing resumes
2172 * => skip vty_event(VTYSH_READ, vty)!
2177 /* hack for asynchronous "write integrated"
2178 * - other commands in "buf" will be ditched
2179 * - input during pending config-write is
2181 if (ret
== CMD_SUSPEND
)
2184 /* warning: watchfrr hardcodes this result write
2187 buffer_put(vty
->obuf
, header
, 4);
2189 if (!vty
->t_write
&& (vtysh_flush(vty
) < 0))
2190 /* Try to flush results; exit if a write
2197 if (vty
->status
== VTY_CLOSE
)
2200 vty_event(VTYSH_READ
, vty
);
2203 static void vtysh_write(struct thread
*thread
)
2205 struct vty
*vty
= THREAD_ARG(thread
);
2212 /* Determine address family to bind. */
2213 void vty_serv_sock(const char *addr
, unsigned short port
, const char *path
)
2215 /* If port is set to 0, do not listen on TCP/IP at all! */
2217 vty_serv_sock_addrinfo(addr
, port
);
2224 static void vty_error_delete(void *arg
)
2226 struct vty_error
*ve
= arg
;
2228 XFREE(MTYPE_TMP
, ve
);
2231 /* Close vty interface. Warning: call this only from functions that
2232 will be careful not to access the vty afterwards (since it has
2233 now been freed). This is safest from top-level functions (called
2234 directly by the thread dispatcher). */
2235 void vty_close(struct vty
*vty
)
2238 bool was_stdio
= false;
2240 /* Drop out of configure / transaction if needed. */
2241 vty_config_exit(vty
);
2243 /* Cancel threads.*/
2244 THREAD_OFF(vty
->t_read
);
2245 THREAD_OFF(vty
->t_write
);
2246 THREAD_OFF(vty
->t_timeout
);
2248 if (vty
->pass_fd
!= -1) {
2249 close(vty
->pass_fd
);
2252 zlog_live_close(&vty
->live_log
);
2255 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2257 /* Free input buffer. */
2258 buffer_free(vty
->obuf
);
2259 buffer_free(vty
->lbuf
);
2261 /* Free command history. */
2262 for (i
= 0; i
< VTY_MAXHIST
; i
++) {
2263 XFREE(MTYPE_VTY_HIST
, vty
->hist
[i
]);
2267 if (vty
->fd
!= -1) {
2268 if (vty
->type
== VTY_SHELL_SERV
)
2269 vtys_del(vtysh_sessions
, vty
);
2271 vtys_del(vty_sessions
, vty
);
2274 if (vty
->wfd
> 0 && vty
->type
== VTY_FILE
)
2278 * note check is for fd > STDERR_FILENO, not fd != -1.
2279 * We never close stdin/stdout/stderr here, because we may be
2280 * running in foreground mode with logging to stdout. Also,
2281 * additionally, we'd need to replace these fds with /dev/null. */
2282 if (vty
->wfd
> STDERR_FILENO
&& vty
->wfd
!= vty
->fd
)
2284 if (vty
->fd
> STDERR_FILENO
)
2286 if (vty
->fd
== STDIN_FILENO
)
2289 XFREE(MTYPE_VTY
, vty
->buf
);
2292 vty
->error
->del
= vty_error_delete
;
2293 list_delete(&vty
->error
);
2297 XFREE(MTYPE_VTY
, vty
);
2303 /* When time out occur output message then close connection. */
2304 static void vty_timeout(struct thread
*thread
)
2308 vty
= THREAD_ARG(thread
);
2312 buffer_reset(vty
->lbuf
);
2313 buffer_reset(vty
->obuf
);
2314 vty_out(vty
, "\nVty connection is timed out.\n");
2316 /* Close connection. */
2317 vty
->status
= VTY_CLOSE
;
2321 /* Read up configuration file from file_name. */
2322 static void vty_read_file(struct nb_config
*config
, FILE *confp
)
2326 struct vty_error
*ve
;
2327 struct listnode
*node
;
2328 unsigned int line_num
= 0;
2331 /* vty_close won't close stderr; if some config command prints
2332 * something it'll end up there. (not ideal; it'd be better if output
2333 * from a file-load went to logging instead. Also note that if this
2334 * function is called after daemonizing, stderr will be /dev/null.)
2336 * vty->fd will be -1 from vty_new()
2338 vty
->wfd
= STDERR_FILENO
;
2339 vty
->type
= VTY_FILE
;
2340 vty
->node
= CONFIG_NODE
;
2343 vty
->candidate_config
= config
;
2345 vty
->private_config
= true;
2346 vty
->candidate_config
= nb_config_new(NULL
);
2349 /* Execute configuration file */
2350 ret
= config_from_file(vty
, confp
, &line_num
);
2352 /* Flush any previous errors before printing messages below */
2353 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2355 if (!((ret
== CMD_SUCCESS
) || (ret
== CMD_ERR_NOTHING_TODO
))) {
2356 const char *message
= NULL
;
2360 case CMD_ERR_AMBIGUOUS
:
2361 message
= "Ambiguous command";
2363 case CMD_ERR_NO_MATCH
:
2364 message
= "No such command";
2367 message
= "Command returned Warning";
2369 case CMD_WARNING_CONFIG_FAILED
:
2370 message
= "Command returned Warning Config Failed";
2372 case CMD_ERR_INCOMPLETE
:
2373 message
= "Command returned Incomplete";
2375 case CMD_ERR_EXEED_ARGC_MAX
:
2377 "Command exceeded maximum number of Arguments";
2380 message
= "Command returned unhandled error message";
2384 for (ALL_LIST_ELEMENTS_RO(vty
->error
, node
, ve
)) {
2385 nl
= strchr(ve
->error_buf
, '\n');
2388 flog_err(EC_LIB_VTY
, "%s on config line %u: %s",
2389 message
, ve
->line_num
, ve
->error_buf
);
2394 * Automatically commit the candidate configuration after
2395 * reading the configuration file.
2397 if (config
== NULL
) {
2398 struct nb_context context
= {};
2399 char errmsg
[BUFSIZ
] = {0};
2401 context
.client
= NB_CLIENT_CLI
;
2403 ret
= nb_candidate_commit(&context
, vty
->candidate_config
, true,
2404 "Read configuration file", NULL
,
2405 errmsg
, sizeof(errmsg
));
2406 if (ret
!= NB_OK
&& ret
!= NB_ERR_NO_CHANGES
)
2408 "%s: failed to read configuration file: %s (%s)",
2409 __func__
, nb_err_name(ret
), errmsg
);
2415 static FILE *vty_use_backup_config(const char *fullpath
)
2417 char *fullpath_sav
, *fullpath_tmp
;
2423 size_t fullpath_sav_sz
= strlen(fullpath
) + strlen(CONF_BACKUP_EXT
) + 1;
2424 fullpath_sav
= malloc(fullpath_sav_sz
);
2425 strlcpy(fullpath_sav
, fullpath
, fullpath_sav_sz
);
2426 strlcat(fullpath_sav
, CONF_BACKUP_EXT
, fullpath_sav_sz
);
2428 sav
= open(fullpath_sav
, O_RDONLY
);
2434 fullpath_tmp
= malloc(strlen(fullpath
) + 8);
2435 snprintf(fullpath_tmp
, strlen(fullpath
) + 8, "%s.XXXXXX", fullpath
);
2437 /* Open file to configuration write. */
2438 tmp
= mkstemp(fullpath_tmp
);
2442 if (fchmod(tmp
, CONFIGFILE_MASK
) != 0)
2445 while ((c
= read(sav
, buffer
, 512)) > 0) {
2446 if (write(tmp
, buffer
, c
) <= 0)
2452 if (rename(fullpath_tmp
, fullpath
) == 0)
2453 ret
= fopen(fullpath
, "r");
2455 unlink(fullpath_tmp
);
2460 unlink(fullpath_tmp
);
2470 /* Read up configuration file from file_name. */
2471 bool vty_read_config(struct nb_config
*config
, const char *config_file
,
2472 char *config_default_dir
)
2474 char cwd
[MAXPATHLEN
];
2476 const char *fullpath
;
2478 bool read_success
= false;
2480 /* If -f flag specified. */
2481 if (config_file
!= NULL
) {
2482 if (!IS_DIRECTORY_SEP(config_file
[0])) {
2483 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
2486 "%s: failure to determine Current Working Directory %d!",
2488 goto tmp_free_and_out
;
2490 size_t tmp_len
= strlen(cwd
) + strlen(config_file
) + 2;
2491 tmp
= XMALLOC(MTYPE_TMP
, tmp_len
);
2492 snprintf(tmp
, tmp_len
, "%s/%s", cwd
, config_file
);
2495 fullpath
= config_file
;
2497 confp
= fopen(fullpath
, "r");
2499 if (confp
== NULL
) {
2501 EC_LIB_BACKUP_CONFIG
,
2502 "%s: failed to open configuration file %s: %s, checking backup",
2503 __func__
, fullpath
, safe_strerror(errno
));
2505 confp
= vty_use_backup_config(fullpath
);
2507 flog_warn(EC_LIB_BACKUP_CONFIG
,
2508 "using backup configuration file!");
2512 "%s: can't open configuration file [%s]",
2513 __func__
, config_file
);
2514 goto tmp_free_and_out
;
2519 host_config_set(config_default_dir
);
2523 struct stat conf_stat
;
2525 /* !!!!PLEASE LEAVE!!!!
2526 * This is NEEDED for use with vtysh -b, or else you can get
2527 * a real configuration food fight with a lot garbage in the
2528 * merged configuration file it creates coming from the per
2529 * daemon configuration files. This also allows the daemons
2530 * to start if there default configuration file is not
2531 * present or ignore them, as needed when using vtysh -b to
2532 * configure the daemons at boot - MAG
2535 /* Stat for vtysh Zebra.conf, if found startup and wait for
2536 * boot configuration
2539 if (strstr(config_default_dir
, "vtysh") == NULL
) {
2540 ret
= stat(integrate_default
, &conf_stat
);
2542 read_success
= true;
2543 goto tmp_free_and_out
;
2547 confp
= fopen(config_default_dir
, "r");
2548 if (confp
== NULL
) {
2551 "%s: failed to open configuration file %s: %s, checking backup",
2552 __func__
, config_default_dir
,
2553 safe_strerror(errno
));
2555 confp
= vty_use_backup_config(config_default_dir
);
2557 flog_warn(EC_LIB_BACKUP_CONFIG
,
2558 "using backup configuration file!");
2559 fullpath
= config_default_dir
;
2561 flog_err(EC_LIB_VTY
,
2562 "can't open configuration file [%s]",
2563 config_default_dir
);
2564 goto tmp_free_and_out
;
2567 fullpath
= config_default_dir
;
2570 vty_read_file(config
, confp
);
2571 read_success
= true;
2575 host_config_set(fullpath
);
2578 XFREE(MTYPE_TMP
, tmp
);
2580 return read_success
;
2583 static void update_xpath(struct vty
*vty
, const char *oldpath
,
2584 const char *newpath
)
2588 for (i
= 0; i
< vty
->xpath_index
; i
++) {
2589 if (!frrstr_startswith(vty
->xpath
[i
], oldpath
))
2592 char *tmp
= frrstr_replace(vty
->xpath
[i
], oldpath
, newpath
);
2593 strlcpy(vty
->xpath
[i
], tmp
, sizeof(vty
->xpath
[0]));
2594 XFREE(MTYPE_TMP
, tmp
);
2598 void vty_update_xpath(const char *oldpath
, const char *newpath
)
2602 frr_each (vtys
, vtysh_sessions
, vty
)
2603 update_xpath(vty
, oldpath
, newpath
);
2604 frr_each (vtys
, vty_sessions
, vty
)
2605 update_xpath(vty
, oldpath
, newpath
);
2608 int vty_config_enter(struct vty
*vty
, bool private_config
, bool exclusive
)
2610 if (exclusive
&& nb_running_lock(NB_CLIENT_CLI
, vty
)) {
2611 vty_out(vty
, "%% Configuration is locked by other client\n");
2615 vty
->node
= CONFIG_NODE
;
2617 vty
->private_config
= private_config
;
2618 vty
->xpath_index
= 0;
2620 if (private_config
) {
2621 vty
->candidate_config
= nb_config_dup(running_config
);
2622 vty
->candidate_config_base
= nb_config_dup(running_config
);
2624 "Warning: uncommitted changes will be discarded on exit.\n\n");
2626 vty
->candidate_config
= vty_shared_candidate_config
;
2627 if (frr_get_cli_mode() == FRR_CLI_TRANSACTIONAL
)
2628 vty
->candidate_config_base
=
2629 nb_config_dup(running_config
);
2635 void vty_config_exit(struct vty
*vty
)
2637 enum node_type node
= vty
->node
;
2638 struct cmd_node
*cnode
;
2640 /* unlock and jump up to ENABLE_NODE if -and only if- we're
2641 * somewhere below CONFIG_NODE */
2642 while (node
&& node
!= CONFIG_NODE
) {
2643 cnode
= vector_lookup(cmdvec
, node
);
2644 node
= cnode
->parent_node
;
2646 if (node
!= CONFIG_NODE
)
2647 /* called outside config, e.g. vty_close() in ENABLE_NODE */
2650 while (vty
->node
!= ENABLE_NODE
)
2651 /* will call vty_config_node_exit() below */
2655 int vty_config_node_exit(struct vty
*vty
)
2657 vty
->xpath_index
= 0;
2659 /* Perform any pending commits. */
2660 (void)nb_cli_pending_commit_check(vty
);
2662 /* Check if there's a pending confirmed commit. */
2663 if (vty
->t_confirmed_commit_timeout
) {
2665 "exiting with a pending confirmed commit. Rolling back to previous configuration.\n\n");
2666 nb_cli_confirmed_commit_rollback(vty
);
2667 nb_cli_confirmed_commit_clean(vty
);
2670 (void)nb_running_unlock(NB_CLIENT_CLI
, vty
);
2672 if (vty
->candidate_config
) {
2673 if (vty
->private_config
)
2674 nb_config_free(vty
->candidate_config
);
2675 vty
->candidate_config
= NULL
;
2677 if (vty
->candidate_config_base
) {
2678 nb_config_free(vty
->candidate_config_base
);
2679 vty
->candidate_config_base
= NULL
;
2682 vty
->config
= false;
2686 /* Master of the threads. */
2687 static struct thread_master
*vty_master
;
2689 static void vty_event_serv(enum vty_event event
, struct vty_serv
*vty_serv
)
2693 thread_add_read(vty_master
, vty_accept
, vty_serv
,
2694 vty_serv
->sock
, &vty_serv
->t_accept
);
2698 thread_add_read(vty_master
, vtysh_accept
, vty_serv
,
2699 vty_serv
->sock
, &vty_serv
->t_accept
);
2703 assert(!"vty_event_serv() called incorrectly");
2707 static void vty_event(enum vty_event event
, struct vty
*vty
)
2712 thread_add_read(vty_master
, vtysh_read
, vty
, vty
->fd
,
2716 thread_add_write(vty_master
, vtysh_write
, vty
, vty
->wfd
,
2721 thread_add_read(vty_master
, vty_read
, vty
, vty
->fd
,
2724 /* Time out treatment. */
2725 if (vty
->v_timeout
) {
2726 THREAD_OFF(vty
->t_timeout
);
2727 thread_add_timer(vty_master
, vty_timeout
, vty
,
2728 vty
->v_timeout
, &vty
->t_timeout
);
2732 thread_add_write(vty_master
, vty_flush
, vty
, vty
->wfd
,
2735 case VTY_TIMEOUT_RESET
:
2736 THREAD_OFF(vty
->t_timeout
);
2738 thread_add_timer(vty_master
, vty_timeout
, vty
,
2739 vty
->v_timeout
, &vty
->t_timeout
);
2742 assert(!"vty_event() called incorrectly");
2746 DEFUN_NOSH (config_who
,
2749 "Display who is on vty\n")
2753 frr_each (vtys
, vty_sessions
, v
)
2754 vty_out(vty
, "%svty[%d] connected from %s%s.\n",
2755 v
->config
? "*" : " ", v
->fd
, v
->address
,
2756 zlog_live_is_null(&v
->live_log
) ? "" : ", live log");
2760 /* Move to vty configuration mode. */
2761 DEFUN_NOSH (line_vty
,
2764 "Configure a terminal line\n"
2765 "Virtual terminal\n")
2767 vty
->node
= VTY_NODE
;
2771 /* Set time out value. */
2772 static int exec_timeout(struct vty
*vty
, const char *min_str
,
2773 const char *sec_str
)
2775 unsigned long timeout
= 0;
2777 /* min_str and sec_str are already checked by parser. So it must be
2778 all digit string. */
2780 timeout
= strtol(min_str
, NULL
, 10);
2784 timeout
+= strtol(sec_str
, NULL
, 10);
2786 vty_timeout_val
= timeout
;
2787 vty
->v_timeout
= timeout
;
2788 vty_event(VTY_TIMEOUT_RESET
, vty
);
2794 DEFUN (exec_timeout_min
,
2795 exec_timeout_min_cmd
,
2796 "exec-timeout (0-35791)",
2797 "Set timeout value\n"
2798 "Timeout value in minutes\n")
2801 return exec_timeout(vty
, argv
[idx_number
]->arg
, NULL
);
2804 DEFUN (exec_timeout_sec
,
2805 exec_timeout_sec_cmd
,
2806 "exec-timeout (0-35791) (0-2147483)",
2807 "Set the EXEC timeout\n"
2808 "Timeout in minutes\n"
2809 "Timeout in seconds\n")
2812 int idx_number_2
= 2;
2813 return exec_timeout(vty
, argv
[idx_number
]->arg
,
2814 argv
[idx_number_2
]->arg
);
2817 DEFUN (no_exec_timeout
,
2818 no_exec_timeout_cmd
,
2821 "Set the EXEC timeout\n")
2823 return exec_timeout(vty
, NULL
, NULL
);
2826 /* Set vty access class. */
2827 DEFUN (vty_access_class
,
2828 vty_access_class_cmd
,
2829 "access-class WORD",
2830 "Filter connections based on an IP access list\n"
2834 if (vty_accesslist_name
)
2835 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2837 vty_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2842 /* Clear vty access class. */
2843 DEFUN (no_vty_access_class
,
2844 no_vty_access_class_cmd
,
2845 "no access-class [WORD]",
2847 "Filter connections based on an IP access list\n"
2851 const char *accesslist
= (argc
== 3) ? argv
[idx_word
]->arg
: NULL
;
2852 if (!vty_accesslist_name
2853 || (argc
== 3 && strcmp(vty_accesslist_name
, accesslist
))) {
2854 vty_out(vty
, "Access-class is not currently applied to vty\n");
2855 return CMD_WARNING_CONFIG_FAILED
;
2858 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2860 vty_accesslist_name
= NULL
;
2865 /* Set vty access class. */
2866 DEFUN (vty_ipv6_access_class
,
2867 vty_ipv6_access_class_cmd
,
2868 "ipv6 access-class WORD",
2870 "Filter connections based on an IP access list\n"
2871 "IPv6 access list\n")
2874 if (vty_ipv6_accesslist_name
)
2875 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2877 vty_ipv6_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2882 /* Clear vty access class. */
2883 DEFUN (no_vty_ipv6_access_class
,
2884 no_vty_ipv6_access_class_cmd
,
2885 "no ipv6 access-class [WORD]",
2888 "Filter connections based on an IP access list\n"
2889 "IPv6 access list\n")
2892 const char *accesslist
= (argc
== 4) ? argv
[idx_word
]->arg
: NULL
;
2894 if (!vty_ipv6_accesslist_name
2895 || (argc
== 4 && strcmp(vty_ipv6_accesslist_name
, accesslist
))) {
2897 "IPv6 access-class is not currently applied to vty\n");
2898 return CMD_WARNING_CONFIG_FAILED
;
2901 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2903 vty_ipv6_accesslist_name
= NULL
;
2912 "Enable password checking\n")
2914 no_password_check
= 0;
2918 DEFUN (no_vty_login
,
2922 "Enable password checking\n")
2924 no_password_check
= 1;
2928 DEFUN (service_advanced_vty
,
2929 service_advanced_vty_cmd
,
2930 "service advanced-vty",
2931 "Set up miscellaneous service\n"
2932 "Enable advanced mode vty interface\n")
2938 DEFUN (no_service_advanced_vty
,
2939 no_service_advanced_vty_cmd
,
2940 "no service advanced-vty",
2942 "Set up miscellaneous service\n"
2943 "Enable advanced mode vty interface\n")
2949 DEFUN_NOSH(terminal_monitor
,
2950 terminal_monitor_cmd
,
2951 "terminal monitor [detach]",
2952 "Set terminal line parameters\n"
2953 "Copy debug output to the current terminal line\n"
2954 "Keep logging feed open independent of VTY session\n")
2958 if (vty
->type
!= VTY_SHELL_SERV
) {
2959 vty_out(vty
, "%% not supported\n");
2964 struct zlog_live_cfg detach_log
= {};
2966 zlog_live_open(&detach_log
, LOG_DEBUG
, &fd_ret
);
2967 zlog_live_disown(&detach_log
);
2969 zlog_live_open(&vty
->live_log
, LOG_DEBUG
, &fd_ret
);
2972 vty_out(vty
, "%% error opening live log: %m\n");
2976 vty_pass_fd(vty
, fd_ret
);
2980 DEFUN_NOSH(no_terminal_monitor
,
2981 no_terminal_monitor_cmd
,
2982 "no terminal monitor",
2984 "Set terminal line parameters\n"
2985 "Copy debug output to the current terminal line\n")
2987 zlog_live_close(&vty
->live_log
);
2991 DEFUN_NOSH(terminal_no_monitor
,
2992 terminal_no_monitor_cmd
,
2993 "terminal no monitor",
2994 "Set terminal line parameters\n"
2996 "Copy debug output to the current terminal line\n")
2998 return no_terminal_monitor(self
, vty
, argc
, argv
);
3002 DEFUN_NOSH (show_history
,
3006 "Display the session command history\n")
3010 for (index
= vty
->hindex
+ 1; index
!= vty
->hindex
;) {
3011 if (index
== VTY_MAXHIST
) {
3016 if (vty
->hist
[index
] != NULL
)
3017 vty_out(vty
, " %s\n", vty
->hist
[index
]);
3026 DEFPY (log_commands
,
3028 "[no] log commands",
3031 "Log all commands\n")
3034 if (do_log_commands_perm
) {
3036 "Daemon started with permanent logging turned on for commands, ignoring\n");
3040 do_log_commands
= false;
3042 do_log_commands
= true;
3047 /* Display current configuration. */
3048 static int vty_config_write(struct vty
*vty
)
3050 vty_frame(vty
, "line vty\n");
3052 if (vty_accesslist_name
)
3053 vty_out(vty
, " access-class %s\n", vty_accesslist_name
);
3055 if (vty_ipv6_accesslist_name
)
3056 vty_out(vty
, " ipv6 access-class %s\n",
3057 vty_ipv6_accesslist_name
);
3060 if (vty_timeout_val
!= VTY_TIMEOUT_DEFAULT
)
3061 vty_out(vty
, " exec-timeout %ld %ld\n", vty_timeout_val
/ 60,
3062 vty_timeout_val
% 60);
3065 if (no_password_check
)
3066 vty_out(vty
, " no login\n");
3068 vty_endframe(vty
, "exit\n");
3070 if (do_log_commands
)
3071 vty_out(vty
, "log commands\n");
3073 vty_out(vty
, "!\n");
3078 static int vty_config_write(struct vty
*vty
);
3079 struct cmd_node vty_node
= {
3082 .parent_node
= CONFIG_NODE
,
3083 .prompt
= "%s(config-line)# ",
3084 .config_write
= vty_config_write
,
3087 /* Reset all VTY status. */
3088 void vty_reset(void)
3092 frr_each_safe (vtys
, vty_sessions
, vty
) {
3093 buffer_reset(vty
->lbuf
);
3094 buffer_reset(vty
->obuf
);
3095 vty
->status
= VTY_CLOSE
;
3099 vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
3101 XFREE(MTYPE_VTY
, vty_accesslist_name
);
3102 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
3105 static void vty_save_cwd(void)
3109 c
= getcwd(vty_cwd
, sizeof(vty_cwd
));
3113 * At this point if these go wrong, more than likely
3114 * the whole world is coming down around us
3115 * Hence not worrying about it too much.
3117 if (chdir(SYSCONFDIR
)) {
3118 flog_err_sys(EC_LIB_SYSTEM_CALL
,
3119 "Failure to chdir to %s, errno: %d",
3123 if (getcwd(vty_cwd
, sizeof(vty_cwd
)) == NULL
) {
3124 flog_err_sys(EC_LIB_SYSTEM_CALL
,
3125 "Failure to getcwd, errno: %d", errno
);
3131 char *vty_get_cwd(void)
3136 int vty_shell(struct vty
*vty
)
3138 return vty
->type
== VTY_SHELL
? 1 : 0;
3141 int vty_shell_serv(struct vty
*vty
)
3143 return vty
->type
== VTY_SHELL_SERV
? 1 : 0;
3146 void vty_init_vtysh(void)
3148 /* currently nothing to do, but likely to have future use */
3151 /* Install vty's own commands like `who' command. */
3152 void vty_init(struct thread_master
*master_thread
, bool do_command_logging
)
3154 /* For further configuration read, preserve current directory. */
3157 vty_master
= master_thread
;
3159 atexit(vty_stdio_atexit
);
3161 /* Install bgp top node. */
3162 install_node(&vty_node
);
3164 install_element(VIEW_NODE
, &config_who_cmd
);
3165 install_element(VIEW_NODE
, &show_history_cmd
);
3166 install_element(CONFIG_NODE
, &line_vty_cmd
);
3167 install_element(CONFIG_NODE
, &service_advanced_vty_cmd
);
3168 install_element(CONFIG_NODE
, &no_service_advanced_vty_cmd
);
3169 install_element(CONFIG_NODE
, &show_history_cmd
);
3170 install_element(CONFIG_NODE
, &log_commands_cmd
);
3172 if (do_command_logging
) {
3173 do_log_commands
= true;
3174 do_log_commands_perm
= true;
3177 install_element(ENABLE_NODE
, &terminal_monitor_cmd
);
3178 install_element(ENABLE_NODE
, &terminal_no_monitor_cmd
);
3179 install_element(ENABLE_NODE
, &no_terminal_monitor_cmd
);
3181 install_default(VTY_NODE
);
3182 install_element(VTY_NODE
, &exec_timeout_min_cmd
);
3183 install_element(VTY_NODE
, &exec_timeout_sec_cmd
);
3184 install_element(VTY_NODE
, &no_exec_timeout_cmd
);
3185 install_element(VTY_NODE
, &vty_access_class_cmd
);
3186 install_element(VTY_NODE
, &no_vty_access_class_cmd
);
3187 install_element(VTY_NODE
, &vty_login_cmd
);
3188 install_element(VTY_NODE
, &no_vty_login_cmd
);
3189 install_element(VTY_NODE
, &vty_ipv6_access_class_cmd
);
3190 install_element(VTY_NODE
, &no_vty_ipv6_access_class_cmd
);
3193 void vty_terminate(void)
3196 struct vty_serv
*vtyserv
;
3198 memset(vty_cwd
, 0x00, sizeof(vty_cwd
));
3202 /* default state of vty_sessions is initialized & empty. */
3203 vtys_fini(vty_sessions
);
3204 vtys_init(vty_sessions
);
3206 /* vty_reset() doesn't close vtysh sessions */
3207 frr_each_safe (vtys
, vtysh_sessions
, vty
) {
3208 buffer_reset(vty
->lbuf
);
3209 buffer_reset(vty
->obuf
);
3210 vty
->status
= VTY_CLOSE
;
3214 vtys_fini(vtysh_sessions
);
3215 vtys_init(vtysh_sessions
);
3217 while ((vtyserv
= vtyservs_pop(vty_servs
))) {
3218 THREAD_OFF(vtyserv
->t_accept
);
3219 close(vtyserv
->sock
);
3220 XFREE(MTYPE_VTY_SERV
, vtyserv
);
3223 vtyservs_fini(vty_servs
);
3224 vtyservs_init(vty_servs
);