1、 邮件中间件 API 接口说明书北京瑞星科技股份有限公司邮件中间件 API 接口说明书（版本号：2009）邮件中间件 API 接口说明书信 息 表文 档 信 息主 题 瑞星邮件中间件用户手册编 号保密等级内 容 邮件中间件 API 接口说明书参考资料日 期 2009-02-24撰 写 人 许自龙修 改 信 息修改时间 修 改 内 容 修改人 备 注邮件中间件 API 接口说明书API 包说明 .5目录结构 .错误！未定义书签。支持系统平台 .5病毒库和引擎 API 接口 .6rav_open_lib .6函数原型 .6函数功能 .6参数说明 .7返回值 .7调用说明 .7rav_close_l
2、ib.7函数原型 .7函数功能 .7参数说明 .7返回值 .7使用说明 .8rav_load_engine.8函数原型 .8函数功能 .8参数说明 .8返回值 .8调用说明 .8rav_unload_engine.9函数原型 .9函数功能 .9参数说明 .9返回值 .9调用说明 .9病毒扫描 API 接口 .9rav_scan_file.9函数原型 .9函数功能 .10参数说明 .10返回值 .10调用说明 .10病毒扫描用户回调 API 接口 .10用户回调函数类型(RAV_POSTCALLBACK_FUN) .10回调函数类型 .10参数说明 .11rav_set_engcallback(
3、注册用户回调函数 ) .11函数原型 .11函数功能 .11参数说明 .11返回值 .12邮件中间件 API 接口说明书宏定义说明 .12扫描文件类型和病毒类型宏 .12病毒扫描结果宏 .13文件或内存对象扫描动作宏 .13邮件中间件 API 接口说明书API 开发包说明【瑞星 UNIX 邮件中间件】是提供给用户进行二次开发的 API 开发包，用户使用C/C+进行二次开发，完成对邮件、网页等文件进行病毒扫描。支持系统平台【瑞星 UNIX 邮件中间件】支持 Linux(X86)、FreeBSD(X86)，Solaris(Sparc),Solaris(X86)系统平台。目录结构用户在本地使用 ta
4、r zxvf mailver.tgz 解开压缩包后，可以看到下列子目录：ravlib这个目录下包含下列文件：a) 瑞星 unix 引擎动态库和病毒库文件。引擎库和动态库的文件较多，用户需要直接使用的是 libraveng.so 文件，其它文件由瑞星 unix 病毒扫描引擎。b) 许可证文件包含序列号的文件c) 升级工具文件用于【瑞星 UNIX 邮件中间件】升级的几个文件，参见 API 包升级include含 ravengapi.h 头文件，用户在使用【瑞星 UNIX 邮件中间件 】API 进行开发的时候应包含这个头文件。开发时需要的函数、结构、常量定义均在此文件中。demo包含几个 demo
5、程序，其中：ravscandl.cpp单进程例子，使用 dlopen 和 dlsym 导出 API 接口ravscan.cpp单进程例子，直接在链接的时候指定-lraveng 使用 API 接口。邮件中间件 API 接口说明书mulprocscan.cpp多进程使用 API 接口的例子multhreadscan.cpp多线程使用 API 接口的例子Doc存放本帮助本文档API 包的安装和设置处理 ravlib 目录将解压后的 ravlib 目录拷贝到用户希望位置，比如说/usr/lib/ravlib，然后设置环境变量 RAV_INSTALLPATH 为/usr/lib/ravlib，升级程序需
6、要这个环境变量。如果用户在开发时没有使用 dlopen 和 dlsym 导出瑞星的 API 接口，需要设置LD_LIBRARY_PATH 环境变量，让它包含这个路径。处理 include 目录include 目录下的 ravengapi.h 文件，用户复制到自己的开发路径。管理病毒库和引擎的 API 接口这一部分包括病毒库的初始化和关闭，引擎的加载和关闭四个接口。rav_open_lib函数原型int rav_open_lib(const char *szLibPath,const char *szVirusPath,char *szErrMsg,int nLenMsg)函数功能初始化病毒库和
7、引擎资源。邮件中间件 API 接口说明书参数说明1) szLibPath【瑞星 UNIX 邮件中间件】引擎动态库所在路径，通常就是 【瑞星 UNIX邮件中间件】所在路径。2) szVirusPath【瑞星 UNIX 邮件中间件】病毒库所在路径，通常就是 【瑞星 UNIX 邮件中间件】所在路径。3) szErrMsg ：存放出错信息的缓冲区4) nLenMsgszErrMsg 缓冲区的长度返回值0：初始化成功， -1：初始化失败调用说明使用【瑞星 UNIX 邮件中间件】API 接口，必须首先调用该接口，这个接口在主进程中调用。fork 的子进程和 pthread_create 创建的线程不调用该
8、接口。rav_close_lib函数原型int rav_close_lib ()函数功能关闭病毒库和引擎参数说明无返回值0：成功， -1：失败邮件中间件 API 接口说明书使用说明主进程退出的时候调用该接口，一个主进程调用一次，fork 的子进程或线程不需要调用该接口，调用该接口后不能再调用【瑞星 UNIX 邮件中间件】的任何API 接口。rav_load_engine函数原型void *rav_load_engine(const char *szVirusPath,const char *szTmpPtah,unsigned long ulScanFlag)函数功能加载【瑞星 UNIX 邮件
9、中间件】引擎库。参数说明1) szVirusPath【瑞星 UNIX 邮件中间件】开发包病毒库所在路径，通常就是【瑞星 UNIX 邮件中间件】所在路径。2) szTmpPtah指定临时文件路径，必须是存在的正常目录。3) ulScanFlag扫描文件类型和病毒类型选项，参见扫描文件类型和病毒类型宏。返回值成功：返回引擎句柄。失败：返回 NULL。调用说明每个进程（包括 fork 的子进程）或线程调用一次，必须在调用 rav_open_lib之后、rav_set_engcallback 和 rav_set_engcallback 之前调用该接口。邮件中间件 API 接口说明书rav_unload
10、_engine函数原型int rav_unload_engine (void *handle)函数功能卸载【瑞星 UNIX 邮件中间件】引擎库参数说明handle：调用 rav_load_engine 返回的句柄。返回值0：成功， -1：失败调用说明每个进程或线程退出时调用，调用该接口之后，不能再调用rav_set_engcallback 和 rav_scan_file 接口。病毒扫描 API 接口病毒扫描接口包括文件扫描和内存扫描接口。rav_scan_file函数原型int rav_scan_file(void *handle,unsigned int scantion,const cha
11、r *filename)邮件中间件 API 接口说明书函数功能对文件或目录进行病毒扫描的接口。参数说明handle：调用 rav_load_engine 返回的引擎句柄。scanaction：扫描动作，参见文件或内存对象扫描动作宏filename：扫描的文件名或者目录名返回值0 ： 无毒0 ：发现的病毒数-1 ：失败调用说明调用这个接口对文件或目录扫描前，必须按顺序调用了下列接口：rav_open_lib、rav_load_engine、rav_set_engcallback。rav_scan_mem函数原型int rav_scan_mem (void *phandle,unsigned int scanaction,const void *inbuf, int inbuflen, void* outbuf, int *pOutbufLen, const char *szIdFlag)函数功能对指定的流缓冲区内容扫描病毒，比如用户将一封邮件的内容放在内存缓冲区中，调用这个接口直接扫描病毒。参数说明handle：调用 rav_load_engine 返回的引擎句柄。scanaction：扫描动作，参见文件或内存对象扫描动作宏
