📄 webssecurityhandler.htm
字号:
<html>
<head>
<title>websSecurityHandler -- GoAhead WebServer API</title>
<link rel="stylesheet" href="../../style/doc.htm" type="text/css">
</head>
<body>
<TABLE border=0 width=100% cellspacing=0 cellpadding=0>
<TR>
<TD class=title-left><b>websSecurityHandler</b></TD>
<TD class=title-center><b> GoAhead WebServer API</b></TD>
<TD class=title-right><B> GoAhead EMF</B></TD>
</TR>
</TABLE>
<HR>
<h2>Synopsis</h2>
<p> URL handler for the default security policy</p>
<h2>Prototype</h2>
<pre>
#include "webs.h"
int <b>websSecurityHandler</b>(webs_t wp, char_t *url, char_t *path,
char_t *query);
</pre>
<h2>Parameters</h2>
<p><table width=90%>
<TR>
<TD width=40>wp
<TD>Web server connection handle
<TR>
<TD width=40>url
<TD>Request URL
<TR>
<TD width=40>path
<TD>Request path portion of the URL
<TR>
<TD width=40>query
<TD>Query string portion of the
URL</TD> </TR></table></p>
<h2>Description</h2>
<P>websSecurityHandler implements
the default security policy. It operates as a URL handler and is installed to run as
the very first URL handler. If you require a replacement security policy, delete the websSecurityHandler and install your
own with <A href="websUrlHandlerDefine.htm">websUrlHandlerDefine</A>.</P>
<P> </P>
<P> The <A href="websSetPassword.htm">websSetPassword</a> procedure defines
the security password. The security handler will require all non-local
requests (those from a remote system) to supply this password. The user name is
ignored. To use the password feature, the <A href="websSecurityHandler.htm" >Security
Handler</A>must be installed by calling
<A href="websUrlHandlerDefine.htm" >websHandlerDefine</A> for
websSecurityHandler. This in done automatically in the GoAhead EMF. If you are
using the GoAhead WebServer, this should be done in your main program. See
main.c for examples.</P>
<P>
</P>
<P>The security handler should return 0 if the request is
acceptable. It should return 1 to deny the request. When websSecurityHandler
denies a request, it first returns a 401 response code to cause the user's browser to prompt for a username
and password.</P>
<p>
<p>Use <A href="websGetRequestPassword.htm">websGetRequestPassword</A> to
get the password supplied with the current request.</p>
<h2>Return Value</h2>
<p> Returns 0 if the request is acceptable. Returns 1 if the request
is denied.</p>
<h2>Example</h2>
<p>The following code with install a new security handler.</p>
<br>
<pre>
websSecurityDelete();
websUrlHandlerDefine("", mySecurityHandler, WEBS_HANDLER_FIRST);
</pre>
<h2>See Also:</h2>
<p>
<A href="websGetRequestFlags.htm">websGetRequestFlags</A>,
<A href="websGetRequestIpaddr.htm">websGetRequestIpaddr</A>,
<A href="websGetRequestPassword.htm">websGetRequestPassword</A>,
<A href="websGetRequestType.htm">websGetRequestType</A>
</p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -