广东电信aWiFi平台接口规范标准详.docx

《广东电信aWiFi平台接口规范标准详.docx》由会员分享，可在线阅读，更多相关《广东电信aWiFi平台接口规范标准详.docx（16页珍藏版）》请在课桌文档上搜索。

1、目 录电信aWiFi平台接口规1第1章 前言11.1aWiFi系统概述11.2网络架构2第2章 aWiFi平台认证接口规42.1概述42.2WiFi用户上线42.3保活和下线7第3章 aWiFi平台云AC接口规103.1概述103.2连接登陆云AC113.3心跳与断开重连机制123.4执行配置管理13测试连接13设置SSID14重启14远程升级1415 / 16第1章 前言本标准是电信aWiFi终端系列企业标准之一，该系列标准目前包括：1) 电信aWiFi终端规-技术指标；2) 电信aWiFi终端技术要求-xxx3) 电信aWiFi平台接口规；4) 电信aWiFi平安审计平台接口规本文描述aW

2、iFi系统中，aWiFi终端设备与aWiFi平台的通信协议流程，包括aWiFi终端设备与aWiFi平台认证效劳的接口，aWiFi终端设备与aWiFi平台云AC通信的接口。1.1 aWiFi系统概述电信aWiFi系统由WiFi用户手机，平板电脑等、WiFi网络接入设备、aWiFi管理平台和BOSS系统组成。 WiFi网络接入设备分为两类，一类是集中控制型AC+瘦AP设备，一类是aWiFi终端。aWiFi管理平台部又可分为两局部：云AC平台和认证效劳平台。分别负责aWiFi终端设备管理和广告推送效劳。为客户提供aWiFi业务。aWiFi系统总体参考模型如图1所示。图：aWiFi系统模型aWiFi系

3、统模型说明如下：1) aWiFi终端aWiFi终端包括单AP终端，融合终端和一体终端，aWiFi终端与aWiFi平台之间使用统一的接口规，aWiFi终端的相关技术指标和接口在本系列规中说明。2) 参考点Mg参考点Mg是aWiFi管理平台和aWiFi终端之间的接口界面，包括终端设备管理和认证效劳两局部，实现aWiFi终端认证和业务配置管理。该接口界面将在本文中说明。3) 参考点Mc参考点Mc是aWiFi管理平台和AC+AP型WiFi网络接入设备之间的接口界面，实现WiFi终端认证和业务配置管理。1.2 网络架构aWiFi系统的网络架构如下列图所示：aWiFi业务平台网络架构如下列图所示第2章 a

4、WiFi平台认证接口规2.1 概述aWiFi终端和aWiFi平台认证效劳的通信协议是基于wifidog_protocol_V1为方便，本文直接用wifidog来代指在aWiFi终端中实现与认证平台通信的程序。aWiFi认证平台的信息如下：aWiFi认证平台主机(%SERVER)aWiFi认证平台端口(%PORT)80012.2 WiFi用户上线WiFi用户上线流程如下列图所示：1. 首先aWiFi终端通过iptables更改防火墙，将未认证的用户dnat到wifidog进程，当WiFi用户接入终端后访问外网时，wifidog首先拦截其 报文，然后询问aWiFi认证平台该用户是否准入，对应上图中

5、的流程，请例如下： /1.0User-Agent: WiFiDog 20150427报文以GET方法访问aWiFi认证平台的auth路径，其中参数stage=preauth表示当前为预鉴权阶段，ip为用户ip，mac为用户MAC，token为用户MAC的md5值，gw_id为aWiFi终端的MAC。2. 对于新用户，aWiFi认证平台将返回鉴权失败的200报文，对应上图中的流程，如下所示： /1.1 200 OKConnection: closeDate: Mon, 31 Aug 2015 11:30:28 GMTContent-Length: 7X-Powered-By: Servlet/2

6、.5 JSP/2.1Auth: 0当aWiFi认证平台返回Auth：1那么表示鉴权成功，wifidog随即放通用户，并把当前web请求重定向回原先访问页面，实现免登陆认证的接入上网；当aWiFi认证平台返回Auth：0那么表示需要该用户鉴权失败，需要登陆认证才能上网，此时wifidog那么通过307报文将用户重定向到aWiFi认证平台的认证页面，对应上图中的流程。重定向请例如下：GET /1.0User-Agent: WiFiDog 20150427报文以GET方法访问aWiFi认证平台的login路径，表示当前已经进入认证阶段，gw_address为aWiFi终端本地网关ip，gw_port

7、设定为2060，mac为用户MAC，gw_id为aWiFi终端的MAC，url为用户原本希望访问的页面。3. WiFi用户在登录页面，输入用户名密码，发送认证请求。4. 认证成功的话aWiFi认证平台发送302报文，携带token信息重定向到wifidog页面。认证失败的话返回失败页面。5. 用户携带token信息向wifidog发起认证请求，wifidog再向aWiFi认证平台发起请求，对应上图中的流程，请例如下： /1.0User-Agent: WiFiDog 20150427报文以GET方法访问aWiFi认证平台的auth路径，其中参数stage=login表示当前为登录鉴权阶段，ip为

8、用户ip，mac为用户MAC，token为用户MAC的md5值，gw_id为aWiFi终端的MAC。6. 认证成功后授权，aWiFi认证平台返回200包给wifidog，对应上图中的流程，如下所示： /1.1 200 OKConnection: closeDate: Tue, 01 Sep 2015 06:40:44 GMTContent-Length: 7X-Powered-By: Servlet/2.5 JSP/2.1Auth: 17. wifidog检测到Auth: 1，用307报文将用户重定向到成功登录页面，对应上图中的流程，如下所示。GET/smartwifi/portal/?gw_

9、id=D4EE07083302 /1.0User-Agent: WiFiDog 20150427报文以GET方法访问aWiFi认证平台的portal路径，其中参数gw_id为aWiFi终端的MAC。aWiFi认证平台根据此参数推送对应商家的成功页面。2.3 保活和下线1. aWiFi终端会定时向aWiFi认证平台发送保活消息。保活消息包括aWiFi终端自身保活和接入aWiFi终端的所有WiFi用户设备保活两局部。2. 其中aWiFi终端自身保活是指aWiFi终端和aWiFi认证平台链路检查。如下列图所示：请例如下所示：GET /smartwifi/ping/?gw_id=D4EE0708330

10、2&sys_uptime=7977811&sys_memfree=86908&sys_load=0.00&wifidog_uptime=362 /1.0User-Agent: WiFiDog 20150427报文以GET方法访问aWiFi认证平台的ping路径，其中参数gw_id为aWiFi终端的MAC。随后几项参数包含aWiFi终端与wifidog进程相关安康状况信息。收到aWiFi终端发出的ping请求后，aWiFi认证平台用200包的文本Pong来回应，如下所示： /1.1 200 OKConnection: closeDate: Tue, 01 Sep 2015 06:51:46 GM

11、TContent-Length: 4X-Powered-By: Servlet/2.5 JSP/2.1Pong3. 接入aWiFi终端的所有WiFi用户设备保活是指aWiFi终端向aWiFi认证平台分别上报每个用户的状态，如果用户已经离线那么上报用户离线消息，否那么等待aWiFi认证平台回应当前用户的权限，aWiFi终端以此为根据决定继续放通该用户正常上网还是需要重新认证，当aWiFi认证平台返回Auth：1那么表示继续允许，Auth：0那么表示需要重新认证。aWiFi终端会每隔十分钟给接入的所有WiFi用户设备保活，首先WiFi用户设备携带设备的参数向aWiFi认证平台发出请求，对应上图中的

12、，请例如下所示：User-Agent: WiFiDog 20150427报文以GET方法访问aWiFi认证平台的auth路径，其中参数stage=counters 表示该鉴权动作是在认证后的保活流程，ip为用户ip，mac为用户设备MAC，token为用户MAC的md5值，gw_id为aWiFi终端的MAC。随后几项参数包含aWiFi终端与wifidog进程相关安康状况信息。正常情况下aWiFi认证平台通过200包文本返回Auth：1表示该用户鉴权成功，允许其继续上网，对应上图中的，如下所示： /1.1 200 OKConnection: closeDate: Mon, 31 Aug 2015

