1mod_security(3)            Erlang Module Definition            mod_security(3)
2
3
4

NAME

6       mod_security - Security Audit and Trailing Functionality
7

DESCRIPTION

9       Security Audit and Trailing Functionality
10

EXPORTS

12       block_user(User, Port, Dir, Seconds) -> true | {error, Reason}
13       block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason}
14
15              Types:
16
17                 User = string()
18                 Port = integer()
19                 Address = {A,B,C,D} | string() | undefined
20                 Dir = string()
21                 Seconds = integer() | infinity
22                 Reason = no_such_directory
23
24              block_user/4 and block_user/5 each blocks the user User from di‐
25              rectory Dir for a specified amount of time.
26
27       list_auth_users(Port) -> Users | []
28       list_auth_users(Address, Port) -> Users | []
29       list_auth_users(Port, Dir) -> Users | []
30       list_auth_users(Address, Port, Dir) -> Users | []
31
32              Types:
33
34                 Port = integer()
35                 Address = {A,B,C,D} | string() | undefined
36                 Dir = string()
37                 Users = list() = [string()]
38
39              list_auth_users/1, list_auth_users/2, and list_auth_users/3 each
40              returns  a  list  of users that are currently authenticated. Au‐
41              thentications are stored for  SecurityAuthTimeout  seconds,  and
42              then discarded.
43
44       list_blocked_users(Port) -> Users | []
45       list_blocked_users(Address, Port) -> Users | []
46       list_blocked_users(Port, Dir) -> Users | []
47       list_blocked_users(Address, Port, Dir) -> Users | []
48
49              Types:
50
51                 Port = integer()
52                 Address = {A,B,C,D} | string() | undefined
53                 Dir = string()
54                 Users = list() = [string()]
55
56              list_blocked_users/1,          list_blocked_users/2,         and
57              list_blocked_users/3 each returns a list of users that are  cur‐
58              rently blocked from access.
59
60       unblock_user(User, Port) -> true | {error, Reason}
61       unblock_user(User, Address, Port) -> true | {error, Reason}
62       unblock_user(User, Port, Dir) -> true | {error, Reason}
63       unblock_user(User, Address, Port, Dir) -> true | {error, Reason}
64
65              Types:
66
67                 User = string()
68                 Port = integer()
69                 Address = {A,B,C,D} | string() | undefined
70                 Dir = string()
71                 Reason = term()
72
73              unblock_user/2,  unblock_user/3, and unblock_user/4 each removes
74              the user User from the list of blocked users for Port (and Dir).
75

SECURITYCALLBACKMODULE

77       The SecurityCallbackModule is a user-written module  that  can  receive
78       events  from the mod_security Erlang web server API module. This module
79       only exports the functions event/[4,5] which are described here.
80

EXPORTS

82       Module:event(What, Port, Dir, Data) -> ignored
83       Module:event(What, Address, Port, Dir, Data) -> ignored
84
85              Types:
86
87                 What = atom()
88                 Port = integer()
89                 Address = {A,B,C,D} | string()
90                 Dir = string()
91                 Data = [Info]
92                 Info = {Name, Value}
93
94              event/4 or event/5 is called whenever an  event  occurs  in  the
95              mod_security Erlang web server API module. (event/4 is called if
96              Address is undefined, otherwise event/5. Argument What specifies
97              the  type of event that has occurred and is one of the following
98              reasons:
99
100                auth_fail:
101                  A failed user authentication.
102
103                user_block:
104                  A user is being blocked from access.
105
106                user_unblock:
107                  A user is being removed from the block list.
108
109          Note:
110              The event user_unblock is not triggered when a user  is  removed
111              from the block list explicitly using the unblock_user function.
112
113
114
115
116Ericsson AB                       inets 8.2.1                  mod_security(3)