table of contents
other versions
- wheezy 1:15.b.1-dfsg-4+deb7u1
- wheezy-backports 1:17.3-dfsg-4~bpo70+1
- jessie 1:17.3-dfsg-4+deb8u1
- jessie-backports 1:19.2.1+dfsg-2~bpo8+1
- testing 1:19.2.1+dfsg-2
- unstable 1:19.2.1+dfsg-2
- experimental 1:19.3.1+dfsg-1
mod_security(3erl) | Erlang Module Definition | mod_security(3erl) |
NAME¶
mod_security - Security Audit and Trailing FunctionalityDESCRIPTION¶
Security Audit and Trailing FunctionalityEXPORTS¶
list_auth_users(Port) -> Users | []
Types:
Port = integer()
Address = {A,B,C,D} | string() | undefined
Dir = string()
Users = list() = [string()]
list_auth_users/1, list_auth_users/2 and list_auth_users/3
returns a list of users that are currently authenticated. Authentications are
stored for SecurityAuthTimeout seconds, and are then discarded.
Types:
Port = integer()
Address = {A,B,C,D} | string() | undefined
Dir = string()
Users = list() = [string()]
list_blocked_users/1, list_blocked_users/2 and
list_blocked_users/3 returns a list of users that are currently blocked
from access.
Types:
User = string()
Port = integer()
Address = {A,B,C,D} | string() | undefined
Dir = string()
Seconds = integer() | infinity
Reason = no_such_directory
block_user/4 and block_user/5 blocks the user User from the
directory Dir for a specified amount of time.
Types:
User = string()
Port = integer()
Address = {A,B,C,D} | string() | undefined
Dir = string()
Reason = term()
unblock_user/2, unblock_user/3 and unblock_user/4 removes
the user User from the list of blocked users for the Port (and Dir)
specified.
THE SECURITYCALLBACKMODULE¶
The SecurityCallbackModule is a user written module that can receive events from the mod_security Erlang Webserver API module. This module only exports the function(s), event/4,5, which are described below.EXPORTS¶
event(What, Port, Dir, Data) -> ignored
Types:
What = atom()
Port = integer()
Address = {A,B,C,D} | string() <v>Dir = string()
Data = [Info]
Info = {Name, Value}
event/4 or event/4 is called whenever an event occurs in the
mod_security Erlang Webserver API module ( event/4 is called if Address
is undefined and event/5 otherwise). The What argument specifies
the type of event that has occurred, and should be one of the following
reasons; auth_fail (a failed user authentication), user_block (a
user is being blocked from access) or user_unblock (a user is being
removed from the block list).
Note:
Note that the user_unblock event is not triggered when a user is removed
from the block list explicitly using the unblock_user function.
inets 5.9 | Ericsson AB |