13、 11:30:28 GMTContent-Length: 7X-Powered-By: Servlet/2.5 JSP/2.1Auth: 14. 当用户主动请求下线后，aWiFi认证平台会记录用户下线请求，同时把用户的请求重定向回wifidog。wifidog随即携带用户信息，向aWiFi认证平台发生下线请求，对应上图的，请例如下列图所示： /1.0User-Agent: WiFiDog 20150427因为aWiFi认证平台此时已经有用户的下线记录，aWiFi认证平台通过200包文本返回Auth：0表示该用户鉴权失败，不允许其继续上网，对应上图中的，如下所示： /1.1 200 OKConn

14、ection: closeDate: Mon, 31 Aug 2015 11:30:28 GMTContent-Length: 7X-Powered-By: Servlet/2.5 JSP/2.1Auth: 0收到报文后，wifidog随即更改防火墙将用户下线，然后把用户重定向到下线页面，下线页面的完整地址为：第3章 aWiFi平台云AC接口规本章描述aWiFi终端与aWiFi平台的云AC以下简称云AC通信的协议规。3.1 概述aWiFi终端与云AC之间的通信采用TCP长连接方式，数据以ASCII字符串方式传输。aWiFi平台的云AC的主机信息如下：云AC主机地址云AC端口14.146.225

15、.98081整个工作流程如下列图所示:3.2 连接登陆云ACaWiFi终端启动后，即开场连接云AC的流程，如下列图所示：aWiFi终端尝试通过TCP连接云AC， 如果连接成功，即完成连接流程，开场发送登陆数据包，如果不成功，检查重试连接的次数，如果重试次数不大于3次，那么等待10秒重新连接，如果超过3次那么等待10分钟后再重新开场本连接流程。连接成功后，要向效劳器发送登陆数据包，发送容定义如下：格式：hi-%MAC-%VER-%SSID-%DEV-%MACaWiFi终端的MAC地址-%VERaWiFi终端的固件版本号-%SSIDaWiFi终端的SSID%DEVaWiFi终端的型号样例：hi-

16、64:D9:54:EE:31:32-1.43-aWiFi_Test-ESHORE EAIW-001-3.3 心跳与断开重连机制aWiFi终端连接云AC并发送登陆包后，当aWiFi终端10分钟没有收到任何数据时，开场向效劳器发送心跳信息，发送完后如果1分钟没有收到云AC发回的任何数据，重试发送心跳信息，重试3次依然没有收到数据，那么关闭连接，重新进入连接流程。如下列图当终端10分钟时间没有接收到任何数据时，需要重新执行一次心跳流程。心跳信息发送和效劳器回复定义如下：发送容：*回复容：*3.4 执行配置管理配置管理命令是由云AC下发的一串字符串，由aWiFi终端接收识别后，将执行结果信息按指定的格

17、式发回给云AC。由于云AC随时可能下发指令，因些aWiFi终端在连接上效劳器后，不能再断开，需要一直保持接收数据状态，接收到数据后，分析区分是否是云AC发送的配置管理命令。3.4.1 测试连接测试连接命令供云AC测试aWiFi终端与云AC的网络连接是否正常测试连接命令定义：格式：%SessionID由云AC生成的标识本次通信的一串随机字符串样例：aWiFi终端响应的容定义如下：格式：ok=%SessionID=%SessionID必须与云AC下发命令中的%SessionID一样样例：ok=77=3.4.2 设置SSID设置SSID命令供云AC设置aWiFi终端的SSID设置SSID命令定义：格

18、式：%INDEX要设置的无线接口编号，第一个为0，第二个为1，%SSID要设置的新SSID名%SessionID由云AC生成的标识本次通信的一串随机字符串样例：aWiFi终端响应的容定义如下：格式：=%SessionID=%SessionID必须与云AC下发命令中的%SessionID一样样例：=17=3.4.3 重启重启命令供云AC重启aWiFi终端设备重启命令定义：格式：%SessionID由云AC生成的标识本次通信的一串随机字符串样例：aWiFi终端发回以下定义容，再重启：格式：disconnection-sys_reboot_ready=%SessionID=%SessionID必须与云AC下发命令中的%SessionID一样样例：disconnection-sys_reboot_ready=83=3.4.4 远程升级远程升级命令供云AC远程升级aWiFi终端设备的固件远程升级命令定义：格式：%SessionID由云AC生成的标识本次通信的一串随机字符串样例：aWiFi终端发回以下定义容，并升级固件再重启：格式：sys_rom_update_ready=%SessionID=%SessionID必须与云AC下发命令中的%SessionID一样样例：sys_rom_update_ready=42=