apfree(wifidog)接口描述

apfree(wifidog)接口描述

ver 2.0 2014.1.6

ver 2.1 2014.1.14 @修改速率单位，添加主机策略“顺序”描述

ver 2.2 2014.2.20 @修正一个代码拼写错误（macwhite）

ver 2.3 2014.5.06 @增加认证服务器login接口新的提交mac参数

ver 2.5 2014.6.23 @补齐wifidog标准接口 by walkingsky

ver 2.6 2014.6.24 @补充完整当前版本的wifidog v2接口

ver 2.7 2014.7.02 @修正ping接口主机规则描述

ver 2.8 2014.7.29 @修改ping接口，增加timestart和timestop两个参数

本文主要写给采用ApFree的wifidog，自己做认证服务器端扩展的开发用户。

一． 配置文件接口

和标准版wifidog配置文件（wifidog.cfg）相比，增加了ReqProcessMode（运行模式）参数

参数名：ReqProcessMode

值： 0 原始模式

1 单线程模式

2 优化后的模式

举例：ReqProcessMode 2

二． 认证服务器接口

标准版wifidog和认证服务器有ping、login、auth、portal 4个接口！ApFree的wifidog也是基于这四个接口，只不过向服务器提交的参数或者认证服务器返回的数据有变化！

1. wifidog 提交参数的变化

a) ping接口增加的参数：dev_id、cpu_usage、nf_conntrack_num

i.

ii.

iii.

iv.

v. dev_id 设备id，如：67869201000-780000541641387-35786613505096001 cpu_usage cpu利用率，单位%，值0-100 nf_conntrack_num 网络连接数，值为整数 out_rate 路由器出口（WAN口）的上行即时速率，单位 bps in_rate 路由器出口（WAN口）的下行即时速率，单位 bps

b) login接口增加的参数：dev_id、mac

i. mac 客户端mac地址

ii. dev_id 设备id，45位字符串（用来区分不同的设备）

c) auth接口增加的参数：dev_id、uprate、downrate

i.

ii.

iii.

iv. dev_id uprate 该客户端该时刻即时上行速率，单位 bps downrate 改客户端该时刻即时下行速率，单位 bps client_name 客户端的设备名称，如果没有获取到，则用*表示

d) portal接口增加的参数：dev_id

2. 认证服务器返回数据的变化

主要是ping接口的返回改了很多！wifidog根据这些返回做对应的流控策略和wifidog域名开放策略

先看一个典型的返回数据格式：

Pong

result={"rule":{"host":[{"id":"35","ip":"192.168.1.145","netmask":"255.255.192.0","up":"102400","down":"52428800","session":"0","timestart":null,"timestop":null}],"host_md5":"e74e2fb47bce1066ec02f9c125089d07","ipwhite":[{"id":"74","ip":"192.168.0.198","netmask":"25

5.255.255.255"},{"id":"77","ip":"192.168.0.169","netmask":"255.255.255.255"}],"ipwhite_md5":"5646ae26578019d406ef9d868bea2fe6","macblack":[],"macblack_md5":"d751713988987e9331980363e24189ce","mackwhite":[],"mackwhite_md5":"d751713988987e9331980363e24189ce","domain":[{"domain":","}],"domain_md5":"119e64c7851aa20a52a06c12a9154c23"}}

开源wifidog只要求认证服务器返回 Pong

ApFree的wifidog要求返回 Pong+空格+result=json字符串

Json格式如下

{

"rule":{

"host":[

{

"id":"35",

"ip":"192.168.1.145",

"netmask":"255.255.192.0",

"up":"102400",

"down":"52428800",

"session":"0",

"timestart":"09:00",

"timestop":"18:00"

}

],

"host_md5":"e74e2fb47bce1066ec02f9c125089d07",

"ipwhite":[

{

"id":"74",

"ip":"192.168.0.198",

"netmask":"255.255.255.255"

},

{

"id":"77",

"ip":"192.168.0.169",

"netmask":"255.255.255.255"

}

],

"ipwhite_md5":"5646ae26578019d406ef9d868bea2fe6",

"macblack":[

],

"macblack_md5":"d751713988987e9331980363e24189ce",

"macwhite":[

],

"macwhite_md5":"d751713988987e9331980363e24189ce",

"domain":[

{

"domain":","

}

],

"domain_md5":"119e64c7851aa20a52a06c12a9154c23"

}

}

host：为流控里主机（网段）限制规则，数组（可以有多条规则），规则内容分别为ip、netmask、up、down、session、timestart、timestop，主要限制主机或网段内所有主机的上行（上传）、下行（下载）带宽，会话数限制不建议采用。本规则和wifidog的认证同时生效，即如果没有通过wifidog的认证，无论针对该主机的规则流量多大，也是不会有流量的（开放域名的除外）；执行顺序问题：主机策略都是有先后顺序的，采用串行模式（类似于程序里的switch case break 模式），先匹配上的先执行，后面的都不再匹配和执行。所有下发多个主机策略的时候一定要注意先后顺序，在前面的先生效，后面的后生效。

注意事项：

ip和netmask组合使用，来决定是单主机规则还是整个网段的规

则；

会话数限制session不建议使用；

不做限制数值要设置成0；

up、down的单位为bps；

限速规则到后台是要用Bps的单位配置下去的（先做除8操作，

再下发），所以主机限速规则要遵循如下规则：要大于8，否则配

置下去的有可能是0；尽量配置成8的整倍数

样例中的id无用处

ipwhite：为流控里的ip白名单规则，数组（可以有多条规则），配置的主机或网段不受主机规则影响。和wifidog共同起作用

注意事项：

本ip白名单是限速的白名单，不是wifidog里的白名单；

ip和netmask组合使用，来决定是单主机规则还是整个网段的规则；

macblack：为流控里的mac黑名单规则，加入规则的mac是不能上网的，和wifdog同时生效。

注意事项：

mac黑名单不再采用json数组格式，所有的mac列表都写在一起，

中间用“,”隔开，如 mac1,mac2,mac3

加 …… 此处隐藏：2780字，全部文档内容请下载后查看。喜欢就下载吧 ……