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

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

《广东电信aWiFi平台接口规范.docx》由会员分享，可在线阅读，更多相关《广东电信aWiFi平台接口规范.docx（11页珍藏版）》请在冰豆网上搜索。

广东电信aWiFi平台接口规范

广东电信aWiFi平台接口规范

日期

版本号

修订说明

修订人

2016-04-08

新建文档

熊远雄

2016-04-13

修改登陆和心跳，添加工作流程

熊远雄

广东电信aWiFi平台接口规范错误!

未定义书签。

第1章前言错误!

未定义书签。

aWiFi系统概述错误！

未定义书签。

网络架构错误！

未定义书签。

第2章aWiFi平台认证接口规范错误!

未定义书签。

概述错误！

未定义书签。

WiFi用户上线错误！

未定义书签。

保活和下线错误！

未定义书签。

第3章aWiFi平台云AC接口规范错误!

未定义书签。

概述错误！

未定义书签。

连接登陆云AC错误！

未定义书签。

心跳与断开重连机制错误！

未定义书签。

执行配置管理错误！

未定义书签。

测试连接错误！

未定义书签。

设置SSID错误！

未定义书签。

重启错误！

未定义书签。

远程升级错误！

未定义书签。

第1章前言

本标准是广东电信aWiFi终端系列企业标准之一，该系列标准目前包括:

1）广东电信aWiFi终端规范--技术指标；

2）广东电信aWiFi终端技术要求--xxx

3）广东电信aWiFi平台接口规范；

4）广东电信aWiFi安全审计平台接口规范

本文描述aWiFi系统中，aWiFi终端设备与aWiFi平台的通信协议流程，包括aWiFi终

端设备与aWiFi平台认证服务的接口，aWiFi终端设备与aWiFi平台云AC通信的接口。

1.1aWiFi系统概述

广东电信aWiFi系统由WiFi用户（手机，平板电脑等）、WiFi网络接入设备、aWiFi管理平台和BOSS系统组成。

WiFi网络接入设备分为两类，一类是集中控制型（AC+瘦AP）

设备，一类是aWiFi终端。

aWiFi管理平台内部又可分为两部分：

云AC平台和认证服务平

台。

分别负责aWiFi终端设备管理和广告推送服务。

为客户提供aWiFi业务。

aWiFi系统总体参考模型如图1所示。

图1：

aWiFi系统模型

aWiFi系统模型说明如下：

1）aWiFi终端

aWiFi终端包括单AP终端，融合终端和一体终端，aWiFi终端与aWiFi平台之间使用统一的接口规范，aWiFi终端的相关技术指标和接口在本系列规范中说明。

2）参考点Mg

参考点Mg是aWiFi管理平台和aWiFi终端之间的接口界面，包括终端设备管理和认证服务两部分，实现aWiFi终端认证和业务配置管理。

该接口界面将在本文中说明。

3）参考点Me

参考点Me是aWiFi管理平台和AC+AP型WiFi网络接入设备之间的接口界面，实现WiFi

终端认证和业务配置管理。

1.2网络架构

aWiFi系统的网络架构如下图所示：

aWiFi业务平台网络架构如下图所示

访客

第2章aWiFi平台认证接口规范

2.1概述

aWiFi终端和aWiFi平台认证服务的通信协议是基于wifidog_protocol_V1（）,并作出了部分细节的修改，其中主要增加了用户的预鉴权流程，实现免登陆认证功能，建议aWiFi终端

厂商使用开源软件包wifdog进行开发实现。

为方便，本文直接用wifidog来代指在aWiFi终端中实现与认证平台通信的程序。

aWiFi认证平台的信息如下:

aWiFi认证平台主机（％SERVER）

aWiFi认证平台端口（％PORT）

2.2用户上线

WiFi用户上线流程如下图所示:

1.首先aWiFi终端通过iptables更改防火墙，将未认证的用户dnat到wifidog进程，当

WiFi用户接入终端后访问外网时，wifidog首先拦截其http报文，然后询问aWiFi认

证平台该用户是否准入，对应上图中的流程②，请求实例如下：

[GET

/smartwifi/auth/?

stage=preauth&ip=&mac=3c:

97:

0e:

d2:

f6:

67&token=bcabec78d913cf512fee6738&inco

ming=0&outgoing=0&gw_id=D4EE07083302

HTTP/

User-Agent:

WiFiDog

Host:

报文以GET方法访问aWiFi认证平台的auth路径，其中参数stage=preauth表示当前为预鉴权阶段，ip为用户ip,mac为用户MACtoken为用户MAC的md5值，gw_id为aWiFi终端的MAC

2.对于新用户，aWiFi认证平台将返回鉴权失败的200报文，对应上图中的流程③，如下

所示：

[HTTP/200OK

Connection:

close

Date:

Mon,31Aug201511:

30:

28GMT

Content-Length:

7

X-Powered-By:

Servlet/JSP/

Auth:

0]

当aWiFi认证平台返回Auth:

1则表示鉴权成功，wifidog随即放通用户，并把当前web请

求重定向回原先访问页面，实现免登陆认证的接入上网；当aWiFi认证平台返回Auth:

0

则表示需要该用户鉴权失败，需要登陆认证才能上网，此时wifidog则通过307报文将用户重定向到aWiFi认证平台的认证页面，对应上图中的流程⑤。

重定向请求实例如下：

[GET

/smartwifi/login/?

gw_address=&gw_port=2060&gw_id=D4EE07083302&mac=3c:

97:

0e:

d2:

f

6:

67&url=http%3A

I-

等待10分

心跳流程

关闭连接

程丿予启动读取参数

Retry=O

Retry++

是

L否

Retry>3?

等待10秒

TCP连接云AC

发送登陆数据包

无数据接收数据

'（超时10分钟）

'『有数据

Retry=O

等待10秒

h.

pr

iF

Retry++

无数据

发送心跳数据包

'接收数据

（超时1分钟）

有数据

分析数据执行处理

A

有数据

wifi-iface[%INDEX].ssid='%SSID';ucicommit;echo'=[%SessionlD]=

'>

%INDEX

要设置的无线接口编号，第一个为0,第二个为1,……

%SSID

要设置的新SSID名

%SessionlD

由云AC生成的标识本次通信的一串随机字符串

样例：

aWiFi终端响应的内容定义如下:

格式：

=[%SessionID]=

%SessionID

必须与云AC下发命令中的%SessionID相同

样例：

=[]=

2.2.1重启

重启命令供云AC重启aWiFi终端设备

重启命令定义：

格式：

vecho'disconnection--sys_reboot_ready';reboot;echo'=[%SessionlD]='>

%SessionID

由云AC生成的标识本次通信的一串随机字符串

样例：

vecho'disconnection--sys_reboot_ready';reboot;echo'=[]='>

aWiFi终端发回以下定义内容，再重启:

格式：

disconnection--sys_reboot_ready

=[%SessionID]=

%SessionID

必须与云AC下发命令中的%SessionID相同

样例：

disconnection--sys_reboot_ready

=[]=

222远程升级

远程升级命令供云AC远程升级aWiFi终端设备的固件

远程升级命令定义：

格式：

vecho'sys_rom_update_ready';/etc_ro/mysh/;echo'=[%SessionlD]='>

%SessionlD

由云AC生成的标识本次通信的一串随机字符串

样例：

aWiFi终端发回以下定义内容，并升级固件再重启:

格式：

sys_rom_update_ready

=[%SessionID]=

%SessionID

必须与云AC下发命令中的%SessionID相同

样例：

sys_rom_update_ready

=[]=