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"
45 #include <arpa/telnet.h>
48 DEFINE_MTYPE_STATIC(LIB
, VTY
, "VTY")
49 DEFINE_MTYPE_STATIC(LIB
, VTY_OUT_BUF
, "VTY output buffer")
50 DEFINE_MTYPE_STATIC(LIB
, VTY_HIST
, "VTY history")
65 static void vty_event(enum event
, int, struct vty
*);
67 /* Extern host structure from command.c */
68 extern struct host host
;
70 /* Vector which store each vty structure. */
73 /* Vty timeout value. */
74 static unsigned long vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
76 /* Vty access-class command */
77 static char *vty_accesslist_name
= NULL
;
79 /* Vty access-calss for IPv6. */
80 static char *vty_ipv6_accesslist_name
= NULL
;
82 /* VTY server thread. */
83 static vector Vvty_serv_thread
;
85 /* Current directory. */
89 static int vty_config
;
90 static int vty_config_is_lockless
= 0;
92 /* Login password check. */
93 static int no_password_check
= 0;
95 /* Integrated configuration file path */
96 char integrate_default
[] = SYSCONFDIR INTEGRATE_DEFAULT_CONFIG
;
98 static int do_log_commands
= 0;
100 void vty_frame(struct vty
*vty
, const char *format
, ...)
104 va_start(args
, format
);
105 vsnprintf(vty
->frame
+ vty
->frame_pos
,
106 sizeof(vty
->frame
) - vty
->frame_pos
, format
, args
);
107 vty
->frame_pos
= strlen(vty
->frame
);
111 void vty_endframe(struct vty
*vty
, const char *endtext
)
113 if (vty
->frame_pos
== 0 && endtext
)
114 vty_out(vty
, "%s", endtext
);
118 bool vty_set_include(struct vty
*vty
, const char *regexp
)
126 regfree(&vty
->include
);
132 errcode
= regcomp(&vty
->include
, regexp
,
133 REG_EXTENDED
| REG_NEWLINE
| REG_NOSUB
);
136 regerror(ret
, &vty
->include
, errbuf
, sizeof(errbuf
));
137 vty_out(vty
, "%% Regex compilation error: %s", errbuf
);
145 /* VTY standard output function. */
146 int vty_out(struct vty
*vty
, const char *format
, ...)
155 if (vty
->frame_pos
) {
157 vty_out(vty
, "%s", vty
->frame
);
160 /* Try to write to initial buffer. */
161 va_start(args
, format
);
162 len
= vsnprintf(buf
, sizeof(buf
), format
, args
);
165 /* Initial buffer is not enough. */
166 if (len
< 0 || len
>= size
) {
173 p
= XREALLOC(MTYPE_VTY_OUT_BUF
, p
, size
);
177 va_start(args
, format
);
178 len
= vsnprintf(p
, size
, format
, args
);
181 if (len
> -1 && len
< size
)
186 /* When initial buffer is enough to store all output. */
192 vector lines
= frrstr_split_vec(p
, "\n");
194 /* Place first value in the cache */
195 char *firstline
= vector_slot(lines
, 0);
196 buffer_put(vty
->lbuf
, (uint8_t *) firstline
, strlen(firstline
));
198 /* If our split returned more than one entry, time to filter */
199 if (vector_active(lines
) > 1) {
201 * returned string is MTYPE_TMP so it matches the MTYPE
202 * of everything else in the vector
204 char *bstr
= buffer_getstr(vty
->lbuf
);
205 buffer_reset(vty
->lbuf
);
206 XFREE(MTYPE_TMP
, lines
->index
[0]);
207 vector_set_index(lines
, 0, bstr
);
208 frrstr_filter_vec(lines
, &vty
->include
);
209 vector_compact(lines
);
211 * Consider the string "foo\n". If the regex is an empty string
212 * and the line ended with a newline, then the vector will look
218 * If the regex isn't empty, the vector will look like:
222 * In this case we'd like to preserve the newline, so we add
223 * the empty string [1] as in the first example.
225 if (p
[strlen(p
) - 1] == '\n' && vector_active(lines
) > 0
226 && strlen(vector_slot(lines
, vector_active(lines
) - 1)))
227 vector_set(lines
, XSTRDUP(MTYPE_TMP
, ""));
229 filtered
= frrstr_join_vec(lines
, "\n");
235 frrstr_strvec_free(lines
);
246 /* print with crlf replacement */
247 buffer_put_crlf(vty
->obuf
, (uint8_t *)filtered
,
251 fprintf(vty
->of
, "%s", filtered
);
257 /* print without crlf replacement */
258 buffer_put(vty
->obuf
, (uint8_t *)filtered
, strlen(filtered
));
264 if (vty
->filter
&& filtered
)
265 XFREE(MTYPE_TMP
, filtered
);
267 /* If p is not different with buf, it is allocated buffer. */
269 XFREE(MTYPE_VTY_OUT_BUF
, p
);
274 static int vty_log_out(struct vty
*vty
, const char *level
,
275 const char *proto_str
, const char *format
,
276 struct timestamp_control
*ctl
, va_list va
)
282 if (!ctl
->already_rendered
) {
283 ctl
->len
= quagga_timestamp(ctl
->precision
, ctl
->buf
,
285 ctl
->already_rendered
= 1;
287 if (ctl
->len
+ 1 >= sizeof(buf
))
289 memcpy(buf
, ctl
->buf
, len
= ctl
->len
);
294 ret
= snprintf(buf
+ len
, sizeof(buf
) - len
, "%s: %s: ", level
,
297 ret
= snprintf(buf
+ len
, sizeof(buf
) - len
, "%s: ", proto_str
);
298 if ((ret
< 0) || ((size_t)(len
+= ret
) >= sizeof(buf
)))
301 if (((ret
= vsnprintf(buf
+ len
, sizeof(buf
) - len
, format
, va
)) < 0)
302 || ((size_t)((len
+= ret
) + 2) > sizeof(buf
)))
308 if (write(vty
->wfd
, buf
, len
) < 0) {
309 if (ERRNO_IO_RETRY(errno
))
310 /* Kernel buffer is full, probably too much debugging
312 drop the data and ignore. */
314 /* Fatal I/O error. */
316 0; /* disable monitoring to avoid infinite recursion */
317 flog_err(EC_LIB_SOCKET
,
318 "%s: write failed to vty client fd %d, closing: %s",
319 __func__
, vty
->fd
, safe_strerror(errno
));
320 buffer_reset(vty
->obuf
);
321 buffer_reset(vty
->lbuf
);
322 /* cannot call vty_close, because a parent routine may still try
323 to access the vty struct */
324 vty
->status
= VTY_CLOSE
;
325 shutdown(vty
->fd
, SHUT_RDWR
);
331 /* Output current time to the vty. */
332 void vty_time_print(struct vty
*vty
, int cr
)
334 char buf
[QUAGGA_TIMESTAMP_LEN
];
336 if (quagga_timestamp(0, buf
, sizeof(buf
)) == 0) {
337 zlog_info("quagga_timestamp error");
341 vty_out(vty
, "%s\n", buf
);
343 vty_out(vty
, "%s ", buf
);
348 /* Say hello to vty interface. */
349 void vty_hello(struct vty
*vty
)
355 f
= fopen(host
.motdfile
, "r");
357 while (fgets(buf
, sizeof(buf
), f
)) {
359 /* work backwards to ignore trailling isspace()
361 for (s
= buf
+ strlen(buf
);
362 (s
> buf
) && isspace((int)*(s
- 1)); s
--)
365 vty_out(vty
, "%s\n", buf
);
369 vty_out(vty
, "MOTD file not found\n");
370 } else if (host
.motd
)
371 vty_out(vty
, "%s", host
.motd
);
374 /* Put out prompt and wait input from user. */
375 static void vty_prompt(struct vty
*vty
)
377 if (vty
->type
== VTY_TERM
) {
378 vty_out(vty
, cmd_prompt(vty
->node
), cmd_hostname_get());
382 /* Send WILL TELOPT_ECHO to remote server. */
383 static void vty_will_echo(struct vty
*vty
)
385 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_ECHO
, '\0'};
386 vty_out(vty
, "%s", cmd
);
389 /* Make suppress Go-Ahead telnet option. */
390 static void vty_will_suppress_go_ahead(struct vty
*vty
)
392 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_SGA
, '\0'};
393 vty_out(vty
, "%s", cmd
);
396 /* Make don't use linemode over telnet. */
397 static void vty_dont_linemode(struct vty
*vty
)
399 unsigned char cmd
[] = {IAC
, DONT
, TELOPT_LINEMODE
, '\0'};
400 vty_out(vty
, "%s", cmd
);
403 /* Use window size. */
404 static void vty_do_window_size(struct vty
*vty
)
406 unsigned char cmd
[] = {IAC
, DO
, TELOPT_NAWS
, '\0'};
407 vty_out(vty
, "%s", cmd
);
410 #if 0 /* Currently not used. */
411 /* Make don't use lflow vty interface. */
413 vty_dont_lflow_ahead (struct vty
*vty
)
415 unsigned char cmd
[] = { IAC
, DONT
, TELOPT_LFLOW
, '\0' };
416 vty_out (vty
, "%s", cmd
);
420 /* Authentication of vty */
421 static void vty_auth(struct vty
*vty
, char *buf
)
424 enum node_type next_node
= 0;
426 char *crypt(const char *, const char *);
431 passwd
= host
.password_encrypt
;
433 passwd
= host
.password
;
435 next_node
= host
.enable
? VIEW_NODE
: ENABLE_NODE
;
437 next_node
= VIEW_NODE
;
439 case AUTH_ENABLE_NODE
:
441 passwd
= host
.enable_encrypt
;
443 passwd
= host
.enable
;
444 next_node
= ENABLE_NODE
;
450 fail
= strcmp(crypt(buf
, passwd
), passwd
);
452 fail
= strcmp(buf
, passwd
);
458 vty
->node
= next_node
; /* Success ! */
461 if (vty
->fail
>= 3) {
462 if (vty
->node
== AUTH_NODE
) {
464 "%% Bad passwords, too many failures!\n");
465 vty
->status
= VTY_CLOSE
;
467 /* AUTH_ENABLE_NODE */
470 "%% Bad enable passwords, too many failures!\n");
471 vty
->status
= VTY_CLOSE
;
477 /* Command execution over the vty interface. */
478 static int vty_command(struct vty
*vty
, char *buf
)
481 const char *protocolname
;
487 * Log non empty command lines
492 /* Skip white spaces. */
493 while (isspace((int)*cp
) && *cp
!= '\0')
496 if (cp
!= NULL
&& *cp
!= '\0') {
498 char vty_str
[VTY_BUFSIZ
];
499 char prompt_str
[VTY_BUFSIZ
];
501 /* format the base vty info */
502 snprintf(vty_str
, sizeof(vty_str
), "vty[??]@%s", vty
->address
);
504 for (i
= 0; i
< vector_active(vtyvec
); i
++)
505 if (vty
== vector_slot(vtyvec
, i
)) {
506 snprintf(vty_str
, sizeof(vty_str
), "vty[%d]@%s",
511 /* format the prompt */
512 snprintf(prompt_str
, sizeof(prompt_str
), cmd_prompt(vty
->node
),
515 /* now log the command */
516 zlog_notice("%s%s", prompt_str
, buf
);
519 #ifdef CONSUMED_TIME_CHECK
523 unsigned long realtime
, cputime
;
526 #endif /* CONSUMED_TIME_CHECK */
528 ret
= cmd_execute(vty
, buf
, NULL
, 0);
530 /* Get the name of the protocol if any */
531 protocolname
= frr_protoname
;
533 #ifdef CONSUMED_TIME_CHECK
535 if ((realtime
= thread_consumed_time(&after
, &before
, &cputime
))
536 > CONSUMED_TIME_CHECK
)
537 /* Warn about CPU hog that must be fixed. */
540 "SLOW COMMAND: command took %lums (cpu time %lums): %s",
541 realtime
/ 1000, cputime
/ 1000, buf
);
543 #endif /* CONSUMED_TIME_CHECK */
545 if (ret
!= CMD_SUCCESS
)
548 if (vty
->type
== VTY_FILE
)
549 vty_out(vty
, "Warning...\n");
551 case CMD_ERR_AMBIGUOUS
:
552 vty_out(vty
, "%% Ambiguous command.\n");
554 case CMD_ERR_NO_MATCH
:
555 vty_out(vty
, "%% [%s] Unknown command: %s\n",
558 case CMD_ERR_INCOMPLETE
:
559 vty_out(vty
, "%% Command incomplete.\n");
566 static const char telnet_backward_char
= 0x08;
567 static const char telnet_space_char
= ' ';
569 /* Basic function to write buffer to vty. */
570 static void vty_write(struct vty
*vty
, const char *buf
, size_t nbytes
)
572 if ((vty
->node
== AUTH_NODE
) || (vty
->node
== AUTH_ENABLE_NODE
))
575 /* Should we do buffering here ? And make vty_flush (vty) ? */
576 buffer_put(vty
->obuf
, buf
, nbytes
);
579 /* Basic function to insert character into vty. */
580 static void vty_self_insert(struct vty
*vty
, char c
)
585 if (vty
->length
+ 1 >= VTY_BUFSIZ
)
588 length
= vty
->length
- vty
->cp
;
589 memmove(&vty
->buf
[vty
->cp
+ 1], &vty
->buf
[vty
->cp
], length
);
590 vty
->buf
[vty
->cp
] = c
;
592 vty_write(vty
, &vty
->buf
[vty
->cp
], length
+ 1);
593 for (i
= 0; i
< length
; i
++)
594 vty_write(vty
, &telnet_backward_char
, 1);
599 vty
->buf
[vty
->length
] = '\0';
602 /* Self insert character 'c' in overwrite mode. */
603 static void vty_self_insert_overwrite(struct vty
*vty
, char c
)
605 if (vty
->cp
== vty
->length
) {
606 vty_self_insert(vty
, c
);
610 vty
->buf
[vty
->cp
++] = c
;
611 vty_write(vty
, &c
, 1);
615 * Insert a string into vty->buf at the current cursor position.
617 * If the resultant string would be larger than VTY_BUFSIZ it is
620 static void vty_insert_word_overwrite(struct vty
*vty
, char *str
)
622 if (vty
->cp
== VTY_BUFSIZ
)
625 size_t nwrite
= MIN((int)strlen(str
), VTY_BUFSIZ
- vty
->cp
- 1);
626 memcpy(&vty
->buf
[vty
->cp
], str
, nwrite
);
628 vty
->length
= MAX(vty
->cp
, vty
->length
);
629 vty
->buf
[vty
->length
] = '\0';
630 vty_write(vty
, str
, nwrite
);
633 /* Forward character. */
634 static void vty_forward_char(struct vty
*vty
)
636 if (vty
->cp
< vty
->length
) {
637 vty_write(vty
, &vty
->buf
[vty
->cp
], 1);
642 /* Backward character. */
643 static void vty_backward_char(struct vty
*vty
)
647 vty_write(vty
, &telnet_backward_char
, 1);
651 /* Move to the beginning of the line. */
652 static void vty_beginning_of_line(struct vty
*vty
)
655 vty_backward_char(vty
);
658 /* Move to the end of the line. */
659 static void vty_end_of_line(struct vty
*vty
)
661 while (vty
->cp
< vty
->length
)
662 vty_forward_char(vty
);
665 static void vty_kill_line_from_beginning(struct vty
*);
666 static void vty_redraw_line(struct vty
*);
668 /* Print command line history. This function is called from
669 vty_next_line and vty_previous_line. */
670 static void vty_history_print(struct vty
*vty
)
674 vty_kill_line_from_beginning(vty
);
676 /* Get previous line from history buffer */
677 length
= strlen(vty
->hist
[vty
->hp
]);
678 memcpy(vty
->buf
, vty
->hist
[vty
->hp
], length
);
679 vty
->cp
= vty
->length
= length
;
680 vty
->buf
[vty
->length
] = '\0';
682 /* Redraw current line */
683 vty_redraw_line(vty
);
686 /* Show next command line history. */
687 static void vty_next_line(struct vty
*vty
)
691 if (vty
->hp
== vty
->hindex
)
694 /* Try is there history exist or not. */
696 if (try_index
== (VTY_MAXHIST
- 1))
701 /* If there is not history return. */
702 if (vty
->hist
[try_index
] == NULL
)
707 vty_history_print(vty
);
710 /* Show previous command line history. */
711 static void vty_previous_line(struct vty
*vty
)
717 try_index
= VTY_MAXHIST
- 1;
721 if (vty
->hist
[try_index
] == NULL
)
726 vty_history_print(vty
);
729 /* This function redraw all of the command line character. */
730 static void vty_redraw_line(struct vty
*vty
)
732 vty_write(vty
, vty
->buf
, vty
->length
);
733 vty
->cp
= vty
->length
;
737 static void vty_forward_word(struct vty
*vty
)
739 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
740 vty_forward_char(vty
);
742 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
743 vty_forward_char(vty
);
746 /* Backward word without skipping training space. */
747 static void vty_backward_pure_word(struct vty
*vty
)
749 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
750 vty_backward_char(vty
);
754 static void vty_backward_word(struct vty
*vty
)
756 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
757 vty_backward_char(vty
);
759 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
760 vty_backward_char(vty
);
763 /* When '^D' is typed at the beginning of the line we move to the down
765 static void vty_down_level(struct vty
*vty
)
773 /* When '^Z' is received from vty, move down to the enable mode. */
774 static void vty_end_config(struct vty
*vty
)
793 case BGP_VRF_POLICY_NODE
:
794 case BGP_VNC_DEFAULTS_NODE
:
795 case BGP_VNC_NVE_GROUP_NODE
:
796 case BGP_VNC_L2_GROUP_NODE
:
811 case LDP_IPV4_IFACE_NODE
:
812 case LDP_IPV6_IFACE_NODE
:
814 case LDP_PSEUDOWIRE_NODE
:
816 case OPENFABRIC_NODE
:
818 case KEYCHAIN_KEY_NODE
:
820 case BGP_EVPN_VNI_NODE
:
823 vty_config_unlock(vty
);
824 vty
->node
= ENABLE_NODE
;
827 /* Unknown node, we have to ignore it. */
835 /* Delete a charcter at the current point. */
836 static void vty_delete_char(struct vty
*vty
)
841 if (vty
->length
== 0) {
846 if (vty
->cp
== vty
->length
)
847 return; /* completion need here? */
849 size
= vty
->length
- vty
->cp
;
852 memmove(&vty
->buf
[vty
->cp
], &vty
->buf
[vty
->cp
+ 1], size
- 1);
853 vty
->buf
[vty
->length
] = '\0';
855 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
858 vty_write(vty
, &vty
->buf
[vty
->cp
], size
- 1);
859 vty_write(vty
, &telnet_space_char
, 1);
861 for (i
= 0; i
< size
; i
++)
862 vty_write(vty
, &telnet_backward_char
, 1);
865 /* Delete a character before the point. */
866 static void vty_delete_backward_char(struct vty
*vty
)
871 vty_backward_char(vty
);
872 vty_delete_char(vty
);
875 /* Kill rest of line from current point. */
876 static void vty_kill_line(struct vty
*vty
)
881 size
= vty
->length
- vty
->cp
;
886 for (i
= 0; i
< size
; i
++)
887 vty_write(vty
, &telnet_space_char
, 1);
888 for (i
= 0; i
< size
; i
++)
889 vty_write(vty
, &telnet_backward_char
, 1);
891 memset(&vty
->buf
[vty
->cp
], 0, size
);
892 vty
->length
= vty
->cp
;
895 /* Kill line from the beginning. */
896 static void vty_kill_line_from_beginning(struct vty
*vty
)
898 vty_beginning_of_line(vty
);
902 /* Delete a word before the point. */
903 static void vty_forward_kill_word(struct vty
*vty
)
905 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
906 vty_delete_char(vty
);
907 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
908 vty_delete_char(vty
);
911 /* Delete a word before the point. */
912 static void vty_backward_kill_word(struct vty
*vty
)
914 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
915 vty_delete_backward_char(vty
);
916 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
917 vty_delete_backward_char(vty
);
920 /* Transpose chars before or at the point. */
921 static void vty_transpose_chars(struct vty
*vty
)
925 /* If length is short or point is near by the beginning of line then
927 if (vty
->length
< 2 || vty
->cp
< 1)
930 /* In case of point is located at the end of the line. */
931 if (vty
->cp
== vty
->length
) {
932 c1
= vty
->buf
[vty
->cp
- 1];
933 c2
= vty
->buf
[vty
->cp
- 2];
935 vty_backward_char(vty
);
936 vty_backward_char(vty
);
937 vty_self_insert_overwrite(vty
, c1
);
938 vty_self_insert_overwrite(vty
, c2
);
940 c1
= vty
->buf
[vty
->cp
];
941 c2
= vty
->buf
[vty
->cp
- 1];
943 vty_backward_char(vty
);
944 vty_self_insert_overwrite(vty
, c1
);
945 vty_self_insert_overwrite(vty
, c2
);
949 /* Do completion at vty interface. */
950 static void vty_complete_command(struct vty
*vty
)
954 char **matched
= NULL
;
957 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
960 vline
= cmd_make_strvec(vty
->buf
);
964 /* In case of 'help \t'. */
965 if (isspace((int)vty
->buf
[vty
->length
- 1]))
966 vector_set(vline
, NULL
);
968 matched
= cmd_complete_command(vline
, vty
, &ret
);
970 cmd_free_strvec(vline
);
974 case CMD_ERR_AMBIGUOUS
:
975 vty_out(vty
, "%% Ambiguous command.\n");
977 vty_redraw_line(vty
);
979 case CMD_ERR_NO_MATCH
:
980 /* vty_out (vty, "%% There is no matched command.\n"); */
982 vty_redraw_line(vty
);
984 case CMD_COMPLETE_FULL_MATCH
:
986 /* 2016-11-28 equinox -- need to debug, SEGV here */
987 vty_out(vty
, "%% CLI BUG: FULL_MATCH with NULL str\n");
989 vty_redraw_line(vty
);
993 vty_redraw_line(vty
);
994 vty_backward_pure_word(vty
);
995 vty_insert_word_overwrite(vty
, matched
[0]);
996 vty_self_insert(vty
, ' ');
997 XFREE(MTYPE_COMPLETION
, matched
[0]);
999 case CMD_COMPLETE_MATCH
:
1001 vty_redraw_line(vty
);
1002 vty_backward_pure_word(vty
);
1003 vty_insert_word_overwrite(vty
, matched
[0]);
1004 XFREE(MTYPE_COMPLETION
, matched
[0]);
1006 case CMD_COMPLETE_LIST_MATCH
:
1007 for (i
= 0; matched
[i
] != NULL
; i
++) {
1008 if (i
!= 0 && ((i
% 6) == 0))
1010 vty_out(vty
, "%-10s ", matched
[i
]);
1011 XFREE(MTYPE_COMPLETION
, matched
[i
]);
1016 vty_redraw_line(vty
);
1018 case CMD_ERR_NOTHING_TODO
:
1020 vty_redraw_line(vty
);
1026 XFREE(MTYPE_TMP
, matched
);
1029 static void vty_describe_fold(struct vty
*vty
, int cmd_width
,
1030 unsigned int desc_width
, struct cmd_token
*token
)
1033 const char *cmd
, *p
;
1038 if (desc_width
<= 0) {
1039 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, token
->desc
);
1043 buf
= XCALLOC(MTYPE_TMP
, strlen(token
->desc
) + 1);
1045 for (p
= token
->desc
; strlen(p
) > desc_width
; p
+= pos
+ 1) {
1046 for (pos
= desc_width
; pos
> 0; pos
--)
1047 if (*(p
+ pos
) == ' ')
1053 strncpy(buf
, p
, pos
);
1055 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, buf
);
1060 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, p
);
1062 XFREE(MTYPE_TMP
, buf
);
1065 /* Describe matched command function. */
1066 static void vty_describe_command(struct vty
*vty
)
1071 unsigned int i
, width
, desc_width
;
1072 struct cmd_token
*token
, *token_cr
= NULL
;
1074 vline
= cmd_make_strvec(vty
->buf
);
1076 /* In case of '> ?'. */
1077 if (vline
== NULL
) {
1078 vline
= vector_init(1);
1079 vector_set(vline
, NULL
);
1080 } else if (isspace((int)vty
->buf
[vty
->length
- 1]))
1081 vector_set(vline
, NULL
);
1083 describe
= cmd_describe_command(vline
, vty
, &ret
);
1087 /* Ambiguous error. */
1089 case CMD_ERR_AMBIGUOUS
:
1090 vty_out(vty
, "%% Ambiguous command.\n");
1093 case CMD_ERR_NO_MATCH
:
1094 vty_out(vty
, "%% There is no matched command.\n");
1099 /* Get width of command string. */
1101 for (i
= 0; i
< vector_active(describe
); i
++)
1102 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1105 if (token
->text
[0] == '\0')
1108 len
= strlen(token
->text
);
1114 /* Get width of description string. */
1115 desc_width
= vty
->width
- (width
+ 6);
1117 /* Print out description. */
1118 for (i
= 0; i
< vector_active(describe
); i
++)
1119 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1120 if (token
->text
[0] == '\0')
1123 if (strcmp(token
->text
, CMD_CR_TEXT
) == 0) {
1129 vty_out(vty
, " %-s\n", token
->text
);
1130 else if (desc_width
>= strlen(token
->desc
))
1131 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1134 vty_describe_fold(vty
, width
, desc_width
,
1137 if (IS_VARYING_TOKEN(token
->type
)) {
1138 const char *ref
= vector_slot(
1139 vline
, vector_active(vline
) - 1);
1141 vector varcomps
= vector_init(VECTOR_MIN_SIZE
);
1142 cmd_variable_complete(token
, ref
, varcomps
);
1144 if (vector_active(varcomps
) > 0) {
1145 char *ac
= cmd_variable_comp2str(
1146 varcomps
, vty
->width
);
1147 vty_out(vty
, "%s\n", ac
);
1148 XFREE(MTYPE_TMP
, ac
);
1151 vector_free(varcomps
);
1154 vty_out (vty
, " %-*s %s\n", width
1155 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1156 desc
->str
? desc
->str
: "");
1160 if ((token
= token_cr
)) {
1162 vty_out(vty
, " %-s\n", token
->text
);
1163 else if (desc_width
>= strlen(token
->desc
))
1164 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1167 vty_describe_fold(vty
, width
, desc_width
, token
);
1171 cmd_free_strvec(vline
);
1173 vector_free(describe
);
1176 vty_redraw_line(vty
);
1179 static void vty_clear_buf(struct vty
*vty
)
1181 memset(vty
->buf
, 0, vty
->max
);
1184 /* ^C stop current input and do not add command line to the history. */
1185 static void vty_stop_input(struct vty
*vty
)
1187 vty
->cp
= vty
->length
= 0;
1191 switch (vty
->node
) {
1194 /* Nothing to do. */
1197 case INTERFACE_NODE
:
1211 case LDP_IPV4_IFACE_NODE
:
1212 case LDP_IPV6_IFACE_NODE
:
1213 case LDP_L2VPN_NODE
:
1214 case LDP_PSEUDOWIRE_NODE
:
1216 case OPENFABRIC_NODE
:
1218 case KEYCHAIN_KEY_NODE
:
1222 vty_config_unlock(vty
);
1223 vty
->node
= ENABLE_NODE
;
1226 /* Unknown node, we have to ignore it. */
1231 /* Set history pointer to the latest one. */
1232 vty
->hp
= vty
->hindex
;
1235 /* Add current command line to the history buffer. */
1236 static void vty_hist_add(struct vty
*vty
)
1240 if (vty
->length
== 0)
1243 index
= vty
->hindex
? vty
->hindex
- 1 : VTY_MAXHIST
- 1;
1245 /* Ignore the same string as previous one. */
1246 if (vty
->hist
[index
])
1247 if (strcmp(vty
->buf
, vty
->hist
[index
]) == 0) {
1248 vty
->hp
= vty
->hindex
;
1252 /* Insert history entry. */
1253 if (vty
->hist
[vty
->hindex
])
1254 XFREE(MTYPE_VTY_HIST
, vty
->hist
[vty
->hindex
]);
1255 vty
->hist
[vty
->hindex
] = XSTRDUP(MTYPE_VTY_HIST
, vty
->buf
);
1257 /* History index rotation. */
1259 if (vty
->hindex
== VTY_MAXHIST
)
1262 vty
->hp
= vty
->hindex
;
1265 /* #define TELNET_OPTION_DEBUG */
1267 /* Get telnet window size. */
1268 static int vty_telnet_option(struct vty
*vty
, unsigned char *buf
, int nbytes
)
1270 #ifdef TELNET_OPTION_DEBUG
1273 for (i
= 0; i
< nbytes
; i
++) {
1276 vty_out(vty
, "IAC ");
1279 vty_out(vty
, "WILL ");
1282 vty_out(vty
, "WONT ");
1285 vty_out(vty
, "DO ");
1288 vty_out(vty
, "DONT ");
1291 vty_out(vty
, "SB ");
1294 vty_out(vty
, "SE ");
1297 vty_out(vty
, "TELOPT_ECHO \n");
1300 vty_out(vty
, "TELOPT_SGA \n");
1303 vty_out(vty
, "TELOPT_NAWS \n");
1306 vty_out(vty
, "%x ", buf
[i
]);
1312 #endif /* TELNET_OPTION_DEBUG */
1317 vty
->iac_sb_in_progress
= 1;
1321 if (!vty
->iac_sb_in_progress
)
1324 if ((vty
->sb_len
== 0) || (vty
->sb_buf
[0] == '\0')) {
1325 vty
->iac_sb_in_progress
= 0;
1328 switch (vty
->sb_buf
[0]) {
1330 if (vty
->sb_len
!= TELNET_NAWS_SB_LEN
)
1333 "RFC 1073 violation detected: telnet NAWS option "
1334 "should send %d characters, but we received %lu",
1336 (unsigned long)vty
->sb_len
);
1337 else if (sizeof(vty
->sb_buf
) < TELNET_NAWS_SB_LEN
)
1340 "Bug detected: sizeof(vty->sb_buf) %lu < %d, too small to handle the telnet NAWS option",
1341 (unsigned long)sizeof(vty
->sb_buf
),
1342 TELNET_NAWS_SB_LEN
);
1344 vty
->width
= ((vty
->sb_buf
[1] << 8)
1346 vty
->height
= ((vty
->sb_buf
[3] << 8)
1348 #ifdef TELNET_OPTION_DEBUG
1350 "TELNET NAWS window size negotiation completed: "
1351 "width %d, height %d\n",
1352 vty
->width
, vty
->height
);
1357 vty
->iac_sb_in_progress
= 0;
1367 /* Execute current command line. */
1368 static int vty_execute(struct vty
*vty
)
1374 switch (vty
->node
) {
1376 case AUTH_ENABLE_NODE
:
1377 vty_auth(vty
, vty
->buf
);
1380 ret
= vty_command(vty
, vty
->buf
);
1381 if (vty
->type
== VTY_TERM
)
1386 /* Clear command line buffer. */
1387 vty
->cp
= vty
->length
= 0;
1390 if (vty
->status
!= VTY_CLOSE
)
1396 #define CONTROL(X) ((X) - '@')
1397 #define VTY_NORMAL 0
1398 #define VTY_PRE_ESCAPE 1
1399 #define VTY_ESCAPE 2
1401 /* Escape character command map. */
1402 static void vty_escape_map(unsigned char c
, struct vty
*vty
)
1406 vty_previous_line(vty
);
1412 vty_forward_char(vty
);
1415 vty_backward_char(vty
);
1421 /* Go back to normal mode. */
1422 vty
->escape
= VTY_NORMAL
;
1425 /* Quit print out to the buffer. */
1426 static void vty_buffer_reset(struct vty
*vty
)
1428 buffer_reset(vty
->obuf
);
1429 buffer_reset(vty
->lbuf
);
1431 vty_redraw_line(vty
);
1434 /* Read data via vty socket. */
1435 static int vty_read(struct thread
*thread
)
1439 unsigned char buf
[VTY_READ_BUFSIZ
];
1441 int vty_sock
= THREAD_FD(thread
);
1442 struct vty
*vty
= THREAD_ARG(thread
);
1445 /* Read raw data from socket */
1446 if ((nbytes
= read(vty
->fd
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
1448 if (ERRNO_IO_RETRY(errno
)) {
1449 vty_event(VTY_READ
, vty_sock
, vty
);
1452 vty
->monitor
= 0; /* disable monitoring to avoid
1453 infinite recursion */
1456 "%s: read error on vty client fd %d, closing: %s",
1457 __func__
, vty
->fd
, safe_strerror(errno
));
1458 buffer_reset(vty
->obuf
);
1459 buffer_reset(vty
->lbuf
);
1461 vty
->status
= VTY_CLOSE
;
1464 for (i
= 0; i
< nbytes
; i
++) {
1465 if (buf
[i
] == IAC
) {
1474 if (vty
->iac_sb_in_progress
&& !vty
->iac
) {
1475 if (vty
->sb_len
< sizeof(vty
->sb_buf
))
1476 vty
->sb_buf
[vty
->sb_len
] = buf
[i
];
1482 /* In case of telnet command */
1484 ret
= vty_telnet_option(vty
, buf
+ i
, nbytes
- i
);
1491 if (vty
->status
== VTY_MORE
) {
1496 vty_buffer_reset(vty
);
1498 #if 0 /* More line does not work for "show ip bgp". */
1501 vty
->status
= VTY_MORELINE
;
1510 /* Escape character. */
1511 if (vty
->escape
== VTY_ESCAPE
) {
1512 vty_escape_map(buf
[i
], vty
);
1516 /* Pre-escape status. */
1517 if (vty
->escape
== VTY_PRE_ESCAPE
) {
1520 vty
->escape
= VTY_ESCAPE
;
1523 vty_backward_word(vty
);
1524 vty
->escape
= VTY_NORMAL
;
1527 vty_forward_word(vty
);
1528 vty
->escape
= VTY_NORMAL
;
1531 vty_forward_kill_word(vty
);
1532 vty
->escape
= VTY_NORMAL
;
1536 vty_backward_kill_word(vty
);
1537 vty
->escape
= VTY_NORMAL
;
1540 vty
->escape
= VTY_NORMAL
;
1548 vty_beginning_of_line(vty
);
1551 vty_backward_char(vty
);
1554 vty_stop_input(vty
);
1557 vty_delete_char(vty
);
1560 vty_end_of_line(vty
);
1563 vty_forward_char(vty
);
1567 vty_delete_backward_char(vty
);
1576 vty_previous_line(vty
);
1579 vty_transpose_chars(vty
);
1582 vty_kill_line_from_beginning(vty
);
1585 vty_backward_kill_word(vty
);
1588 vty_end_config(vty
);
1596 vty_complete_command(vty
);
1599 if (vty
->node
== AUTH_NODE
1600 || vty
->node
== AUTH_ENABLE_NODE
)
1601 vty_self_insert(vty
, buf
[i
]);
1603 vty_describe_command(vty
);
1606 if (i
+ 1 < nbytes
&& buf
[i
+ 1] == '[') {
1607 vty
->escape
= VTY_ESCAPE
;
1610 vty
->escape
= VTY_PRE_ESCAPE
;
1613 if (buf
[i
] > 31 && buf
[i
] < 127)
1614 vty_self_insert(vty
, buf
[i
]);
1620 if (vty
->status
== VTY_CLOSE
)
1623 vty_event(VTY_WRITE
, vty
->wfd
, vty
);
1624 vty_event(VTY_READ
, vty_sock
, vty
);
1629 /* Flush buffer to the vty. */
1630 static int vty_flush(struct thread
*thread
)
1633 buffer_status_t flushrc
;
1634 int vty_sock
= THREAD_FD(thread
);
1635 struct vty
*vty
= THREAD_ARG(thread
);
1637 vty
->t_write
= NULL
;
1639 /* Tempolary disable read thread. */
1640 if ((vty
->lines
== 0) && vty
->t_read
) {
1641 thread_cancel(vty
->t_read
);
1645 /* Function execution continue. */
1646 erase
= ((vty
->status
== VTY_MORE
|| vty
->status
== VTY_MORELINE
));
1648 /* N.B. if width is 0, that means we don't know the window size. */
1649 if ((vty
->lines
== 0) || (vty
->width
== 0) || (vty
->height
== 0))
1650 flushrc
= buffer_flush_available(vty
->obuf
, vty_sock
);
1651 else if (vty
->status
== VTY_MORELINE
)
1652 flushrc
= buffer_flush_window(vty
->obuf
, vty_sock
, vty
->width
,
1655 flushrc
= buffer_flush_window(
1656 vty
->obuf
, vty_sock
, vty
->width
,
1657 vty
->lines
>= 0 ? vty
->lines
: vty
->height
, erase
, 0);
1661 0; /* disable monitoring to avoid infinite recursion */
1662 zlog_info("buffer_flush failed on vty client fd %d, closing",
1664 buffer_reset(vty
->lbuf
);
1665 buffer_reset(vty
->obuf
);
1669 if (vty
->status
== VTY_CLOSE
)
1672 vty
->status
= VTY_NORMAL
;
1673 if (vty
->lines
== 0)
1674 vty_event(VTY_READ
, vty_sock
, vty
);
1677 case BUFFER_PENDING
:
1678 /* There is more data waiting to be written. */
1679 vty
->status
= VTY_MORE
;
1680 if (vty
->lines
== 0)
1681 vty_event(VTY_WRITE
, vty_sock
, vty
);
1688 /* Allocate new vty struct. */
1689 struct vty
*vty_new()
1691 struct vty
*new = XCALLOC(MTYPE_VTY
, sizeof(struct vty
));
1693 new->fd
= new->wfd
= -1;
1695 new->lbuf
= buffer_new(0);
1696 new->obuf
= buffer_new(0); /* Use default buffer size. */
1697 new->buf
= XCALLOC(MTYPE_VTY
, VTY_BUFSIZ
);
1698 new->error_buf
= XCALLOC(MTYPE_VTY
, VTY_BUFSIZ
);
1699 new->max
= VTY_BUFSIZ
;
1705 /* allocate and initialise vty */
1706 static struct vty
*vty_new_init(int vty_sock
)
1712 vty
->wfd
= vty_sock
;
1713 vty
->type
= VTY_TERM
;
1714 vty
->node
= AUTH_NODE
;
1719 memset(vty
->hist
, 0, sizeof(vty
->hist
));
1722 vector_set_index(vtyvec
, vty_sock
, vty
);
1723 vty
->status
= VTY_NORMAL
;
1726 vty
->iac_sb_in_progress
= 0;
1732 /* Create new vty structure. */
1733 static struct vty
*vty_create(int vty_sock
, union sockunion
*su
)
1735 char buf
[SU_ADDRSTRLEN
];
1738 sockunion2str(su
, buf
, SU_ADDRSTRLEN
);
1740 /* Allocate new vty structure and set up default values. */
1741 vty
= vty_new_init(vty_sock
);
1743 /* configurable parameters not part of basic init */
1744 vty
->v_timeout
= vty_timeout_val
;
1745 strcpy(vty
->address
, buf
);
1746 if (no_password_check
) {
1748 vty
->node
= ENABLE_NODE
;
1750 vty
->node
= VIEW_NODE
;
1752 if (host
.lines
>= 0)
1753 vty
->lines
= host
.lines
;
1755 if (!no_password_check
) {
1756 /* Vty is not available if password isn't set. */
1757 if (host
.password
== NULL
&& host
.password_encrypt
== NULL
) {
1758 vty_out(vty
, "Vty password is not set.\n");
1759 vty
->status
= VTY_CLOSE
;
1765 /* Say hello to the world. */
1767 if (!no_password_check
)
1768 vty_out(vty
, "\nUser Access Verification\n\n");
1770 /* Setting up terminal. */
1772 vty_will_suppress_go_ahead(vty
);
1774 vty_dont_linemode(vty
);
1775 vty_do_window_size(vty
);
1776 /* vty_dont_lflow_ahead (vty); */
1780 /* Add read/write thread. */
1781 vty_event(VTY_WRITE
, vty_sock
, vty
);
1782 vty_event(VTY_READ
, vty_sock
, vty
);
1787 /* create vty for stdio */
1788 static struct termios stdio_orig_termios
;
1789 static struct vty
*stdio_vty
= NULL
;
1790 static bool stdio_termios
= false;
1791 static void (*stdio_vty_atclose
)(int isexit
);
1793 static void vty_stdio_reset(int isexit
)
1797 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1798 stdio_termios
= false;
1802 if (stdio_vty_atclose
)
1803 stdio_vty_atclose(isexit
);
1804 stdio_vty_atclose
= NULL
;
1808 static void vty_stdio_atexit(void)
1813 void vty_stdio_suspend(void)
1818 if (stdio_vty
->t_write
)
1819 thread_cancel(stdio_vty
->t_write
);
1820 if (stdio_vty
->t_read
)
1821 thread_cancel(stdio_vty
->t_read
);
1822 if (stdio_vty
->t_timeout
)
1823 thread_cancel(stdio_vty
->t_timeout
);
1826 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1827 stdio_termios
= false;
1830 void vty_stdio_resume(void)
1835 if (!tcgetattr(0, &stdio_orig_termios
)) {
1836 struct termios termios
;
1838 termios
= stdio_orig_termios
;
1839 termios
.c_iflag
&= ~(IGNBRK
| BRKINT
| PARMRK
| ISTRIP
| INLCR
1840 | IGNCR
| ICRNL
| IXON
);
1841 termios
.c_oflag
&= ~OPOST
;
1842 termios
.c_lflag
&= ~(ECHO
| ECHONL
| ICANON
| IEXTEN
);
1843 termios
.c_cflag
&= ~(CSIZE
| PARENB
);
1844 termios
.c_cflag
|= CS8
;
1845 tcsetattr(0, TCSANOW
, &termios
);
1846 stdio_termios
= true;
1849 vty_prompt(stdio_vty
);
1851 /* Add read/write thread. */
1852 vty_event(VTY_WRITE
, 1, stdio_vty
);
1853 vty_event(VTY_READ
, 0, stdio_vty
);
1856 void vty_stdio_close(void)
1860 vty_close(stdio_vty
);
1863 struct vty
*vty_stdio(void (*atclose
)(int isexit
))
1867 /* refuse creating two vtys on stdio */
1871 vty
= stdio_vty
= vty_new_init(0);
1872 stdio_vty_atclose
= atclose
;
1875 /* always have stdio vty in a known _unchangeable_ state, don't want
1877 * to have any effect here to make sure scripting this works as intended
1879 vty
->node
= ENABLE_NODE
;
1881 strcpy(vty
->address
, "console");
1887 /* Accept connection from the network. */
1888 static int vty_accept(struct thread
*thread
)
1896 struct access_list
*acl
= NULL
;
1897 char buf
[SU_ADDRSTRLEN
];
1899 accept_sock
= THREAD_FD(thread
);
1901 /* We continue hearing vty socket. */
1902 vty_event(VTY_SERV
, accept_sock
, NULL
);
1904 memset(&su
, 0, sizeof(union sockunion
));
1906 /* We can handle IPv4 or IPv6 socket. */
1907 vty_sock
= sockunion_accept(accept_sock
, &su
);
1909 flog_err(EC_LIB_SOCKET
, "can't accept vty socket : %s",
1910 safe_strerror(errno
));
1913 set_nonblocking(vty_sock
);
1914 set_cloexec(vty_sock
);
1916 sockunion2hostprefix(&su
, &p
);
1918 /* VTY's accesslist apply. */
1919 if (p
.family
== AF_INET
&& vty_accesslist_name
) {
1920 if ((acl
= access_list_lookup(AFI_IP
, vty_accesslist_name
))
1921 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1922 zlog_info("Vty connection refused from %s",
1923 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1926 /* continue accepting connections */
1927 vty_event(VTY_SERV
, accept_sock
, NULL
);
1933 /* VTY's ipv6 accesslist apply. */
1934 if (p
.family
== AF_INET6
&& vty_ipv6_accesslist_name
) {
1935 if ((acl
= access_list_lookup(AFI_IP6
,
1936 vty_ipv6_accesslist_name
))
1937 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1938 zlog_info("Vty connection refused from %s",
1939 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1942 /* continue accepting connections */
1943 vty_event(VTY_SERV
, accept_sock
, NULL
);
1950 ret
= setsockopt(vty_sock
, IPPROTO_TCP
, TCP_NODELAY
, (char *)&on
,
1953 zlog_info("can't set sockopt to vty_sock : %s",
1954 safe_strerror(errno
));
1956 zlog_info("Vty connection from %s",
1957 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1959 vty_create(vty_sock
, &su
);
1964 static void vty_serv_sock_addrinfo(const char *hostname
, unsigned short port
)
1967 struct addrinfo req
;
1968 struct addrinfo
*ainfo
;
1969 struct addrinfo
*ainfo_save
;
1971 char port_str
[BUFSIZ
];
1973 memset(&req
, 0, sizeof(struct addrinfo
));
1974 req
.ai_flags
= AI_PASSIVE
;
1975 req
.ai_family
= AF_UNSPEC
;
1976 req
.ai_socktype
= SOCK_STREAM
;
1977 sprintf(port_str
, "%d", port
);
1978 port_str
[sizeof(port_str
) - 1] = '\0';
1980 ret
= getaddrinfo(hostname
, port_str
, &req
, &ainfo
);
1983 flog_err_sys(EC_LIB_SYSTEM_CALL
, "getaddrinfo failed: %s",
1991 if (ainfo
->ai_family
!= AF_INET
&& ainfo
->ai_family
!= AF_INET6
)
1994 sock
= socket(ainfo
->ai_family
, ainfo
->ai_socktype
,
1995 ainfo
->ai_protocol
);
1999 sockopt_v6only(ainfo
->ai_family
, sock
);
2000 sockopt_reuseaddr(sock
);
2001 sockopt_reuseport(sock
);
2004 ret
= bind(sock
, ainfo
->ai_addr
, ainfo
->ai_addrlen
);
2006 close(sock
); /* Avoid sd leak. */
2010 ret
= listen(sock
, 3);
2012 close(sock
); /* Avoid sd leak. */
2016 vty_event(VTY_SERV
, sock
, NULL
);
2017 } while ((ainfo
= ainfo
->ai_next
) != NULL
);
2019 freeaddrinfo(ainfo_save
);
2023 /* For sockaddr_un. */
2026 /* VTY shell UNIX domain socket. */
2027 static void vty_serv_un(const char *path
)
2031 struct sockaddr_un serv
;
2033 struct zprivs_ids_t ids
;
2035 /* First of all, unlink existing socket */
2039 old_mask
= umask(0007);
2041 /* Make UNIX domain socket. */
2042 sock
= socket(AF_UNIX
, SOCK_STREAM
, 0);
2044 flog_err_sys(EC_LIB_SOCKET
,
2045 "Cannot create unix stream socket: %s",
2046 safe_strerror(errno
));
2050 /* Make server socket. */
2051 memset(&serv
, 0, sizeof(struct sockaddr_un
));
2052 serv
.sun_family
= AF_UNIX
;
2053 strlcpy(serv
.sun_path
, path
, sizeof(serv
.sun_path
));
2054 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
2055 len
= serv
.sun_len
= SUN_LEN(&serv
);
2057 len
= sizeof(serv
.sun_family
) + strlen(serv
.sun_path
);
2058 #endif /* HAVE_STRUCT_SOCKADDR_UN_SUN_LEN */
2062 ret
= bind(sock
, (struct sockaddr
*)&serv
, len
);
2064 flog_err_sys(EC_LIB_SOCKET
, "Cannot bind path %s: %s", path
,
2065 safe_strerror(errno
));
2066 close(sock
); /* Avoid sd leak. */
2070 ret
= listen(sock
, 5);
2072 flog_err_sys(EC_LIB_SOCKET
, "listen(fd %d) failed: %s", sock
,
2073 safe_strerror(errno
));
2074 close(sock
); /* Avoid sd leak. */
2080 zprivs_get_ids(&ids
);
2082 /* Hack: ids.gid_vty is actually a uint, but we stored -1 in it
2083 earlier for the case when we don't need to chown the file
2084 type casting it here to make a compare */
2085 if ((int)ids
.gid_vty
> 0) {
2086 /* set group of socket */
2087 if (chown(path
, -1, ids
.gid_vty
)) {
2088 flog_err_sys(EC_LIB_SYSTEM_CALL
,
2089 "vty_serv_un: could chown socket, %s",
2090 safe_strerror(errno
));
2094 vty_event(VTYSH_SERV
, sock
, NULL
);
2097 /* #define VTYSH_DEBUG 1 */
2099 static int vtysh_accept(struct thread
*thread
)
2104 struct sockaddr_un client
;
2107 accept_sock
= THREAD_FD(thread
);
2109 vty_event(VTYSH_SERV
, accept_sock
, NULL
);
2111 memset(&client
, 0, sizeof(struct sockaddr_un
));
2112 client_len
= sizeof(struct sockaddr_un
);
2114 sock
= accept(accept_sock
, (struct sockaddr
*)&client
,
2115 (socklen_t
*)&client_len
);
2118 flog_err(EC_LIB_SOCKET
, "can't accept vty socket : %s",
2119 safe_strerror(errno
));
2123 if (set_nonblocking(sock
) < 0) {
2126 "vtysh_accept: could not set vty socket %d to non-blocking, %s, closing",
2127 sock
, safe_strerror(errno
));
2134 printf("VTY shell accept\n");
2135 #endif /* VTYSH_DEBUG */
2140 vty
->type
= VTY_SHELL_SERV
;
2141 vty
->node
= VIEW_NODE
;
2143 vty_event(VTYSH_READ
, sock
, vty
);
2148 static int vtysh_flush(struct vty
*vty
)
2150 switch (buffer_flush_available(vty
->obuf
, vty
->wfd
)) {
2151 case BUFFER_PENDING
:
2152 vty_event(VTYSH_WRITE
, vty
->wfd
, vty
);
2156 0; /* disable monitoring to avoid infinite recursion */
2157 flog_err(EC_LIB_SOCKET
, "%s: write error to fd %d, closing",
2159 buffer_reset(vty
->lbuf
);
2160 buffer_reset(vty
->obuf
);
2170 static int vtysh_read(struct thread
*thread
)
2176 unsigned char buf
[VTY_READ_BUFSIZ
];
2178 uint8_t header
[4] = {0, 0, 0, 0};
2180 sock
= THREAD_FD(thread
);
2181 vty
= THREAD_ARG(thread
);
2184 if ((nbytes
= read(sock
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
2186 if (ERRNO_IO_RETRY(errno
)) {
2187 vty_event(VTYSH_READ
, sock
, vty
);
2190 vty
->monitor
= 0; /* disable monitoring to avoid
2191 infinite recursion */
2194 "%s: read failed on vtysh client fd %d, closing: %s",
2195 __func__
, sock
, safe_strerror(errno
));
2197 buffer_reset(vty
->lbuf
);
2198 buffer_reset(vty
->obuf
);
2201 printf("close vtysh\n");
2202 #endif /* VTYSH_DEBUG */
2207 printf("line: %.*s\n", nbytes
, buf
);
2208 #endif /* VTYSH_DEBUG */
2210 if (vty
->length
+ nbytes
>= VTY_BUFSIZ
) {
2211 /* Clear command line buffer. */
2212 vty
->cp
= vty
->length
= 0;
2214 vty_out(vty
, "%% Command is too long.\n");
2216 for (p
= buf
; p
< buf
+ nbytes
; p
++) {
2217 vty
->buf
[vty
->length
++] = *p
;
2219 /* Pass this line to parser. */
2220 ret
= vty_execute(vty
);
2221 /* Note that vty_execute clears the command buffer and resets
2222 vty->length to 0. */
2224 /* Return result. */
2226 printf("result: %d\n", ret
);
2227 printf("vtysh node: %d\n", vty
->node
);
2228 #endif /* VTYSH_DEBUG */
2230 /* hack for asynchronous "write integrated"
2231 * - other commands in "buf" will be ditched
2232 * - input during pending config-write is
2234 if (ret
== CMD_SUSPEND
)
2237 /* warning: watchfrr hardcodes this result write
2240 buffer_put(vty
->obuf
, header
, 4);
2242 if (!vty
->t_write
&& (vtysh_flush(vty
) < 0))
2243 /* Try to flush results; exit if a write
2250 if (vty
->status
== VTY_CLOSE
)
2253 vty_event(VTYSH_READ
, sock
, vty
);
2258 static int vtysh_write(struct thread
*thread
)
2260 struct vty
*vty
= THREAD_ARG(thread
);
2262 vty
->t_write
= NULL
;
2269 /* Determine address family to bind. */
2270 void vty_serv_sock(const char *addr
, unsigned short port
, const char *path
)
2272 /* If port is set to 0, do not listen on TCP/IP at all! */
2274 vty_serv_sock_addrinfo(addr
, port
);
2281 /* Close vty interface. Warning: call this only from functions that
2282 will be careful not to access the vty afterwards (since it has
2283 now been freed). This is safest from top-level functions (called
2284 directly by the thread dispatcher). */
2285 void vty_close(struct vty
*vty
)
2288 bool was_stdio
= false;
2290 /* Cancel threads.*/
2292 thread_cancel(vty
->t_read
);
2294 thread_cancel(vty
->t_write
);
2296 thread_cancel(vty
->t_timeout
);
2299 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2301 /* Free input buffer. */
2302 buffer_free(vty
->obuf
);
2303 buffer_free(vty
->lbuf
);
2305 /* Free command history. */
2306 for (i
= 0; i
< VTY_MAXHIST
; i
++)
2308 XFREE(MTYPE_VTY_HIST
, vty
->hist
[i
]);
2312 vector_unset(vtyvec
, vty
->fd
);
2314 if (vty
->wfd
> 0 && vty
->type
== VTY_FILE
)
2318 * note check is for fd > STDERR_FILENO, not fd != -1.
2319 * We never close stdin/stdout/stderr here, because we may be
2320 * running in foreground mode with logging to stdout. Also,
2321 * additionally, we'd need to replace these fds with /dev/null. */
2322 if (vty
->wfd
> STDERR_FILENO
&& vty
->wfd
!= vty
->fd
)
2324 if (vty
->fd
> STDERR_FILENO
)
2326 if (vty
->fd
== STDIN_FILENO
)
2330 XFREE(MTYPE_VTY
, vty
->buf
);
2333 XFREE(MTYPE_VTY
, vty
->error_buf
);
2335 /* Check configure. */
2336 vty_config_unlock(vty
);
2339 XFREE(MTYPE_VTY
, vty
);
2345 /* When time out occur output message then close connection. */
2346 static int vty_timeout(struct thread
*thread
)
2350 vty
= THREAD_ARG(thread
);
2351 vty
->t_timeout
= NULL
;
2355 buffer_reset(vty
->lbuf
);
2356 buffer_reset(vty
->obuf
);
2357 vty_out(vty
, "\nVty connection is timed out.\n");
2359 /* Close connection. */
2360 vty
->status
= VTY_CLOSE
;
2366 /* Read up configuration file from file_name. */
2367 static void vty_read_file(FILE *confp
)
2371 unsigned int line_num
= 0;
2374 /* vty_close won't close stderr; if some config command prints
2375 * something it'll end up there. (not ideal; it'd be beter if output
2376 * from a file-load went to logging instead. Also note that if this
2377 * function is called after daemonizing, stderr will be /dev/null.)
2379 * vty->fd will be -1 from vty_new()
2381 vty
->wfd
= STDERR_FILENO
;
2382 vty
->type
= VTY_FILE
;
2383 vty
->node
= CONFIG_NODE
;
2385 /* Execute configuration file */
2386 ret
= config_from_file(vty
, confp
, &line_num
);
2388 /* Flush any previous errors before printing messages below */
2389 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2391 if (!((ret
== CMD_SUCCESS
) || (ret
== CMD_ERR_NOTHING_TODO
))) {
2392 const char *message
= NULL
;
2396 case CMD_ERR_AMBIGUOUS
:
2397 message
= "Ambiguous command";
2399 case CMD_ERR_NO_MATCH
:
2400 message
= "No such command";
2403 message
= "Command returned Warning";
2405 case CMD_WARNING_CONFIG_FAILED
:
2406 message
= "Command returned Warning Config Failed";
2408 case CMD_ERR_INCOMPLETE
:
2409 message
= "Command returned Incomplete";
2411 case CMD_ERR_EXEED_ARGC_MAX
:
2413 "Command exceeded maximum number of Arguments";
2416 message
= "Command returned unhandled error message";
2420 nl
= strchr(vty
->error_buf
, '\n');
2423 flog_err(EC_LIB_VTY
,
2424 "ERROR: %s on config line %u: %s", message
, line_num
,
2431 static FILE *vty_use_backup_config(const char *fullpath
)
2433 char *fullpath_sav
, *fullpath_tmp
;
2439 fullpath_sav
= malloc(strlen(fullpath
) + strlen(CONF_BACKUP_EXT
) + 1);
2440 strcpy(fullpath_sav
, fullpath
);
2441 strcat(fullpath_sav
, CONF_BACKUP_EXT
);
2443 sav
= open(fullpath_sav
, O_RDONLY
);
2449 fullpath_tmp
= malloc(strlen(fullpath
) + 8);
2450 sprintf(fullpath_tmp
, "%s.XXXXXX", fullpath
);
2452 /* Open file to configuration write. */
2453 tmp
= mkstemp(fullpath_tmp
);
2457 if (fchmod(tmp
, CONFIGFILE_MASK
) != 0)
2460 while ((c
= read(sav
, buffer
, 512)) > 0) {
2461 if (write(tmp
, buffer
, c
) <= 0)
2467 if (rename(fullpath_tmp
, fullpath
) == 0)
2468 ret
= fopen(fullpath
, "r");
2470 unlink(fullpath_tmp
);
2475 unlink(fullpath_tmp
);
2485 /* Read up configuration file from file_name. */
2486 bool vty_read_config(const char *config_file
, char *config_default_dir
)
2488 char cwd
[MAXPATHLEN
];
2490 const char *fullpath
;
2492 bool read_success
= false;
2494 /* If -f flag specified. */
2495 if (config_file
!= NULL
) {
2496 if (!IS_DIRECTORY_SEP(config_file
[0])) {
2497 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
2500 "Failure to determine Current Working Directory %d!",
2504 tmp
= XMALLOC(MTYPE_TMP
,
2505 strlen(cwd
) + strlen(config_file
) + 2);
2506 sprintf(tmp
, "%s/%s", cwd
, config_file
);
2509 fullpath
= config_file
;
2511 confp
= fopen(fullpath
, "r");
2513 if (confp
== NULL
) {
2515 EC_LIB_BACKUP_CONFIG
,
2516 "%s: failed to open configuration file %s: %s, checking backup",
2517 __func__
, fullpath
, safe_strerror(errno
));
2519 confp
= vty_use_backup_config(fullpath
);
2522 EC_LIB_BACKUP_CONFIG
,
2523 "WARNING: using backup configuration file!");
2525 flog_err(EC_LIB_VTY
,
2526 "can't open configuration file [%s]",
2533 host_config_set(config_default_dir
);
2537 struct stat conf_stat
;
2539 /* !!!!PLEASE LEAVE!!!!
2540 * This is NEEDED for use with vtysh -b, or else you can get
2541 * a real configuration food fight with a lot garbage in the
2542 * merged configuration file it creates coming from the per
2543 * daemon configuration files. This also allows the daemons
2544 * to start if there default configuration file is not
2545 * present or ignore them, as needed when using vtysh -b to
2546 * configure the daemons at boot - MAG
2549 /* Stat for vtysh Zebra.conf, if found startup and wait for
2550 * boot configuration
2553 if (strstr(config_default_dir
, "vtysh") == NULL
) {
2554 ret
= stat(integrate_default
, &conf_stat
);
2556 read_success
= true;
2557 goto tmp_free_and_out
;
2561 confp
= fopen(config_default_dir
, "r");
2562 if (confp
== NULL
) {
2565 "%s: failed to open configuration file %s: %s, checking backup",
2566 __func__
, config_default_dir
,
2567 safe_strerror(errno
));
2569 confp
= vty_use_backup_config(config_default_dir
);
2572 EC_LIB_BACKUP_CONFIG
,
2573 "WARNING: using backup configuration file!");
2574 fullpath
= config_default_dir
;
2576 flog_err(EC_LIB_VTY
,
2577 "can't open configuration file [%s]",
2578 config_default_dir
);
2579 goto tmp_free_and_out
;
2582 fullpath
= config_default_dir
;
2585 vty_read_file(confp
);
2586 read_success
= true;
2590 host_config_set(fullpath
);
2594 XFREE(MTYPE_TMP
, tmp
);
2596 return read_success
;
2599 /* Small utility function which output log to the VTY. */
2600 void vty_log(const char *level
, const char *proto_str
, const char *format
,
2601 struct timestamp_control
*ctl
, va_list va
)
2609 for (i
= 0; i
< vector_active(vtyvec
); i
++)
2610 if ((vty
= vector_slot(vtyvec
, i
)) != NULL
)
2614 vty_log_out(vty
, level
, proto_str
, format
, ctl
,
2620 /* Async-signal-safe version of vty_log for fixed strings. */
2621 void vty_log_fixed(char *buf
, size_t len
)
2624 struct iovec iov
[2];
2625 char crlf
[4] = "\r\n";
2627 /* vty may not have been initialised */
2631 iov
[0].iov_base
= buf
;
2632 iov
[0].iov_len
= len
;
2633 iov
[1].iov_base
= crlf
;
2636 for (i
= 0; i
< vector_active(vtyvec
); i
++) {
2638 if (((vty
= vector_slot(vtyvec
, i
)) != NULL
) && vty
->monitor
)
2639 /* N.B. We don't care about the return code, since
2641 most likely just about to die anyway. */
2642 if (writev(vty
->wfd
, iov
, 2) == -1) {
2643 fprintf(stderr
, "Failure to writev: %d\n",
2650 int vty_config_lock(struct vty
*vty
)
2652 if (vty_config_is_lockless
)
2654 if (vty_config
== 0) {
2661 int vty_config_unlock(struct vty
*vty
)
2663 if (vty_config_is_lockless
)
2665 if (vty_config
== 1 && vty
->config
== 1) {
2672 void vty_config_lockless(void)
2674 vty_config_is_lockless
= 1;
2677 /* Master of the threads. */
2678 static struct thread_master
*vty_master
;
2680 static void vty_event(enum event event
, int sock
, struct vty
*vty
)
2682 struct thread
*vty_serv_thread
= NULL
;
2686 vty_serv_thread
= thread_add_read(vty_master
, vty_accept
, vty
,
2688 vector_set_index(Vvty_serv_thread
, sock
, vty_serv_thread
);
2692 vty_serv_thread
= thread_add_read(vty_master
, vtysh_accept
, vty
,
2694 vector_set_index(Vvty_serv_thread
, sock
, vty_serv_thread
);
2698 thread_add_read(vty_master
, vtysh_read
, vty
, sock
,
2702 vty
->t_write
= NULL
;
2703 thread_add_write(vty_master
, vtysh_write
, vty
, sock
,
2709 thread_add_read(vty_master
, vty_read
, vty
, sock
, &vty
->t_read
);
2711 /* Time out treatment. */
2712 if (vty
->v_timeout
) {
2714 thread_cancel(vty
->t_timeout
);
2715 vty
->t_timeout
= NULL
;
2716 thread_add_timer(vty_master
, vty_timeout
, vty
,
2717 vty
->v_timeout
, &vty
->t_timeout
);
2721 thread_add_write(vty_master
, vty_flush
, vty
, sock
,
2724 case VTY_TIMEOUT_RESET
:
2725 if (vty
->t_timeout
) {
2726 thread_cancel(vty
->t_timeout
);
2727 vty
->t_timeout
= NULL
;
2729 if (vty
->v_timeout
) {
2730 vty
->t_timeout
= NULL
;
2731 thread_add_timer(vty_master
, vty_timeout
, vty
,
2732 vty
->v_timeout
, &vty
->t_timeout
);
2738 DEFUN_NOSH (config_who
,
2741 "Display who is on vty\n")
2746 for (i
= 0; i
< vector_active(vtyvec
); i
++)
2747 if ((v
= vector_slot(vtyvec
, i
)) != NULL
)
2748 vty_out(vty
, "%svty[%d] connected from %s.\n",
2749 v
->config
? "*" : " ", i
, v
->address
);
2753 /* Move to vty configuration mode. */
2754 DEFUN_NOSH (line_vty
,
2757 "Configure a terminal line\n"
2758 "Virtual terminal\n")
2760 vty
->node
= VTY_NODE
;
2764 /* Set time out value. */
2765 static int exec_timeout(struct vty
*vty
, const char *min_str
,
2766 const char *sec_str
)
2768 unsigned long timeout
= 0;
2770 /* min_str and sec_str are already checked by parser. So it must be
2771 all digit string. */
2773 timeout
= strtol(min_str
, NULL
, 10);
2777 timeout
+= strtol(sec_str
, NULL
, 10);
2779 vty_timeout_val
= timeout
;
2780 vty
->v_timeout
= timeout
;
2781 vty_event(VTY_TIMEOUT_RESET
, 0, vty
);
2787 DEFUN (exec_timeout_min
,
2788 exec_timeout_min_cmd
,
2789 "exec-timeout (0-35791)",
2790 "Set timeout value\n"
2791 "Timeout value in minutes\n")
2794 return exec_timeout(vty
, argv
[idx_number
]->arg
, NULL
);
2797 DEFUN (exec_timeout_sec
,
2798 exec_timeout_sec_cmd
,
2799 "exec-timeout (0-35791) (0-2147483)",
2800 "Set the EXEC timeout\n"
2801 "Timeout in minutes\n"
2802 "Timeout in seconds\n")
2805 int idx_number_2
= 2;
2806 return exec_timeout(vty
, argv
[idx_number
]->arg
,
2807 argv
[idx_number_2
]->arg
);
2810 DEFUN (no_exec_timeout
,
2811 no_exec_timeout_cmd
,
2814 "Set the EXEC timeout\n")
2816 return exec_timeout(vty
, NULL
, NULL
);
2819 /* Set vty access class. */
2820 DEFUN (vty_access_class
,
2821 vty_access_class_cmd
,
2822 "access-class WORD",
2823 "Filter connections based on an IP access list\n"
2827 if (vty_accesslist_name
)
2828 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2830 vty_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2835 /* Clear vty access class. */
2836 DEFUN (no_vty_access_class
,
2837 no_vty_access_class_cmd
,
2838 "no access-class [WORD]",
2840 "Filter connections based on an IP access list\n"
2844 const char *accesslist
= (argc
== 3) ? argv
[idx_word
]->arg
: NULL
;
2845 if (!vty_accesslist_name
2846 || (argc
== 3 && strcmp(vty_accesslist_name
, accesslist
))) {
2847 vty_out(vty
, "Access-class is not currently applied to vty\n");
2848 return CMD_WARNING_CONFIG_FAILED
;
2851 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2853 vty_accesslist_name
= NULL
;
2858 /* Set vty access class. */
2859 DEFUN (vty_ipv6_access_class
,
2860 vty_ipv6_access_class_cmd
,
2861 "ipv6 access-class WORD",
2863 "Filter connections based on an IP access list\n"
2864 "IPv6 access list\n")
2867 if (vty_ipv6_accesslist_name
)
2868 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2870 vty_ipv6_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2875 /* Clear vty access class. */
2876 DEFUN (no_vty_ipv6_access_class
,
2877 no_vty_ipv6_access_class_cmd
,
2878 "no ipv6 access-class [WORD]",
2881 "Filter connections based on an IP access list\n"
2882 "IPv6 access list\n")
2885 const char *accesslist
= (argc
== 4) ? argv
[idx_word
]->arg
: NULL
;
2887 if (!vty_ipv6_accesslist_name
2888 || (argc
== 4 && strcmp(vty_ipv6_accesslist_name
, accesslist
))) {
2890 "IPv6 access-class is not currently applied to vty\n");
2891 return CMD_WARNING_CONFIG_FAILED
;
2894 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2896 vty_ipv6_accesslist_name
= NULL
;
2905 "Enable password checking\n")
2907 no_password_check
= 0;
2911 DEFUN (no_vty_login
,
2915 "Enable password checking\n")
2917 no_password_check
= 1;
2921 DEFUN (service_advanced_vty
,
2922 service_advanced_vty_cmd
,
2923 "service advanced-vty",
2924 "Set up miscellaneous service\n"
2925 "Enable advanced mode vty interface\n")
2931 DEFUN (no_service_advanced_vty
,
2932 no_service_advanced_vty_cmd
,
2933 "no service advanced-vty",
2935 "Set up miscellaneous service\n"
2936 "Enable advanced mode vty interface\n")
2942 DEFUN_NOSH (terminal_monitor
,
2943 terminal_monitor_cmd
,
2945 "Set terminal line parameters\n"
2946 "Copy debug output to the current terminal line\n")
2952 DEFUN_NOSH (terminal_no_monitor
,
2953 terminal_no_monitor_cmd
,
2954 "terminal no monitor",
2955 "Set terminal line parameters\n"
2957 "Copy debug output to the current terminal line\n")
2963 DEFUN_NOSH (no_terminal_monitor
,
2964 no_terminal_monitor_cmd
,
2965 "no terminal monitor",
2967 "Set terminal line parameters\n"
2968 "Copy debug output to the current terminal line\n")
2970 return terminal_no_monitor(self
, vty
, argc
, argv
);
2974 DEFUN_NOSH (show_history
,
2978 "Display the session command history\n")
2982 for (index
= vty
->hindex
+ 1; index
!= vty
->hindex
;) {
2983 if (index
== VTY_MAXHIST
) {
2988 if (vty
->hist
[index
] != NULL
)
2989 vty_out(vty
, " %s\n", vty
->hist
[index
]);
2998 DEFUN (log_commands
,
3002 "Log all commands (can't be unset without restart)\n")
3004 do_log_commands
= 1;
3008 /* Display current configuration. */
3009 static int vty_config_write(struct vty
*vty
)
3011 vty_out(vty
, "line vty\n");
3013 if (vty_accesslist_name
)
3014 vty_out(vty
, " access-class %s\n", vty_accesslist_name
);
3016 if (vty_ipv6_accesslist_name
)
3017 vty_out(vty
, " ipv6 access-class %s\n",
3018 vty_ipv6_accesslist_name
);
3021 if (vty_timeout_val
!= VTY_TIMEOUT_DEFAULT
)
3022 vty_out(vty
, " exec-timeout %ld %ld\n", vty_timeout_val
/ 60,
3023 vty_timeout_val
% 60);
3026 if (no_password_check
)
3027 vty_out(vty
, " no login\n");
3029 if (do_log_commands
)
3030 vty_out(vty
, "log commands\n");
3032 vty_out(vty
, "!\n");
3037 struct cmd_node vty_node
= {
3038 VTY_NODE
, "%s(config-line)# ", 1,
3041 /* Reset all VTY status. */
3046 struct thread
*vty_serv_thread
;
3048 for (i
= 0; i
< vector_active(vtyvec
); i
++)
3049 if ((vty
= vector_slot(vtyvec
, i
)) != NULL
) {
3050 buffer_reset(vty
->lbuf
);
3051 buffer_reset(vty
->obuf
);
3052 vty
->status
= VTY_CLOSE
;
3056 for (i
= 0; i
< vector_active(Vvty_serv_thread
); i
++)
3057 if ((vty_serv_thread
= vector_slot(Vvty_serv_thread
, i
))
3059 thread_cancel(vty_serv_thread
);
3060 vector_slot(Vvty_serv_thread
, i
) = NULL
;
3064 vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
3066 if (vty_accesslist_name
) {
3067 XFREE(MTYPE_VTY
, vty_accesslist_name
);
3068 vty_accesslist_name
= NULL
;
3071 if (vty_ipv6_accesslist_name
) {
3072 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
3073 vty_ipv6_accesslist_name
= NULL
;
3077 static void vty_save_cwd(void)
3079 char cwd
[MAXPATHLEN
];
3082 c
= getcwd(cwd
, MAXPATHLEN
);
3086 * At this point if these go wrong, more than likely
3087 * the whole world is coming down around us
3088 * Hence not worrying about it too much.
3090 if (!chdir(SYSCONFDIR
)) {
3091 flog_err_sys(EC_LIB_SYSTEM_CALL
,
3092 "Failure to chdir to %s, errno: %d",
3096 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
3097 flog_err_sys(EC_LIB_SYSTEM_CALL
,
3098 "Failure to getcwd, errno: %d", errno
);
3103 vty_cwd
= XMALLOC(MTYPE_TMP
, strlen(cwd
) + 1);
3104 strcpy(vty_cwd
, cwd
);
3112 int vty_shell(struct vty
*vty
)
3114 return vty
->type
== VTY_SHELL
? 1 : 0;
3117 int vty_shell_serv(struct vty
*vty
)
3119 return vty
->type
== VTY_SHELL_SERV
? 1 : 0;
3122 void vty_init_vtysh()
3124 vtyvec
= vector_init(VECTOR_MIN_SIZE
);
3127 /* Install vty's own commands like `who' command. */
3128 void vty_init(struct thread_master
*master_thread
)
3130 /* For further configuration read, preserve current directory. */
3133 vtyvec
= vector_init(VECTOR_MIN_SIZE
);
3135 vty_master
= master_thread
;
3137 atexit(vty_stdio_atexit
);
3139 /* Initilize server thread vector. */
3140 Vvty_serv_thread
= vector_init(VECTOR_MIN_SIZE
);
3142 /* Install bgp top node. */
3143 install_node(&vty_node
, vty_config_write
);
3145 install_element(VIEW_NODE
, &config_who_cmd
);
3146 install_element(VIEW_NODE
, &show_history_cmd
);
3147 install_element(CONFIG_NODE
, &line_vty_cmd
);
3148 install_element(CONFIG_NODE
, &service_advanced_vty_cmd
);
3149 install_element(CONFIG_NODE
, &no_service_advanced_vty_cmd
);
3150 install_element(CONFIG_NODE
, &show_history_cmd
);
3151 install_element(CONFIG_NODE
, &log_commands_cmd
);
3152 install_element(ENABLE_NODE
, &terminal_monitor_cmd
);
3153 install_element(ENABLE_NODE
, &terminal_no_monitor_cmd
);
3154 install_element(ENABLE_NODE
, &no_terminal_monitor_cmd
);
3156 install_default(VTY_NODE
);
3157 install_element(VTY_NODE
, &exec_timeout_min_cmd
);
3158 install_element(VTY_NODE
, &exec_timeout_sec_cmd
);
3159 install_element(VTY_NODE
, &no_exec_timeout_cmd
);
3160 install_element(VTY_NODE
, &vty_access_class_cmd
);
3161 install_element(VTY_NODE
, &no_vty_access_class_cmd
);
3162 install_element(VTY_NODE
, &vty_login_cmd
);
3163 install_element(VTY_NODE
, &no_vty_login_cmd
);
3164 install_element(VTY_NODE
, &vty_ipv6_access_class_cmd
);
3165 install_element(VTY_NODE
, &no_vty_ipv6_access_class_cmd
);
3168 void vty_terminate(void)
3171 XFREE(MTYPE_TMP
, vty_cwd
);
3173 if (vtyvec
&& Vvty_serv_thread
) {
3175 vector_free(vtyvec
);
3176 vector_free(Vvty_serv_thread
);
3178 Vvty_serv_thread
= NULL
;