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
18 * along with GNU Zebra; see the file COPYING. If not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
28 #include <lib/version.h>
30 #include "sockunion.h"
40 #include <arpa/telnet.h>
56 static void vty_event (enum event
, int, struct vty
*);
58 /* Extern host structure from command.c */
59 extern struct host host
;
61 /* Vector which store each vty structure. */
64 /* Vty timeout value. */
65 static unsigned long vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
67 /* Vty access-class command */
68 static char *vty_accesslist_name
= NULL
;
70 /* Vty access-calss for IPv6. */
71 static char *vty_ipv6_accesslist_name
= NULL
;
73 /* VTY server thread. */
74 vector Vvty_serv_thread
;
76 /* Current directory. */
80 static int vty_config
;
82 /* Login password check. */
83 static int no_password_check
= 0;
85 /* Integrated configuration file path */
86 char integrate_default
[] = SYSCONFDIR INTEGRATE_DEFAULT_CONFIG
;
89 /* VTY standard output function. */
91 vty_out (struct vty
*vty
, const char *format
, ...)
101 va_start (args
, format
);
102 vprintf (format
, args
);
107 /* Try to write to initial buffer. */
108 va_start (args
, format
);
109 len
= vsnprintf (buf
, sizeof buf
, format
, args
);
112 /* Initial buffer is not enough. */
113 if (len
< 0 || len
>= size
)
122 p
= XREALLOC (MTYPE_VTY_OUT_BUF
, p
, size
);
126 va_start (args
, format
);
127 len
= vsnprintf (p
, size
, format
, args
);
130 if (len
> -1 && len
< size
)
135 /* When initial buffer is enough to store all output. */
139 /* Pointer p must point out buffer. */
140 buffer_put (vty
->obuf
, (u_char
*) p
, len
);
142 /* If p is not different with buf, it is allocated buffer. */
144 XFREE (MTYPE_VTY_OUT_BUF
, p
);
151 vty_log_out (struct vty
*vty
, const char *level
, const char *proto_str
,
152 const char *format
, va_list va
)
159 len
= snprintf(buf
, sizeof(buf
), "%s: %s: ", level
, proto_str
);
161 len
= snprintf(buf
, sizeof(buf
), "%s: ", proto_str
);
162 if ((len
< 0) || ((size_t)len
>= sizeof(buf
)))
165 if (((ret
= vsnprintf(buf
+len
, sizeof(buf
)-len
, format
, va
)) < 0) ||
166 ((size_t)((len
+= ret
)+2) > sizeof(buf
)))
172 if (write(vty
->fd
, buf
, len
) < 0)
174 if (ERRNO_IO_RETRY(errno
))
175 /* Kernel buffer is full, probably too much debugging output, so just
176 drop the data and ignore. */
178 /* Fatal I/O error. */
179 zlog_warn("%s: write failed to vty client fd %d, closing: %s",
180 __func__
, vty
->fd
, safe_strerror(errno
));
181 buffer_reset(vty
->obuf
);
188 /* Output current time to the vty. */
190 vty_time_print (struct vty
*vty
, int cr
)
199 tm
= localtime (&clock
);
201 ret
= strftime (buf
, TIME_BUF
, "%Y/%m/%d %H:%M:%S", tm
);
204 zlog (NULL
, LOG_INFO
, "strftime error");
208 vty_out (vty
, "%s\n", buf
);
210 vty_out (vty
, "%s ", buf
);
215 /* Say hello to vty interface. */
217 vty_hello (struct vty
*vty
)
224 f
= fopen (host
.motdfile
, "r");
227 while (fgets (buf
, sizeof (buf
), f
))
230 /* work backwards to ignore trailling isspace() */
231 for (s
= buf
+ strlen (buf
); (s
> buf
) && isspace ((int)*(s
- 1));
234 vty_out (vty
, "%s%s", buf
, VTY_NEWLINE
);
239 vty_out (vty
, "MOTD file not found%s", VTY_NEWLINE
);
242 vty_out (vty
, host
.motd
);
245 /* Put out prompt and wait input from user. */
247 vty_prompt (struct vty
*vty
)
249 struct utsname names
;
252 if (vty
->type
== VTY_TERM
)
254 hostname
= host
.name
;
258 hostname
= names
.nodename
;
260 vty_out (vty
, cmd_prompt (vty
->node
), hostname
);
264 /* Send WILL TELOPT_ECHO to remote server. */
266 vty_will_echo (struct vty
*vty
)
268 unsigned char cmd
[] = { IAC
, WILL
, TELOPT_ECHO
, '\0' };
269 vty_out (vty
, "%s", cmd
);
272 /* Make suppress Go-Ahead telnet option. */
274 vty_will_suppress_go_ahead (struct vty
*vty
)
276 unsigned char cmd
[] = { IAC
, WILL
, TELOPT_SGA
, '\0' };
277 vty_out (vty
, "%s", cmd
);
280 /* Make don't use linemode over telnet. */
282 vty_dont_linemode (struct vty
*vty
)
284 unsigned char cmd
[] = { IAC
, DONT
, TELOPT_LINEMODE
, '\0' };
285 vty_out (vty
, "%s", cmd
);
288 /* Use window size. */
290 vty_do_window_size (struct vty
*vty
)
292 unsigned char cmd
[] = { IAC
, DO
, TELOPT_NAWS
, '\0' };
293 vty_out (vty
, "%s", cmd
);
296 #if 0 /* Currently not used. */
297 /* Make don't use lflow vty interface. */
299 vty_dont_lflow_ahead (struct vty
*vty
)
301 unsigned char cmd
[] = { IAC
, DONT
, TELOPT_LFLOW
, '\0' };
302 vty_out (vty
, "%s", cmd
);
306 /* Allocate new vty struct. */
310 struct vty
*new = XCALLOC (MTYPE_VTY
, sizeof (struct vty
));
312 new->obuf
= buffer_new(0); /* Use default buffer size. */
313 new->buf
= XCALLOC (MTYPE_VTY
, VTY_BUFSIZ
);
314 new->max
= VTY_BUFSIZ
;
319 /* Authentication of vty */
321 vty_auth (struct vty
*vty
, char *buf
)
324 enum node_type next_node
= 0;
326 char *crypt (const char *, const char *);
332 passwd
= host
.password_encrypt
;
334 passwd
= host
.password
;
336 next_node
= host
.enable
? VIEW_NODE
: ENABLE_NODE
;
338 next_node
= VIEW_NODE
;
340 case AUTH_ENABLE_NODE
:
342 passwd
= host
.enable_encrypt
;
344 passwd
= host
.enable
;
345 next_node
= ENABLE_NODE
;
352 fail
= strcmp (crypt(buf
, passwd
), passwd
);
354 fail
= strcmp (buf
, passwd
);
362 vty
->node
= next_node
; /* Success ! */
369 if (vty
->node
== AUTH_NODE
)
371 vty_out (vty
, "%% Bad passwords, too many failures!%s", VTY_NEWLINE
);
372 vty
->status
= VTY_CLOSE
;
376 /* AUTH_ENABLE_NODE */
378 vty_out (vty
, "%% Bad enable passwords, too many failures!%s", VTY_NEWLINE
);
379 vty
->node
= VIEW_NODE
;
385 /* Command execution over the vty interface. */
387 vty_command (struct vty
*vty
, char *buf
)
391 const char *protocolname
;
393 /* Split readline string up into the vector */
394 vline
= cmd_make_strvec (buf
);
399 #ifdef CONSUMED_TIME_CHECK
403 unsigned long realtime
, cputime
;
406 #endif /* CONSUMED_TIME_CHECK */
408 ret
= cmd_execute_command (vline
, vty
, NULL
, 0);
410 /* Get the name of the protocol if any */
412 protocolname
= zlog_proto_names
[zlog_default
->protocol
];
414 protocolname
= zlog_proto_names
[ZLOG_NONE
];
416 #ifdef CONSUMED_TIME_CHECK
418 if ((realtime
= thread_consumed_time(&after
, &before
, &cputime
)) >
420 /* Warn about CPU hog that must be fixed. */
421 zlog_warn("SLOW COMMAND: command took %lums (cpu time %lums): %s",
422 realtime
/1000, cputime
/1000, buf
);
424 #endif /* CONSUMED_TIME_CHECK */
426 if (ret
!= CMD_SUCCESS
)
430 if (vty
->type
== VTY_FILE
)
431 vty_out (vty
, "Warning...%s", VTY_NEWLINE
);
433 case CMD_ERR_AMBIGUOUS
:
434 vty_out (vty
, "%% Ambiguous command.%s", VTY_NEWLINE
);
436 case CMD_ERR_NO_MATCH
:
437 vty_out (vty
, "%% [%s] Unknown command: %s%s", protocolname
, buf
, VTY_NEWLINE
);
439 case CMD_ERR_INCOMPLETE
:
440 vty_out (vty
, "%% Command incomplete.%s", VTY_NEWLINE
);
443 cmd_free_strvec (vline
);
448 static const char telnet_backward_char
= 0x08;
449 static const char telnet_space_char
= ' ';
451 /* Basic function to write buffer to vty. */
453 vty_write (struct vty
*vty
, const char *buf
, size_t nbytes
)
455 if ((vty
->node
== AUTH_NODE
) || (vty
->node
== AUTH_ENABLE_NODE
))
458 /* Should we do buffering here ? And make vty_flush (vty) ? */
459 buffer_put (vty
->obuf
, buf
, nbytes
);
462 /* Ensure length of input buffer. Is buffer is short, double it. */
464 vty_ensure (struct vty
*vty
, int length
)
466 if (vty
->max
<= length
)
469 vty
->buf
= XREALLOC (MTYPE_VTY
, vty
->buf
, vty
->max
);
473 /* Basic function to insert character into vty. */
475 vty_self_insert (struct vty
*vty
, char c
)
480 vty_ensure (vty
, vty
->length
+ 1);
481 length
= vty
->length
- vty
->cp
;
482 memmove (&vty
->buf
[vty
->cp
+ 1], &vty
->buf
[vty
->cp
], length
);
483 vty
->buf
[vty
->cp
] = c
;
485 vty_write (vty
, &vty
->buf
[vty
->cp
], length
+ 1);
486 for (i
= 0; i
< length
; i
++)
487 vty_write (vty
, &telnet_backward_char
, 1);
493 /* Self insert character 'c' in overwrite mode. */
495 vty_self_insert_overwrite (struct vty
*vty
, char c
)
497 vty_ensure (vty
, vty
->length
+ 1);
498 vty
->buf
[vty
->cp
++] = c
;
500 if (vty
->cp
> vty
->length
)
503 if ((vty
->node
== AUTH_NODE
) || (vty
->node
== AUTH_ENABLE_NODE
))
506 vty_write (vty
, &c
, 1);
509 /* Insert a word into vty interface with overwrite mode. */
511 vty_insert_word_overwrite (struct vty
*vty
, char *str
)
513 int len
= strlen (str
);
514 vty_write (vty
, str
, len
);
515 strcpy (&vty
->buf
[vty
->cp
], str
);
517 vty
->length
= vty
->cp
;
520 /* Forward character. */
522 vty_forward_char (struct vty
*vty
)
524 if (vty
->cp
< vty
->length
)
526 vty_write (vty
, &vty
->buf
[vty
->cp
], 1);
531 /* Backward character. */
533 vty_backward_char (struct vty
*vty
)
538 vty_write (vty
, &telnet_backward_char
, 1);
542 /* Move to the beginning of the line. */
544 vty_beginning_of_line (struct vty
*vty
)
547 vty_backward_char (vty
);
550 /* Move to the end of the line. */
552 vty_end_of_line (struct vty
*vty
)
554 while (vty
->cp
< vty
->length
)
555 vty_forward_char (vty
);
558 static void vty_kill_line_from_beginning (struct vty
*);
559 static void vty_redraw_line (struct vty
*);
561 /* Print command line history. This function is called from
562 vty_next_line and vty_previous_line. */
564 vty_history_print (struct vty
*vty
)
568 vty_kill_line_from_beginning (vty
);
570 /* Get previous line from history buffer */
571 length
= strlen (vty
->hist
[vty
->hp
]);
572 memcpy (vty
->buf
, vty
->hist
[vty
->hp
], length
);
573 vty
->cp
= vty
->length
= length
;
575 /* Redraw current line */
576 vty_redraw_line (vty
);
579 /* Show next command line history. */
581 vty_next_line (struct vty
*vty
)
585 if (vty
->hp
== vty
->hindex
)
588 /* Try is there history exist or not. */
590 if (try_index
== (VTY_MAXHIST
- 1))
595 /* If there is not history return. */
596 if (vty
->hist
[try_index
] == NULL
)
601 vty_history_print (vty
);
604 /* Show previous command line history. */
606 vty_previous_line (struct vty
*vty
)
612 try_index
= VTY_MAXHIST
- 1;
616 if (vty
->hist
[try_index
] == NULL
)
621 vty_history_print (vty
);
624 /* This function redraw all of the command line character. */
626 vty_redraw_line (struct vty
*vty
)
628 vty_write (vty
, vty
->buf
, vty
->length
);
629 vty
->cp
= vty
->length
;
634 vty_forward_word (struct vty
*vty
)
636 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
637 vty_forward_char (vty
);
639 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
640 vty_forward_char (vty
);
643 /* Backward word without skipping training space. */
645 vty_backward_pure_word (struct vty
*vty
)
647 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
648 vty_backward_char (vty
);
653 vty_backward_word (struct vty
*vty
)
655 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
656 vty_backward_char (vty
);
658 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
659 vty_backward_char (vty
);
662 /* When '^D' is typed at the beginning of the line we move to the down
665 vty_down_level (struct vty
*vty
)
667 vty_out (vty
, "%s", VTY_NEWLINE
);
668 (*config_exit_cmd
.func
)(NULL
, vty
, 0, NULL
);
673 /* When '^Z' is received from vty, move down to the enable mode. */
675 vty_end_config (struct vty
*vty
)
677 vty_out (vty
, "%s", VTY_NEWLINE
);
701 case KEYCHAIN_KEY_NODE
:
704 vty_config_unlock (vty
);
705 vty
->node
= ENABLE_NODE
;
708 /* Unknown node, we have to ignore it. */
716 /* Delete a charcter at the current point. */
718 vty_delete_char (struct vty
*vty
)
723 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
726 if (vty
->length
== 0)
728 vty_down_level (vty
);
732 if (vty
->cp
== vty
->length
)
733 return; /* completion need here? */
735 size
= vty
->length
- vty
->cp
;
738 memmove (&vty
->buf
[vty
->cp
], &vty
->buf
[vty
->cp
+ 1], size
- 1);
739 vty
->buf
[vty
->length
] = '\0';
741 vty_write (vty
, &vty
->buf
[vty
->cp
], size
- 1);
742 vty_write (vty
, &telnet_space_char
, 1);
744 for (i
= 0; i
< size
; i
++)
745 vty_write (vty
, &telnet_backward_char
, 1);
748 /* Delete a character before the point. */
750 vty_delete_backward_char (struct vty
*vty
)
755 vty_backward_char (vty
);
756 vty_delete_char (vty
);
759 /* Kill rest of line from current point. */
761 vty_kill_line (struct vty
*vty
)
766 size
= vty
->length
- vty
->cp
;
771 for (i
= 0; i
< size
; i
++)
772 vty_write (vty
, &telnet_space_char
, 1);
773 for (i
= 0; i
< size
; i
++)
774 vty_write (vty
, &telnet_backward_char
, 1);
776 memset (&vty
->buf
[vty
->cp
], 0, size
);
777 vty
->length
= vty
->cp
;
780 /* Kill line from the beginning. */
782 vty_kill_line_from_beginning (struct vty
*vty
)
784 vty_beginning_of_line (vty
);
788 /* Delete a word before the point. */
790 vty_forward_kill_word (struct vty
*vty
)
792 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] == ' ')
793 vty_delete_char (vty
);
794 while (vty
->cp
!= vty
->length
&& vty
->buf
[vty
->cp
] != ' ')
795 vty_delete_char (vty
);
798 /* Delete a word before the point. */
800 vty_backward_kill_word (struct vty
*vty
)
802 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] == ' ')
803 vty_delete_backward_char (vty
);
804 while (vty
->cp
> 0 && vty
->buf
[vty
->cp
- 1] != ' ')
805 vty_delete_backward_char (vty
);
808 /* Transpose chars before or at the point. */
810 vty_transpose_chars (struct vty
*vty
)
814 /* If length is short or point is near by the beginning of line then
816 if (vty
->length
< 2 || vty
->cp
< 1)
819 /* In case of point is located at the end of the line. */
820 if (vty
->cp
== vty
->length
)
822 c1
= vty
->buf
[vty
->cp
- 1];
823 c2
= vty
->buf
[vty
->cp
- 2];
825 vty_backward_char (vty
);
826 vty_backward_char (vty
);
827 vty_self_insert_overwrite (vty
, c1
);
828 vty_self_insert_overwrite (vty
, c2
);
832 c1
= vty
->buf
[vty
->cp
];
833 c2
= vty
->buf
[vty
->cp
- 1];
835 vty_backward_char (vty
);
836 vty_self_insert_overwrite (vty
, c1
);
837 vty_self_insert_overwrite (vty
, c2
);
841 /* Do completion at vty interface. */
843 vty_complete_command (struct vty
*vty
)
847 char **matched
= NULL
;
850 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
853 vline
= cmd_make_strvec (vty
->buf
);
857 /* In case of 'help \t'. */
858 if (isspace ((int) vty
->buf
[vty
->length
- 1]))
859 vector_set (vline
, '\0');
861 matched
= cmd_complete_command (vline
, vty
, &ret
);
863 cmd_free_strvec (vline
);
865 vty_out (vty
, "%s", VTY_NEWLINE
);
868 case CMD_ERR_AMBIGUOUS
:
869 vty_out (vty
, "%% Ambiguous command.%s", VTY_NEWLINE
);
871 vty_redraw_line (vty
);
873 case CMD_ERR_NO_MATCH
:
874 /* vty_out (vty, "%% There is no matched command.%s", VTY_NEWLINE); */
876 vty_redraw_line (vty
);
878 case CMD_COMPLETE_FULL_MATCH
:
880 vty_redraw_line (vty
);
881 vty_backward_pure_word (vty
);
882 vty_insert_word_overwrite (vty
, matched
[0]);
883 vty_self_insert (vty
, ' ');
884 XFREE (MTYPE_TMP
, matched
[0]);
886 case CMD_COMPLETE_MATCH
:
888 vty_redraw_line (vty
);
889 vty_backward_pure_word (vty
);
890 vty_insert_word_overwrite (vty
, matched
[0]);
891 XFREE (MTYPE_TMP
, matched
[0]);
892 vector_only_index_free (matched
);
895 case CMD_COMPLETE_LIST_MATCH
:
896 for (i
= 0; matched
[i
] != NULL
; i
++)
898 if (i
!= 0 && ((i
% 6) == 0))
899 vty_out (vty
, "%s", VTY_NEWLINE
);
900 vty_out (vty
, "%-10s ", matched
[i
]);
901 XFREE (MTYPE_TMP
, matched
[i
]);
903 vty_out (vty
, "%s", VTY_NEWLINE
);
906 vty_redraw_line (vty
);
908 case CMD_ERR_NOTHING_TODO
:
910 vty_redraw_line (vty
);
916 vector_only_index_free (matched
);
920 vty_describe_fold (struct vty
*vty
, int cmd_width
,
921 unsigned int desc_width
, struct desc
*desc
)
927 cmd
= desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
;
931 vty_out (vty
, " %-*s %s%s", cmd_width
, cmd
, desc
->str
, VTY_NEWLINE
);
935 buf
= XCALLOC (MTYPE_TMP
, strlen (desc
->str
) + 1);
937 for (p
= desc
->str
; strlen (p
) > desc_width
; p
+= pos
+ 1)
939 for (pos
= desc_width
; pos
> 0; pos
--)
940 if (*(p
+ pos
) == ' ')
946 strncpy (buf
, p
, pos
);
948 vty_out (vty
, " %-*s %s%s", cmd_width
, cmd
, buf
, VTY_NEWLINE
);
953 vty_out (vty
, " %-*s %s%s", cmd_width
, cmd
, p
, VTY_NEWLINE
);
955 XFREE (MTYPE_TMP
, buf
);
958 /* Describe matched command function. */
960 vty_describe_command (struct vty
*vty
)
965 unsigned int i
, width
, desc_width
;
966 struct desc
*desc
, *desc_cr
= NULL
;
968 vline
= cmd_make_strvec (vty
->buf
);
970 /* In case of '> ?'. */
973 vline
= vector_init (1);
974 vector_set (vline
, '\0');
977 if (isspace ((int) vty
->buf
[vty
->length
- 1]))
978 vector_set (vline
, '\0');
980 describe
= cmd_describe_command (vline
, vty
, &ret
);
982 vty_out (vty
, "%s", VTY_NEWLINE
);
984 /* Ambiguous error. */
987 case CMD_ERR_AMBIGUOUS
:
988 vty_out (vty
, "%% Ambiguous command.%s", VTY_NEWLINE
);
991 case CMD_ERR_NO_MATCH
:
992 vty_out (vty
, "%% There is no matched command.%s", VTY_NEWLINE
);
997 /* Get width of command string. */
999 for (i
= 0; i
< vector_active (describe
); i
++)
1000 if ((desc
= vector_slot (describe
, i
)) != NULL
)
1004 if (desc
->cmd
[0] == '\0')
1007 len
= strlen (desc
->cmd
);
1008 if (desc
->cmd
[0] == '.')
1015 /* Get width of description string. */
1016 desc_width
= vty
->width
- (width
+ 6);
1018 /* Print out description. */
1019 for (i
= 0; i
< vector_active (describe
); i
++)
1020 if ((desc
= vector_slot (describe
, i
)) != NULL
)
1022 if (desc
->cmd
[0] == '\0')
1025 if (strcmp (desc
->cmd
, "<cr>") == 0)
1032 vty_out (vty
, " %-s%s",
1033 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1035 else if (desc_width
>= strlen (desc
->str
))
1036 vty_out (vty
, " %-*s %s%s", width
,
1037 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1038 desc
->str
, VTY_NEWLINE
);
1040 vty_describe_fold (vty
, width
, desc_width
, desc
);
1043 vty_out (vty
, " %-*s %s%s", width
1044 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1045 desc
->str
? desc
->str
: "", VTY_NEWLINE
);
1049 if ((desc
= desc_cr
))
1052 vty_out (vty
, " %-s%s",
1053 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1055 else if (desc_width
>= strlen (desc
->str
))
1056 vty_out (vty
, " %-*s %s%s", width
,
1057 desc
->cmd
[0] == '.' ? desc
->cmd
+ 1 : desc
->cmd
,
1058 desc
->str
, VTY_NEWLINE
);
1060 vty_describe_fold (vty
, width
, desc_width
, desc
);
1064 cmd_free_strvec (vline
);
1065 vector_free (describe
);
1068 vty_redraw_line (vty
);
1072 vty_clear_buf (struct vty
*vty
)
1074 memset (vty
->buf
, 0, vty
->max
);
1077 /* ^C stop current input and do not add command line to the history. */
1079 vty_stop_input (struct vty
*vty
)
1081 vty
->cp
= vty
->length
= 0;
1082 vty_clear_buf (vty
);
1083 vty_out (vty
, "%s", VTY_NEWLINE
);
1089 /* Nothing to do. */
1092 case INTERFACE_NODE
:
1102 case KEYCHAIN_KEY_NODE
:
1105 vty_config_unlock (vty
);
1106 vty
->node
= ENABLE_NODE
;
1109 /* Unknown node, we have to ignore it. */
1114 /* Set history pointer to the latest one. */
1115 vty
->hp
= vty
->hindex
;
1118 /* Add current command line to the history buffer. */
1120 vty_hist_add (struct vty
*vty
)
1124 if (vty
->length
== 0)
1127 index
= vty
->hindex
? vty
->hindex
- 1 : VTY_MAXHIST
- 1;
1129 /* Ignore the same string as previous one. */
1130 if (vty
->hist
[index
])
1131 if (strcmp (vty
->buf
, vty
->hist
[index
]) == 0)
1133 vty
->hp
= vty
->hindex
;
1137 /* Insert history entry. */
1138 if (vty
->hist
[vty
->hindex
])
1139 XFREE (MTYPE_VTY_HIST
, vty
->hist
[vty
->hindex
]);
1140 vty
->hist
[vty
->hindex
] = XSTRDUP (MTYPE_VTY_HIST
, vty
->buf
);
1142 /* History index rotation. */
1144 if (vty
->hindex
== VTY_MAXHIST
)
1147 vty
->hp
= vty
->hindex
;
1150 /* #define TELNET_OPTION_DEBUG */
1152 /* Get telnet window size. */
1154 vty_telnet_option (struct vty
*vty
, unsigned char *buf
, int nbytes
)
1156 #ifdef TELNET_OPTION_DEBUG
1159 for (i
= 0; i
< nbytes
; i
++)
1164 vty_out (vty
, "IAC ");
1167 vty_out (vty
, "WILL ");
1170 vty_out (vty
, "WONT ");
1173 vty_out (vty
, "DO ");
1176 vty_out (vty
, "DONT ");
1179 vty_out (vty
, "SB ");
1182 vty_out (vty
, "SE ");
1185 vty_out (vty
, "TELOPT_ECHO %s", VTY_NEWLINE
);
1188 vty_out (vty
, "TELOPT_SGA %s", VTY_NEWLINE
);
1191 vty_out (vty
, "TELOPT_NAWS %s", VTY_NEWLINE
);
1194 vty_out (vty
, "%x ", buf
[i
]);
1198 vty_out (vty
, "%s", VTY_NEWLINE
);
1200 #endif /* TELNET_OPTION_DEBUG */
1206 vty
->iac_sb_in_progress
= 1;
1211 if (!vty
->iac_sb_in_progress
)
1214 if ((vty
->sb_len
== 0) || (vty
->sb_buf
[0] == '\0'))
1216 vty
->iac_sb_in_progress
= 0;
1219 switch (vty
->sb_buf
[0])
1222 if (vty
->sb_len
!= TELNET_NAWS_SB_LEN
)
1223 zlog_warn("RFC 1073 violation detected: telnet NAWS option "
1224 "should send %d characters, but we received %lu",
1225 TELNET_NAWS_SB_LEN
, (u_long
)vty
->sb_len
);
1226 else if (sizeof(vty
->sb_buf
) < TELNET_NAWS_SB_LEN
)
1227 zlog_err("Bug detected: sizeof(vty->sb_buf) %lu < %d, "
1228 "too small to handle the telnet NAWS option",
1229 (u_long
)sizeof(vty
->sb_buf
), TELNET_NAWS_SB_LEN
);
1232 vty
->width
= ((vty
->sb_buf
[1] << 8)|vty
->sb_buf
[2]);
1233 vty
->height
= ((vty
->sb_buf
[3] << 8)|vty
->sb_buf
[4]);
1234 #ifdef TELNET_OPTION_DEBUG
1235 vty_out(vty
, "TELNET NAWS window size negotiation completed: "
1236 "width %d, height %d%s",
1237 vty
->width
, vty
->height
, VTY_NEWLINE
);
1242 vty
->iac_sb_in_progress
= 0;
1252 /* Execute current command line. */
1254 vty_execute (struct vty
*vty
)
1263 case AUTH_ENABLE_NODE
:
1264 vty_auth (vty
, vty
->buf
);
1267 ret
= vty_command (vty
, vty
->buf
);
1268 if (vty
->type
== VTY_TERM
)
1273 /* Clear command line buffer. */
1274 vty
->cp
= vty
->length
= 0;
1275 vty_clear_buf (vty
);
1277 if (vty
->status
!= VTY_CLOSE
)
1283 #define CONTROL(X) ((X) - '@')
1284 #define VTY_NORMAL 0
1285 #define VTY_PRE_ESCAPE 1
1286 #define VTY_ESCAPE 2
1288 /* Escape character command map. */
1290 vty_escape_map (unsigned char c
, struct vty
*vty
)
1295 vty_previous_line (vty
);
1298 vty_next_line (vty
);
1301 vty_forward_char (vty
);
1304 vty_backward_char (vty
);
1310 /* Go back to normal mode. */
1311 vty
->escape
= VTY_NORMAL
;
1314 /* Quit print out to the buffer. */
1316 vty_buffer_reset (struct vty
*vty
)
1318 buffer_reset (vty
->obuf
);
1320 vty_redraw_line (vty
);
1323 /* Read data via vty socket. */
1325 vty_read (struct thread
*thread
)
1329 unsigned char buf
[VTY_READ_BUFSIZ
];
1331 int vty_sock
= THREAD_FD (thread
);
1332 struct vty
*vty
= THREAD_ARG (thread
);
1335 /* Read raw data from socket */
1336 if ((nbytes
= read (vty
->fd
, buf
, VTY_READ_BUFSIZ
)) <= 0)
1340 if (ERRNO_IO_RETRY(errno
))
1342 vty_event (VTY_READ
, vty_sock
, vty
);
1345 zlog_warn("%s: read error on vty client fd %d, closing: %s",
1346 __func__
, vty
->fd
, safe_strerror(errno
));
1348 buffer_reset(vty
->obuf
);
1349 vty
->status
= VTY_CLOSE
;
1352 for (i
= 0; i
< nbytes
; i
++)
1367 if (vty
->iac_sb_in_progress
&& !vty
->iac
)
1369 if (vty
->sb_len
< sizeof(vty
->sb_buf
))
1370 vty
->sb_buf
[vty
->sb_len
] = buf
[i
];
1377 /* In case of telnet command */
1379 ret
= vty_telnet_option (vty
, buf
+ i
, nbytes
- i
);
1386 if (vty
->status
== VTY_MORE
)
1393 vty_buffer_reset (vty
);
1395 #if 0 /* More line does not work for "show ip bgp". */
1398 vty
->status
= VTY_MORELINE
;
1407 /* Escape character. */
1408 if (vty
->escape
== VTY_ESCAPE
)
1410 vty_escape_map (buf
[i
], vty
);
1414 /* Pre-escape status. */
1415 if (vty
->escape
== VTY_PRE_ESCAPE
)
1420 vty
->escape
= VTY_ESCAPE
;
1423 vty_backward_word (vty
);
1424 vty
->escape
= VTY_NORMAL
;
1427 vty_forward_word (vty
);
1428 vty
->escape
= VTY_NORMAL
;
1431 vty_forward_kill_word (vty
);
1432 vty
->escape
= VTY_NORMAL
;
1436 vty_backward_kill_word (vty
);
1437 vty
->escape
= VTY_NORMAL
;
1440 vty
->escape
= VTY_NORMAL
;
1449 vty_beginning_of_line (vty
);
1452 vty_backward_char (vty
);
1455 vty_stop_input (vty
);
1458 vty_delete_char (vty
);
1461 vty_end_of_line (vty
);
1464 vty_forward_char (vty
);
1468 vty_delete_backward_char (vty
);
1471 vty_kill_line (vty
);
1474 vty_next_line (vty
);
1477 vty_previous_line (vty
);
1480 vty_transpose_chars (vty
);
1483 vty_kill_line_from_beginning (vty
);
1486 vty_backward_kill_word (vty
);
1489 vty_end_config (vty
);
1493 vty_out (vty
, "%s", VTY_NEWLINE
);
1497 vty_complete_command (vty
);
1500 if (vty
->node
== AUTH_NODE
|| vty
->node
== AUTH_ENABLE_NODE
)
1501 vty_self_insert (vty
, buf
[i
]);
1503 vty_describe_command (vty
);
1506 if (i
+ 1 < nbytes
&& buf
[i
+ 1] == '[')
1508 vty
->escape
= VTY_ESCAPE
;
1512 vty
->escape
= VTY_PRE_ESCAPE
;
1515 if (buf
[i
] > 31 && buf
[i
] < 127)
1516 vty_self_insert (vty
, buf
[i
]);
1522 if (vty
->status
== VTY_CLOSE
)
1526 vty_event (VTY_WRITE
, vty_sock
, vty
);
1527 vty_event (VTY_READ
, vty_sock
, vty
);
1532 /* Flush buffer to the vty. */
1534 vty_flush (struct thread
*thread
)
1537 buffer_status_t flushrc
;
1538 int vty_sock
= THREAD_FD (thread
);
1539 struct vty
*vty
= THREAD_ARG (thread
);
1541 vty
->t_write
= NULL
;
1543 /* Tempolary disable read thread. */
1544 if ((vty
->lines
== 0) && vty
->t_read
)
1546 thread_cancel (vty
->t_read
);
1550 /* Function execution continue. */
1551 erase
= ((vty
->status
== VTY_MORE
|| vty
->status
== VTY_MORELINE
));
1553 /* N.B. if width is 0, that means we don't know the window size. */
1554 if ((vty
->lines
== 0) || (vty
->width
== 0))
1555 flushrc
= buffer_flush_available(vty
->obuf
, vty
->fd
);
1556 else if (vty
->status
== VTY_MORELINE
)
1557 flushrc
= buffer_flush_window(vty
->obuf
, vty
->fd
, vty
->width
,
1560 flushrc
= buffer_flush_window(vty
->obuf
, vty
->fd
, vty
->width
,
1561 vty
->lines
>= 0 ? vty
->lines
:
1567 zlog_warn("buffer_flush failed on vty client fd %d, closing",
1569 buffer_reset(vty
->obuf
);
1573 if (vty
->status
== VTY_CLOSE
)
1577 vty
->status
= VTY_NORMAL
;
1578 if (vty
->lines
== 0)
1579 vty_event (VTY_READ
, vty_sock
, vty
);
1582 case BUFFER_PENDING
:
1583 /* There is more data waiting to be written. */
1584 vty
->status
= VTY_MORE
;
1585 if (vty
->lines
== 0)
1586 vty_event (VTY_WRITE
, vty_sock
, vty
);
1593 /* Create new vty structure. */
1595 vty_create (int vty_sock
, union sockunion
*su
)
1599 /* Allocate new vty structure and set up default values. */
1602 vty
->type
= VTY_TERM
;
1603 vty
->address
= sockunion_su2str (su
);
1604 if (no_password_check
)
1607 vty
->node
= ENABLE_NODE
;
1609 vty
->node
= VIEW_NODE
;
1612 vty
->node
= AUTH_NODE
;
1615 vty_clear_buf (vty
);
1617 memset (vty
->hist
, 0, sizeof (vty
->hist
));
1620 vector_set_index (vtyvec
, vty_sock
, vty
);
1621 vty
->status
= VTY_NORMAL
;
1622 vty
->v_timeout
= vty_timeout_val
;
1623 if (host
.lines
>= 0)
1624 vty
->lines
= host
.lines
;
1628 vty
->iac_sb_in_progress
= 0;
1631 if (! no_password_check
)
1633 /* Vty is not available if password isn't set. */
1634 if (host
.password
== NULL
&& host
.password_encrypt
== NULL
)
1636 vty_out (vty
, "Vty password is not set.%s", VTY_NEWLINE
);
1637 vty
->status
= VTY_CLOSE
;
1643 /* Say hello to the world. */
1645 if (! no_password_check
)
1646 vty_out (vty
, "%sUser Access Verification%s%s", VTY_NEWLINE
, VTY_NEWLINE
, VTY_NEWLINE
);
1648 /* Setting up terminal. */
1649 vty_will_echo (vty
);
1650 vty_will_suppress_go_ahead (vty
);
1652 vty_dont_linemode (vty
);
1653 vty_do_window_size (vty
);
1654 /* vty_dont_lflow_ahead (vty); */
1658 /* Add read/write thread. */
1659 vty_event (VTY_WRITE
, vty_sock
, vty
);
1660 vty_event (VTY_READ
, vty_sock
, vty
);
1665 /* Accept connection from the network. */
1667 vty_accept (struct thread
*thread
)
1675 struct prefix
*p
= NULL
;
1676 struct access_list
*acl
= NULL
;
1678 accept_sock
= THREAD_FD (thread
);
1680 /* We continue hearing vty socket. */
1681 vty_event (VTY_SERV
, accept_sock
, NULL
);
1683 memset (&su
, 0, sizeof (union sockunion
));
1685 /* We can handle IPv4 or IPv6 socket. */
1686 vty_sock
= sockunion_accept (accept_sock
, &su
);
1689 zlog_warn ("can't accept vty socket : %s", safe_strerror (errno
));
1692 set_nonblocking(vty_sock
);
1694 p
= sockunion2hostprefix (&su
);
1696 /* VTY's accesslist apply. */
1697 if (p
->family
== AF_INET
&& vty_accesslist_name
)
1699 if ((acl
= access_list_lookup (AFI_IP
, vty_accesslist_name
)) &&
1700 (access_list_apply (acl
, p
) == FILTER_DENY
))
1703 zlog (NULL
, LOG_INFO
, "Vty connection refused from %s",
1704 (buf
= sockunion_su2str (&su
)));
1708 /* continue accepting connections */
1709 vty_event (VTY_SERV
, accept_sock
, NULL
);
1718 /* VTY's ipv6 accesslist apply. */
1719 if (p
->family
== AF_INET6
&& vty_ipv6_accesslist_name
)
1721 if ((acl
= access_list_lookup (AFI_IP6
, vty_ipv6_accesslist_name
)) &&
1722 (access_list_apply (acl
, p
) == FILTER_DENY
))
1725 zlog (NULL
, LOG_INFO
, "Vty connection refused from %s",
1726 (buf
= sockunion_su2str (&su
)));
1730 /* continue accepting connections */
1731 vty_event (VTY_SERV
, accept_sock
, NULL
);
1738 #endif /* HAVE_IPV6 */
1743 ret
= setsockopt (vty_sock
, IPPROTO_TCP
, TCP_NODELAY
,
1744 (char *) &on
, sizeof (on
));
1746 zlog (NULL
, LOG_INFO
, "can't set sockopt to vty_sock : %s",
1747 safe_strerror (errno
));
1749 vty
= vty_create (vty_sock
, &su
);
1754 #if defined(HAVE_IPV6) && !defined(NRL)
1756 vty_serv_sock_addrinfo (const char *hostname
, unsigned short port
)
1759 struct addrinfo req
;
1760 struct addrinfo
*ainfo
;
1761 struct addrinfo
*ainfo_save
;
1763 char port_str
[BUFSIZ
];
1765 memset (&req
, 0, sizeof (struct addrinfo
));
1766 req
.ai_flags
= AI_PASSIVE
;
1767 req
.ai_family
= AF_UNSPEC
;
1768 req
.ai_socktype
= SOCK_STREAM
;
1769 sprintf (port_str
, "%d", port
);
1770 port_str
[sizeof (port_str
) - 1] = '\0';
1772 ret
= getaddrinfo (hostname
, port_str
, &req
, &ainfo
);
1776 fprintf (stderr
, "getaddrinfo failed: %s\n", gai_strerror (ret
));
1784 if (ainfo
->ai_family
!= AF_INET
1786 && ainfo
->ai_family
!= AF_INET6
1787 #endif /* HAVE_IPV6 */
1791 sock
= socket (ainfo
->ai_family
, ainfo
->ai_socktype
, ainfo
->ai_protocol
);
1795 sockopt_reuseaddr (sock
);
1796 sockopt_reuseport (sock
);
1798 ret
= bind (sock
, ainfo
->ai_addr
, ainfo
->ai_addrlen
);
1801 close (sock
); /* Avoid sd leak. */
1805 ret
= listen (sock
, 3);
1808 close (sock
); /* Avoid sd leak. */
1812 vty_event (VTY_SERV
, sock
, NULL
);
1814 while ((ainfo
= ainfo
->ai_next
) != NULL
);
1816 freeaddrinfo (ainfo_save
);
1818 #endif /* HAVE_IPV6 && ! NRL */
1820 /* Make vty server socket. */
1822 vty_serv_sock_family (const char* addr
, unsigned short port
, int family
)
1829 memset (&su
, 0, sizeof (union sockunion
));
1830 su
.sa
.sa_family
= family
;
1835 naddr
=&su
.sin
.sin_addr
;
1838 naddr
=&su
.sin6
.sin6_addr
;
1843 switch(inet_pton(family
,addr
,naddr
))
1846 zlog_err("bad address %s",addr
);
1850 zlog_err("error translating address %s: %s",addr
,safe_strerror(errno
));
1854 /* Make new socket. */
1855 accept_sock
= sockunion_stream_socket (&su
);
1856 if (accept_sock
< 0)
1859 /* This is server, so reuse address. */
1860 sockopt_reuseaddr (accept_sock
);
1861 sockopt_reuseport (accept_sock
);
1863 /* Bind socket to universal address and given port. */
1864 ret
= sockunion_bind (accept_sock
, &su
, port
, naddr
);
1867 zlog_warn("can't bind socket");
1868 close (accept_sock
); /* Avoid sd leak. */
1872 /* Listen socket under queue 3. */
1873 ret
= listen (accept_sock
, 3);
1876 zlog (NULL
, LOG_WARNING
, "can't listen socket");
1877 close (accept_sock
); /* Avoid sd leak. */
1881 /* Add vty server event. */
1882 vty_event (VTY_SERV
, accept_sock
, NULL
);
1886 /* For sockaddr_un. */
1889 /* VTY shell UNIX domain socket. */
1891 vty_serv_un (const char *path
)
1895 struct sockaddr_un serv
;
1897 struct zprivs_ids_t ids
;
1899 /* First of all, unlink existing socket */
1903 old_mask
= umask (0007);
1905 /* Make UNIX domain socket. */
1906 sock
= socket (AF_UNIX
, SOCK_STREAM
, 0);
1909 zlog_err("Cannot create unix stream socket: %s", safe_strerror(errno
));
1913 /* Make server socket. */
1914 memset (&serv
, 0, sizeof (struct sockaddr_un
));
1915 serv
.sun_family
= AF_UNIX
;
1916 strncpy (serv
.sun_path
, path
, strlen (path
));
1918 len
= serv
.sun_len
= SUN_LEN(&serv
);
1920 len
= sizeof (serv
.sun_family
) + strlen (serv
.sun_path
);
1921 #endif /* HAVE_SUN_LEN */
1923 ret
= bind (sock
, (struct sockaddr
*) &serv
, len
);
1926 zlog_err("Cannot bind path %s: %s", path
, safe_strerror(errno
));
1927 close (sock
); /* Avoid sd leak. */
1931 ret
= listen (sock
, 5);
1934 zlog_err("listen(fd %d) failed: %s", sock
, safe_strerror(errno
));
1935 close (sock
); /* Avoid sd leak. */
1941 zprivs_get_ids(&ids
);
1943 if (ids
.gid_vty
> 0)
1945 /* set group of socket */
1946 if ( chown (path
, -1, ids
.gid_vty
) )
1948 zlog_err ("vty_serv_un: could chown socket, %s",
1949 safe_strerror (errno
) );
1953 vty_event (VTYSH_SERV
, sock
, NULL
);
1956 /* #define VTYSH_DEBUG 1 */
1959 vtysh_accept (struct thread
*thread
)
1964 struct sockaddr_un client
;
1967 accept_sock
= THREAD_FD (thread
);
1969 vty_event (VTYSH_SERV
, accept_sock
, NULL
);
1971 memset (&client
, 0, sizeof (struct sockaddr_un
));
1972 client_len
= sizeof (struct sockaddr_un
);
1974 sock
= accept (accept_sock
, (struct sockaddr
*) &client
,
1975 (socklen_t
*) &client_len
);
1979 zlog_warn ("can't accept vty socket : %s", safe_strerror (errno
));
1983 if (set_nonblocking(sock
) < 0)
1985 zlog_warn ("vtysh_accept: could not set vty socket %d to non-blocking,"
1986 " %s, closing", sock
, safe_strerror (errno
));
1992 printf ("VTY shell accept\n");
1993 #endif /* VTYSH_DEBUG */
1997 vty
->type
= VTY_SHELL_SERV
;
1998 vty
->node
= VIEW_NODE
;
2000 vty_event (VTYSH_READ
, sock
, vty
);
2006 vtysh_flush(struct vty
*vty
)
2008 switch (buffer_flush_available(vty
->obuf
, vty
->fd
))
2010 case BUFFER_PENDING
:
2011 vty_event(VTYSH_WRITE
, vty
->fd
, vty
);
2014 zlog_warn("%s: write error to fd %d, closing", __func__
, vty
->fd
);
2015 buffer_reset(vty
->obuf
);
2026 vtysh_read (struct thread
*thread
)
2032 unsigned char buf
[VTY_READ_BUFSIZ
];
2034 u_char header
[4] = {0, 0, 0, 0};
2036 sock
= THREAD_FD (thread
);
2037 vty
= THREAD_ARG (thread
);
2040 if ((nbytes
= read (sock
, buf
, VTY_READ_BUFSIZ
)) <= 0)
2044 if (ERRNO_IO_RETRY(errno
))
2046 vty_event (VTYSH_READ
, sock
, vty
);
2049 zlog_warn("%s: read failed on vtysh client fd %d, closing: %s",
2050 __func__
, sock
, safe_strerror(errno
));
2052 buffer_reset(vty
->obuf
);
2055 printf ("close vtysh\n");
2056 #endif /* VTYSH_DEBUG */
2061 printf ("line: %.*s\n", nbytes
, buf
);
2062 #endif /* VTYSH_DEBUG */
2064 for (p
= buf
; p
< buf
+nbytes
; p
++)
2066 vty_ensure(vty
, vty
->length
+1);
2067 vty
->buf
[vty
->length
++] = *p
;
2070 /* Pass this line to parser. */
2071 ret
= vty_execute (vty
);
2072 /* Note that vty_execute clears the command buffer and resets
2073 vty->length to 0. */
2075 /* Return result. */
2077 printf ("result: %d\n", ret
);
2078 printf ("vtysh node: %d\n", vty
->node
);
2079 #endif /* VTYSH_DEBUG */
2082 buffer_put(vty
->obuf
, header
, 4);
2084 if (!vty
->t_write
&& (vtysh_flush(vty
) < 0))
2085 /* Try to flush results; exit if a write error occurs. */
2090 vty_event (VTYSH_READ
, sock
, vty
);
2096 vtysh_write (struct thread
*thread
)
2098 struct vty
*vty
= THREAD_ARG (thread
);
2100 vty
->t_write
= NULL
;
2107 /* Determine address family to bind. */
2109 vty_serv_sock (const char *addr
, unsigned short port
, const char *path
)
2111 /* If port is set to 0, do not listen on TCP/IP at all! */
2117 vty_serv_sock_family (addr
, port
, AF_INET
);
2118 vty_serv_sock_family (addr
, port
, AF_INET6
);
2120 vty_serv_sock_addrinfo (addr
, port
);
2122 #else /* ! HAVE_IPV6 */
2123 vty_serv_sock_family (addr
,port
, AF_INET
);
2124 #endif /* HAVE_IPV6 */
2132 /* Close vty interface. */
2134 vty_close (struct vty
*vty
)
2138 /* Cancel threads.*/
2140 thread_cancel (vty
->t_read
);
2142 thread_cancel (vty
->t_write
);
2144 thread_cancel (vty
->t_timeout
);
2147 buffer_flush_all (vty
->obuf
, vty
->fd
);
2149 /* Free input buffer. */
2150 buffer_free (vty
->obuf
);
2152 /* Free command history. */
2153 for (i
= 0; i
< VTY_MAXHIST
; i
++)
2155 XFREE (MTYPE_VTY_HIST
, vty
->hist
[i
]);
2158 vector_unset (vtyvec
, vty
->fd
);
2165 XFREE (MTYPE_TMP
, vty
->address
);
2167 XFREE (MTYPE_VTY
, vty
->buf
);
2169 /* Check configure. */
2170 vty_config_unlock (vty
);
2173 XFREE (MTYPE_VTY
, vty
);
2176 /* When time out occur output message then close connection. */
2178 vty_timeout (struct thread
*thread
)
2182 vty
= THREAD_ARG (thread
);
2183 vty
->t_timeout
= NULL
;
2187 buffer_reset (vty
->obuf
);
2188 vty_out (vty
, "%sVty connection is timed out.%s", VTY_NEWLINE
, VTY_NEWLINE
);
2190 /* Close connection. */
2191 vty
->status
= VTY_CLOSE
;
2197 /* Read up configuration file from file_name. */
2199 vty_read_file (FILE *confp
)
2205 vty
->fd
= 0; /* stdout */
2206 vty
->type
= VTY_TERM
;
2207 vty
->node
= CONFIG_NODE
;
2209 /* Execute configuration file */
2210 ret
= config_from_file (vty
, confp
);
2212 if ( !((ret
== CMD_SUCCESS
) || (ret
== CMD_ERR_NOTHING_TODO
)) )
2216 case CMD_ERR_AMBIGUOUS
:
2217 fprintf (stderr
, "Ambiguous command.\n");
2219 case CMD_ERR_NO_MATCH
:
2220 fprintf (stderr
, "There is no such command.\n");
2223 fprintf (stderr
, "Error occured during reading below line.\n%s\n",
2233 vty_use_backup_config (char *fullpath
)
2235 char *fullpath_sav
, *fullpath_tmp
;
2242 fullpath_sav
= malloc (strlen (fullpath
) + strlen (CONF_BACKUP_EXT
) + 1);
2243 strcpy (fullpath_sav
, fullpath
);
2244 strcat (fullpath_sav
, CONF_BACKUP_EXT
);
2245 if (stat (fullpath_sav
, &buf
) == -1)
2247 free (fullpath_sav
);
2251 fullpath_tmp
= malloc (strlen (fullpath
) + 8);
2252 sprintf (fullpath_tmp
, "%s.XXXXXX", fullpath
);
2254 /* Open file to configuration write. */
2255 tmp
= mkstemp (fullpath_tmp
);
2258 free (fullpath_sav
);
2259 free (fullpath_tmp
);
2263 sav
= open (fullpath_sav
, O_RDONLY
);
2266 unlink (fullpath_tmp
);
2267 free (fullpath_sav
);
2268 free (fullpath_tmp
);
2272 while((c
= read (sav
, buffer
, 512)) > 0)
2273 write (tmp
, buffer
, c
);
2278 if (chmod(fullpath_tmp
, CONFIGFILE_MASK
) != 0)
2280 unlink (fullpath_tmp
);
2281 free (fullpath_sav
);
2282 free (fullpath_tmp
);
2286 if (link (fullpath_tmp
, fullpath
) == 0)
2287 ret
= fopen (fullpath
, "r");
2289 unlink (fullpath_tmp
);
2291 free (fullpath_sav
);
2292 free (fullpath_tmp
);
2296 /* Read up configuration file from file_name. */
2298 vty_read_config (char *config_file
,
2299 char *config_default_dir
)
2301 char cwd
[MAXPATHLEN
];
2306 /* If -f flag specified. */
2307 if (config_file
!= NULL
)
2309 if (! IS_DIRECTORY_SEP (config_file
[0]))
2311 getcwd (cwd
, MAXPATHLEN
);
2312 tmp
= XMALLOC (MTYPE_TMP
,
2313 strlen (cwd
) + strlen (config_file
) + 2);
2314 sprintf (tmp
, "%s/%s", cwd
, config_file
);
2318 fullpath
= config_file
;
2320 confp
= fopen (fullpath
, "r");
2324 fprintf (stderr
, "%s: failed to open configuration file %s: %s\n",
2325 __func__
, fullpath
, safe_strerror (errno
));
2327 confp
= vty_use_backup_config (fullpath
);
2329 fprintf (stderr
, "WARNING: using backup configuration file!\n");
2332 fprintf (stderr
, "can't open configuration file [%s]\n",
2342 struct stat conf_stat
;
2344 /* !!!!PLEASE LEAVE!!!!
2345 * This is NEEDED for use with vtysh -b, or else you can get
2346 * a real configuration food fight with a lot garbage in the
2347 * merged configuration file it creates coming from the per
2348 * daemon configuration files. This also allows the daemons
2349 * to start if there default configuration file is not
2350 * present or ignore them, as needed when using vtysh -b to
2351 * configure the daemons at boot - MAG
2354 /* Stat for vtysh Zebra.conf, if found startup and wait for
2355 * boot configuration
2358 if ( strstr(config_default_dir
, "vtysh") == NULL
)
2360 ret
= stat (integrate_default
, &conf_stat
);
2366 confp
= fopen (config_default_dir
, "r");
2369 fprintf (stderr
, "%s: failed to open configuration file %s: %s\n",
2370 __func__
, config_default_dir
, safe_strerror (errno
));
2372 confp
= vty_use_backup_config (config_default_dir
);
2375 fprintf (stderr
, "WARNING: using backup configuration file!\n");
2376 fullpath
= config_default_dir
;
2380 fprintf (stderr
, "can't open configuration file [%s]\n",
2381 config_default_dir
);
2386 fullpath
= config_default_dir
;
2389 vty_read_file (confp
);
2393 host_config_set (fullpath
);
2396 XFREE (MTYPE_TMP
, fullpath
);
2399 /* Small utility function which output log to the VTY. */
2401 vty_log (const char *level
, const char *proto_str
,
2402 const char *format
, va_list va
)
2407 for (i
= 0; i
< vector_active (vtyvec
); i
++)
2408 if ((vty
= vector_slot (vtyvec
, i
)) != NULL
)
2413 vty_log_out (vty
, level
, proto_str
, format
, ac
);
2418 /* Async-signal-safe version of vty_log for fixed strings. */
2420 vty_log_fixed (const char *buf
, size_t len
)
2423 struct iovec iov
[2];
2425 iov
[0].iov_base
= (void *)buf
;
2426 iov
[0].iov_len
= len
;
2427 iov
[1].iov_base
= (void *)"\r\n";
2430 for (i
= 0; i
< vector_active (vtyvec
); i
++)
2433 if (((vty
= vector_slot (vtyvec
, i
)) != NULL
) && vty
->monitor
)
2434 /* N.B. We don't care about the return code, since process is
2435 most likely just about to die anyway. */
2436 writev(vty
->fd
, iov
, 2);
2441 vty_config_lock (struct vty
*vty
)
2443 if (vty_config
== 0)
2452 vty_config_unlock (struct vty
*vty
)
2454 if (vty_config
== 1 && vty
->config
== 1)
2462 /* Master of the threads. */
2463 static struct thread_master
*master
;
2466 vty_event (enum event event
, int sock
, struct vty
*vty
)
2468 struct thread
*vty_serv_thread
;
2473 vty_serv_thread
= thread_add_read (master
, vty_accept
, vty
, sock
);
2474 vector_set_index (Vvty_serv_thread
, sock
, vty_serv_thread
);
2478 thread_add_read (master
, vtysh_accept
, vty
, sock
);
2481 vty
->t_read
= thread_add_read (master
, vtysh_read
, vty
, sock
);
2484 vty
->t_write
= thread_add_write (master
, vtysh_write
, vty
, sock
);
2488 vty
->t_read
= thread_add_read (master
, vty_read
, vty
, sock
);
2490 /* Time out treatment. */
2494 thread_cancel (vty
->t_timeout
);
2496 thread_add_timer (master
, vty_timeout
, vty
, vty
->v_timeout
);
2501 vty
->t_write
= thread_add_write (master
, vty_flush
, vty
, sock
);
2503 case VTY_TIMEOUT_RESET
:
2506 thread_cancel (vty
->t_timeout
);
2507 vty
->t_timeout
= NULL
;
2512 thread_add_timer (master
, vty_timeout
, vty
, vty
->v_timeout
);
2521 "Display who is on vty\n")
2526 for (i
= 0; i
< vector_active (vtyvec
); i
++)
2527 if ((v
= vector_slot (vtyvec
, i
)) != NULL
)
2528 vty_out (vty
, "%svty[%d] connected from %s.%s",
2529 v
->config
? "*" : " ",
2530 i
, v
->address
, VTY_NEWLINE
);
2534 /* Move to vty configuration mode. */
2538 "Configure a terminal line\n"
2539 "Virtual terminal\n")
2541 vty
->node
= VTY_NODE
;
2545 /* Set time out value. */
2547 exec_timeout (struct vty
*vty
, const char *min_str
, const char *sec_str
)
2549 unsigned long timeout
= 0;
2551 /* min_str and sec_str are already checked by parser. So it must be
2552 all digit string. */
2555 timeout
= strtol (min_str
, NULL
, 10);
2559 timeout
+= strtol (sec_str
, NULL
, 10);
2561 vty_timeout_val
= timeout
;
2562 vty
->v_timeout
= timeout
;
2563 vty_event (VTY_TIMEOUT_RESET
, 0, vty
);
2569 DEFUN (exec_timeout_min
,
2570 exec_timeout_min_cmd
,
2571 "exec-timeout <0-35791>",
2572 "Set timeout value\n"
2573 "Timeout value in minutes\n")
2575 return exec_timeout (vty
, argv
[0], NULL
);
2578 DEFUN (exec_timeout_sec
,
2579 exec_timeout_sec_cmd
,
2580 "exec-timeout <0-35791> <0-2147483>",
2581 "Set the EXEC timeout\n"
2582 "Timeout in minutes\n"
2583 "Timeout in seconds\n")
2585 return exec_timeout (vty
, argv
[0], argv
[1]);
2588 DEFUN (no_exec_timeout
,
2589 no_exec_timeout_cmd
,
2592 "Set the EXEC timeout\n")
2594 return exec_timeout (vty
, NULL
, NULL
);
2597 /* Set vty access class. */
2598 DEFUN (vty_access_class
,
2599 vty_access_class_cmd
,
2600 "access-class WORD",
2601 "Filter connections based on an IP access list\n"
2604 if (vty_accesslist_name
)
2605 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2607 vty_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[0]);
2612 /* Clear vty access class. */
2613 DEFUN (no_vty_access_class
,
2614 no_vty_access_class_cmd
,
2615 "no access-class [WORD]",
2617 "Filter connections based on an IP access list\n"
2620 if (! vty_accesslist_name
|| (argc
&& strcmp(vty_accesslist_name
, argv
[0])))
2622 vty_out (vty
, "Access-class is not currently applied to vty%s",
2627 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2629 vty_accesslist_name
= NULL
;
2635 /* Set vty access class. */
2636 DEFUN (vty_ipv6_access_class
,
2637 vty_ipv6_access_class_cmd
,
2638 "ipv6 access-class WORD",
2640 "Filter connections based on an IP access list\n"
2641 "IPv6 access list\n")
2643 if (vty_ipv6_accesslist_name
)
2644 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2646 vty_ipv6_accesslist_name
= XSTRDUP(MTYPE_VTY
, argv
[0]);
2651 /* Clear vty access class. */
2652 DEFUN (no_vty_ipv6_access_class
,
2653 no_vty_ipv6_access_class_cmd
,
2654 "no ipv6 access-class [WORD]",
2657 "Filter connections based on an IP access list\n"
2658 "IPv6 access list\n")
2660 if (! vty_ipv6_accesslist_name
||
2661 (argc
&& strcmp(vty_ipv6_accesslist_name
, argv
[0])))
2663 vty_out (vty
, "IPv6 access-class is not currently applied to vty%s",
2668 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2670 vty_ipv6_accesslist_name
= NULL
;
2674 #endif /* HAVE_IPV6 */
2680 "Enable password checking\n")
2682 no_password_check
= 0;
2686 DEFUN (no_vty_login
,
2690 "Enable password checking\n")
2692 no_password_check
= 1;
2696 DEFUN (service_advanced_vty
,
2697 service_advanced_vty_cmd
,
2698 "service advanced-vty",
2699 "Set up miscellaneous service\n"
2700 "Enable advanced mode vty interface\n")
2706 DEFUN (no_service_advanced_vty
,
2707 no_service_advanced_vty_cmd
,
2708 "no service advanced-vty",
2710 "Set up miscellaneous service\n"
2711 "Enable advanced mode vty interface\n")
2717 DEFUN (terminal_monitor
,
2718 terminal_monitor_cmd
,
2720 "Set terminal line parameters\n"
2721 "Copy debug output to the current terminal line\n")
2727 DEFUN (terminal_no_monitor
,
2728 terminal_no_monitor_cmd
,
2729 "terminal no monitor",
2730 "Set terminal line parameters\n"
2732 "Copy debug output to the current terminal line\n")
2738 ALIAS (terminal_no_monitor
,
2739 no_terminal_monitor_cmd
,
2740 "no terminal monitor",
2742 "Set terminal line parameters\n"
2743 "Copy debug output to the current terminal line\n")
2745 DEFUN (show_history
,
2749 "Display the session command history\n")
2753 for (index
= vty
->hindex
+ 1; index
!= vty
->hindex
;)
2755 if (index
== VTY_MAXHIST
)
2761 if (vty
->hist
[index
] != NULL
)
2762 vty_out (vty
, " %s%s", vty
->hist
[index
], VTY_NEWLINE
);
2770 /* Display current configuration. */
2772 vty_config_write (struct vty
*vty
)
2774 vty_out (vty
, "line vty%s", VTY_NEWLINE
);
2776 if (vty_accesslist_name
)
2777 vty_out (vty
, " access-class %s%s",
2778 vty_accesslist_name
, VTY_NEWLINE
);
2780 if (vty_ipv6_accesslist_name
)
2781 vty_out (vty
, " ipv6 access-class %s%s",
2782 vty_ipv6_accesslist_name
, VTY_NEWLINE
);
2785 if (vty_timeout_val
!= VTY_TIMEOUT_DEFAULT
)
2786 vty_out (vty
, " exec-timeout %ld %ld%s",
2787 vty_timeout_val
/ 60,
2788 vty_timeout_val
% 60, VTY_NEWLINE
);
2791 if (no_password_check
)
2792 vty_out (vty
, " no login%s", VTY_NEWLINE
);
2794 vty_out (vty
, "!%s", VTY_NEWLINE
);
2799 struct cmd_node vty_node
=
2802 "%s(config-line)# ",
2806 /* Reset all VTY status. */
2812 struct thread
*vty_serv_thread
;
2814 for (i
= 0; i
< vector_active (vtyvec
); i
++)
2815 if ((vty
= vector_slot (vtyvec
, i
)) != NULL
)
2817 buffer_reset (vty
->obuf
);
2818 vty
->status
= VTY_CLOSE
;
2822 for (i
= 0; i
< vector_active (Vvty_serv_thread
); i
++)
2823 if ((vty_serv_thread
= vector_slot (Vvty_serv_thread
, i
)) != NULL
)
2825 thread_cancel (vty_serv_thread
);
2826 vector_slot (Vvty_serv_thread
, i
) = NULL
;
2830 vty_timeout_val
= VTY_TIMEOUT_DEFAULT
;
2832 if (vty_accesslist_name
)
2834 XFREE(MTYPE_VTY
, vty_accesslist_name
);
2835 vty_accesslist_name
= NULL
;
2838 if (vty_ipv6_accesslist_name
)
2840 XFREE(MTYPE_VTY
, vty_ipv6_accesslist_name
);
2841 vty_ipv6_accesslist_name
= NULL
;
2848 char cwd
[MAXPATHLEN
];
2851 c
= getcwd (cwd
, MAXPATHLEN
);
2856 getcwd (cwd
, MAXPATHLEN
);
2859 vty_cwd
= XMALLOC (MTYPE_TMP
, strlen (cwd
) + 1);
2860 strcpy (vty_cwd
, cwd
);
2870 vty_shell (struct vty
*vty
)
2872 return vty
->type
== VTY_SHELL
? 1 : 0;
2876 vty_shell_serv (struct vty
*vty
)
2878 return vty
->type
== VTY_SHELL_SERV
? 1 : 0;
2884 vtyvec
= vector_init (VECTOR_MIN_SIZE
);
2887 /* Install vty's own commands like `who' command. */
2889 vty_init (struct thread_master
*master_thread
)
2891 /* For further configuration read, preserve current directory. */
2894 vtyvec
= vector_init (VECTOR_MIN_SIZE
);
2896 master
= master_thread
;
2898 /* Initilize server thread vector. */
2899 Vvty_serv_thread
= vector_init (VECTOR_MIN_SIZE
);
2901 /* Install bgp top node. */
2902 install_node (&vty_node
, vty_config_write
);
2904 install_element (VIEW_NODE
, &config_who_cmd
);
2905 install_element (VIEW_NODE
, &show_history_cmd
);
2906 install_element (ENABLE_NODE
, &config_who_cmd
);
2907 install_element (CONFIG_NODE
, &line_vty_cmd
);
2908 install_element (CONFIG_NODE
, &service_advanced_vty_cmd
);
2909 install_element (CONFIG_NODE
, &no_service_advanced_vty_cmd
);
2910 install_element (CONFIG_NODE
, &show_history_cmd
);
2911 install_element (ENABLE_NODE
, &terminal_monitor_cmd
);
2912 install_element (ENABLE_NODE
, &terminal_no_monitor_cmd
);
2913 install_element (ENABLE_NODE
, &no_terminal_monitor_cmd
);
2914 install_element (ENABLE_NODE
, &show_history_cmd
);
2916 install_default (VTY_NODE
);
2917 install_element (VTY_NODE
, &exec_timeout_min_cmd
);
2918 install_element (VTY_NODE
, &exec_timeout_sec_cmd
);
2919 install_element (VTY_NODE
, &no_exec_timeout_cmd
);
2920 install_element (VTY_NODE
, &vty_access_class_cmd
);
2921 install_element (VTY_NODE
, &no_vty_access_class_cmd
);
2922 install_element (VTY_NODE
, &vty_login_cmd
);
2923 install_element (VTY_NODE
, &no_vty_login_cmd
);
2925 install_element (VTY_NODE
, &vty_ipv6_access_class_cmd
);
2926 install_element (VTY_NODE
, &no_vty_ipv6_access_class_cmd
);
2927 #endif /* HAVE_IPV6 */