1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_http_acl_set">
<refmeta>
<refentrytitle>http_acl_set</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>http_acl_set</refname>
<refpurpose>Set conditions against web server ACL's</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_http_acl_set">
<funcprototype id="fproto_http_acl_set">
<funcdef>integer <function>http_acl_set</function></funcdef>
<paramdef>in <parameter>list_name</parameter> varchar</paramdef>
<paramdef>in <parameter>order</parameter> integer</paramdef>
<paramdef>in <parameter>client_ip</parameter> varchar</paramdef>
<paramdef>in <parameter>flag</parameter> integer</paramdef>
<paramdef><optional>in <parameter>destination_ip_or_host</parameter> varchar</optional></paramdef>
<paramdef><optional>in <parameter>object_id</parameter> integer</optional></paramdef>
<paramdef><optional>in <parameter>read_write_flag</parameter> integer</optional></paramdef>
<paramdef>in <parameter>rate</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_http_acl_set">
<title>Description</title>
<para>This function can be used within application logic to set ACLs rule.</para>
</refsect1>
<refsect1 id="params_http_acl_set">
<title>Parameters</title>
<refsect2><title>list_name</title>
<para>a string designating which list to be used for matching</para></refsect2>
<refsect2><title>order</title>
<para>a string designating order</para></refsect2>
<refsect2><title>client_ip</title>
<para>a string containing the IP number of client to set rules</para></refsect2>
<refsect2><title>flag</title>
<para>0 - allow, 1 - deny</para></refsect2>
<refsect2><title>destination_ip_or_host</title>
<para>a string containing the IP number of destination requested by client </para></refsect2>
<refsect2><title>object_id</title>
<para>is a integer designating a object to match </para></refsect2>
<refsect2><title>read_write_flag</title>
<para>an integer designating action to match: 0 - read, 1 - write</para></refsect2>
<refsect2><title>rate</title>
<para>When set, the filter will calculate hit rate average and will compare with limit for http acl rule.
If it is larger then will drop connection. Once per day the statistics will be reset.</para></refsect2>
</refsect1>
<refsect1 id="ret_http_acl_set"><title>Return Types</title>
<para>The function returns the value of the HA_FLAG of the first matching
rule. If no rule matches it returns -1.</para>
</refsect1>
<refsect1 id="seealso_http_acl_set">
<title>See Also</title>
<para>
<link linkend="fn_http"><function>http</function></link>,
<link linkend="fn_http_acl_get"><function>http_acl_get</function></link>,
<link linkend="fn_http_acl_remove"><function>http_acl_remove</function></link>,
<link linkend="fn_http_url"><function>http_url</function></link>,
<link linkend="fn_string_output"><function>string_output</function></link>,
<link linkend="fn_http_rewrite"><function>http_rewrite</function></link>,
<link linkend="wsaclgenpurpacl">General ACLs</link>.
</para>
</refsect1>
</refentry>
|
