mirror/mongoose
1
0
Fork 0
mirror of https://github.com/cesanta/mongoose.git synced 2024-11-28 21:59:02 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Update mg_check_ip_acl.md

Browse Source
This commit is contained in:
Evelyn 2016-07-22 15:13:59 +01:00 committed by GitHub
parent 3cf4e32d9f
commit a2d07ef983
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/c-api/net.h/mg_check_ip_acl.md
View File

@ -6,7 +6,7 @@ signature: |
int mg_check_ip_acl(const char *acl, uint32_t remote_ip);
---
Verify given IP address against the ACL.
Verifies given IP address against the ACL.
`remote_ip` - an IPv4 address to check, in host byte order
`acl` - a comma separated list of IP subnets: `x.x.x.x/x` or `x.x.x.x`.
@ -15,13 +15,13 @@ prepended by either a - or a + sign. A plus sign means allow, where a
minus sign means deny. If a subnet mask is omitted, such as `-1.2.3.4`,
this means to deny only that single IP address.
Subnet masks may vary from 0 to 32, inclusive. The default setting
is to allow all accesses. On each request the full list is traversed,
is to allow all access. On each request the full list is traversed,
and the last match wins. Example:
`-0.0.0.0/0,+192.168/16` - deny all acccesses, only allow 192.168/16 subnet
To learn more about subnet masks, see the
link:https://en.wikipedia.org/wiki/Subnetwork[Wikipedia page on Subnetwork]
To learn more about subnet masks, see this
link:https://en.wikipedia.org/wiki/Subnetwork[Wikipedia page on Subnetwork].
Return -1 if ACL is malformed, 0 if address is disallowed, 1 if allowed.
Returns -1 if ACL is malformed, 0 if address is disallowed, 1 if allowed.