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"
44 #include <arpa/telnet.h>
47 DEFINE_MTYPE_STATIC(LIB
, VTY
, "VTY")
48 DEFINE_MTYPE_STATIC(LIB
, VTY_OUT_BUF
, "VTY output buffer")
49 DEFINE_MTYPE_STATIC(LIB
, VTY_HIST
, "VTY history")
64 static void vty_event(enum event
, int, struct vty
*);
66 /* Extern host structure from command.c */
67 extern struct host host
;
69 /* Vector which store each vty structure. */
72 /* Vty timeout value. */
73 static unsigned long vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
75 /* Vty access-class command */
76 static char *vty_accesslist_name
= NULL
;
78 /* Vty access-calss for IPv6. */
79 static char *vty_ipv6_accesslist_name
= NULL
;
81 /* VTY server thread. */
82 static vector Vvty_serv_thread
;
84 /* Current directory. */
88 static int vty_config
;
89 static int vty_config_is_lockless
= 0;
91 /* Login password check. */
92 static int no_password_check
= 0;
94 /* Integrated configuration file path */
95 char integrate_default
[] = SYSCONFDIR INTEGRATE_DEFAULT_CONFIG
;
97 static int do_log_commands
= 0;
99 void vty_frame(struct vty
*vty
, const char *format
, ...)
103 va_start(args
, format
);
104 vsnprintf(vty
->frame
+ vty
->frame_pos
,
105 sizeof(vty
->frame
) - vty
->frame_pos
, format
, args
);
106 vty
->frame_pos
= strlen(vty
->frame
);
110 void vty_endframe(struct vty
*vty
, const char *endtext
)
112 if (vty
->frame_pos
== 0 && endtext
)
113 vty_out(vty
, "%s", endtext
);
117 bool vty_set_include(struct vty
*vty
, const char *regexp
)
125 regfree(&vty
->include
);
131 errcode
= regcomp(&vty
->include
, regexp
,
132 REG_EXTENDED
| REG_NEWLINE
| REG_NOSUB
);
135 regerror(ret
, &vty
->include
, errbuf
, sizeof(errbuf
));
136 vty_out(vty
, "%% Regex compilation error: %s", errbuf
);
144 /* VTY standard output function. */
145 int vty_out(struct vty
*vty
, const char *format
, ...)
154 if (vty
->frame_pos
) {
156 vty_out(vty
, "%s", vty
->frame
);
159 /* Try to write to initial buffer. */
160 va_start(args
, format
);
161 len
= vsnprintf(buf
, sizeof(buf
), format
, args
);
164 /* Initial buffer is not enough. */
165 if (len
< 0 || len
>= size
) {
172 p
= XREALLOC(MTYPE_VTY_OUT_BUF
, p
, size
);
176 va_start(args
, format
);
177 len
= vsnprintf(p
, size
, format
, args
);
180 if (len
> -1 && len
< size
)
185 /* When initial buffer is enough to store all output. */
191 vector lines
= frrstr_split_vec(p
, "\n");
193 /* Place first value in the cache */
194 char *firstline
= vector_slot(lines
, 0);
195 buffer_put(vty
->lbuf
, (uint8_t *) firstline
, strlen(firstline
));
197 /* If our split returned more than one entry, time to filter */
198 if (vector_active(lines
) > 1) {
200 * returned string is MTYPE_TMP so it matches the MTYPE
201 * of everything else in the vector
203 char *bstr
= buffer_getstr(vty
->lbuf
);
204 buffer_reset(vty
->lbuf
);
205 XFREE(MTYPE_TMP
, lines
->index
[0]);
206 vector_set_index(lines
, 0, bstr
);
207 frrstr_filter_vec(lines
, &vty
->include
);
208 vector_compact(lines
);
210 * Consider the string "foo\n". If the regex is an empty string
211 * and the line ended with a newline, then the vector will look
217 * If the regex isn't empty, the vector will look like:
221 * In this case we'd like to preserve the newline, so we add
222 * the empty string [1] as in the first example.
224 if (p
[strlen(p
) - 1] == '\n' && vector_active(lines
) > 0
225 && strlen(vector_slot(lines
, vector_active(lines
) - 1)))
226 vector_set(lines
, XSTRDUP(MTYPE_TMP
, ""));
228 filtered
= frrstr_join_vec(lines
, "\n");
234 frrstr_strvec_free(lines
);
245 /* print with crlf replacement */
246 buffer_put_crlf(vty
->obuf
, (uint8_t *)filtered
,
250 fprintf(vty
->of
, "%s", filtered
);
256 /* print without crlf replacement */
257 buffer_put(vty
->obuf
, (uint8_t *)filtered
, strlen(filtered
));
263 if (vty
->filter
&& filtered
)
264 XFREE(MTYPE_TMP
, filtered
);
266 /* If p is not different with buf, it is allocated buffer. */
268 XFREE(MTYPE_VTY_OUT_BUF
, p
);
273 static int vty_log_out(struct vty
*vty
, const char *level
,
274 const char *proto_str
, const char *format
,
275 struct timestamp_control
*ctl
, va_list va
)
281 if (!ctl
->already_rendered
) {
282 ctl
->len
= quagga_timestamp(ctl
->precision
, ctl
->buf
,
284 ctl
->already_rendered
= 1;
286 if (ctl
->len
+ 1 >= sizeof(buf
))
288 memcpy(buf
, ctl
->buf
, len
= ctl
->len
);
293 ret
= snprintf(buf
+ len
, sizeof(buf
) - len
, "%s: %s: ", level
,
296 ret
= snprintf(buf
+ len
, sizeof(buf
) - len
, "%s: ", proto_str
);
297 if ((ret
< 0) || ((size_t)(len
+= ret
) >= sizeof(buf
)))
300 if (((ret
= vsnprintf(buf
+ len
, sizeof(buf
) - len
, format
, va
)) < 0)
301 || ((size_t)((len
+= ret
) + 2) > sizeof(buf
)))
307 if (write(vty
->wfd
, buf
, len
) < 0) {
308 if (ERRNO_IO_RETRY(errno
))
309 /* Kernel buffer is full, probably too much debugging
311 drop the data and ignore. */
313 /* Fatal I/O error. */
315 0; /* disable monitoring to avoid infinite recursion */
316 zlog_warn("%s: write failed to vty client fd %d, closing: %s",
317 __func__
, vty
->fd
, safe_strerror(errno
));
318 buffer_reset(vty
->obuf
);
319 buffer_reset(vty
->lbuf
);
320 /* cannot call vty_close, because a parent routine may still try
321 to access the vty struct */
322 vty
->status
= VTY_CLOSE
;
323 shutdown(vty
->fd
, SHUT_RDWR
);
329 /* Output current time to the vty. */
330 void vty_time_print(struct vty
*vty
, int cr
)
332 char buf
[QUAGGA_TIMESTAMP_LEN
];
334 if (quagga_timestamp(0, buf
, sizeof(buf
)) == 0) {
335 zlog_info("quagga_timestamp error");
339 vty_out(vty
, "%s\n", buf
);
341 vty_out(vty
, "%s ", buf
);
346 /* Say hello to vty interface. */
347 void vty_hello(struct vty
*vty
)
353 f
= fopen(host
.motdfile
, "r");
355 while (fgets(buf
, sizeof(buf
), f
)) {
357 /* work backwards to ignore trailling isspace()
359 for (s
= buf
+ strlen(buf
);
360 (s
> buf
) && isspace((int)*(s
- 1)); s
--)
363 vty_out(vty
, "%s\n", buf
);
367 vty_out(vty
, "MOTD file not found\n");
368 } else if (host
.motd
)
369 vty_out(vty
, "%s", host
.motd
);
372 /* Put out prompt and wait input from user. */
373 static void vty_prompt(struct vty
*vty
)
375 if (vty
->type
== VTY_TERM
) {
376 vty_out(vty
, cmd_prompt(vty
->node
), cmd_hostname_get());
380 /* Send WILL TELOPT_ECHO to remote server. */
381 static void vty_will_echo(struct vty
*vty
)
383 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_ECHO
, '\0'};
384 vty_out(vty
, "%s", cmd
);
387 /* Make suppress Go-Ahead telnet option. */
388 static void vty_will_suppress_go_ahead(struct vty
*vty
)
390 unsigned char cmd
[] = {IAC
, WILL
, TELOPT_SGA
, '\0'};
391 vty_out(vty
, "%s", cmd
);
394 /* Make don't use linemode over telnet. */
395 static void vty_dont_linemode(struct vty
*vty
)
397 unsigned char cmd
[] = {IAC
, DONT
, TELOPT_LINEMODE
, '\0'};
398 vty_out(vty
, "%s", cmd
);
401 /* Use window size. */
402 static void vty_do_window_size(struct vty
*vty
)
404 unsigned char cmd
[] = {IAC
, DO
, TELOPT_NAWS
, '\0'};
405 vty_out(vty
, "%s", cmd
);
408 #if 0 /* Currently not used. */
409 /* Make don't use lflow vty interface. */
411 vty_dont_lflow_ahead (struct vty
*vty
)
413 unsigned char cmd
[] = { IAC
, DONT
, TELOPT_LFLOW
, '\0' };
414 vty_out (vty
, "%s", cmd
);
418 /* Authentication of vty */
419 static void vty_auth(struct vty
*vty
, char *buf
)
422 enum node_type next_node
= 0;
424 char *crypt(const char *, const char *);
429 passwd
= host
.password_encrypt
;
431 passwd
= host
.password
;
433 next_node
= host
.enable
? VIEW_NODE
: ENABLE_NODE
;
435 next_node
= VIEW_NODE
;
437 case AUTH_ENABLE_NODE
:
439 passwd
= host
.enable_encrypt
;
441 passwd
= host
.enable
;
442 next_node
= ENABLE_NODE
;
448 fail
= strcmp(crypt(buf
, passwd
), passwd
);
450 fail
= strcmp(buf
, passwd
);
456 vty
->node
= next_node
; /* Success ! */
459 if (vty
->fail
>= 3) {
460 if (vty
->node
== AUTH_NODE
) {
462 "%% Bad passwords, too many failures!\n");
463 vty
->status
= VTY_CLOSE
;
465 /* AUTH_ENABLE_NODE */
468 "%% Bad enable passwords, too many failures!\n");
469 vty
->status
= VTY_CLOSE
;
475 /* Command execution over the vty interface. */
476 static int vty_command(struct vty
*vty
, char *buf
)
479 const char *protocolname
;
485 * Log non empty command lines
490 /* Skip white spaces. */
491 while (isspace((int)*cp
) && *cp
!= '\0')
494 if (cp
!= NULL
&& *cp
!= '\0') {
496 char vty_str
[VTY_BUFSIZ
];
497 char prompt_str
[VTY_BUFSIZ
];
499 /* format the base vty info */
500 snprintf(vty_str
, sizeof(vty_str
), "vty[??]@%s", vty
->address
);
502 for (i
= 0; i
< vector_active(vtyvec
); i
++)
503 if (vty
== vector_slot(vtyvec
, i
)) {
504 snprintf(vty_str
, sizeof(vty_str
), "vty[%d]@%s",
509 /* format the prompt */
510 snprintf(prompt_str
, sizeof(prompt_str
), cmd_prompt(vty
->node
),
513 /* now log the command */
514 zlog_err("%s%s", prompt_str
, buf
);
517 #ifdef CONSUMED_TIME_CHECK
521 unsigned long realtime
, cputime
;
524 #endif /* CONSUMED_TIME_CHECK */
526 ret
= cmd_execute(vty
, buf
, NULL
, 0);
528 /* Get the name of the protocol if any */
529 protocolname
= frr_protoname
;
531 #ifdef CONSUMED_TIME_CHECK
533 if ((realtime
= thread_consumed_time(&after
, &before
, &cputime
))
534 > CONSUMED_TIME_CHECK
)
535 /* Warn about CPU hog that must be fixed. */
537 "SLOW COMMAND: command took %lums (cpu time %lums): %s",
538 realtime
/ 1000, cputime
/ 1000, buf
);
540 #endif /* CONSUMED_TIME_CHECK */
542 if (ret
!= CMD_SUCCESS
)
545 if (vty
->type
== VTY_FILE
)
546 vty_out(vty
, "Warning...\n");
548 case CMD_ERR_AMBIGUOUS
:
549 vty_out(vty
, "%% Ambiguous command.\n");
551 case CMD_ERR_NO_MATCH
:
552 vty_out(vty
, "%% [%s] Unknown command: %s\n",
555 case CMD_ERR_INCOMPLETE
:
556 vty_out(vty
, "%% Command incomplete.\n");
563 static const char telnet_backward_char
= 0x08;
564 static const char telnet_space_char
= ' ';
566 /* Basic function to write buffer to vty. */
567 static void vty_write(struct vty
*vty
, const char *buf
, size_t nbytes
)
569 if ((vty
->node
== AUTH_NODE
) || (vty
->node
== AUTH_ENABLE_NODE
))
572 /* Should we do buffering here ? And make vty_flush (vty) ? */
573 buffer_put(vty
->obuf
, buf
, nbytes
);
576 /* Basic function to insert character into vty. */
577 static void vty_self_insert(struct vty
*vty
, char c
)
582 if (vty
->length
+ 1 >= VTY_BUFSIZ
)
585 length
= vty
->length
- vty
->cp
;
586 memmove(&vty
->buf
[vty
->cp
+ 1], &vty
->buf
[vty
->cp
], length
);
587 vty
->buf
[vty
->cp
] = c
;
589 vty_write(vty
, &vty
->buf
[vty
->cp
], length
+ 1);
590 for (i
= 0; i
< length
; i
++)
591 vty_write(vty
, &telnet_backward_char
, 1);
596 vty
->buf
[vty
->length
] = '\0';
599 /* Self insert character 'c' in overwrite mode. */
600 static void vty_self_insert_overwrite(struct vty
*vty
, char c
)
602 if (vty
->cp
== vty
->length
) {
603 vty_self_insert(vty
, c
);
607 vty
->buf
[vty
->cp
++] = c
;
608 vty_write(vty
, &c
, 1);
612 * Insert a string into vty->buf at the current cursor position.
614 * If the resultant string would be larger than VTY_BUFSIZ it is
617 static void vty_insert_word_overwrite(struct vty
*vty
, char *str
)
619 if (vty
->cp
== VTY_BUFSIZ
)
622 size_t nwrite
= MIN((int)strlen(str
), VTY_BUFSIZ
- vty
->cp
- 1);
623 memcpy(&vty
->buf
[vty
->cp
], str
, nwrite
);
625 vty
->length
= MAX(vty
->cp
, vty
->length
);
626 vty
->buf
[vty
->length
] = '\0';
627 vty_write(vty
, str
, nwrite
);
630 /* Forward character. */
631 static void vty_forward_char(struct vty
*vty
)
633 if (vty
->cp
< vty
->length
) {
634 vty_write(vty
, &vty
->buf
[vty
->cp
], 1);
639 /* Backward character. */
640 static void vty_backward_char(struct vty
*vty
)
644 vty_write(vty
, &telnet_backward_char
, 1);
648 /* Move to the beginning of the line. */
649 static void vty_beginning_of_line(struct vty
*vty
)
652 vty_backward_char(vty
);
655 /* Move to the end of the line. */
656 static void vty_end_of_line(struct vty
*vty
)
658 while (vty
->cp
< vty
->length
)
659 vty_forward_char(vty
);
662 static void vty_kill_line_from_beginning(struct vty
*);
663 static void vty_redraw_line(struct vty
*);
665 /* Print command line history. This function is called from
666 vty_next_line and vty_previous_line. */
667 static void vty_history_print(struct vty
*vty
)
671 vty_kill_line_from_beginning(vty
);
673 /* Get previous line from history buffer */
674 length
= strlen(vty
->hist
[vty
->hp
]);
675 memcpy(vty
->buf
, vty
->hist
[vty
->hp
], length
);
676 vty
->cp
= vty
->length
= length
;
677 vty
->buf
[vty
->length
] = '\0';
679 /* Redraw current line */
680 vty_redraw_line(vty
);
683 /* Show next command line history. */
684 static void vty_next_line(struct vty
*vty
)
688 if (vty
->hp
== vty
->hindex
)
691 /* Try is there history exist or not. */
693 if (try_index
== (VTY_MAXHIST
- 1))
698 /* If there is not history return. */
699 if (vty
->hist
[try_index
] == NULL
)
704 vty_history_print(vty
);
707 /* Show previous command line history. */
708 static void vty_previous_line(struct vty
*vty
)
714 try_index
= VTY_MAXHIST
- 1;
718 if (vty
->hist
[try_index
] == NULL
)
723 vty_history_print(vty
);
726 /* This function redraw all of the command line character. */
727 static void vty_redraw_line(struct vty
*vty
)
729 vty_write(vty
, vty
->buf
, vty
->length
);
730 vty
->cp
= vty
->length
;
734 static void vty_forward_word(struct vty
*vty
)
736 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
737 vty_forward_char(vty
);
739 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
740 vty_forward_char(vty
);
743 /* Backward word without skipping training space. */
744 static void vty_backward_pure_word(struct vty
*vty
)
746 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
747 vty_backward_char(vty
);
751 static void vty_backward_word(struct vty
*vty
)
753 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
754 vty_backward_char(vty
);
756 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
757 vty_backward_char(vty
);
760 /* When '^D' is typed at the beginning of the line we move to the down
762 static void vty_down_level(struct vty
*vty
)
770 /* When '^Z' is received from vty, move down to the enable mode. */
771 static void vty_end_config(struct vty
*vty
)
790 case BGP_VRF_POLICY_NODE
:
791 case BGP_VNC_DEFAULTS_NODE
:
792 case BGP_VNC_NVE_GROUP_NODE
:
793 case BGP_VNC_L2_GROUP_NODE
:
808 case LDP_IPV4_IFACE_NODE
:
809 case LDP_IPV6_IFACE_NODE
:
811 case LDP_PSEUDOWIRE_NODE
:
814 case KEYCHAIN_KEY_NODE
:
816 case BGP_EVPN_VNI_NODE
:
817 vty_config_unlock(vty
);
818 vty
->node
= ENABLE_NODE
;
821 /* Unknown node, we have to ignore it. */
829 /* Delete a charcter at the current point. */
830 static void vty_delete_char(struct vty
*vty
)
835 if (vty
->length
== 0) {
840 if (vty
->cp
== vty
->length
)
841 return; /* completion need here? */
843 size
= vty
->length
- vty
->cp
;
846 memmove(&vty
->buf
[vty
->cp
], &vty
->buf
[vty
->cp
+ 1], size
- 1);
847 vty
->buf
[vty
->length
] = '\0';
849 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
852 vty_write(vty
, &vty
->buf
[vty
->cp
], size
- 1);
853 vty_write(vty
, &telnet_space_char
, 1);
855 for (i
= 0; i
< size
; i
++)
856 vty_write(vty
, &telnet_backward_char
, 1);
859 /* Delete a character before the point. */
860 static void vty_delete_backward_char(struct vty
*vty
)
865 vty_backward_char(vty
);
866 vty_delete_char(vty
);
869 /* Kill rest of line from current point. */
870 static void vty_kill_line(struct vty
*vty
)
875 size
= vty
->length
- vty
->cp
;
880 for (i
= 0; i
< size
; i
++)
881 vty_write(vty
, &telnet_space_char
, 1);
882 for (i
= 0; i
< size
; i
++)
883 vty_write(vty
, &telnet_backward_char
, 1);
885 memset(&vty
->buf
[vty
->cp
], 0, size
);
886 vty
->length
= vty
->cp
;
889 /* Kill line from the beginning. */
890 static void vty_kill_line_from_beginning(struct vty
*vty
)
892 vty_beginning_of_line(vty
);
896 /* Delete a word before the point. */
897 static void vty_forward_kill_word(struct vty
*vty
)
899 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
900 vty_delete_char(vty
);
901 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
902 vty_delete_char(vty
);
905 /* Delete a word before the point. */
906 static void vty_backward_kill_word(struct vty
*vty
)
908 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
909 vty_delete_backward_char(vty
);
910 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
911 vty_delete_backward_char(vty
);
914 /* Transpose chars before or at the point. */
915 static void vty_transpose_chars(struct vty
*vty
)
919 /* If length is short or point is near by the beginning of line then
921 if (vty
->length
< 2 || vty
->cp
< 1)
924 /* In case of point is located at the end of the line. */
925 if (vty
->cp
== vty
->length
) {
926 c1
= vty
->buf
[vty
->cp
- 1];
927 c2
= vty
->buf
[vty
->cp
- 2];
929 vty_backward_char(vty
);
930 vty_backward_char(vty
);
931 vty_self_insert_overwrite(vty
, c1
);
932 vty_self_insert_overwrite(vty
, c2
);
934 c1
= vty
->buf
[vty
->cp
];
935 c2
= vty
->buf
[vty
->cp
- 1];
937 vty_backward_char(vty
);
938 vty_self_insert_overwrite(vty
, c1
);
939 vty_self_insert_overwrite(vty
, c2
);
943 /* Do completion at vty interface. */
944 static void vty_complete_command(struct vty
*vty
)
948 char **matched
= NULL
;
951 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
954 vline
= cmd_make_strvec(vty
->buf
);
958 /* In case of 'help \t'. */
959 if (isspace((int)vty
->buf
[vty
->length
- 1]))
960 vector_set(vline
, NULL
);
962 matched
= cmd_complete_command(vline
, vty
, &ret
);
964 cmd_free_strvec(vline
);
968 case CMD_ERR_AMBIGUOUS
:
969 vty_out(vty
, "%% Ambiguous command.\n");
971 vty_redraw_line(vty
);
973 case CMD_ERR_NO_MATCH
:
974 /* vty_out (vty, "%% There is no matched command.\n"); */
976 vty_redraw_line(vty
);
978 case CMD_COMPLETE_FULL_MATCH
:
980 /* 2016-11-28 equinox -- need to debug, SEGV here */
981 vty_out(vty
, "%% CLI BUG: FULL_MATCH with NULL str\n");
983 vty_redraw_line(vty
);
987 vty_redraw_line(vty
);
988 vty_backward_pure_word(vty
);
989 vty_insert_word_overwrite(vty
, matched
[0]);
990 vty_self_insert(vty
, ' ');
991 XFREE(MTYPE_COMPLETION
, matched
[0]);
993 case CMD_COMPLETE_MATCH
:
995 vty_redraw_line(vty
);
996 vty_backward_pure_word(vty
);
997 vty_insert_word_overwrite(vty
, matched
[0]);
998 XFREE(MTYPE_COMPLETION
, matched
[0]);
1000 case CMD_COMPLETE_LIST_MATCH
:
1001 for (i
= 0; matched
[i
] != NULL
; i
++) {
1002 if (i
!= 0 && ((i
% 6) == 0))
1004 vty_out(vty
, "%-10s ", matched
[i
]);
1005 XFREE(MTYPE_COMPLETION
, matched
[i
]);
1010 vty_redraw_line(vty
);
1012 case CMD_ERR_NOTHING_TODO
:
1014 vty_redraw_line(vty
);
1020 XFREE(MTYPE_TMP
, matched
);
1023 static void vty_describe_fold(struct vty
*vty
, int cmd_width
,
1024 unsigned int desc_width
, struct cmd_token
*token
)
1027 const char *cmd
, *p
;
1032 if (desc_width
<= 0) {
1033 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, token
->desc
);
1037 buf
= XCALLOC(MTYPE_TMP
, strlen(token
->desc
) + 1);
1039 for (p
= token
->desc
; strlen(p
) > desc_width
; p
+= pos
+ 1) {
1040 for (pos
= desc_width
; pos
> 0; pos
--)
1041 if (*(p
+ pos
) == ' ')
1047 strncpy(buf
, p
, pos
);
1049 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, buf
);
1054 vty_out(vty
, " %-*s %s\n", cmd_width
, cmd
, p
);
1056 XFREE(MTYPE_TMP
, buf
);
1059 /* Describe matched command function. */
1060 static void vty_describe_command(struct vty
*vty
)
1065 unsigned int i
, width
, desc_width
;
1066 struct cmd_token
*token
, *token_cr
= NULL
;
1068 vline
= cmd_make_strvec(vty
->buf
);
1070 /* In case of '> ?'. */
1071 if (vline
== NULL
) {
1072 vline
= vector_init(1);
1073 vector_set(vline
, NULL
);
1074 } else if (isspace((int)vty
->buf
[vty
->length
- 1]))
1075 vector_set(vline
, NULL
);
1077 describe
= cmd_describe_command(vline
, vty
, &ret
);
1081 /* Ambiguous error. */
1083 case CMD_ERR_AMBIGUOUS
:
1084 vty_out(vty
, "%% Ambiguous command.\n");
1087 case CMD_ERR_NO_MATCH
:
1088 vty_out(vty
, "%% There is no matched command.\n");
1093 /* Get width of command string. */
1095 for (i
= 0; i
< vector_active(describe
); i
++)
1096 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1099 if (token
->text
[0] == '\0')
1102 len
= strlen(token
->text
);
1108 /* Get width of description string. */
1109 desc_width
= vty
->width
- (width
+ 6);
1111 /* Print out description. */
1112 for (i
= 0; i
< vector_active(describe
); i
++)
1113 if ((token
= vector_slot(describe
, i
)) != NULL
) {
1114 if (token
->text
[0] == '\0')
1117 if (strcmp(token
->text
, CMD_CR_TEXT
) == 0) {
1123 vty_out(vty
, " %-s\n", token
->text
);
1124 else if (desc_width
>= strlen(token
->desc
))
1125 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1128 vty_describe_fold(vty
, width
, desc_width
,
1131 if (IS_VARYING_TOKEN(token
->type
)) {
1132 const char *ref
= vector_slot(
1133 vline
, vector_active(vline
) - 1);
1135 vector varcomps
= vector_init(VECTOR_MIN_SIZE
);
1136 cmd_variable_complete(token
, ref
, varcomps
);
1138 if (vector_active(varcomps
) > 0) {
1139 char *ac
= cmd_variable_comp2str(
1140 varcomps
, vty
->width
);
1141 vty_out(vty
, "%s\n", ac
);
1142 XFREE(MTYPE_TMP
, ac
);
1145 vector_free(varcomps
);
1148 vty_out (vty
, " %-*s %s\n", width
1149 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1150 desc
->str
? desc
->str
: "");
1154 if ((token
= token_cr
)) {
1156 vty_out(vty
, " %-s\n", token
->text
);
1157 else if (desc_width
>= strlen(token
->desc
))
1158 vty_out(vty
, " %-*s %s\n", width
, token
->text
,
1161 vty_describe_fold(vty
, width
, desc_width
, token
);
1165 cmd_free_strvec(vline
);
1167 vector_free(describe
);
1170 vty_redraw_line(vty
);
1173 static void vty_clear_buf(struct vty
*vty
)
1175 memset(vty
->buf
, 0, vty
->max
);
1178 /* ^C stop current input and do not add command line to the history. */
1179 static void vty_stop_input(struct vty
*vty
)
1181 vty
->cp
= vty
->length
= 0;
1185 switch (vty
->node
) {
1188 /* Nothing to do. */
1191 case INTERFACE_NODE
:
1205 case LDP_IPV4_IFACE_NODE
:
1206 case LDP_IPV6_IFACE_NODE
:
1207 case LDP_L2VPN_NODE
:
1208 case LDP_PSEUDOWIRE_NODE
:
1211 case KEYCHAIN_KEY_NODE
:
1213 vty_config_unlock(vty
);
1214 vty
->node
= ENABLE_NODE
;
1217 /* Unknown node, we have to ignore it. */
1222 /* Set history pointer to the latest one. */
1223 vty
->hp
= vty
->hindex
;
1226 /* Add current command line to the history buffer. */
1227 static void vty_hist_add(struct vty
*vty
)
1231 if (vty
->length
== 0)
1234 index
= vty
->hindex
? vty
->hindex
- 1 : VTY_MAXHIST
- 1;
1236 /* Ignore the same string as previous one. */
1237 if (vty
->hist
[index
])
1238 if (strcmp(vty
->buf
, vty
->hist
[index
]) == 0) {
1239 vty
->hp
= vty
->hindex
;
1243 /* Insert history entry. */
1244 if (vty
->hist
[vty
->hindex
])
1245 XFREE(MTYPE_VTY_HIST
, vty
->hist
[vty
->hindex
]);
1246 vty
->hist
[vty
->hindex
] = XSTRDUP(MTYPE_VTY_HIST
, vty
->buf
);
1248 /* History index rotation. */
1250 if (vty
->hindex
== VTY_MAXHIST
)
1253 vty
->hp
= vty
->hindex
;
1256 /* #define TELNET_OPTION_DEBUG */
1258 /* Get telnet window size. */
1259 static int vty_telnet_option(struct vty
*vty
, unsigned char *buf
, int nbytes
)
1261 #ifdef TELNET_OPTION_DEBUG
1264 for (i
= 0; i
< nbytes
; i
++) {
1267 vty_out(vty
, "IAC ");
1270 vty_out(vty
, "WILL ");
1273 vty_out(vty
, "WONT ");
1276 vty_out(vty
, "DO ");
1279 vty_out(vty
, "DONT ");
1282 vty_out(vty
, "SB ");
1285 vty_out(vty
, "SE ");
1288 vty_out(vty
, "TELOPT_ECHO \n");
1291 vty_out(vty
, "TELOPT_SGA \n");
1294 vty_out(vty
, "TELOPT_NAWS \n");
1297 vty_out(vty
, "%x ", buf
[i
]);
1303 #endif /* TELNET_OPTION_DEBUG */
1308 vty
->iac_sb_in_progress
= 1;
1312 if (!vty
->iac_sb_in_progress
)
1315 if ((vty
->sb_len
== 0) || (vty
->sb_buf
[0] == '\0')) {
1316 vty
->iac_sb_in_progress
= 0;
1319 switch (vty
->sb_buf
[0]) {
1321 if (vty
->sb_len
!= TELNET_NAWS_SB_LEN
)
1323 "RFC 1073 violation detected: telnet NAWS option "
1324 "should send %d characters, but we received %lu",
1326 (unsigned long)vty
->sb_len
);
1327 else if (sizeof(vty
->sb_buf
) < TELNET_NAWS_SB_LEN
)
1329 "Bug detected: sizeof(vty->sb_buf) %lu < %d, "
1330 "too small to handle the telnet NAWS option",
1331 (unsigned long)sizeof(vty
->sb_buf
),
1332 TELNET_NAWS_SB_LEN
);
1334 vty
->width
= ((vty
->sb_buf
[1] << 8)
1336 vty
->height
= ((vty
->sb_buf
[3] << 8)
1338 #ifdef TELNET_OPTION_DEBUG
1340 "TELNET NAWS window size negotiation completed: "
1341 "width %d, height %d\n",
1342 vty
->width
, vty
->height
);
1347 vty
->iac_sb_in_progress
= 0;
1357 /* Execute current command line. */
1358 static int vty_execute(struct vty
*vty
)
1364 switch (vty
->node
) {
1366 case AUTH_ENABLE_NODE
:
1367 vty_auth(vty
, vty
->buf
);
1370 ret
= vty_command(vty
, vty
->buf
);
1371 if (vty
->type
== VTY_TERM
)
1376 /* Clear command line buffer. */
1377 vty
->cp
= vty
->length
= 0;
1380 if (vty
->status
!= VTY_CLOSE
)
1386 #define CONTROL(X) ((X) - '@')
1387 #define VTY_NORMAL 0
1388 #define VTY_PRE_ESCAPE 1
1389 #define VTY_ESCAPE 2
1391 /* Escape character command map. */
1392 static void vty_escape_map(unsigned char c
, struct vty
*vty
)
1396 vty_previous_line(vty
);
1402 vty_forward_char(vty
);
1405 vty_backward_char(vty
);
1411 /* Go back to normal mode. */
1412 vty
->escape
= VTY_NORMAL
;
1415 /* Quit print out to the buffer. */
1416 static void vty_buffer_reset(struct vty
*vty
)
1418 buffer_reset(vty
->obuf
);
1419 buffer_reset(vty
->lbuf
);
1421 vty_redraw_line(vty
);
1424 /* Read data via vty socket. */
1425 static int vty_read(struct thread
*thread
)
1429 unsigned char buf
[VTY_READ_BUFSIZ
];
1431 int vty_sock
= THREAD_FD(thread
);
1432 struct vty
*vty
= THREAD_ARG(thread
);
1435 /* Read raw data from socket */
1436 if ((nbytes
= read(vty
->fd
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
1438 if (ERRNO_IO_RETRY(errno
)) {
1439 vty_event(VTY_READ
, vty_sock
, vty
);
1442 vty
->monitor
= 0; /* disable monitoring to avoid
1443 infinite recursion */
1445 "%s: read error on vty client fd %d, closing: %s",
1446 __func__
, vty
->fd
, safe_strerror(errno
));
1447 buffer_reset(vty
->obuf
);
1448 buffer_reset(vty
->lbuf
);
1450 vty
->status
= VTY_CLOSE
;
1453 for (i
= 0; i
< nbytes
; i
++) {
1454 if (buf
[i
] == IAC
) {
1463 if (vty
->iac_sb_in_progress
&& !vty
->iac
) {
1464 if (vty
->sb_len
< sizeof(vty
->sb_buf
))
1465 vty
->sb_buf
[vty
->sb_len
] = buf
[i
];
1471 /* In case of telnet command */
1473 ret
= vty_telnet_option(vty
, buf
+ i
, nbytes
- i
);
1480 if (vty
->status
== VTY_MORE
) {
1485 vty_buffer_reset(vty
);
1487 #if 0 /* More line does not work for "show ip bgp". */
1490 vty
->status
= VTY_MORELINE
;
1499 /* Escape character. */
1500 if (vty
->escape
== VTY_ESCAPE
) {
1501 vty_escape_map(buf
[i
], vty
);
1505 /* Pre-escape status. */
1506 if (vty
->escape
== VTY_PRE_ESCAPE
) {
1509 vty
->escape
= VTY_ESCAPE
;
1512 vty_backward_word(vty
);
1513 vty
->escape
= VTY_NORMAL
;
1516 vty_forward_word(vty
);
1517 vty
->escape
= VTY_NORMAL
;
1520 vty_forward_kill_word(vty
);
1521 vty
->escape
= VTY_NORMAL
;
1525 vty_backward_kill_word(vty
);
1526 vty
->escape
= VTY_NORMAL
;
1529 vty
->escape
= VTY_NORMAL
;
1537 vty_beginning_of_line(vty
);
1540 vty_backward_char(vty
);
1543 vty_stop_input(vty
);
1546 vty_delete_char(vty
);
1549 vty_end_of_line(vty
);
1552 vty_forward_char(vty
);
1556 vty_delete_backward_char(vty
);
1565 vty_previous_line(vty
);
1568 vty_transpose_chars(vty
);
1571 vty_kill_line_from_beginning(vty
);
1574 vty_backward_kill_word(vty
);
1577 vty_end_config(vty
);
1585 vty_complete_command(vty
);
1588 if (vty
->node
== AUTH_NODE
1589 || vty
->node
== AUTH_ENABLE_NODE
)
1590 vty_self_insert(vty
, buf
[i
]);
1592 vty_describe_command(vty
);
1595 if (i
+ 1 < nbytes
&& buf
[i
+ 1] == '[') {
1596 vty
->escape
= VTY_ESCAPE
;
1599 vty
->escape
= VTY_PRE_ESCAPE
;
1602 if (buf
[i
] > 31 && buf
[i
] < 127)
1603 vty_self_insert(vty
, buf
[i
]);
1609 if (vty
->status
== VTY_CLOSE
)
1612 vty_event(VTY_WRITE
, vty
->wfd
, vty
);
1613 vty_event(VTY_READ
, vty_sock
, vty
);
1618 /* Flush buffer to the vty. */
1619 static int vty_flush(struct thread
*thread
)
1622 buffer_status_t flushrc
;
1623 int vty_sock
= THREAD_FD(thread
);
1624 struct vty
*vty
= THREAD_ARG(thread
);
1626 vty
->t_write
= NULL
;
1628 /* Tempolary disable read thread. */
1629 if ((vty
->lines
== 0) && vty
->t_read
) {
1630 thread_cancel(vty
->t_read
);
1634 /* Function execution continue. */
1635 erase
= ((vty
->status
== VTY_MORE
|| vty
->status
== VTY_MORELINE
));
1637 /* N.B. if width is 0, that means we don't know the window size. */
1638 if ((vty
->lines
== 0) || (vty
->width
== 0) || (vty
->height
== 0))
1639 flushrc
= buffer_flush_available(vty
->obuf
, vty_sock
);
1640 else if (vty
->status
== VTY_MORELINE
)
1641 flushrc
= buffer_flush_window(vty
->obuf
, vty_sock
, vty
->width
,
1644 flushrc
= buffer_flush_window(
1645 vty
->obuf
, vty_sock
, vty
->width
,
1646 vty
->lines
>= 0 ? vty
->lines
: vty
->height
, erase
, 0);
1650 0; /* disable monitoring to avoid infinite recursion */
1651 zlog_warn("buffer_flush failed on vty client fd %d, closing",
1653 buffer_reset(vty
->lbuf
);
1654 buffer_reset(vty
->obuf
);
1658 if (vty
->status
== VTY_CLOSE
)
1661 vty
->status
= VTY_NORMAL
;
1662 if (vty
->lines
== 0)
1663 vty_event(VTY_READ
, vty_sock
, vty
);
1666 case BUFFER_PENDING
:
1667 /* There is more data waiting to be written. */
1668 vty
->status
= VTY_MORE
;
1669 if (vty
->lines
== 0)
1670 vty_event(VTY_WRITE
, vty_sock
, vty
);
1677 /* Allocate new vty struct. */
1678 struct vty
*vty_new()
1680 struct vty
*new = XCALLOC(MTYPE_VTY
, sizeof(struct vty
));
1682 new->fd
= new->wfd
= -1;
1684 new->lbuf
= buffer_new(0);
1685 new->obuf
= buffer_new(0); /* Use default buffer size. */
1686 new->buf
= XCALLOC(MTYPE_VTY
, VTY_BUFSIZ
);
1687 new->error_buf
= XCALLOC(MTYPE_VTY
, VTY_BUFSIZ
);
1688 new->max
= VTY_BUFSIZ
;
1694 /* allocate and initialise vty */
1695 static struct vty
*vty_new_init(int vty_sock
)
1701 vty
->wfd
= vty_sock
;
1702 vty
->type
= VTY_TERM
;
1703 vty
->node
= AUTH_NODE
;
1708 memset(vty
->hist
, 0, sizeof(vty
->hist
));
1711 vector_set_index(vtyvec
, vty_sock
, vty
);
1712 vty
->status
= VTY_NORMAL
;
1715 vty
->iac_sb_in_progress
= 0;
1721 /* Create new vty structure. */
1722 static struct vty
*vty_create(int vty_sock
, union sockunion
*su
)
1724 char buf
[SU_ADDRSTRLEN
];
1727 sockunion2str(su
, buf
, SU_ADDRSTRLEN
);
1729 /* Allocate new vty structure and set up default values. */
1730 vty
= vty_new_init(vty_sock
);
1732 /* configurable parameters not part of basic init */
1733 vty
->v_timeout
= vty_timeout_val
;
1734 strcpy(vty
->address
, buf
);
1735 if (no_password_check
) {
1737 vty
->node
= ENABLE_NODE
;
1739 vty
->node
= VIEW_NODE
;
1741 if (host
.lines
>= 0)
1742 vty
->lines
= host
.lines
;
1744 if (!no_password_check
) {
1745 /* Vty is not available if password isn't set. */
1746 if (host
.password
== NULL
&& host
.password_encrypt
== NULL
) {
1747 vty_out(vty
, "Vty password is not set.\n");
1748 vty
->status
= VTY_CLOSE
;
1754 /* Say hello to the world. */
1756 if (!no_password_check
)
1757 vty_out(vty
, "\nUser Access Verification\n\n");
1759 /* Setting up terminal. */
1761 vty_will_suppress_go_ahead(vty
);
1763 vty_dont_linemode(vty
);
1764 vty_do_window_size(vty
);
1765 /* vty_dont_lflow_ahead (vty); */
1769 /* Add read/write thread. */
1770 vty_event(VTY_WRITE
, vty_sock
, vty
);
1771 vty_event(VTY_READ
, vty_sock
, vty
);
1776 /* create vty for stdio */
1777 static struct termios stdio_orig_termios
;
1778 static struct vty
*stdio_vty
= NULL
;
1779 static bool stdio_termios
= false;
1780 static void (*stdio_vty_atclose
)(int isexit
);
1782 static void vty_stdio_reset(int isexit
)
1786 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1787 stdio_termios
= false;
1791 if (stdio_vty_atclose
)
1792 stdio_vty_atclose(isexit
);
1793 stdio_vty_atclose
= NULL
;
1797 static void vty_stdio_atexit(void)
1802 void vty_stdio_suspend(void)
1807 if (stdio_vty
->t_write
)
1808 thread_cancel(stdio_vty
->t_write
);
1809 if (stdio_vty
->t_read
)
1810 thread_cancel(stdio_vty
->t_read
);
1811 if (stdio_vty
->t_timeout
)
1812 thread_cancel(stdio_vty
->t_timeout
);
1815 tcsetattr(0, TCSANOW
, &stdio_orig_termios
);
1816 stdio_termios
= false;
1819 void vty_stdio_resume(void)
1824 if (!tcgetattr(0, &stdio_orig_termios
)) {
1825 struct termios termios
;
1827 termios
= stdio_orig_termios
;
1828 termios
.c_iflag
&= ~(IGNBRK
| BRKINT
| PARMRK
| ISTRIP
| INLCR
1829 | IGNCR
| ICRNL
| IXON
);
1830 termios
.c_oflag
&= ~OPOST
;
1831 termios
.c_lflag
&= ~(ECHO
| ECHONL
| ICANON
| IEXTEN
);
1832 termios
.c_cflag
&= ~(CSIZE
| PARENB
);
1833 termios
.c_cflag
|= CS8
;
1834 tcsetattr(0, TCSANOW
, &termios
);
1835 stdio_termios
= true;
1838 vty_prompt(stdio_vty
);
1840 /* Add read/write thread. */
1841 vty_event(VTY_WRITE
, 1, stdio_vty
);
1842 vty_event(VTY_READ
, 0, stdio_vty
);
1845 void vty_stdio_close(void)
1849 vty_close(stdio_vty
);
1852 struct vty
*vty_stdio(void (*atclose
)(int isexit
))
1856 /* refuse creating two vtys on stdio */
1860 vty
= stdio_vty
= vty_new_init(0);
1861 stdio_vty_atclose
= atclose
;
1864 /* always have stdio vty in a known _unchangeable_ state, don't want
1866 * to have any effect here to make sure scripting this works as intended
1868 vty
->node
= ENABLE_NODE
;
1870 strcpy(vty
->address
, "console");
1876 /* Accept connection from the network. */
1877 static int vty_accept(struct thread
*thread
)
1885 struct access_list
*acl
= NULL
;
1886 char buf
[SU_ADDRSTRLEN
];
1888 accept_sock
= THREAD_FD(thread
);
1890 /* We continue hearing vty socket. */
1891 vty_event(VTY_SERV
, accept_sock
, NULL
);
1893 memset(&su
, 0, sizeof(union sockunion
));
1895 /* We can handle IPv4 or IPv6 socket. */
1896 vty_sock
= sockunion_accept(accept_sock
, &su
);
1898 zlog_warn("can't accept vty socket : %s", safe_strerror(errno
));
1901 set_nonblocking(vty_sock
);
1902 set_cloexec(vty_sock
);
1904 sockunion2hostprefix(&su
, &p
);
1906 /* VTY's accesslist apply. */
1907 if (p
.family
== AF_INET
&& vty_accesslist_name
) {
1908 if ((acl
= access_list_lookup(AFI_IP
, vty_accesslist_name
))
1909 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1910 zlog_info("Vty connection refused from %s",
1911 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1914 /* continue accepting connections */
1915 vty_event(VTY_SERV
, accept_sock
, NULL
);
1921 /* VTY's ipv6 accesslist apply. */
1922 if (p
.family
== AF_INET6
&& vty_ipv6_accesslist_name
) {
1923 if ((acl
= access_list_lookup(AFI_IP6
,
1924 vty_ipv6_accesslist_name
))
1925 && (access_list_apply(acl
, &p
) == FILTER_DENY
)) {
1926 zlog_info("Vty connection refused from %s",
1927 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1930 /* continue accepting connections */
1931 vty_event(VTY_SERV
, accept_sock
, NULL
);
1938 ret
= setsockopt(vty_sock
, IPPROTO_TCP
, TCP_NODELAY
, (char *)&on
,
1941 zlog_info("can't set sockopt to vty_sock : %s",
1942 safe_strerror(errno
));
1944 zlog_info("Vty connection from %s",
1945 sockunion2str(&su
, buf
, SU_ADDRSTRLEN
));
1947 vty_create(vty_sock
, &su
);
1952 static void vty_serv_sock_addrinfo(const char *hostname
, unsigned short port
)
1955 struct addrinfo req
;
1956 struct addrinfo
*ainfo
;
1957 struct addrinfo
*ainfo_save
;
1959 char port_str
[BUFSIZ
];
1961 memset(&req
, 0, sizeof(struct addrinfo
));
1962 req
.ai_flags
= AI_PASSIVE
;
1963 req
.ai_family
= AF_UNSPEC
;
1964 req
.ai_socktype
= SOCK_STREAM
;
1965 sprintf(port_str
, "%d", port
);
1966 port_str
[sizeof(port_str
) - 1] = '\0';
1968 ret
= getaddrinfo(hostname
, port_str
, &req
, &ainfo
);
1971 zlog_err("getaddrinfo failed: %s", gai_strerror(ret
));
1978 if (ainfo
->ai_family
!= AF_INET
&& ainfo
->ai_family
!= AF_INET6
)
1981 sock
= socket(ainfo
->ai_family
, ainfo
->ai_socktype
,
1982 ainfo
->ai_protocol
);
1986 sockopt_v6only(ainfo
->ai_family
, sock
);
1987 sockopt_reuseaddr(sock
);
1988 sockopt_reuseport(sock
);
1991 ret
= bind(sock
, ainfo
->ai_addr
, ainfo
->ai_addrlen
);
1993 close(sock
); /* Avoid sd leak. */
1997 ret
= listen(sock
, 3);
1999 close(sock
); /* Avoid sd leak. */
2003 vty_event(VTY_SERV
, sock
, NULL
);
2004 } while ((ainfo
= ainfo
->ai_next
) != NULL
);
2006 freeaddrinfo(ainfo_save
);
2010 /* For sockaddr_un. */
2013 /* VTY shell UNIX domain socket. */
2014 static void vty_serv_un(const char *path
)
2018 struct sockaddr_un serv
;
2020 struct zprivs_ids_t ids
;
2022 /* First of all, unlink existing socket */
2026 old_mask
= umask(0007);
2028 /* Make UNIX domain socket. */
2029 sock
= socket(AF_UNIX
, SOCK_STREAM
, 0);
2031 zlog_err("Cannot create unix stream socket: %s",
2032 safe_strerror(errno
));
2036 /* Make server socket. */
2037 memset(&serv
, 0, sizeof(struct sockaddr_un
));
2038 serv
.sun_family
= AF_UNIX
;
2039 strlcpy(serv
.sun_path
, path
, sizeof(serv
.sun_path
));
2040 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
2041 len
= serv
.sun_len
= SUN_LEN(&serv
);
2043 len
= sizeof(serv
.sun_family
) + strlen(serv
.sun_path
);
2044 #endif /* HAVE_STRUCT_SOCKADDR_UN_SUN_LEN */
2048 ret
= bind(sock
, (struct sockaddr
*)&serv
, len
);
2050 zlog_err("Cannot bind path %s: %s", path
, safe_strerror(errno
));
2051 close(sock
); /* Avoid sd leak. */
2055 ret
= listen(sock
, 5);
2057 zlog_err("listen(fd %d) failed: %s", sock
,
2058 safe_strerror(errno
));
2059 close(sock
); /* Avoid sd leak. */
2065 zprivs_get_ids(&ids
);
2067 /* Hack: ids.gid_vty is actually a uint, but we stored -1 in it
2068 earlier for the case when we don't need to chown the file
2069 type casting it here to make a compare */
2070 if ((int)ids
.gid_vty
> 0) {
2071 /* set group of socket */
2072 if (chown(path
, -1, ids
.gid_vty
)) {
2073 zlog_err("vty_serv_un: could chown socket, %s",
2074 safe_strerror(errno
));
2078 vty_event(VTYSH_SERV
, sock
, NULL
);
2081 /* #define VTYSH_DEBUG 1 */
2083 static int vtysh_accept(struct thread
*thread
)
2088 struct sockaddr_un client
;
2091 accept_sock
= THREAD_FD(thread
);
2093 vty_event(VTYSH_SERV
, accept_sock
, NULL
);
2095 memset(&client
, 0, sizeof(struct sockaddr_un
));
2096 client_len
= sizeof(struct sockaddr_un
);
2098 sock
= accept(accept_sock
, (struct sockaddr
*)&client
,
2099 (socklen_t
*)&client_len
);
2102 zlog_warn("can't accept vty socket : %s", safe_strerror(errno
));
2106 if (set_nonblocking(sock
) < 0) {
2108 "vtysh_accept: could not set vty socket %d to non-blocking,"
2110 sock
, safe_strerror(errno
));
2117 printf("VTY shell accept\n");
2118 #endif /* VTYSH_DEBUG */
2123 vty
->type
= VTY_SHELL_SERV
;
2124 vty
->node
= VIEW_NODE
;
2126 vty_event(VTYSH_READ
, sock
, vty
);
2131 static int vtysh_flush(struct vty
*vty
)
2133 switch (buffer_flush_available(vty
->obuf
, vty
->wfd
)) {
2134 case BUFFER_PENDING
:
2135 vty_event(VTYSH_WRITE
, vty
->wfd
, vty
);
2139 0; /* disable monitoring to avoid infinite recursion */
2140 zlog_warn("%s: write error to fd %d, closing", __func__
,
2142 buffer_reset(vty
->lbuf
);
2143 buffer_reset(vty
->obuf
);
2153 static int vtysh_read(struct thread
*thread
)
2159 unsigned char buf
[VTY_READ_BUFSIZ
];
2161 uint8_t header
[4] = {0, 0, 0, 0};
2163 sock
= THREAD_FD(thread
);
2164 vty
= THREAD_ARG(thread
);
2167 if ((nbytes
= read(sock
, buf
, VTY_READ_BUFSIZ
)) <= 0) {
2169 if (ERRNO_IO_RETRY(errno
)) {
2170 vty_event(VTYSH_READ
, sock
, vty
);
2173 vty
->monitor
= 0; /* disable monitoring to avoid
2174 infinite recursion */
2176 "%s: read failed on vtysh client fd %d, closing: %s",
2177 __func__
, sock
, safe_strerror(errno
));
2179 buffer_reset(vty
->lbuf
);
2180 buffer_reset(vty
->obuf
);
2183 printf("close vtysh\n");
2184 #endif /* VTYSH_DEBUG */
2189 printf("line: %.*s\n", nbytes
, buf
);
2190 #endif /* VTYSH_DEBUG */
2192 if (vty
->length
+ nbytes
>= VTY_BUFSIZ
) {
2193 /* Clear command line buffer. */
2194 vty
->cp
= vty
->length
= 0;
2196 vty_out(vty
, "%% Command is too long.\n");
2198 for (p
= buf
; p
< buf
+ nbytes
; p
++) {
2199 vty
->buf
[vty
->length
++] = *p
;
2201 /* Pass this line to parser. */
2202 ret
= vty_execute(vty
);
2203 /* Note that vty_execute clears the command buffer and resets
2204 vty->length to 0. */
2206 /* Return result. */
2208 printf("result: %d\n", ret
);
2209 printf("vtysh node: %d\n", vty
->node
);
2210 #endif /* VTYSH_DEBUG */
2212 /* hack for asynchronous "write integrated"
2213 * - other commands in "buf" will be ditched
2214 * - input during pending config-write is
2216 if (ret
== CMD_SUSPEND
)
2219 /* warning: watchfrr hardcodes this result write
2222 buffer_put(vty
->obuf
, header
, 4);
2224 if (!vty
->t_write
&& (vtysh_flush(vty
) < 0))
2225 /* Try to flush results; exit if a write
2232 if (vty
->status
== VTY_CLOSE
)
2235 vty_event(VTYSH_READ
, sock
, vty
);
2240 static int vtysh_write(struct thread
*thread
)
2242 struct vty
*vty
= THREAD_ARG(thread
);
2244 vty
->t_write
= NULL
;
2251 /* Determine address family to bind. */
2252 void vty_serv_sock(const char *addr
, unsigned short port
, const char *path
)
2254 /* If port is set to 0, do not listen on TCP/IP at all! */
2256 vty_serv_sock_addrinfo(addr
, port
);
2263 /* Close vty interface. Warning: call this only from functions that
2264 will be careful not to access the vty afterwards (since it has
2265 now been freed). This is safest from top-level functions (called
2266 directly by the thread dispatcher). */
2267 void vty_close(struct vty
*vty
)
2270 bool was_stdio
= false;
2272 /* Cancel threads.*/
2274 thread_cancel(vty
->t_read
);
2276 thread_cancel(vty
->t_write
);
2278 thread_cancel(vty
->t_timeout
);
2281 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2283 /* Free input buffer. */
2284 buffer_free(vty
->obuf
);
2285 buffer_free(vty
->lbuf
);
2287 /* Free command history. */
2288 for (i
= 0; i
< VTY_MAXHIST
; i
++)
2290 XFREE(MTYPE_VTY_HIST
, vty
->hist
[i
]);
2294 vector_unset(vtyvec
, vty
->fd
);
2296 if (vty
->wfd
> 0 && vty
->type
== VTY_FILE
)
2300 * note check is for fd > STDERR_FILENO, not fd != -1.
2301 * We never close stdin/stdout/stderr here, because we may be
2302 * running in foreground mode with logging to stdout. Also,
2303 * additionally, we'd need to replace these fds with /dev/null. */
2304 if (vty
->wfd
> STDERR_FILENO
&& vty
->wfd
!= vty
->fd
)
2306 if (vty
->fd
> STDERR_FILENO
) {
2312 XFREE(MTYPE_VTY
, vty
->buf
);
2315 XFREE(MTYPE_VTY
, vty
->error_buf
);
2317 /* Check configure. */
2318 vty_config_unlock(vty
);
2321 XFREE(MTYPE_VTY
, vty
);
2327 /* When time out occur output message then close connection. */
2328 static int vty_timeout(struct thread
*thread
)
2332 vty
= THREAD_ARG(thread
);
2333 vty
->t_timeout
= NULL
;
2337 buffer_reset(vty
->lbuf
);
2338 buffer_reset(vty
->obuf
);
2339 vty_out(vty
, "\nVty connection is timed out.\n");
2341 /* Close connection. */
2342 vty
->status
= VTY_CLOSE
;
2348 /* Read up configuration file from file_name. */
2349 static void vty_read_file(FILE *confp
)
2353 unsigned int line_num
= 0;
2356 /* vty_close won't close stderr; if some config command prints
2357 * something it'll end up there. (not ideal; it'd be beter if output
2358 * from a file-load went to logging instead. Also note that if this
2359 * function is called after daemonizing, stderr will be /dev/null.)
2361 * vty->fd will be -1 from vty_new()
2363 vty
->wfd
= STDERR_FILENO
;
2364 vty
->type
= VTY_FILE
;
2365 vty
->node
= CONFIG_NODE
;
2367 /* Execute configuration file */
2368 ret
= config_from_file(vty
, confp
, &line_num
);
2370 /* Flush any previous errors before printing messages below */
2371 buffer_flush_all(vty
->obuf
, vty
->wfd
);
2373 if (!((ret
== CMD_SUCCESS
) || (ret
== CMD_ERR_NOTHING_TODO
))) {
2374 const char *message
= NULL
;
2378 case CMD_ERR_AMBIGUOUS
:
2379 message
= "Ambiguous command";
2381 case CMD_ERR_NO_MATCH
:
2382 message
= "No such command";
2385 message
= "Command returned Warning";
2387 case CMD_WARNING_CONFIG_FAILED
:
2388 message
= "Command returned Warning Config Failed";
2390 case CMD_ERR_INCOMPLETE
:
2391 message
= "Command returned Incomplete";
2393 case CMD_ERR_EXEED_ARGC_MAX
:
2395 "Command exceeded maximum number of Arguments";
2398 message
= "Command returned unhandled error message";
2402 nl
= strchr(vty
->error_buf
, '\n');
2405 zlog_err("ERROR: %s on config line %u: %s", message
, line_num
,
2412 static FILE *vty_use_backup_config(const char *fullpath
)
2414 char *fullpath_sav
, *fullpath_tmp
;
2420 fullpath_sav
= malloc(strlen(fullpath
) + strlen(CONF_BACKUP_EXT
) + 1);
2421 strcpy(fullpath_sav
, fullpath
);
2422 strcat(fullpath_sav
, CONF_BACKUP_EXT
);
2424 sav
= open(fullpath_sav
, O_RDONLY
);
2430 fullpath_tmp
= malloc(strlen(fullpath
) + 8);
2431 sprintf(fullpath_tmp
, "%s.XXXXXX", fullpath
);
2433 /* Open file to configuration write. */
2434 tmp
= mkstemp(fullpath_tmp
);
2438 if (fchmod(tmp
, CONFIGFILE_MASK
) != 0)
2441 while ((c
= read(sav
, buffer
, 512)) > 0) {
2442 if (write(tmp
, buffer
, c
) <= 0)
2448 if (rename(fullpath_tmp
, fullpath
) == 0)
2449 ret
= fopen(fullpath
, "r");
2451 unlink(fullpath_tmp
);
2456 unlink(fullpath_tmp
);
2466 /* Read up configuration file from file_name. */
2467 bool vty_read_config(const char *config_file
, char *config_default_dir
)
2469 char cwd
[MAXPATHLEN
];
2471 const char *fullpath
;
2473 bool read_success
= false;
2475 /* If -f flag specified. */
2476 if (config_file
!= NULL
) {
2477 if (!IS_DIRECTORY_SEP(config_file
[0])) {
2478 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
2480 "Failure to determine Current Working Directory %d!",
2484 tmp
= XMALLOC(MTYPE_TMP
,
2485 strlen(cwd
) + strlen(config_file
) + 2);
2486 sprintf(tmp
, "%s/%s", cwd
, config_file
);
2489 fullpath
= config_file
;
2491 confp
= fopen(fullpath
, "r");
2493 if (confp
== NULL
) {
2494 zlog_err("%s: failed to open configuration file %s: %s",
2495 __func__
, fullpath
, safe_strerror(errno
));
2497 confp
= vty_use_backup_config(fullpath
);
2500 "WARNING: using backup configuration file!");
2502 zlog_err("can't open configuration file [%s]",
2509 host_config_set(config_default_dir
);
2513 struct stat conf_stat
;
2515 /* !!!!PLEASE LEAVE!!!!
2516 * This is NEEDED for use with vtysh -b, or else you can get
2517 * a real configuration food fight with a lot garbage in the
2518 * merged configuration file it creates coming from the per
2519 * daemon configuration files. This also allows the daemons
2520 * to start if there default configuration file is not
2521 * present or ignore them, as needed when using vtysh -b to
2522 * configure the daemons at boot - MAG
2525 /* Stat for vtysh Zebra.conf, if found startup and wait for
2526 * boot configuration
2529 if (strstr(config_default_dir
, "vtysh") == NULL
) {
2530 ret
= stat(integrate_default
, &conf_stat
);
2532 read_success
= true;
2533 goto tmp_free_and_out
;
2537 confp
= fopen(config_default_dir
, "r");
2538 if (confp
== NULL
) {
2539 zlog_err("%s: failed to open configuration file %s: %s",
2540 __func__
, config_default_dir
,
2541 safe_strerror(errno
));
2543 confp
= vty_use_backup_config(config_default_dir
);
2546 "WARNING: using backup configuration file!");
2547 fullpath
= config_default_dir
;
2549 zlog_err("can't open configuration file [%s]",
2550 config_default_dir
);
2551 goto tmp_free_and_out
;
2554 fullpath
= config_default_dir
;
2557 vty_read_file(confp
);
2558 read_success
= true;
2562 host_config_set(fullpath
);
2566 XFREE(MTYPE_TMP
, tmp
);
2568 return read_success
;
2571 /* Small utility function which output log to the VTY. */
2572 void vty_log(const char *level
, const char *proto_str
, const char *format
,
2573 struct timestamp_control
*ctl
, va_list va
)
2581 for (i
= 0; i
< vector_active(vtyvec
); i
++)
2582 if ((vty
= vector_slot(vtyvec
, i
)) != NULL
)
2586 vty_log_out(vty
, level
, proto_str
, format
, ctl
,
2592 /* Async-signal-safe version of vty_log for fixed strings. */
2593 void vty_log_fixed(char *buf
, size_t len
)
2596 struct iovec iov
[2];
2597 char crlf
[4] = "\r\n";
2599 /* vty may not have been initialised */
2603 iov
[0].iov_base
= buf
;
2604 iov
[0].iov_len
= len
;
2605 iov
[1].iov_base
= crlf
;
2608 for (i
= 0; i
< vector_active(vtyvec
); i
++) {
2610 if (((vty
= vector_slot(vtyvec
, i
)) != NULL
) && vty
->monitor
)
2611 /* N.B. We don't care about the return code, since
2613 most likely just about to die anyway. */
2614 if (writev(vty
->wfd
, iov
, 2) == -1) {
2615 fprintf(stderr
, "Failure to writev: %d\n",
2622 int vty_config_lock(struct vty
*vty
)
2624 if (vty_config_is_lockless
)
2626 if (vty_config
== 0) {
2633 int vty_config_unlock(struct vty
*vty
)
2635 if (vty_config_is_lockless
)
2637 if (vty_config
== 1 && vty
->config
== 1) {
2644 void vty_config_lockless(void)
2646 vty_config_is_lockless
= 1;
2649 /* Master of the threads. */
2650 static struct thread_master
*vty_master
;
2652 static void vty_event(enum event event
, int sock
, struct vty
*vty
)
2654 struct thread
*vty_serv_thread
= NULL
;
2658 vty_serv_thread
= thread_add_read(vty_master
, vty_accept
, vty
,
2660 vector_set_index(Vvty_serv_thread
, sock
, vty_serv_thread
);
2664 vty_serv_thread
= thread_add_read(vty_master
, vtysh_accept
, vty
,
2666 vector_set_index(Vvty_serv_thread
, sock
, vty_serv_thread
);
2670 thread_add_read(vty_master
, vtysh_read
, vty
, sock
,
2674 vty
->t_write
= NULL
;
2675 thread_add_write(vty_master
, vtysh_write
, vty
, sock
,
2681 thread_add_read(vty_master
, vty_read
, vty
, sock
, &vty
->t_read
);
2683 /* Time out treatment. */
2684 if (vty
->v_timeout
) {
2686 thread_cancel(vty
->t_timeout
);
2687 vty
->t_timeout
= NULL
;
2688 thread_add_timer(vty_master
, vty_timeout
, vty
,
2689 vty
->v_timeout
, &vty
->t_timeout
);
2693 thread_add_write(vty_master
, vty_flush
, vty
, sock
,
2696 case VTY_TIMEOUT_RESET
:
2697 if (vty
->t_timeout
) {
2698 thread_cancel(vty
->t_timeout
);
2699 vty
->t_timeout
= NULL
;
2701 if (vty
->v_timeout
) {
2702 vty
->t_timeout
= NULL
;
2703 thread_add_timer(vty_master
, vty_timeout
, vty
,
2704 vty
->v_timeout
, &vty
->t_timeout
);
2710 DEFUN_NOSH (config_who
,
2713 "Display who is on vty\n")
2718 for (i
= 0; i
< vector_active(vtyvec
); i
++)
2719 if ((v
= vector_slot(vtyvec
, i
)) != NULL
)
2720 vty_out(vty
, "%svty[%d] connected from %s.\n",
2721 v
->config
? "*" : " ", i
, v
->address
);
2725 /* Move to vty configuration mode. */
2726 DEFUN_NOSH (line_vty
,
2729 "Configure a terminal line\n"
2730 "Virtual terminal\n")
2732 vty
->node
= VTY_NODE
;
2736 /* Set time out value. */
2737 static int exec_timeout(struct vty
*vty
, const char *min_str
,
2738 const char *sec_str
)
2740 unsigned long timeout
= 0;
2742 /* min_str and sec_str are already checked by parser. So it must be
2743 all digit string. */
2745 timeout
= strtol(min_str
, NULL
, 10);
2749 timeout
+= strtol(sec_str
, NULL
, 10);
2751 vty_timeout_val
= timeout
;
2752 vty
->v_timeout
= timeout
;
2753 vty_event(VTY_TIMEOUT_RESET
, 0, vty
);
2759 DEFUN (exec_timeout_min
,
2760 exec_timeout_min_cmd
,
2761 "exec-timeout (0-35791)",
2762 "Set timeout value\n"
2763 "Timeout value in minutes\n")
2766 return exec_timeout(vty
, argv
[idx_number
]->arg
, NULL
);
2769 DEFUN (exec_timeout_sec
,
2770 exec_timeout_sec_cmd
,
2771 "exec-timeout (0-35791) (0-2147483)",
2772 "Set the EXEC timeout\n"
2773 "Timeout in minutes\n"
2774 "Timeout in seconds\n")
2777 int idx_number_2
= 2;
2778 return exec_timeout(vty
, argv
[idx_number
]->arg
,
2779 argv
[idx_number_2
]->arg
);
2782 DEFUN (no_exec_timeout
,
2783 no_exec_timeout_cmd
,
2786 "Set the EXEC timeout\n")
2788 return exec_timeout(vty
, NULL
, NULL
);
2791 /* Set vty access class. */
2792 DEFUN (vty_access_class
,
2793 vty_access_class_cmd
,
2794 "access-class WORD",
2795 "Filter connections based on an IP access list\n"
2799 if (vty_accesslist_name
)
2800 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2802 vty_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2807 /* Clear vty access class. */
2808 DEFUN (no_vty_access_class
,
2809 no_vty_access_class_cmd
,
2810 "no access-class [WORD]",
2812 "Filter connections based on an IP access list\n"
2816 const char *accesslist
= (argc
== 3) ? argv
[idx_word
]->arg
: NULL
;
2817 if (!vty_accesslist_name
2818 || (argc
== 3 && strcmp(vty_accesslist_name
, accesslist
))) {
2819 vty_out(vty
, "Access-class is not currently applied to vty\n");
2820 return CMD_WARNING_CONFIG_FAILED
;
2823 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2825 vty_accesslist_name
= NULL
;
2830 /* Set vty access class. */
2831 DEFUN (vty_ipv6_access_class
,
2832 vty_ipv6_access_class_cmd
,
2833 "ipv6 access-class WORD",
2835 "Filter connections based on an IP access list\n"
2836 "IPv6 access list\n")
2839 if (vty_ipv6_accesslist_name
)
2840 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2842 vty_ipv6_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[idx_word
]->arg
);
2847 /* Clear vty access class. */
2848 DEFUN (no_vty_ipv6_access_class
,
2849 no_vty_ipv6_access_class_cmd
,
2850 "no ipv6 access-class [WORD]",
2853 "Filter connections based on an IP access list\n"
2854 "IPv6 access list\n")
2857 const char *accesslist
= (argc
== 4) ? argv
[idx_word
]->arg
: NULL
;
2859 if (!vty_ipv6_accesslist_name
2860 || (argc
== 4 && strcmp(vty_ipv6_accesslist_name
, accesslist
))) {
2862 "IPv6 access-class is not currently applied to vty\n");
2863 return CMD_WARNING_CONFIG_FAILED
;
2866 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2868 vty_ipv6_accesslist_name
= NULL
;
2877 "Enable password checking\n")
2879 no_password_check
= 0;
2883 DEFUN (no_vty_login
,
2887 "Enable password checking\n")
2889 no_password_check
= 1;
2893 DEFUN (service_advanced_vty
,
2894 service_advanced_vty_cmd
,
2895 "service advanced-vty",
2896 "Set up miscellaneous service\n"
2897 "Enable advanced mode vty interface\n")
2903 DEFUN (no_service_advanced_vty
,
2904 no_service_advanced_vty_cmd
,
2905 "no service advanced-vty",
2907 "Set up miscellaneous service\n"
2908 "Enable advanced mode vty interface\n")
2914 DEFUN_NOSH (terminal_monitor
,
2915 terminal_monitor_cmd
,
2917 "Set terminal line parameters\n"
2918 "Copy debug output to the current terminal line\n")
2924 DEFUN_NOSH (terminal_no_monitor
,
2925 terminal_no_monitor_cmd
,
2926 "terminal no monitor",
2927 "Set terminal line parameters\n"
2929 "Copy debug output to the current terminal line\n")
2935 DEFUN_NOSH (no_terminal_monitor
,
2936 no_terminal_monitor_cmd
,
2937 "no terminal monitor",
2939 "Set terminal line parameters\n"
2940 "Copy debug output to the current terminal line\n")
2942 return terminal_no_monitor(self
, vty
, argc
, argv
);
2946 DEFUN_NOSH (show_history
,
2950 "Display the session command history\n")
2954 for (index
= vty
->hindex
+ 1; index
!= vty
->hindex
;) {
2955 if (index
== VTY_MAXHIST
) {
2960 if (vty
->hist
[index
] != NULL
)
2961 vty_out(vty
, " %s\n", vty
->hist
[index
]);
2970 DEFUN (log_commands
,
2974 "Log all commands (can't be unset without restart)\n")
2976 do_log_commands
= 1;
2980 /* Display current configuration. */
2981 static int vty_config_write(struct vty
*vty
)
2983 vty_out(vty
, "line vty\n");
2985 if (vty_accesslist_name
)
2986 vty_out(vty
, " access-class %s\n", vty_accesslist_name
);
2988 if (vty_ipv6_accesslist_name
)
2989 vty_out(vty
, " ipv6 access-class %s\n",
2990 vty_ipv6_accesslist_name
);
2993 if (vty_timeout_val
!= VTY_TIMEOUT_DEFAULT
)
2994 vty_out(vty
, " exec-timeout %ld %ld\n", vty_timeout_val
/ 60,
2995 vty_timeout_val
% 60);
2998 if (no_password_check
)
2999 vty_out(vty
, " no login\n");
3001 if (do_log_commands
)
3002 vty_out(vty
, "log commands\n");
3004 vty_out(vty
, "!\n");
3009 struct cmd_node vty_node
= {
3010 VTY_NODE
, "%s(config-line)# ", 1,
3013 /* Reset all VTY status. */
3018 struct thread
*vty_serv_thread
;
3020 for (i
= 0; i
< vector_active(vtyvec
); i
++)
3021 if ((vty
= vector_slot(vtyvec
, i
)) != NULL
) {
3022 buffer_reset(vty
->lbuf
);
3023 buffer_reset(vty
->obuf
);
3024 vty
->status
= VTY_CLOSE
;
3028 for (i
= 0; i
< vector_active(Vvty_serv_thread
); i
++)
3029 if ((vty_serv_thread
= vector_slot(Vvty_serv_thread
, i
))
3031 thread_cancel(vty_serv_thread
);
3032 vector_slot(Vvty_serv_thread
, i
) = NULL
;
3036 vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
3038 if (vty_accesslist_name
) {
3039 XFREE(MTYPE_VTY
, vty_accesslist_name
);
3040 vty_accesslist_name
= NULL
;
3043 if (vty_ipv6_accesslist_name
) {
3044 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
3045 vty_ipv6_accesslist_name
= NULL
;
3049 static void vty_save_cwd(void)
3051 char cwd
[MAXPATHLEN
];
3054 c
= getcwd(cwd
, MAXPATHLEN
);
3058 * At this point if these go wrong, more than likely
3059 * the whole world is coming down around us
3060 * Hence not worrying about it too much.
3062 if (!chdir(SYSCONFDIR
)) {
3063 zlog_err("Failure to chdir to %s, errno: %d",
3067 if (getcwd(cwd
, MAXPATHLEN
) == NULL
) {
3068 zlog_err("Failure to getcwd, errno: %d", errno
);
3073 vty_cwd
= XMALLOC(MTYPE_TMP
, strlen(cwd
) + 1);
3074 strcpy(vty_cwd
, cwd
);
3082 int vty_shell(struct vty
*vty
)
3084 return vty
->type
== VTY_SHELL
? 1 : 0;
3087 int vty_shell_serv(struct vty
*vty
)
3089 return vty
->type
== VTY_SHELL_SERV
? 1 : 0;
3092 void vty_init_vtysh()
3094 vtyvec
= vector_init(VECTOR_MIN_SIZE
);
3097 /* Install vty's own commands like `who' command. */
3098 void vty_init(struct thread_master
*master_thread
)
3100 /* For further configuration read, preserve current directory. */
3103 vtyvec
= vector_init(VECTOR_MIN_SIZE
);
3105 vty_master
= master_thread
;
3107 atexit(vty_stdio_atexit
);
3109 /* Initilize server thread vector. */
3110 Vvty_serv_thread
= vector_init(VECTOR_MIN_SIZE
);
3112 /* Install bgp top node. */
3113 install_node(&vty_node
, vty_config_write
);
3115 install_element(VIEW_NODE
, &config_who_cmd
);
3116 install_element(VIEW_NODE
, &show_history_cmd
);
3117 install_element(CONFIG_NODE
, &line_vty_cmd
);
3118 install_element(CONFIG_NODE
, &service_advanced_vty_cmd
);
3119 install_element(CONFIG_NODE
, &no_service_advanced_vty_cmd
);
3120 install_element(CONFIG_NODE
, &show_history_cmd
);
3121 install_element(CONFIG_NODE
, &log_commands_cmd
);
3122 install_element(ENABLE_NODE
, &terminal_monitor_cmd
);
3123 install_element(ENABLE_NODE
, &terminal_no_monitor_cmd
);
3124 install_element(ENABLE_NODE
, &no_terminal_monitor_cmd
);
3126 install_default(VTY_NODE
);
3127 install_element(VTY_NODE
, &exec_timeout_min_cmd
);
3128 install_element(VTY_NODE
, &exec_timeout_sec_cmd
);
3129 install_element(VTY_NODE
, &no_exec_timeout_cmd
);
3130 install_element(VTY_NODE
, &vty_access_class_cmd
);
3131 install_element(VTY_NODE
, &no_vty_access_class_cmd
);
3132 install_element(VTY_NODE
, &vty_login_cmd
);
3133 install_element(VTY_NODE
, &no_vty_login_cmd
);
3134 install_element(VTY_NODE
, &vty_ipv6_access_class_cmd
);
3135 install_element(VTY_NODE
, &no_vty_ipv6_access_class_cmd
);
3138 void vty_terminate(void)
3141 XFREE(MTYPE_TMP
, vty_cwd
);
3143 if (vtyvec
&& Vvty_serv_thread
) {
3145 vector_free(vtyvec
);
3146 vector_free(Vvty_serv_thread
);
3148 Vvty_serv_thread
= NULL
;