1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
29 #include "telnet_server.h"
30 #include <target/target_request.h>
31 #include <helper/configuration.h>
32 #include <helper/list.h>
34 static char *telnet_port
;
36 static char *negotiate
=
37 "\xFF\xFB\x03" /* IAC WILL Suppress Go Ahead */
38 "\xFF\xFB\x01" /* IAC WILL Echo */
39 "\xFF\xFD\x03" /* IAC DO Suppress Go Ahead */
40 "\xFF\xFE\x01"; /* IAC DON'T Echo */
42 #define CTRL(c) (c - '@')
43 #define TELNET_HISTORY ".openocd_history"
45 /* The only way we can detect that the socket is closed is the first time
46 * we write to it, we will fail. Subsequent write operations will
49 static int telnet_write(struct connection
*connection
, const void *data
,
52 struct telnet_connection
*t_con
= connection
->priv
;
54 return ERROR_SERVER_REMOTE_CLOSED
;
56 if (connection_write(connection
, data
, len
) == len
)
59 return ERROR_SERVER_REMOTE_CLOSED
;
62 /* output an audible bell */
63 static int telnet_bell(struct connection
*connection
)
65 /* ("\a" does not work, at least on windows) */
66 return telnet_write(connection
, "\x07", 1);
69 static int telnet_prompt(struct connection
*connection
)
71 struct telnet_connection
*t_con
= connection
->priv
;
73 return telnet_write(connection
, t_con
->prompt
, strlen(t_con
->prompt
));
76 static int telnet_outputline(struct connection
*connection
, const char *line
)
80 /* process lines in buffer */
82 char *line_end
= strchr(line
, '\n');
89 telnet_write(connection
, line
, len
);
91 telnet_write(connection
, "\r\n", 2);
100 static int telnet_output(struct command_context
*cmd_ctx
, const char *line
)
102 struct connection
*connection
= cmd_ctx
->output_handler_priv
;
104 return telnet_outputline(connection
, line
);
107 static void telnet_log_callback(void *priv
, const char *file
, unsigned line
,
108 const char *function
, const char *string
)
110 struct connection
*connection
= priv
;
111 struct telnet_connection
*t_con
= connection
->priv
;
115 /* If the prompt is not visible, simply output the message. */
116 if (!t_con
->prompt_visible
) {
117 telnet_outputline(connection
, string
);
121 /* Clear the command line. */
122 tmp
= strlen(t_con
->prompt
) + t_con
->line_size
;
124 for (i
= 0; i
< tmp
; i
+= 16)
125 telnet_write(connection
, "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b",
128 for (i
= 0; i
< tmp
; i
+= 16)
129 telnet_write(connection
, " ", MIN(tmp
- i
, 16));
131 for (i
= 0; i
< tmp
; i
+= 16)
132 telnet_write(connection
, "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b",
135 telnet_outputline(connection
, string
);
137 /* Put the command line to its previous state. */
138 telnet_prompt(connection
);
139 telnet_write(connection
, t_con
->line
, t_con
->line_size
);
141 for (i
= t_con
->line_cursor
; i
< t_con
->line_size
; i
++)
142 telnet_write(connection
, "\b", 1);
145 static void telnet_load_history(struct telnet_connection
*t_con
)
148 char buffer
[TELNET_BUFFER_SIZE
];
151 char *history
= get_home_dir(TELNET_HISTORY
);
154 LOG_INFO("unable to get user home directory, telnet history will be disabled");
158 histfp
= fopen(history
, "rb");
162 while (fgets(buffer
, sizeof(buffer
), histfp
)) {
164 char *p
= strchr(buffer
, '\n');
167 if (buffer
[0] && i
< TELNET_LINE_HISTORY_SIZE
)
168 t_con
->history
[i
++] = strdup(buffer
);
171 t_con
->next_history
= i
;
172 t_con
->next_history
%= TELNET_LINE_HISTORY_SIZE
;
173 /* try to set to last entry - 1, that way we skip over any exit/shutdown cmds */
174 t_con
->current_history
= t_con
->next_history
> 0 ? i
- 1 : 0;
181 static void telnet_save_history(struct telnet_connection
*t_con
)
187 char *history
= get_home_dir(TELNET_HISTORY
);
190 LOG_INFO("unable to get user home directory, telnet history will be disabled");
194 histfp
= fopen(history
, "wb");
198 num
= TELNET_LINE_HISTORY_SIZE
;
199 i
= t_con
->current_history
+ 1;
200 i
%= TELNET_LINE_HISTORY_SIZE
;
202 while (!t_con
->history
[i
] && num
> 0) {
204 i
%= TELNET_LINE_HISTORY_SIZE
;
209 for (; num
> 0; num
--) {
210 fprintf(histfp
, "%s\n", t_con
->history
[i
]);
212 i
%= TELNET_LINE_HISTORY_SIZE
;
221 static int telnet_new_connection(struct connection
*connection
)
223 struct telnet_connection
*telnet_connection
;
224 struct telnet_service
*telnet_service
= connection
->service
->priv
;
227 telnet_connection
= malloc(sizeof(struct telnet_connection
));
229 if (!telnet_connection
) {
230 LOG_ERROR("Failed to allocate telnet connection.");
234 connection
->priv
= telnet_connection
;
236 /* initialize telnet connection information */
237 telnet_connection
->closed
= false;
238 telnet_connection
->line_size
= 0;
239 telnet_connection
->line_cursor
= 0;
240 telnet_connection
->prompt
= strdup("> ");
241 telnet_connection
->prompt_visible
= true;
242 telnet_connection
->state
= TELNET_STATE_DATA
;
244 /* output goes through telnet connection */
245 command_set_output_handler(connection
->cmd_ctx
, telnet_output
, connection
);
247 /* negotiate telnet options */
248 telnet_write(connection
, negotiate
, strlen(negotiate
));
250 /* print connection banner */
251 if (telnet_service
->banner
) {
252 telnet_write(connection
, telnet_service
->banner
, strlen(telnet_service
->banner
));
253 telnet_write(connection
, "\r\n", 2);
256 /* the prompt is always placed at the line beginning */
257 telnet_write(connection
, "\r", 1);
258 telnet_prompt(connection
);
260 /* initialize history */
261 for (i
= 0; i
< TELNET_LINE_HISTORY_SIZE
; i
++)
262 telnet_connection
->history
[i
] = NULL
;
263 telnet_connection
->next_history
= 0;
264 telnet_connection
->current_history
= 0;
265 telnet_load_history(telnet_connection
);
267 log_add_callback(telnet_log_callback
, connection
);
272 static void telnet_clear_line(struct connection
*connection
,
273 struct telnet_connection
*t_con
)
275 /* move to end of line */
276 if (t_con
->line_cursor
< t_con
->line_size
)
277 telnet_write(connection
,
278 t_con
->line
+ t_con
->line_cursor
,
279 t_con
->line_size
- t_con
->line_cursor
);
281 /* backspace, overwrite with space, backspace */
282 while (t_con
->line_size
> 0) {
283 telnet_write(connection
, "\b \b", 3);
286 t_con
->line_cursor
= 0;
289 static void telnet_history_go(struct connection
*connection
, int idx
)
291 struct telnet_connection
*t_con
= connection
->priv
;
293 if (t_con
->history
[idx
]) {
294 telnet_clear_line(connection
, t_con
);
295 t_con
->line_size
= strlen(t_con
->history
[idx
]);
296 t_con
->line_cursor
= t_con
->line_size
;
297 memcpy(t_con
->line
, t_con
->history
[idx
], t_con
->line_size
);
298 telnet_write(connection
, t_con
->line
, t_con
->line_size
);
299 t_con
->current_history
= idx
;
301 t_con
->state
= TELNET_STATE_DATA
;
304 static void telnet_history_up(struct connection
*connection
)
306 struct telnet_connection
*t_con
= connection
->priv
;
308 size_t last_history
= (t_con
->current_history
> 0) ?
309 t_con
->current_history
- 1 :
310 TELNET_LINE_HISTORY_SIZE
-1;
311 telnet_history_go(connection
, last_history
);
314 static void telnet_history_down(struct connection
*connection
)
316 struct telnet_connection
*t_con
= connection
->priv
;
319 next_history
= (t_con
->current_history
+ 1) % TELNET_LINE_HISTORY_SIZE
;
320 telnet_history_go(connection
, next_history
);
323 static int telnet_history_print(struct connection
*connection
)
325 struct telnet_connection
*tc
;
327 tc
= connection
->priv
;
329 for (size_t i
= 1; i
< TELNET_LINE_HISTORY_SIZE
; i
++) {
333 * The tc->next_history line contains empty string (unless NULL), thus
336 line
= tc
->history
[(tc
->next_history
+ i
) % TELNET_LINE_HISTORY_SIZE
];
339 telnet_write(connection
, line
, strlen(line
));
340 telnet_write(connection
, "\r\n\x00", 3);
347 /* The prompt is always placed at the line beginning. */
348 telnet_write(connection
, "\r", 1);
350 return telnet_prompt(connection
);
353 static void telnet_move_cursor(struct connection
*connection
, size_t pos
)
355 struct telnet_connection
*tc
= connection
->priv
;
358 if (pos
== tc
->line_cursor
) /* nothing to do */
361 if (pos
> tc
->line_size
) /* out of bounds */
364 if (pos
< tc
->line_cursor
) {
365 tmp
= tc
->line_cursor
- pos
;
367 for (size_t i
= 0; i
< tmp
; i
+= 16)
368 telnet_write(connection
, "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b",
371 tmp
= pos
- tc
->line_cursor
;
373 for (size_t i
= 0; i
< tmp
; i
+= 16)
374 telnet_write(connection
, tc
->line
+ tc
->line_cursor
+ i
,
378 tc
->line_cursor
= pos
;
381 /* check buffer size leaving one spare character for string null termination */
382 static inline bool telnet_can_insert(struct connection
*connection
, size_t len
)
384 struct telnet_connection
*t_con
= connection
->priv
;
386 return t_con
->line_size
+ len
< TELNET_LINE_MAX_SIZE
;
389 /* write to telnet console, and update the telnet_connection members
390 * this function is capable of inserting in the middle of a line
391 * please ensure that data does not contain special characters (\n, \r, \t, \b ...)
393 * returns false when it fails to insert the requested data
395 static bool telnet_insert(struct connection
*connection
, const void *data
, size_t len
)
397 struct telnet_connection
*t_con
= connection
->priv
;
399 if (!telnet_can_insert(connection
, len
)) {
400 telnet_bell(connection
);
404 if (t_con
->line_cursor
< t_con
->line_size
) {
405 /* we have some content after the cursor */
406 memmove(t_con
->line
+ t_con
->line_cursor
+ len
,
407 t_con
->line
+ t_con
->line_cursor
,
408 t_con
->line_size
- t_con
->line_cursor
);
411 strncpy(t_con
->line
+ t_con
->line_cursor
, data
, len
);
413 telnet_write(connection
,
414 t_con
->line
+ t_con
->line_cursor
,
415 t_con
->line_size
+ len
- t_con
->line_cursor
);
417 t_con
->line_size
+= len
;
418 t_con
->line_cursor
+= len
;
420 for (size_t i
= t_con
->line_cursor
; i
< t_con
->line_size
; i
++)
421 telnet_write(connection
, "\b", 1);
426 static void telnet_auto_complete(struct connection
*connection
)
428 struct telnet_connection
*t_con
= connection
->priv
;
429 struct command_context
*command_context
= connection
->cmd_ctx
;
438 /* user command sequence, either at line beginning
439 * or we start over after these characters ';', '[', '{' */
440 size_t seq_start
= (t_con
->line_cursor
== 0) ? 0 : (t_con
->line_cursor
- 1);
441 while (seq_start
> 0) {
442 char c
= t_con
->line
[seq_start
];
443 if (c
== ';' || c
== '[' || c
== '{') {
451 /* user command position in the line, ignore leading spaces */
452 size_t usr_cmd_pos
= seq_start
;
453 while ((usr_cmd_pos
< t_con
->line_cursor
) && isspace(t_con
->line
[usr_cmd_pos
]))
456 /* user command length */
457 size_t usr_cmd_len
= t_con
->line_cursor
- usr_cmd_pos
;
459 /* optimize multiple spaces in the user command,
460 * because info commands does not tolerate multiple spaces */
461 size_t optimized_spaces
= 0;
462 char query
[usr_cmd_len
+ 1];
463 for (size_t i
= 0; i
< usr_cmd_len
; i
++) {
464 if ((i
< usr_cmd_len
- 1) && isspace(t_con
->line
[usr_cmd_pos
+ i
])
465 && isspace(t_con
->line
[usr_cmd_pos
+ i
+ 1])) {
470 query
[i
- optimized_spaces
] = t_con
->line
[usr_cmd_pos
+ i
];
473 usr_cmd_len
-= optimized_spaces
;
474 query
[usr_cmd_len
] = '\0';
476 /* filter commands */
477 char *query_cmd
= alloc_printf("_telnet_autocomplete_helper {%s*}", query
);
480 LOG_ERROR("Out of memory");
484 int retval
= Jim_EvalSource(command_context
->interp
, __FILE__
, __LINE__
, query_cmd
);
486 if (retval
!= JIM_OK
)
489 Jim_Obj
*list
= Jim_GetResult(command_context
->interp
);
490 Jim_IncrRefCount(list
);
492 /* common prefix length of the matched commands */
493 size_t common_len
= 0;
494 char *first_match
= NULL
; /* used to compute the common prefix length */
496 int len
= Jim_ListLength(command_context
->interp
, list
);
497 for (int i
= 0; i
< len
; i
++) {
498 Jim_Obj
*elem
= Jim_ListGetIndex(command_context
->interp
, list
, i
);
499 Jim_IncrRefCount(elem
);
501 char *name
= (char *)Jim_GetString(elem
, NULL
);
503 /* validate the command */
504 bool ignore_cmd
= false;
505 Jim_Cmd
*jim_cmd
= Jim_GetCommand(command_context
->interp
, elem
, JIM_NONE
);
508 /* Why we are here? Let's ignore it! */
510 } else if (jimcmd_is_oocd_command(jim_cmd
)) {
511 struct command
*cmd
= jimcmd_privdata(jim_cmd
);
513 if (cmd
&& !cmd
->handler
&& !cmd
->jim_handler
) {
514 /* Initial part of a multi-word command. Ignore it! */
516 } else if (cmd
&& cmd
->mode
== COMMAND_CONFIG
) {
517 /* Not executable after config phase. Ignore it! */
522 /* save the command in the prediction list */
524 struct cmd_match
*match
= calloc(1, sizeof(struct cmd_match
));
526 LOG_ERROR("Out of memory");
527 Jim_DecrRefCount(command_context
->interp
, elem
);
528 break; /* break the for loop */
531 if (list_empty(&matches
)) {
532 common_len
= strlen(name
);
535 size_t new_common_len
= usr_cmd_len
; /* save some loops */
537 while (new_common_len
< common_len
&& first_match
[new_common_len
] == name
[new_common_len
])
540 common_len
= new_common_len
;
544 list_add_tail(&match
->lh
, &matches
);
547 Jim_DecrRefCount(command_context
->interp
, elem
);
549 /* end of command filtering */
551 /* proceed with auto-completion */
552 if (list_empty(&matches
))
553 telnet_bell(connection
);
554 else if (common_len
== usr_cmd_len
&& list_is_singular(&matches
) && t_con
->line_cursor
== t_con
->line_size
)
555 telnet_insert(connection
, " ", 1);
556 else if (common_len
> usr_cmd_len
) {
557 int completion_size
= common_len
- usr_cmd_len
;
558 if (telnet_insert(connection
, first_match
+ usr_cmd_len
, completion_size
)) {
559 /* in bash this extra space is only added when the cursor in at the end of line */
560 if (list_is_singular(&matches
) && t_con
->line_cursor
== t_con
->line_size
)
561 telnet_insert(connection
, " ", 1);
563 } else if (!list_is_singular(&matches
)) {
564 telnet_write(connection
, "\n\r", 2);
566 struct cmd_match
*match
;
567 list_for_each_entry(match
, &matches
, lh
) {
568 telnet_write(connection
, match
->cmd
, strlen(match
->cmd
));
569 telnet_write(connection
, "\n\r", 2);
572 telnet_prompt(connection
);
573 telnet_write(connection
, t_con
->line
, t_con
->line_size
);
575 /* restore the terminal visible cursor location */
576 for (size_t i
= t_con
->line_cursor
; i
< t_con
->line_size
; i
++)
577 telnet_write(connection
, "\b", 1);
580 /* destroy the command_list */
581 struct cmd_match
*tmp
, *match
;
582 list_for_each_entry_safe(match
, tmp
, &matches
, lh
)
585 Jim_DecrRefCount(command_context
->interp
, list
);
588 static int telnet_input(struct connection
*connection
)
591 unsigned char buffer
[TELNET_BUFFER_SIZE
];
592 unsigned char *buf_p
;
593 struct telnet_connection
*t_con
= connection
->priv
;
594 struct command_context
*command_context
= connection
->cmd_ctx
;
596 bytes_read
= connection_read(connection
, buffer
, TELNET_BUFFER_SIZE
);
599 return ERROR_SERVER_REMOTE_CLOSED
;
600 else if (bytes_read
== -1) {
601 LOG_ERROR("error during read: %s", strerror(errno
));
602 return ERROR_SERVER_REMOTE_CLOSED
;
607 switch (t_con
->state
) {
608 case TELNET_STATE_DATA
:
609 if (*buf_p
== 0xff) {
610 t_con
->state
= TELNET_STATE_IAC
;
612 if (isprint(*buf_p
)) { /* printable character */
613 telnet_insert(connection
, buf_p
, 1);
614 } else { /* non-printable */
615 if (*buf_p
== 0x1b) { /* escape */
616 t_con
->state
= TELNET_STATE_ESCAPE
;
617 t_con
->last_escape
= '\x00';
618 } else if ((*buf_p
== 0xd) || (*buf_p
== 0xa)) { /* CR/LF */
621 /* skip over combinations with CR/LF and NUL characters */
622 if ((bytes_read
> 1) && ((*(buf_p
+ 1) == 0xa) ||
623 (*(buf_p
+ 1) == 0xd))) {
627 if ((bytes_read
> 1) && (*(buf_p
+ 1) == 0)) {
631 t_con
->line
[t_con
->line_size
] = 0;
633 telnet_write(connection
, "\r\n\x00", 3);
635 if (strcmp(t_con
->line
, "history") == 0) {
636 retval
= telnet_history_print(connection
);
638 if (retval
!= ERROR_OK
)
644 /* save only non-blank not repeating lines in the history */
645 char *prev_line
= t_con
->history
[(t_con
->current_history
> 0) ?
646 t_con
->current_history
- 1 : TELNET_LINE_HISTORY_SIZE
-1];
647 if (*t_con
->line
&& (!prev_line
||
648 strcmp(t_con
->line
, prev_line
))) {
649 /* if the history slot is already taken, free it */
650 free(t_con
->history
[t_con
->next_history
]);
652 /* add line to history */
653 t_con
->history
[t_con
->next_history
] = strdup(t_con
->line
);
655 /* wrap history at TELNET_LINE_HISTORY_SIZE */
656 t_con
->next_history
= (t_con
->next_history
+ 1) %
657 TELNET_LINE_HISTORY_SIZE
;
659 /* current history line starts at the new entry */
660 t_con
->current_history
=
663 free(t_con
->history
[t_con
->current_history
]);
664 t_con
->history
[t_con
->current_history
] = strdup("");
667 t_con
->line_size
= 0;
669 /* to suppress prompt in log callback during command execution */
670 t_con
->prompt_visible
= false;
672 if (strcmp(t_con
->line
, "shutdown") == 0)
673 telnet_save_history(t_con
);
675 retval
= command_run_line(command_context
, t_con
->line
);
677 t_con
->line_cursor
= 0;
678 t_con
->prompt_visible
= true;
680 if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
681 return ERROR_SERVER_REMOTE_CLOSED
;
683 /* the prompt is always * placed at the line beginning */
684 telnet_write(connection
, "\r", 1);
686 retval
= telnet_prompt(connection
);
687 if (retval
== ERROR_SERVER_REMOTE_CLOSED
)
688 return ERROR_SERVER_REMOTE_CLOSED
;
690 } else if ((*buf_p
== 0x7f) || (*buf_p
== 0x8)) { /* delete character */
691 if (t_con
->line_cursor
> 0) {
692 if (t_con
->line_cursor
!= t_con
->line_size
) {
694 telnet_write(connection
, "\b", 1);
695 t_con
->line_cursor
--;
697 memmove(t_con
->line
+ t_con
->line_cursor
,
698 t_con
->line
+ t_con
->line_cursor
+ 1,
702 telnet_write(connection
,
703 t_con
->line
+ t_con
->line_cursor
,
706 telnet_write(connection
, " \b", 2);
707 for (i
= t_con
->line_cursor
; i
< t_con
->line_size
; i
++)
708 telnet_write(connection
, "\b", 1);
711 t_con
->line_cursor
--;
712 /* back space: move the 'printer' head one char
713 * back, overwrite with space, move back again */
714 telnet_write(connection
, "\b \b", 3);
717 } else if (*buf_p
== 0x15) { /* clear line */
718 telnet_clear_line(connection
, t_con
);
719 } else if (*buf_p
== CTRL('B')) { /* cursor left */
720 if (t_con
->line_cursor
> 0) {
721 telnet_write(connection
, "\b", 1);
722 t_con
->line_cursor
--;
724 t_con
->state
= TELNET_STATE_DATA
;
725 } else if (*buf_p
== CTRL('C')) { /* interrupt */
726 /* print '^C' at line end, and display a new command prompt */
727 telnet_move_cursor(connection
, t_con
->line_size
);
728 telnet_write(connection
, "^C\n\r", 4);
729 t_con
->line_cursor
= 0;
730 t_con
->line_size
= 0;
731 telnet_prompt(connection
);
732 } else if (*buf_p
== CTRL('F')) { /* cursor right */
733 if (t_con
->line_cursor
< t_con
->line_size
)
734 telnet_write(connection
, t_con
->line
+ t_con
->line_cursor
++, 1);
735 t_con
->state
= TELNET_STATE_DATA
;
736 } else if (*buf_p
== CTRL('P')) { /* cursor up */
737 telnet_history_up(connection
);
738 } else if (*buf_p
== CTRL('N')) { /* cursor down */
739 telnet_history_down(connection
);
740 } else if (*buf_p
== CTRL('A')) { /* move the cursor to the beginning of the line */
741 telnet_move_cursor(connection
, 0);
742 } else if (*buf_p
== CTRL('E')) { /* move the cursor to the end of the line */
743 telnet_move_cursor(connection
, t_con
->line_size
);
744 } else if (*buf_p
== CTRL('K')) { /* kill line to end */
745 if (t_con
->line_cursor
< t_con
->line_size
) {
746 /* overwrite with space, until end of line, move back */
747 for (size_t i
= t_con
->line_cursor
; i
< t_con
->line_size
; i
++)
748 telnet_write(connection
, " ", 1);
749 for (size_t i
= t_con
->line_cursor
; i
< t_con
->line_size
; i
++)
750 telnet_write(connection
, "\b", 1);
751 t_con
->line
[t_con
->line_cursor
] = '\0';
752 t_con
->line_size
= t_con
->line_cursor
;
754 } else if (*buf_p
== '\t') {
755 telnet_auto_complete(connection
);
757 LOG_DEBUG("unhandled nonprintable: %2.2x", *buf_p
);
762 case TELNET_STATE_IAC
:
765 t_con
->state
= TELNET_STATE_DONT
;
768 t_con
->state
= TELNET_STATE_DO
;
771 t_con
->state
= TELNET_STATE_WONT
;
774 t_con
->state
= TELNET_STATE_WILL
;
778 case TELNET_STATE_SB
:
780 case TELNET_STATE_SE
:
782 case TELNET_STATE_WILL
:
783 case TELNET_STATE_WONT
:
784 case TELNET_STATE_DO
:
785 case TELNET_STATE_DONT
:
786 t_con
->state
= TELNET_STATE_DATA
;
788 case TELNET_STATE_ESCAPE
:
789 if (t_con
->last_escape
== '[') {
790 if (*buf_p
== 'D') { /* cursor left */
791 if (t_con
->line_cursor
> 0) {
792 telnet_write(connection
, "\b", 1);
793 t_con
->line_cursor
--;
795 t_con
->state
= TELNET_STATE_DATA
;
796 } else if (*buf_p
== 'C') { /* cursor right */
797 if (t_con
->line_cursor
< t_con
->line_size
)
798 telnet_write(connection
,
799 t_con
->line
+ t_con
->line_cursor
++, 1);
800 t_con
->state
= TELNET_STATE_DATA
;
801 } else if (*buf_p
== 'A') { /* cursor up */
802 telnet_history_up(connection
);
803 } else if (*buf_p
== 'B') { /* cursor down */
804 telnet_history_down(connection
);
805 } else if (*buf_p
== 'F') { /* end key */
806 telnet_move_cursor(connection
, t_con
->line_size
);
807 t_con
->state
= TELNET_STATE_DATA
;
808 } else if (*buf_p
== 'H') { /* home key */
809 telnet_move_cursor(connection
, 0);
810 t_con
->state
= TELNET_STATE_DATA
;
811 } else if (*buf_p
== '3') {
812 t_con
->last_escape
= *buf_p
;
814 t_con
->state
= TELNET_STATE_DATA
;
816 } else if (t_con
->last_escape
== '3') {
817 /* Remove character */
819 if (t_con
->line_cursor
< t_con
->line_size
) {
822 /* remove char from line buffer */
823 memmove(t_con
->line
+ t_con
->line_cursor
,
824 t_con
->line
+ t_con
->line_cursor
+ 1,
825 t_con
->line_size
- t_con
->line_cursor
);
827 /* print remainder of buffer */
828 telnet_write(connection
, t_con
->line
+ t_con
->line_cursor
,
829 t_con
->line_size
- t_con
->line_cursor
);
830 /* overwrite last char with whitespace */
831 telnet_write(connection
, " \b", 2);
833 /* move back to cursor position*/
834 for (i
= t_con
->line_cursor
; i
< t_con
->line_size
; i
++)
835 telnet_write(connection
, "\b", 1);
838 t_con
->state
= TELNET_STATE_DATA
;
840 t_con
->state
= TELNET_STATE_DATA
;
841 } else if (t_con
->last_escape
== '\x00') {
843 t_con
->last_escape
= *buf_p
;
845 t_con
->state
= TELNET_STATE_DATA
;
847 LOG_ERROR("BUG: unexpected value in t_con->last_escape");
848 t_con
->state
= TELNET_STATE_DATA
;
853 LOG_ERROR("unknown telnet state");
864 static int telnet_connection_closed(struct connection
*connection
)
866 struct telnet_connection
*t_con
= connection
->priv
;
869 log_remove_callback(telnet_log_callback
, connection
);
872 t_con
->prompt
= NULL
;
874 /* save telnet history */
875 telnet_save_history(t_con
);
877 for (i
= 0; i
< TELNET_LINE_HISTORY_SIZE
; i
++) {
878 free(t_con
->history
[i
]);
879 t_con
->history
[i
] = NULL
;
882 /* if this connection registered a debug-message receiver delete it */
883 delete_debug_msg_receiver(connection
->cmd_ctx
, NULL
);
885 free(connection
->priv
);
886 connection
->priv
= NULL
;
891 int telnet_init(char *banner
)
893 if (strcmp(telnet_port
, "disabled") == 0) {
894 LOG_INFO("telnet server disabled");
898 struct telnet_service
*telnet_service
=
899 malloc(sizeof(struct telnet_service
));
901 if (!telnet_service
) {
902 LOG_ERROR("Failed to allocate telnet service.");
906 telnet_service
->banner
= banner
;
908 int ret
= add_service("telnet", telnet_port
, CONNECTION_LIMIT_UNLIMITED
,
909 telnet_new_connection
, telnet_input
, telnet_connection_closed
,
912 if (ret
!= ERROR_OK
) {
913 free(telnet_service
);
920 /* daemon configuration command telnet_port */
921 COMMAND_HANDLER(handle_telnet_port_command
)
923 return CALL_COMMAND_HANDLER(server_pipe_command
, &telnet_port
);
926 COMMAND_HANDLER(handle_exit_command
)
928 return ERROR_COMMAND_CLOSE_CONNECTION
;
931 static const struct command_registration telnet_command_handlers
[] = {
934 .handler
= handle_exit_command
,
935 .mode
= COMMAND_EXEC
,
937 .help
= "exit telnet session",
940 .name
= "telnet_port",
941 .handler
= handle_telnet_port_command
,
942 .mode
= COMMAND_CONFIG
,
943 .help
= "Specify port on which to listen "
944 "for incoming telnet connections. "
945 "Read help on 'gdb_port'.",
946 .usage
= "[port_num]",
948 COMMAND_REGISTRATION_DONE
951 int telnet_register_commands(struct command_context
*cmd_ctx
)
953 telnet_port
= strdup("4444");
954 return register_commands(cmd_ctx
, NULL
, telnet_command_handlers
);
957 void telnet_service_free(void)
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)