不再回头 .net学习日记&资料

我再也不愿听你要求 我受够了你那些自私要求

  IT博客 :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理 ::
  39 随笔 :: 2 文章 :: 14 评论 :: 0 Trackbacks
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) ( 
struct _HTTP_FILTER_CONTEXT * pfc, 
LPSTR lpszVariableName, 
LPVOID lpvBuffer, 
LPDWORD lpdwSize 
); 

BOOL (WINAPI * AddResponseHeaders) ( //回调函数,给HTTP响应添加一个标头 
struct _HTTP_FILTER_CONTEXT * pfc, 
LPSTR lpszHeaders, 
DWORD dwReserved 
); 

BOOL (WINAPI * WriteClient) ( //回调函数,将原始数据发送给客户端 
struct _HTTP_FILTER_CONTEXT * pfc, 
LPVOID Buffer, 
LPDWORD lpdwBytes, 
DWORD dwReserved 
); 

VOID * (WINAPI * AllocMem) ( //回调函数,分配内存。 
struct _HTTP_FILTER_CONTEXT * pfc, 
DWORD cbSize, 
DWORD dwReserved 
); 

BOOL (WINAPI * ServerSupportFunction) ( //回调函数,访问服务器的一般和特定功能 
struct _HTTP_FILTER_CONTEXT * pfc, 
enum SF_REQ_TYPE sfReq, 
PVOID pData, 
DWORD ul1, 
DWORD ul2 
); 

} HTTP_FILTER_CONTEXT, *PHTTP_FILTER_CONTEXT; 

四、VC++ 6.0中对ISAPI的支持 

VC++ 6.0中定义了5个相关的类以简化ISAPI的编程工作:CHttpServer、CHttpServerContext、CHttpFilter、CHttpFilterContext、CHtmlStream,这5个类都没有父类。其中CHttpServer和CHttpServerContext主要用来编写ISA,CHttpFilter和CHttpFilterContext则用来编写ISAPI Filter,而CHtmlStream则用来操作内存中的HTML文件,为其它的4个类提供服务。CHttpServer在每个ISA中只能有一个实例,一个CHttpServer可以对应多个CHttpServerContext实例,每个 
CHttpServerContext处理一个客户请求,这样可以处理并发的HTTP请求;CttpFilter和CHttpFilterContext之间的关系与此类似,在每个ISAPI Filter中只能有一个CHttpFilter实例,但是可以有多个CHttpFilterContext来处理并发的事件。CHttpServer和CHttpFilter是独立的类,它们可以共存于一个DLL中,也可以分别在不同的DLL中。 

一个ISA可以提供多个命令,每个命令对应于CHttpServer(或其子类)的一个成员函数,客户端可以在URL中指定命令名及其参数。在VC++ 6.0中是通过parse map来实现这种对应的。 

Parse map类似MFC中的Windows消息分发机制,通过使用VC提供的DECLARE_PARSE_MAP、BEGIN_PARSE_MAP、ON_PARSE_COMMAND、ON_PARSE_COMMAND_PARAMS、DEFAULT_PARSE_COMMAND、END_PARSE_MAP等宏,可以实现对不同的命令的处理。每个CHttpServer中只能建立一个parse map,当客户端给ISA发来命令的时候,parse map可以分析HTTP请求中的命令名及其参数,将该命令与相应的成员函数关联起来,即由该成员函数处理该命令。以MSDN中的例子程序pinball为例,该例中有下面这样一个表单: 

<form method=get action="pinball.dll?"> 
<input type="hidden" name="MfcISAPICommand" VALUE="GetImage"> 
<input type="radio" name="Favorite" value="1" checked> Attack from Mars<br> 
<input type="radio" name="Favorite" value="2"> Twilight Zone<br> 
<input type="radio" name="Favorite" value="3"> The Addams Family<br> 
<input type="radio" name="Favorite" value="4"> Cirqus Voltaire<br> 
<input type="radio" name="Favorite" value="0"> I don't see it here<br> 
<br> 
<input type="submit" value="Show Me!"> 
</form> 

当客户端选中了上面的表单中的“Attack from Mars”这一项并点击了submit按钮后,服务器端 
最终将得到如下的URL串: 

http://www.abc.com/pinball.dll?MfcISAPICommand=GetImage&Favorite=1 

在该URL串中,命令名是GetImage,参数Favorite的值是1,因此pinball.dll中的如下成员函数 
将被调用以处理该请求,其中参数dwChoice对应URL中的参数Favorite: 

void CPinballExtension::GetImage(CHttpServerContext* pCtxt, long dwChoice); 

而parse map需要按照下面的形式定义: 

//CPinballExtension从CHttpServer派生而来 
BEGIN_PARSE_MAP(CPinballExtension, CHttpServer) 

//GetImage是CPinballExtension的成员函数,且有一个long型的参数即dwChoice 
ON_PARSE_COMMAND(GetImage, CPinballExtension, ITS_I4) 

