LwIP应用开发笔记之九:LwIP无操作系统TELNET服务器
前面我们已经实现了基于RAW API的TCP服务器和客户端,也在此基础上实现了HTTP应用。接下来我们实现一个基于TCP的Telnet服务器应用。
1、Telnet协议简介
Telnet协议是TCP/IP协议族中的一员,是Internet远程登陆服务的标准协议和主要方式。它为用户提供了在本地计算机上完成远程主机工作的能力。在终端使用者的电脑上使用telnet程序,用它连接到服务器。终端使用者可以在telnet程序中输入命令,这些命令会在服务器上运行,就像直接在服务器的控制台上输入一样。可以在本地就能控制服务器。要开始一个telnet会话,必须输入用户名和密码来登录服务器。Telnet是常用的远程控制Web服务器的方法。
Telnet是位于OSI模型的第7层---应用层上的一种协议,是一个通过创建虚拟终端提供连接到远程主机终端仿真的TCP/IP协议。这一协议需要通过用户名和口令进行认证,是Internet远程登陆服务的标准协议。应用Telnet协议能够把本地用户所使用的计算机变成远程主机系统的一个终端。它提供了三种基本服务:
- Telnet定义一个网络虚拟终端为远程系统提供一个标准接口。客户机程序不必详细了解远程系统,他们只需构造使用标准接口的程序;
- Telnet包括一个允许客户机和服务器协商选项的机制,而且它还提供一组标准选项; .
- Telnet对称处理连接的两端,即Telnet不强迫客户机从键盘输入,也不强迫客户机在屏幕上显示输出。
2、TELNET服务器的设计
Telnet是一种基于TCP实现的远程登录方式,Telnet协议也分配有固定端口23,在这里我们就是用这一端口来实现一个Telnet服务器。这个服务器可以提供给多个客户端访问。
我们要实现的这个Telnet服务器是比较简单的一个设计。当客户端成功链接到服务器后,服务器就会提示用户登录,成功登陆后就可以向服务器发送命令,当发送不同的命令时,服务器给出不同的响应。具体的操作流程设计如下:
从上面的流程图看其实我们设计的Telnet服务器功能已经非常明确了。但有两点需要描述一下。首先是关于连接状态的设定,在这里我们只是简单的将状态定义为两种:已登录和未登录。如果已登录则按命令交互来解析。如果未登录则按登录密码来解析。
另一方面,为了实现命令交互,我们需要为Telnet服务器设定命令。我们简单的设定6种命令:"hello"、"date"、"time"、"version"、"quit"与"help"等命令。事实上我们实现Telnet服务器主要就是处理:如何接收和响应这些命令。
3、TELNET服务器的实现
我们已经设计了Telnet服务器的基本功能。接下来就是如何实现它了。我们已经有前面实现TCP服务器的基础。所以实现他的重点就是我们设计的Telnet服务器了。
我们依然采用实现普通TCP服务器结构来实现Telnet服务器,只是在信息处理回调函数上更复杂一点。还有就是端口方面我们采用Telnet的惯用端口。首先必然是Telnet服务器的初始化。
1 /* TELNET服务器初始化配置*/ 2 void Telnet_Server_Initialization(void) 3 { 4 struct tcp_pcb *pcb; 5 6 /* 生成一个新的TCP控制块 */ 7 pcb = tcp_new(); 8 9 /* 控制块邦定到本地IP和对应端口 */ 10 tcp_bind(pcb, IP_ADDR_ANY, TCP_TELNET_SERVER_PORT); 11 12 /* 服务器进入侦听状态 */ 13 pcb = tcp_listen(pcb); 14 15 /* 注册服务器accept回调函数 */ 16 tcp_accept(pcb, TelnetServerAccept); 17 }
其实初始化部分就是我们已经熟悉的TCP服务器的初始化,只是使用了Telnet的惯用端口。接下来就是实现在初始化中注册的Telnet服务器接收回调函数。该函数为tcp_accept_fn类型,注册到了监听控制块的accept字段。在服务器上有新连接建立时就会被内核调用。
1 /* TELNET接收回调函数,客户端建立连接后,本函数被调用 */ 2 static err_t TelnetServerAccept(void *arg, struct tcp_pcb *pcb, err_t err) 3 { 4 u32_t remote_ip; 5 char linkInfo [100]; 6 u8_t iptab[4]; 7 telnet_conn_arg *conn_arg = NULL; 8 remote_ip = pcb->remote_ip.addr; 9 10 iptab[0] = (u8_t)(remote_ip >> 24); 11 iptab[1] = (u8_t)(remote_ip >> 16); 12 iptab[2] = (u8_t)(remote_ip >> 8); 13 iptab[3] = (u8_t)(remote_ip); 14 15 //生成登录提示信息 16 sprintf(linkInfo, "Welcome to Telnet! your IP:Port --> [%d.%d.%d.%d:%d]\r\n", \ 17 iptab[3], iptab[2], iptab[1], iptab[0], pcb->remote_port); 18 19 conn_arg = mem_calloc(sizeof(telnet_conn_arg), 1); 20 if(!conn_arg) 21 { 22 return ERR_MEM; 23 } 24 25 conn_arg->state = TELNET_SETUP; 26 conn_arg->client_port = pcb->remote_port; 27 conn_arg->bytes_len = 0; 28 memset(conn_arg->bytes, 0, MAX_MSG_SIZE); 29 30 tcp_arg(pcb, conn_arg); 31 32 /* 注册Telnet服务器连接错误回调函数 */ 33 tcp_err(pcb, TelnetServeConnectError); 34 /* 注册Telnet服务器消息处理回调函数*/ 35 tcp_recv(pcb, TelnetServerCallback); 36 37 /* 连接成功,发送登录提示信息 */ 38 tcp_write(pcb, linkInfo, strlen(linkInfo), 1); 39 tcp_write(pcb, LOGIN_INFO, strlen(LOGIN_INFO), 1); 40 41 return ERR_OK; 42 }
在这个函数中,我们实现的功能主要是三方面:注册Telnet服务器消息处理回调函数;注册Telnet服务器连接错误回调函数;初始化Telnet服务器的状态。这个初始化是在连接建立后,Telnet服务器与客户端的交互初始化,比如登录状态,用户提示等。
在上面的函数中,我们注册了两个回调函数,接下来必然就是实现这两个函数。我们先来实现Telnet服务器信息处理回调函数。这个函数其实就是我们前面注册过的TCP服务器数据接收处理函数。这个函数是tcp_recv_fn类型。这是使用RAW API实现TCP服务器最重要的函数,因为我们实现的TCP服务器究竟有什么功能,完全依赖于这个函数及其所调用的函数。
1 /* TELNET服务器信息处理回调函数,在有消息需要处理时,调用此函数 */ 2 static err_t TelnetServerCallback(void *arg, struct tcp_pcb *pcb, struct pbuf *p, err_t err) 3 { 4 telnet_conn_arg *conn_args = (telnet_conn_arg *)arg; 5 char sndbuf[50]; 6 int strlen = 0; 7 int ret = 0; 8 9 if(NULL == conn_args || pcb->remote_port != conn_args->client_port) 10 { 11 if(p!= NULL) 12 { 13 pbuf_free(p); 14 } 15 return ERR_ARG; 16 } 17 18 if (p != NULL) 19 { 20 /* 更新接收窗口 */ 21 tcp_recved(pcb, p->tot_len); 22 23 ret = TelnetCommandInput(pcb, conn_args, p); 24 25 if(ret == 1)//是完整命令 26 { 27 switch(conn_args->state) 28 { 29 case TELNET_SETUP: 30 { 31 if(strcmp(conn_args->bytes,PASSWORD) == 0)//密码正确 32 { 33 strlen = sprintf(sndbuf,"##Hello! This is an LwIP-based Telnet Server##\r\n"); 34 tcp_write(pcb, sndbuf, strlen,TCP_WRITE_FLAG_COPY); 35 strlen = sprintf(sndbuf,"##Created by Moonan... ##\r\n"); 36 tcp_write(pcb, sndbuf, strlen,TCP_WRITE_FLAG_COPY); 37 strlen = sprintf(sndbuf,"##Enter help for help. Enter quit for quit.##\r\n"); 38 tcp_write(pcb, sndbuf, strlen,TCP_WRITE_FLAG_COPY); 39 strlen = sprintf(sndbuf,"LwIP Telnet>"); 40 tcp_write(pcb,sndbuf,strlen, 1); 41 42 conn_args->state = TELNET_CONNECTED;//转换状态 43 } 44 else//密码错误,提示重新登录 45 { 46 strlen = sprintf(sndbuf,"##PASSWORD ERROR! Try again:##\r\n"); 47 tcp_write(pcb, sndbuf, strlen,TCP_WRITE_FLAG_COPY); 48 } 49 memset(conn_args->bytes, 0, MAX_MSG_SIZE); 50 conn_args->bytes_len = 0; 51 break; 52 } 53 case TELNET_CONNECTED: 54 { 55 if(TelnetCommandParse(pcb, conn_args->bytes) == 0) 56 { 57 memset(conn_args->bytes, 0, MAX_MSG_SIZE); 58 conn_args->bytes_len = 0; 59 } 60 else 61 { 62 /* 服务器关闭连接 */ 63 ServerCloseTelnetConnection(pcb); 64 } 65 break; 66 } 67 default: 68 { 69 break; 70 } 71 } 72 } 73 pbuf_free(p); 74 } 75 else if (err == ERR_OK) 76 { 77 /* 服务器关闭连接 */ 78 ServerCloseTelnetConnection(pcb); 79 } 80 81 return ERR_OK; 82 83 }
在这个函数中,我们实现了Telnet服务器的各种功能,如登录验证,命令检查,命令响应等。已经具备一个Telnet服务器的基本框架。接下来还要实现Telnet连接错误回调函数。这个函数是tcp_err_fn类型,在这个程序中主要完成连接异常结束时的一些处理,可以释放一些必要的资源。在这个函数被内核调用时,连接实际上已经断开,相关控制块也已经被删除。所以在这个函数中我们可以重新初始化连接及其资源。
1 /* TELNET连接错误回调函数,连接故障时调用本函数 */ 2 static void TelnetServeConnectError(void *arg, err_t err) 3 { 4 Telnet_Server_Initialization(); 5 }
至此,我们就实现了一个简单的Telnet服务器,当然它只是一个雏形,需要开发更复杂的功能则需要修改这几个回调函数。
4、TELNET服务器总结
我们已经实现了一个简单的Telnet服务器。当然,我们的目的主要是以此来学习基于LwIP的复杂的TCP应用。事实上理解了TCP服务器的实现机制,诸如此类基于TCP的高级应用协议并不是特别复杂的事情。
欢迎关注:
如果阅读这篇文章让您略有所得,还请点击下方的【好文要顶】按钮。
当然,如果您想及时了解我的博客更新,不妨点击下方的【关注我】按钮。
如果您希望更方便且及时的阅读相关文章,也可以扫描上方二维码关注我的微信公众号【木南创智】