OpenetICS系统内部接口的要求规范.docx
- 文档编号:30589975
- 上传时间:2023-08-18
- 格式:DOCX
- 页数:78
- 大小:39.24KB
OpenetICS系统内部接口的要求规范.docx
《OpenetICS系统内部接口的要求规范.docx》由会员分享,可在线阅读,更多相关《OpenetICS系统内部接口的要求规范.docx(78页珍藏版)》请在冰豆网上搜索。
OpenetICS系统内部接口的要求规范
Openet互联网内容控制系统
〔OpenetICS〕
内部接口规X
拟制人______________
审核人______________________
批准人______________________
傲天信息技术〔某某〕
2003年9月
1.接口协议
1.1.IM协议
IM协议是Openet自定义的一种基于Socket方式的实时通信接口,主要用于策略服务器与前置机、WEB系统与策略服务器之间进展实时通信。
IM协议每一个通讯数据包由定长的某某和不定长的包体组成。
1)协议某某
字段名称
字段长度
字段类型
说明
协议版本号
1Byte
unsignedchar
填1
操作码编号
4Byte
unsignedint
定义一种通信操作,参见操作码说明。
应答标志
2Byte
unsignedshort
该字段值在发送和接收情况下含义不同。
◆发送数据:
0=表示后续没有数据包
1=表示后续还有数据包
◆接收数据:
0=表示成功
非0=表示出错后的错误码
保存1
1Byte
unsignedchar
保存未用,填0。
协议包的序列号
4Byte
unsignedint
协议包的序列号,每个数据包的序列号要求不能重复。
包体长度
2Byte
unsignedshort
数据包体的长度
md5的校验码
16Byte
unsignedchar[16]
md5校验码,用[包体+MD5KEY]后做MD5运算得到的校验码。
保存2
2Byte
unsignedchar[2]
保存未用,填0。
协议某某用C语言结构定义如下:
structim_head_t
{
unsignedcharcVersion;
unsignedintiOperationCode;
unsignedshortiFunctionCode;
unsignedcharcReserved1;
unsignedintiSeqno;
unsignedshortisLength;
unsignedcharcMd5[16];
unsignedcharcReserved2[2];
};
2)协议包体
协议包体定义为一个最长1024字节的字节数组,包体不定长,其容内容根据某某中的操作码进展解析,每个操作码对应一种具体的包体格式定义〔参见操作码的定义〕。
3)IM操作码定义
操作码编号
操作码名称
操作码说明
1
连接请求
2
连接响应
255
连接保持
3
增加一个IPS服务器
4
改变一个IPS服务器的配置
5
61
用户上线
62
用户上线应答
63
用户下线
64
用户下线应答
6000
6044
文件更新
策略服务器通知前置机需要更新的文件。
6045
文件更新响应
前置机收到文件更新包后的响应。
1.2.文件接口
1)文件传送
对某些非实时的、数据量比拟大的数据采用文件接口方式进展处理,如黑白地址数据、全局的控制策略数据等。
文件通过FTP方式进展传送,由FTP客户端主动登录服务器端获取数据。
2)文件的加/解密
所有跨子系统进展传送的文件需要进展加密,由文件生成方对文件内容进展加密,文件接收方对文件内容进展解密,加解密方式如下:
Ø密钥:
文件发送方和接收方拥有一样的公共密钥。
Ø加密:
对文件中的每行记录进展逐一加密,加密采用〔逐字节+1〕后和密钥进展异或的简单算法。
Ø解密:
对文件中的每行记录进展逐一解密,用密文与密钥进展异或后〔逐字节-1〕的方法进展解密。
1.3.Radius协议
使用标准的Radius协议进展通讯,主要适用于策略服务器与IP计费系统RadiusServer之间的通讯,用于处理用户的上下线信息〔记帐开始包和记帐完毕包〕。
2.全网策略管理中心与节点策略服务器的策略同步接口
全网策略管理中心与节点策略服务器之间的接口用于同步黑名地址数据、域名-IP对应关系数据、过滤关键字、过滤端口、过滤IP等控制策略数据。
所有的数据接口采用文件方式,由全网策略管理中心生成策略文件,节点策略服务器主动以FTP方式进展获取。
1)通讯方式:
◆通讯协议:
FTP
◆发送方:
全网策略管理中心
◆接收方:
节点策略服务器〔节点策略服务器主动与全网策略管理中心建立FTP连接并以GET方式获取文件。
〕
2)文件管理
全网策略管理中心给每个节点策略服务器开一个FTP某某,策略管理中心生成文件时给每个某某复制一份一样的文件,节点策略服务器以FTP方式登录后,从本某某的主路径下获取文件,文件传送成功后可删除远程文件。
2.1.黑白地址基准文件接口
1)接口说明:
同步全网策略管理中心的全部黑白地址数据给节点策略服务器。
2)同步时间:
全网策略管理中心每月产生一次基准文件〔时间间隔可设置〕,策略服务器自行控制获取基准文件的时间间隔。
3)文件命名:
BURLYYYYMMDDNNN.TXT
◆BURL表示地址基准文件
◆YYYYMMDD表示文件产生的日期
◆NNN表示文件序列号,序列号每天重新开始编号,从000开始编号,到999后循环。
4)文件规X
◆文件头〔定长,总字节数:
60Byte〕
序号
名称
长度(Byte)
备注
1
文件序列号
3
每天从000开始编号。
2
文件版本号
2
00
3
文件类型
2
01:
黑白地址基准文件
4
文件产生时间
14
YYYYMMDDHHMISS
5
文件生成方系统代码
3
001:
全网策略管理中心
6
文件接收方系统代码
3
002:
节点策略服务
7
总记录数
10
本文件中的总记录数〔不包括文件头〕,左对齐,右填空。
8
保存
22
填空
9
换行
1
\n
◆文件体
文件体中每行为1条数据记录,由固定顺序的非定长字段组成,字段之间通过逗号分隔。
数据记录之间通过换行符〔\n〕分隔。
〔每个字段的内容不能包含逗号〕
序号
名称
长度(Byte)
备注
1
数据类型
2
1=地址分类数据
2=域名-IP对应关系数据
2
操作标志
2
1=增加
3
地址分类
10
地址分类编号〔第二级编号〕。
4
主机域名
100
主机域名,如“sina〞
5
路径
200
路径,如“/〞。
〔数据类型为2时该字段无效〕
6
IP地址
20
主机IP地址,以INT型表示。
〔数据类型为1时该字段无效〕
7
换行
1
\n
说明:
文件记录中应按照域名排序。
2.2.黑白地址增量文件接口
1)接口说明:
同步全网策略管理中心从上次数据同步后黑白地址的变更数据给节点策略服务器。
2)同步时间:
全网策略管理中心每天产生一次增量文件〔时间间隔可设置,无数据改动时可生成一个空文件〕,策略服务器自行控制获取基准文件的时间间隔。
3)文件命名:
GURLYYYYMMDDNNN.TXT
◆GURL表示地址增量文件
◆YYYYMMDD表示文件产生的日期
◆NNN表示文件序列号,序列号每天重新开始编号,从000开始编号,到999后循环。
4)文件规X
◆文件头〔定长,总字节数:
60Byte〕
序号
名称
长度(Byte)
备注
1
文件序列号
3
每天从000开始编号。
2
文件版本号
2
00
3
文件类型
2
02:
黑白地址增量文件
4
文件产生时间
14
YYYYMMDDHHMISS
5
文件生成方系统代码
3
001:
全网策略管理中心
6
文件接收方系统代码
3
002:
节点策略服务
7
总记录数
10
本文件中的总记录数〔不包括文件头〕,左对齐,右填空。
8
保存
22
填空
9
换行
1
\n
说明:
文件记录中应按照域名排序。
◆文件体
文件体中每行为1条数据记录,由固定顺序的非定长字段组成,字段之间通过逗号分隔。
数据记录之间通过换行符〔\n〕分隔。
〔每个字段的内容不能包含逗号〕
序号
名称
长度(Byte)
备注
1
数据类型
2
1=地址分类数据
2=域名-IP对应关系数据
2
操作标志
2
1=增加2=删除
3
地址分类
10
地址分类编号〔第二级编号〕。
4
主机域名
100
主机域名,如“sina〞
5
路径
200
路径,如“/〞。
〔数据类型为2时该字段无效〕
6
IP地址
20
主机IP地址,以INT型表示。
〔数据类型为1时该字段无效〕
7
换行
1
\n
2.3.根本控制策略基准文件接口
1)接口说明:
同步全网策略管理中心的全部过滤关键字、过滤端口、过滤IP数据给节点策略服务器。
2)同步时间:
全网策略管理中心每天产生一次基准文件〔时间间隔可设置,无数据改动时可不生成文件〕,策略服务器自行控制获取基准文件的时间间隔。
3)文件命名:
BPCYYYYYMMDDNNN.TXT
◆BPCY表示控制策略数据基准文件
◆YYYYMMDD表示文件产生的时间
◆NNN表示文件序列号,序列号每天重新开始编号,从000开始编号,到999后循环。
4)文件规X
◆文件头〔定长,总字节数:
60Byte〕
序号
名称
长度(Byte)
备注
1
文件序列号
3
每天从000开始编号。
2
文件版本号
2
00
3
文件类型
2
05:
控制策略基准文件
4
文件产生时间
14
YYYYMMDDHHMISS
5
文件生成方系统代码
3
001:
全网策略管理中心
6
文件接收方系统代码
3
002:
节点策略服务
7
总记录数
10
本文件中的总记录数〔不包括文件头〕,左对齐,右填空。
8
保存
22
填空
9
换行
1
\n
◆文件体
文件体中每行为1条数据记录,由固定顺序的非定长字段组成,字段之间通过逗号分隔。
数据记录之间通过换行符〔\n〕分隔。
〔每个字段的内容不能包含逗号〕
序号
名称
长度(Byte)
备注
1
数据类型
2
01=过滤关键字数据
02=过滤端口数据
03=过滤IP数据
2
操作标志
2
1=增加2=删除
3
分类编号
10
关键字、端口、IP等的二级分类编号。
4
关键字
40
过滤关键字,对02/03类型该字段填空
5
IP地址
20
主机IP地址,以INT型表示。
对关键字过滤数据该字段填空。
6
端口
10
端口号,对关键字和IP过滤数据该字段填空。
7
说明
40
可填写端口名、IP说明等信息。
8
换行
1
\n
2.4.根本控制策略增量文件接口
5)接口说明:
同步全网策略管理中心的过滤关键字、过滤端口、过滤IP增量数据给节点策略服务器。
6)同步时间:
全网策略管理中心每隔一定的时间产生一次增量文件〔时间间隔可设置,无数据改动时可不生成文件〕,策略服务器自行控制获取增量文件的时间间隔。
7)文件命名:
BPCYYYYYMMDDNNN.TXT
◆GPCY表示控制策略数据基准文件
◆YYYYMMDD表示文件产生的时间
◆NNN表示文件序列号,序列号每天重新开始编号,从000开始编号,到999后循环。
8)文件规X
◆文件头〔定长,总字节数:
60Byte〕
序号
名称
长度(Byte)
备注
1
文件序列号
3
每天从000开始编号。
2
文件版本号
2
00
3
文件类型
2
06:
控制策略增量文件
4
文件产生时间
14
YYYYMMDDHHMISS
5
文件生成方系统代码
3
001:
全网策略管理中心
6
文件接收方系统代码
3
002:
节点策略服务
7
总记录数
10
本文件中的总记录数〔不包括文件头〕,左对齐,右填空。
8
保存
22
填空
9
换行
1
\n
◆文件体
文件体中每行为1条数据记录,由固定顺序的非定长字段组成,字段之间通过逗号分隔。
数据记录之间通过换行符〔\n〕分隔。
〔每个字段的内容不能包含逗号〕
序号
名称
长度(Byte)
备注
1
数据类型
2
01=过滤关键字数据
02=过滤端口数据
03=过滤IP数据
2
操作标志
2
1=增加2=删除
3
分类编号
10
关键字、端口、IP等的二级分类编号。
4
关键字
40
过滤关键字,对02/03类型该字段填空
5
IP地址
20
主机IP地址,以INT型表示。
对关键字过滤数据该字段填空。
6
端口
10
端口号,对关键字和IP过滤数据该字段填空。
7
说明
40
可填写端口名、IP说明等信息。
8
换行
1
\n
3.节点策略服务器与前置机的策略同步接口
全网策略管理中心将黑白地址数据、域名-IP对应关系数据、过滤关键字、过滤端口、过滤IP等控制策略数据以基准和增量文件方式同步给节点策略服务器,节点策略服务器将数据同步给其管辖X围内各个前置机。
节点策略服务器可自定义一些本地的控制策略,如过滤关键字、过滤端口、过滤IP等控制策略,控制策略仍以文件的形式同步给各个前置机。
节点策略服务器产生策略文件时,以IM接口协议方式实时通知前置机有新文件产生,前置机收到通知后主动以FTP方式登录策略服务下载文件。
1)文件通知通讯方式
◆通讯协议:
IM
◆发送方:
节点策略服务器
◆接收方:
前置机
2)文件下载通讯方式:
◆通讯协议:
FTP
◆发送方:
节点策略服务器,作为FTP服务器。
◆接收方:
前置机,作为FTP客户端。
3)文件管理
节点策略服务器给每个前置机开一个FTP某某,前置机以FTP方式登录后,从本某某的主路径下获取文件,前置机无权限删除远程主机上的文件。
3.1.文件更新通知接口
接口说明
策略服务器产生新文件后,通知前置机哪些文件需要更新,前置机收到通知后根据收到的文件名以FTP方式从策略服务器下载文件。
接口协议
IM
发送方
策略服务器
接收方
前置机
操作码
6044
响应码
6045
发送包体
包体中包括假如干个文件名通知结构〔ICS_FILE〕的数据,参见ICS_FILE结构定义。
响应包体
无
备注
文件名通知结构〔ICS_FILE〕定义:
字段名称
字段长度
字段类型
说明
文件类型
1Byte
unsignedchar
1=黑白地址文件
2=控制策略文件
3=
操作类型
1Byte
unsignedchar
1=基准文件2=增量文件
文件名
32Byte
unsignedchar[32]
需要处理的文件名,不包括文件路径。
3.2.文件下载接口
前置机收到节点策略服务器的文件更新通知消息后,以FTP方式登录策略服务器,根据策略服务发送的文件名进展文件下载,需要同步的文件包括:
◆黑白地址基准文件
◆黑白地址增量文件
◆全局控制策略文件
◆本地控制策略文件
3.3.节点本地的根本控制策略增量文件接口
1)接口说明:
节点策略服务器可定义本地的过滤关键字、过滤端口、过滤IP等控制策略,本地的控制策略数据以FTP方式同步给各个前置机。
2)同步时间:
节点策略服务器每天产生一次策略增量文件〔时间间隔可设置,如可设置为有数据变动时生成策略文件。
无数据改动时不生成文件〕,文件产生成功后策略服务器通知前置机下载文件进展处理。
3)文件命名:
PCYYYYYMMDDNNN.TXT
◆PCY表示本地控制策略数据增量文件
◆YYYYMMDD表示文件产生的时间
◆NNN表示文件序列号,序列号每天重新开始编号,从000开始编号,到999后循环。
4)文件规X
◆文件头〔定长,总字节数:
60Byte〕
序号
名称
长度(Byte)
备注
1
文件序列号
3
每天从000开始编号。
2
文件版本号
2
00
3
文件类型
2
10:
节点本地的控制策略文件
4
文件产生时间
14
YYYYMMDDHHMISS
5
文件生成方系统代码
3
002:
节点策略服务
6
文件接收方系统代码
3
003:
前置机
7
总记录数
10
本文件中的总记录数〔不包括文件头〕,左对齐,右填空。
8
保存
22
填空
9
换行
1
\n
◆文件体
文件体中每行为1条数据记录,由固定顺序的非定长字段组成,字段之间通过逗号分隔。
数据记录之间通过换行符〔\n〕分隔。
〔每个字段的内容不能包含逗号〕
序号
名称
长度(Byte)
备注
1
数据类型
2
01=过滤关键字数据
02=过滤端口数据
03=过滤IP数据
2
操作标志
2
1=增加2=删除
3
分类编号
10
关键字、端口、IP等的二级分类编号。
4
关键字
40
过滤关键字,对02/03类型该字段填空
5
IP地址
20
主机IP地址,以INT型表示。
对关键字过滤数据该字段填空。
6
端口
10
端口号,对关键字和IP过滤数据该字段填空。
7
说明
40
可填写端口名、IP说明等信息。
8
换行
1
\n
3.4.本地域名-IP对应关系增量文件接口〔可选〕
1)接口说明:
ICS用户通过自定义黑或白会产生一些域名地址,当域名在ICS地址库中不存在时需要在本地定时维护域名与IP的对应关系。
2)同步时间:
节点策略服务器每天产生一次增量文件〔时间间隔可设置,无数据改动时生成一个空文件〕。
3)文件命名:
JDIPYYYYMMDDNNN.TXT
◆JDIP表示节点本地的域名-IP对应关系增量文件
◆YYYYMMDD表示文件产生的时间
◆NNN表示文件序列号,序列号每天重新开始编号,从000开始编号,到999后循环。
4)文件规X
◆文件头〔定长,总字节数:
60Byte〕
序号
名称
长度(Byte)
备注
1
文件序列号
3
每天从000开始编号。
2
文件版本号
2
00
3
文件类型
2
11:
节点本地的域名-IP对应关系增量文件。
4
文件产生时间
14
YYYYMMDDHHMISS
5
文件生成方系统代码
3
002:
节点策略服务
6
文件接收方系统代码
3
003:
前置机
7
总记录数
10
本文件中的总记录数〔不包括文件头〕,左对齐,右填空。
8
保存
22
填空
9
换行
1
\n
◆文件体
文件体中每行为1条数据记录,由固定顺序的非定长字段组成,字段之间通过逗号分隔。
数据记录之间通过换行符〔\n〕分隔。
〔每个字段的内容不能包含逗号〕
序号
名称
长度(Byte)
备注
1
数据类型
2
1=地址分类数据
2=域名-IP对应关系数据
2
操作标志
2
1=增加2=删除
3
地址分类
10
地址分类编号〔第二级编号〕。
4
主机域名
100
主机域名,如“sina〞
5
路径
200
路径,如“/〞。
〔数据类型为2时该字段无效〕
6
IP地址
20
主机IP地址,以INT型表示。
〔数据类型为1时该字段无效〕
7
换行
1
\n
说明:
文件记录按域名进展排序
4.WEB门户与策略服务器接口
WEB门户〔用户自服务门户与系统管理门户〕与策略服务器之间目前主要有两种形式的数据接口:
◆数据更改通知接口:
用户或管理员通过WEB门户更改〔增、删、改〕某些数据后,将操作日志存放在表as_op_log中,然后以socket数据包的形式通知策略服务器,策略服务器收到通知消息后,从as_op_log表读取更改数据进展处理。
◆数据更新接口:
对于某些特殊的操作,WEB门户不直接操作数据库,而是通过将数据更新信息封装为Socket数据包发给策略服务器,由策略服务器对数据进展处理后更新数据库记录。
4.1.通知接口
4.1.1.用户数据更改通知〔7036〕
接口说明
用户或管理员通过WEB门户更改〔增、删、改〕用户相关的数据〔如自定义或个性化的防鲨网控制策略等〕,将操作日志存放在表as_op_log中,然后以socket数据包的形式通知策略服务器,策略服务器收到通知消息后,从as_op_log表读取更改数据进展处理。
接口协议
IM
发送方
用户自服务门户或系统管理门户
接收方
策略服务器
操作码
7036
响应码
7037
发送包体
无
响应包体
无
备注
4.1.2.配置数据更改通知〔7038〕
接口说明
管理员通过管理门户更改〔增、删、改〕配置数据〔Radius、NAS、前置机、无条件放行IP、互联特区地址控制〕,将操作日志存放在表cfg_op_log中,然后以socket数据包的形式通知策略服务器,策略服务器收到通知消息后,从cfg_op_log表读取更改数据进展处理。
接口协议
IM
发送方
系统管理门户
接收方
策略服务器
操作码
7038
响应码
7039
发送包体
无
响应包体
无
备注
4.1.3.防鲨网控制策略数据更改通知〔7040〕
接口说明
管理员通过管理门户更改〔增、删、改〕防鲨网业务配置数据〔关键字、IP过滤、端口过滤、安全模板等〕,将操作日志存放在对应的操作记录表*_operate中,然后以socket数据包的形式通知策略服务器,策略服务器收到通知消息后,从*_operate表读取更改数据进展处理。
接口协议
IM
发送方
系统管理门户
接收方
策略服务器
操作码
7040
响应码
7041
发送包体
unsignedinttempletType
/*模板类型1=keyword2=ip3=port4=security*/
响应包体
无
备注
4.2.日志参数修改接口
4.2.1.修改日志配置参数〔224〕
接口说明
修改日志配置参数〔log_param表〕
接口协议
IM
发送方
系统管理门户
接收方
策略服务器
操作码
224
响应码
225
发送包体
结构sys_log_param_t的连续
响应包体
无
备注
管理工具在修改了日志参数后,通知策略服务器,策略服务器将其实际应用到日志模块中去
4.3.推送策略管理接口
structpush_policy_attr_t
{
unsignedcharupdFlag;/*标志:
0=添加/修改策略和参数1=修改策略*/
unsignedintpolicyid;/*策略编号〔添加时填0〕*/
unsignedcharpolicyName[81]
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- OpenetICS 系统 内部 接口 要求 规范
![提示](https://static.bdocx.com/images/bang_tan.gif)