//该参数在URL中的名字为Favorite 
ON_PARSE_COMMAND_PARAMS("Favorite") 

END_PARSE_MAP(CPinballExtension) 

而对于ISAPI Filter,在VC中可以通过重载CHttpFilter(或其子类)的不同的成员函数来实现对不同事件的处理。可重载的函数如下,每一个成员函数均对应一个或多个事件: 

OnPreprocHeaders 
OnAuthentication 
OnUrlMap 
OnSendRawData 
OnReadRawData 
OnLog 
OnEndOfNetSession 

MSDN提供了4个关于ISAPI的编程实例:counter、MFCUCASE、pinball、wwwquote,有兴趣的可看看,本文主要不是介绍编程,所以不再赘述。
posted on 2006-07-30 18:53 不再回头 阅读(2108) 评论(1)  编辑 收藏 引用 所属分类: ISapi

评论

# re: IIS的ISAPI接口简介 2006-07-30 19:03 不再回头
1.1 GetExtensionVersion()函数 这是一个非常简单的函数,它唯一的目的是指定ISAPI版本,并给出扩展的描述。当DLL第一次被装载时,由服务器调用。这发生在HttpExtensionProc()函数第一次调用前,在此函数中,你所需做的全部就是用常量HSE_VERSION_MAJOR和HSE_VERSION_ MINOR(在Isapi2.hpp中定义)设置扩展版本域。并且返回一true值。

  GetExtensionVersion()函数实现实例见清单2。

