1、详细设计说明书编写规范案卷号日期 2014-07-03SNMP AGENT 设计软件详细设计说明书作 者： 完成日期： 2014 年 07 月 03 日 签 收 人： 签收日期： 修改情况记录：版本号修改批准人 修改人 安装日期签收人详细设计说明书编写规范目录 1 引言 .11.1 编写目的 11.2 背景 11.3 定义 11.4 参考资料 12 程序系统的结构 .13 系统设计说明 .33.1 系统描述 33.2 功能 33.3 性能 33.4 输入项 43.5 输出项 43.6 算法 83.7 流程逻辑 93.8 接口 113.9 存储分配 113.10 注释设计 113.11 限制条件
2、 113.12 测试计划 123.13 尚未解决的问题 12详细设计说明书编写规范11 引言1.1 编写目的Agent 软件需求说明书为项目后续的系统测试计划，概要设计提供依据，为设计人员，编码测试人员做相关参考。该说明书供下列对象查阅：系统设计人员；软件开发人员；软件测试人员；系统维护人员等。1.2 背景软件名称：网络管理平台代理 Agent；本项目的任务提出者：冯建老师开发者：闫阿丹1.3 定义缩写 注释 描述Snmp Simple Network Management Protocol 简单网络管理协议MIB Manger information Base 管理信息数据库OID Obje
3、ct Identifier 对象标识符OMID Object Monitor Identifier 监控对象标识符1.4 参考资料1）参考标准的 snmp 协议；2）SNMP，MIB：RFC1155，RFC1157，RFC1213；2 程序系统的结构软件各模块关系图：详细设计说明书编写规范2Agent 内部结构说明：设备侧Snmp Manager设备侧MIB 加载和管理和设备之间的通信协议的转换和转发 AgentAgent 内部结构图说明：1） Agent 和 Snmp Manager 之间通过 UDP 连接，执行 snmp 协议；端口（161，162）2） Agent 和设备侧之间通过 TC
4、PIP 连接；通信消息接口包括：(1) 查询请求消息：Get-Request；(2) 查询响应消息：Get-Response；(3) 设置请求消息：Set-Request；(4) 设置响应消息：Set-Response；(5) 集群查询请求消息：Get-Next-Request；详细设计说明书编写规范33 系统设计说明3.1 系统描述SNMP 是用来规定 Manager 和 Agent 之间是如何传递管理信息的应用层协议。SNMP Agent 接受来自 SNMP Manager 的请求报文后，进行解码，分析，然后从相关模块中得到管理变量的值，生成 Response 报文，编码返送回 SNMP
5、Manager。在有异常告警的情况下，Agent 向 Manager 主动发 Trap 报文，Manager 收到后，进行解码，分析，然后作出相应措施。为了简化 Agent 的开发，SNMP 规定只有两种操作 Get,Set,前者用于从被管设备获取管理信息。后者通过设置变量值来起到配置被管设备的作用。Manager 和 Agent 之间通过发送报文来传递管理信息，系统中规定了五种报文： Get Request 报文：用于获取指定管理变量的值。 GetNext Request 报文：用于连续获取一组管理变量的值。 GetResponse 报文：用于响应请求，返回请求值或错误类型等。 Set Re
6、quest 报文：用于设置指定的管理变量。 Trap 报文：用于在紧急情况下由被管设备向 NMS 主动发信息3.2 功能设计网络管理平台代理 SNMP AGENT，使程序运行后能与 SNMP MANAGER 程序正确通信。系统总的来说可以分为五大模块，即初始化模块、通信模块、报文处理模块、Trap 处理模块和 MIB 管理模块。主要实现 mib 的加载，实现对 snmp 消息的解析并转换为内部消息，实现对对应底层设备的获取和设置，包括对设备信息的读取，设置，及告警消息的上送等功能。3.3性能静态数值需求可能包括：1) 由于网络管理平台所管理的设备的属性具体相同的属性，所以不会为 Agent 下
7、详细设计说明书编写规范4面的每个设备分配一个唯一的 OID，采用公共的 OID 和 IP 来确定网络管理系统内的设备属性的唯一性；2) 目前设计需求 Agent 支持连接最大 10 个 monitor 的终端，如果超过一个地区的 monitor 超过 10 个则另外安装一个 Agent 支持，并为 Agent 分配新的AgentID；3) 支持并行操作的用户数；4) 处理的文卷和记录数；5) 表和文卷的大小。动态数值需求可能包括：欲处理的事务和任务的数量，以及在正常情况下和峰值工作条件下一定时间周期中处理的数据总量。3.4 输入输出项1. SNMP 连接功能1）说明：系统启动时首先要建立 SN
8、MP 通信；2）输入：读取配置文件：port1：161; port2：162；3）处理：调用 snmp 提供的开发包建立连接；4）输出：无；2加载 MIB 功能1）描述：Agent 对 MIB 进行加载：Agent 模块初始化的时候要对管理的 MIB 库进行加载到系统中以便实现对设备的管理；2）输入：无；3）处理：加载 MIB；4）输出：a）加载成功，写加载成功日志；b）加载失败，系统退出，写加载 mib 失败日志；3GetRequest 查询节点信息请求）描述：Snmp Manager 通过 Agent 获取节点信息的 GetRequest 消息；）输入：详细设计说明书编写规范5a）Agen
9、t 从 161 端口读取 Snmp Manager 发送的 snmp 的 GetRequest 消息；b）Monitor 输入到 Agent 的响应消息；3）处理：Agent MonitorManager1)GetRequest 消息2) 查询请求消息3) 查询请求响应消息4)Get Response 消息Getrequest 查询信息请求消息图说明：1） Agent 收到 Manager 的 GetRequest 消息；2） Agent 对收到的 GetRequest 消息进行解析，根据 OID 查找相应的 OMID；根据OMID 查找到对应的设备，并组成查询请求消息发送的相应的设备侧,等待
10、设备侧返回响应消息；（Agent 同步返回 GetResponse 消息）3） Monitor 返回查询请求的响应消息给 Agent；4） Agent 根据 Monitor 响应消息返回给 Manager 响应消息；4）输出a）输出到 Monitor 查询请求消息； b）输出到 ManagerGetResponse 响应消息；4 SetRequest 设置节点信息请求1）描述： Snmp Manager 通过 Agent 设置节点信息的 SetRequest 消息；2）输入：a）Agent 从 161 端口读取 Snmp Manager 发送的 snmp 的 SetRequest 消息；b）M
11、onitor 输入到 Agent 的响应消息；3）处理：详细设计说明书编写规范6Agent MonitorManager1)SetRequest 消息2) 设置请求消息3) 设置请求响应消息4)Set Response 消息Setrequest 查询信息请求消息图：说明：1)Agent 收到 Manager 的 SetRequest 消息；2)Agent 对收到的 SetRequest 消息进行解析，根据 OID 查找相应的 OMID；根据OMID 查找到对应的设备，并组成设置请求消息发送的相应的设备侧,等待设备侧返回响应消息；（Agent 同步返回 GetResponse 消息）3)Moni
12、tor 返回查询请求的响应消息给 Agent；4)Agent 根据 Monitor 响应消息返回给 Manager 响应消息；4）输出：a）输出到 Monitor 设置请求消息；b）输出到 Manager GetResponse 响应消息；5 GetNextRequest 集群查询节点信息请求1）描述： Snmp Manager 通过 Agent 获取节点信息的 GetNextRequest 消息；2）输入：a）Agent 从 161 端口读取 Snmp Manager 发送的 snmp 的 GetNextRequest 消息；b）Monitor 输入到 Agent 的集群信息信息请求响应消息
13、；3） 处理：详细设计说明书编写规范7Agent MonitorManager1)GetNextRequest 消息2) 查询集群信息请求消息3) 查询集群信息请求响应消息4)Get Response 消息GetNextRequest 查询信息请求消息图：说明：1） Agent 收到 Manager 的 GetNextRequest 消息；2）Agent 对收到的 GetNextRequest 消息进行解析，根据 OID 查找相应的 OMID；根据 OMID 查找到对应的设备，并组成查询请求消息发送的相应的设备侧,等待设备侧返回响应消息；（Agent 同步返回 GetResponse 消息）3
14、）Monitor 返回查询请求的响应消息给 Agent；4）Agent 根据 Monitor 响应消息返回给 Manager GetRequest 响应消息；4）输出a） 输出到 Monitor 查询请求消息；b） 输出到 ManagerGetResponse 响应消息；6 Trap 告警上送消息1）描述：设备侧产生告警后，当告警级别高于现在系统设置的告警级别后要上报到Agent， Agent 收到设备侧的告警后要写本地告警日志，并上报 Trap 消息到 Manager；2） 输入：设备侧发送告警消息到 Agent； 3） 处理：详细设计说明书编写规范8Getrequest 查询信息请求消息图
15、：说明：1）monitor 发送告警消息上送到 Agent；2）Agent 收到 Monitor 的告警消息后根据本地消息中的告警级别分析是否上报，告警级别大于本地告警级别时，先写本地告警日志，然后编码 Trap 消息，否则只写本地告警日志；3）Agent 发送 Trap 消息到 Manager；4） 输出 ）发送 Trap 消息到 Manager；）输出到 ManagerGetResponse 响应消息；3.6 算法在设计软件的过程中用到 DES 加密算法和 MD5 哈希函数算法。DES 算法实现加密需要三个步骤：第一步：变换明文。对给定的 64 位比特的明文 x，首先通过一个置换 IP 表
16、来重新排列x，从而构造出 64 位比特的 x0，x0=IP(x)=L0R0，其中 L0 表示 x0 的前 32 比特，R0 表示x0 的后 32 位。第二步：按照规则迭代。规则为：Li = Ri-1；Ri = Lif(Ri-1,Ki) （i=1,2,316）其中符号表示的数学运算是异或，f 表示一种置换，由 S 盒置换构成，Ki 是一些由密钥编排函数产生的比特块。第三步：对 L16R16 利用 IP-1 作逆置换，就得到了密文 y。MD5 哈希函数算法对于每个明文分组的摘要生成过程如下： （1）将 512 位的明文分组划分为 16 个子明文分组，每个子明文分组为 32 位。 详细设计说明书编写
17、规范9（2）申请 4 个 32 位的链接变量，记为 A、B、C、D （3）子明文分组与链接变量进行第 1 轮运算。 （4）子明文分组与链接变量进行第 2 轮运算。 （5）子明文分组与链接变量进行第 3 轮运算。 （6）子明文分组与链接变量进行第 4 轮运算。（7）链接变量与初始链接变量进行求和运算。 （8）链接变量作为下一个明文分组的输入重复进行以上操作。 （9）最后，4 个链接变量里面的数据就是 MD5 摘要。3.7 流程逻辑详细设计说明书编写规范10详细设计说明书编写规范113.8 接口用户接口提供用户使用软件产品时的接口需求。例如，如果系统的用户通过显示终端进行操作，就必须指定如下要求：
18、对屏幕格式的要求；报表或菜单的页面打印格式和内容；输入输出的相对时间；程序功能键的可用性。 软件接口需要与 SNMP Manager 同时使用，因此需要有与其连接的接口。SNMP Agent 接受来自SNMP Manager 的请求报文后，进行解码，分析，然后从相关模块中得到管理变量的值，生成 Response 报文，编码返送回 SNMP Manager。在有异常告警的情况下，Agent 向 Manager主动发 Trap 报文，Manager 收到后，进行解码，分析，然后作出相应措施。 3.9 存储分配在 other init 对其他接口模块 (tcp_mib,ip_mib,ipx_mibe
19、tc.)进行初始化，是为存放相对应的表的索引分配内存。3.10 注释设计在模块首部加必要的注释；在各分枝点处加注释；对各变量的功能、范围、缺省条件等所加注释；对使用的逻辑加注释等。3.11 限制条件a 硬件配置的特点（接口数，指令系统等） ；b 内存储器和辅助存储器的容量。详细设计说明书编写规范123.12 测试计划首先对初始化监听进行测试，测试结果应该是成功的；再进行 Get-Request、Get-Next-Request 、Set-Request 消息的测试，预期结果应该是可以收到消息并能作出 Get-Response 应答；最后测试 Trap 消息能否发送成功。3.13 尚未解决的问题软件设计是没有实现 GetBulk 和 Inform 这两个 PDU，也就是说是 SNMPv1，不是SNMPv，功能上不是特别强大，性能不是很完善等。
