[转载]ISAPI接口简介

ISAPI（Internet Server Application Programming Interface）作为一种可用来替代CGI的方

法，是由微软和Process软件公司联合提出的Web服务器上的API标准。ISAPI与Web服务器结合紧

密，功能强大，能够获得大量的信息，因此利用ISAPI可以开发出灵活高效的Web服务器增强程序

。由于ISAPI程序与Web服务器的关系，使得ISAPI接口在安全方面有一定的研究价值。本文主要

讨论ISAPI在IIS和VC++ 6.0中的实现。

一、ISAPI接口和CGI接口的不同。

ISAPI程序和CGI程序完成类似的功能，但是实现方法不同。

1、ISAPI程序以DLL形式被Web服务器加载到自己的进程空间中，因此和服务器共用同一个地址空

间，且在没有客户请求时可以将其从内存中卸载；而对客户端发来的每个对CGI程序的请求则需

要服务器为它单独启动一个进程，这需要耗费大量的时间和内存。当并发的请求数目很大时，使

用CGI在效率上不如ISAPI。

2、CGI程序通过环境块和标准输入输出与Web服务器进行通信，而ISAPI程序与服务器结合得更为

紧密，与服务器共享同一个进程上下文，主要通过一个参数块与服务器进行交互，可以从服务器

那里获得关于当前HTTP连接的大量信息。

ISAPI主要分为ISA和ISAPI Filter两部分。ISA方法相对而言要传统一些，利用一些特殊的链接

，指向服务器的作业，供程序开发人员设计一些扩展功能；而ISAPI过滤器则倾向于构造服务器

直接调用的模块，提供一种无缝链接部件用于监测直接来自于服务器的HTTP请求。

二、ISA

ISA（Internet Server Application）也可称为ISAPI DLL，其功能和CGI程序的功能直接相对应

，使用方法和CGI也类似，由客户端在URL中指定其名称而激活。例如下面的请求将调用服务器的

虚拟可执行目录Scripts下的function.dll（ISAPI DLL必须放在服务器的虚拟可执行目录下）：

http://www.abc.com/Scripts/function.dll?

ISA和服务器之间的接口主要有两个：GetExtentionVersion( )和HttpExtentionProc( )。任何

ISA都必须在其PE文件头的引出表中定义这两个引出函数，以供Web服务器在适当的时候调用。

1、当服务器刚加载ISA时，它会调用ISA提供的GetExtentionVersion( )来获得该ISA所需要的服

务器版本，并与自己的版本相比较，以保证版本兼容。函数原型如下：

BOOL WINAPI GetExtentionVersion(HSE_VERSION_INFO *version)；

typedef struct _HSE_VERSION_INFO

{

DWORD dwExtensionVersion; //版本号

CHAR lpszExtensionDesc[HSE_MAX_EXT_DLL_NAME_LEN]; //关于ISA的描述字符串

} HSE_VERSION_INFO, *LPHSE_VERSION_INFO;

2、ISA的真正入口是HttpExtentionProc( )，它相当于普通C程序的main( )函数，在这个函数中

根据不同的客户请求作不同的处理。服务器和HttpExtentionProc( )之间是通过扩展控制块（

Extention Control Block）来进行通信的，即ECB中存放入口参数和出口参数，包括服务器提供

的几个回调函数的入口地址。函数原型如下：

DWORD HttpExtensionProc( EXTENSION_CONTROL_BLOCK *pECB );

ECB的结构定义如下（IN表示入口参数，OUT表示出口参数）：

typedef struct _EXTENSION_CONTROL_BLOCK