BOOL_export WINAPI
GetextensionVersion(Isapi2::THSE_VERSION_INFO &Ver) { /*设置扩展版本域*/ Ver.dwExtensionVersion=MAKELONG(HSE_VERSION_MAJOR,HSE_VERSION_MINOR);
Ver.lpszExtensionDesc="Example ISAPI extension";//设置扩展描述域 return
true; //返回true }

  在此函数中,程序员还可以加入初始化代码,如全局变量的初始化等。

  1.2 HttpExtensionProc()函数

  HttpExtensionProc() 函数是扩展的功能实现部分,每次产生对扩展的请求,服务 器就调用这个函数,同时传递一类型为TEXTENSION_CONTROL_BLOCK结构的参数(ECB) , 这个结构在Isapi2.hpp中定义:

  struct TEXTENSION_CONTROL_BLOCK

  { unsigned cbSize;//结构大小 unsigned dwVersion;//版本信息 unsigned ConnID; /*正在被服务的连接的ID;调用回调函数时必须作为一参数传递*/

  unsigned dwHttpStatusCode;/*在HttpExtensionProc () 函数返回前,在此放置HTTP状态码,参见HTTP1.0规范定义*/

  char lpszLogData[80];//接收一记录信息字符串 char *lpszMethod;//命名请求方式的字符串的指针 char *lpszQueryString;//含一个GET请求查询的字符串指针 char *lpszPathInfo;//请求的字符串的指针 char *lpszPathTranslated;//把请求的字符串指针翻译为服务器的物理路径 unsigned cbTotalBytes;//请求中字节的全部数目

  unsigned cbAvailable;//lpbData缓冲区长度 void *lpbData;//POST请求的数据缓冲区指针 char
*lpszContentType;//识别请求的MIME内容类型的指针 TGetServerVariableProc GetServerVariable;
/*检索服务器变量值的回调函数指 针*/ TWriteClientProc WriteClient;//写数据给用户的回调函数的指针 TReadClientProc

  ReadClient;//检索用户数据的回调函数指针 TServerSupportFunctionProc ServerSupportFunction;
/*支持其他操作的回调函数指针*/ }

  这种结构包含服务请求和回调函数指针所需得信息,你可以调用它来获取信息或执 行操作,下面对其中的回调函数作一说明:

  (1)GetServerVariable函数

  原型为:

  typedef BOOL _stdcall (*TgetServerVarableProc) (int hConn,*VariableName, void *Buff,int &Size);

  调用这个函数来获取服务器变量(如CONTEXT_TYPE)和同请求一起收到的头部。如通 过请求, 则得到HTTP_COOKIE来检索Cookies头部的内容。参数说明:hConn为传入参数 的连ECB接句柄ConnID;VariableName为要检索的变量的名字(如HTTP_COOKIE);Buffer为 接收变量的缓冲区指针;Size为缓冲区大小,若由于缓冲区空间不够而失败,该值被改 变为必要的缓冲区大小。

  (2)WriteClient函数

  原型为:

  typedef BOOL _stdcall (*TWriteClientProc) (int ConnID,void *Buffer,int & Bytes,int dwReserver)

  调用这个函数来发送响应内容给用户, 参数说明:ConnID为传入参数ECB中的连接 句柄ConnID; Buffer为包含写数据缓冲区的指针; Bytes为缓冲区数据的字节数; dwReserver保留。

  (3)ReadClient函数

  原型为:

  typedef BOOL _stdcall (*TReadClientProc) (int ConnID, void *Buffer,int & Size)

  调用这个函数读取用户的附加数据,通过检验ECB中cbAvailable和cbTotalBytes的 值来确定是否调用此函数, 若cbTotalBytes大于cbAvailable;就表明有更多的数据需 要调用该函数去读取。 参数说明:ConnID为传入参数ECB中的连接句柄ConnID;Buffer 为读入数据存放的缓冲区;Size在调用时,传入Buffer缓冲区的大小,返回时,等于实 际读取的字节数。

  (4)ServerSupportFunction函数

  原型为:

  typedef BOOL _stdcall (*TServerSupportFunctionProc) (int hConn, int HSERRequest,void buffer,int &Size,PDWORD DataType);

  这个函数实现其他一些操作,参数说明:hConn为传入参数ECB的连接句柄ConnID, HSERRequest为要实现操作的常量值。Size为Buffer缓冲区的大小,Buffer缓冲区指针; DataType为数据类型指针;其中Buffer和DataType的含义根据HSERRequest的值变化。

  下面说明这个函数的几个主要操作(也就是HSERRequest的可用值,在Isapi2.hpp中 定义),以及对应不同的操作,参数Buffer,Size,DataType的不同含义:

  ●HSE_REQ_SEND_URL_REDIRECT_RESP: 重定向客户浏览器到另一个网址上的URL。 Buffer:指向一重定向目标URL字符串;DataType被忽略。

  ●HSE_REQ_SEND_URL: 重定向到本服务器上的一个URL,Buffer: 指向一重定向目标 URL字符串;DataType被忽略。

  ●HSE_REQ_SEND_RESPONSE_HEADER:发送响应头部给用户;Buffer: 指向包含头部的 字符串;DataType被忽略。

  ●HSE_REQ_DONE_WITH_SESSION: 通知服务器, 异步的请求处理已经完成。 Size, Buffer,DataType均被忽略。

  ●HSE_REQ_MAP_URL_TO_PATH: 映射一个逻辑路径到一个物理路径。Buffer:映射在 此缓冲区上完成;DataType被忽略。

  HttpExtensionProc()函数的返回值必须使以下四个值(在Isapi2.hpp中定义)中的一个:

  ●HSE_STATUS_SUCCESS:所有进程已完成。

  ●HSE_STATUS_SUCCESS_AND_KEEP_CONN:所有进程已经完成,但希望保持连接以继 续进一步的交互。

  ●HSE_STATUS_PENDING: 进程未完成。 当扩展异步完成进程时, 将以参数 HSERRequest=HSE_REQ_DONE_WITH_SESSION调用ServerSupportFunction(),以提醒服务 器进程已完成。

  ●HSE_STATUS_ERROR:进程由于错误已异常终止。

  清单3包含了

int _export WINAPI
HttpExtensionProc(Isapi2::TEXTENSION_CONTROL_BLOCK &ECB) { char my_string[256];
int length; strcpy(my_string,"200 OK/r/nContext-Type:text/html");
length=strlen(my_string); ECB.dwHttpStatusCode=200; ECB.ServerSupportFunction(ECB.ConnID,
HSE_REQ_SEND_RESPONSE_HEADER, my_ string,length,NULL);//发送头部 strcpy(my_string,"Hello
World!"); length=strlen(my_string); ECB.WriteClient(ECB.ConnID,my_string,length,0);
//发送数据给客户浏览器 return(HSE_STATUS_SUCCESS); }

  处理一个"Hello World"网页请求的简单 但必要的逻辑。

  这是一个简单的例子,实际应用的ISAPI扩展将需要做比这更多的工作。

  与GetExtenVersion()函数和TerninateExtension()函数不同,HttpExtensionProc ()函数对用户的行为产生作用。

  1.3 TerminateExtension()函数

  TerminateExtension() 函数在用户将卸载DLL时被调用,它是可选择的。传入参数 为dwFlages,类型为int,是以下两个值(在Isapi2.hpp中定义)中的一个:

  ●请求同意卸载DLL的HSE_TERM_ADVISORY_UNLOAD值。 函数返回true将允许服务器 卸载该DLL。

  ●强迫DLL清除并准备被卸载的HSE_TERM_MUST_UNLOAD值。 TerminateExtension()函数对服务器行为产生作用。编写完ISAPI扩展应用程序后,用C++ Builder的Project->菜单项功能,为ISAPI扩 展生成一个DLL,这个DLL就可以直接被作为ISAPI扩展使用。

  2.结束语

  本文介绍的是一种在C++ Builder开发环境下较为复杂的ISAPI扩展的实现方法,这 种方法对理解ISAPI扩展的工作方式有很大帮助,除此以外,在C++ Builder中有更简单 的方法来实现,即通过使用WebModule, 以及TISAPIApplication、TISAPIRequest、 TISAPIResponse等类。详细方法参见C++ Builder文档。
  回复  更多评论
  

只有注册用户登录后才能发表评论。