{

DWORD cbSize; //IN，本结构的大小，只读

DWORD dwVersion //IN，版本号，高16位为主版本号，低16位为次版本号

HCONN ConnID; //IN，连接句柄，由服务器分配，ISA只能读取该值

DWORD dwHttpStatusCode; //OUT，当前完成的事务状态

CHAR lpszLogData[HSE_LOG_BUFFER_LEN]; //OUT，需要写入到日志文件中的内容

LPSTR lpszMethod; //IN，等价于CGI的环境变量REQUEST_METHOD

LPSTR lpszQueryString; //IN，等价于环境变量QUERY_STRING

LPSTR lpszPathInfo; //IN，等价于环境变量PATH_INFO

LPSTR lpszPathTranslated; //IN，等价于环境变量PATH_TRANSLATED

DWORD cbTotalBytes; //IN，等价于环境变量CONTENT_LENGTH

DWORD cbAvailable; //IN，缓冲区中的可用字节数

LPBYTE lpbData; //IN，缓冲区指针，指向客户端发来的数据

LPSTR lpszContentType; //IN，等价于环境变量CONTENT_TYPE

//回调函数，用于返回服务器的连接信息或特定的服务器详细情况

BOOL ( WINAPI * GetServerVariable )

( HCONN hConn,

LPSTR lpszVariableName,

LPVOID lpvBuffer,

LPDWORD lpdwSize );

BOOL ( WINAPI * WriteClient ) //回调函数，从客户端的HTTP请求中读取数据

( HCONN ConnID,

LPVOID Buffer,

LPDWORD lpdwBytes,

DWORD dwReserved );

BOOL ( WINAPI * ReadClient ) //回调函数，向客户端发送数据

( HCONN ConnID,

LPVOID lpvBuffer,

LPDWORD lpdwSize );

BOOL ( WINAPI * ServerSupportFunction ) //回调函数，访问服务器的一般和特定功能

( HCONN hConn,

DWORD dwHSERRequest,

LPVOID lpvBuffer,

LPDWORD lpdwSize,

LPDWORD lpdwDataType );

} EXTENSION_CONTROL_BLOCK, *LPEXTENSION_CONTROL_BLOCK;

在上述ECB中，服务器不但提供了当前HTTP连接的句柄和一些变量，而且提供了4个回调函数给

ISA调用，从而使ISA可以获得更详尽的信息。

三、ISAPI Filter

ISAPI Filter位于服务器和客户端之间，能够对服务器和客户端之间的通信进行预处理和后处理

，比如对通信进行加密/解密、提供对客户进行身份验证的新方法、提供自定义的日志记录等，

在CGI中没有与ISAPI Filter直接相对应的部分。

ISAPI Filter与服务器之间的接口有两个：GetFilterVersion( )和HttpFilterProc( )。任何

ISAPI Filter都必须引出这两个函数以供服务器调用。

1、在注册表的如下键值中存放着所有ISAPI Filter的文件名，IIS服务器启动时从该键值中获得

Filter的文件名并加载它们。

HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet/Services/W3SVC/Parameters/FilterDLL

2、然后服务器调用每个Filter提供的GetFilterVersion( )函数，获得版本号以及该Filter希望

处理的事件，即ISAPI Filter通过引出GetFilterVersion( )函数来告知服务器自己希望处理什

么类型的事件，因为ISAPI Filter是通过事件来激活的，当满足条件的事件到达时，服务器就会

调用Filter引出的主函数HttpFilterProc( )对该事件进行处理。GetFilterVersion( )的原型如

下：

BOOL WINAPI GetFilterVersion(

DWORD dwServerFilterVersion; //IN，服务器使用的版本规范

DWORD dwFilterVersion; //OUT，过滤器使用的版本规范

CHAR lpszFilterDesc[SF_MAX_FILTER_DESC_LEN+1]; //OUT，对该过滤器的描述字符串

DWORD dwFlags //OUT，事件和优先级标志

)；

事件和优先级标志dwFlasg的取值在MSDN中有详细解释，其中包括该Filter被调用的优先级，一

般应使用默认的低优先级，否则可能会对系统的性能造成很大影响。

3、HttpFilterProc( )是ISAPI Filter主要的入口函数，它根据当前的事件的不同作出不同的处

理。服务器通过如下的参数块和Filter进行交互，这个参数块的作用和ISA中的ECB类似。

typedef struct _HTTP_FILTER_CONTEXT

{

DWORD cbSize; //IN，本参数块的大小

DWORD Revision; //IN

PVOID ServerContext; //IN，由server使用本参数

DWORD ulReserved; //IN，由server使用本参数

BOOL fIsSecurePort; //IN，事件是否发生在安全端口上

PVOID pFilterContext; //IN/OUT，与本次请求相关的上下文

//回调函数，取得关于服务器和本次连接的信息

BOOL (WINAPI * GetServerVariable) (