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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
.TH mod_security 3 "inets 5.0.9" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
mod_security \- Security Audit and Trailing Functionality
.SH DESCRIPTION
.LP
Security Audit and Trailing Functionality
.SH EXPORTS
.LP
.B
list_auth_users(Port) -> Users | []
.br
.B
list_auth_users(Address, Port) -> Users | []
.br
.B
list_auth_users(Port, Dir) -> Users | []
.br
.B
list_auth_users(Address, Port, Dir) -> Users | []
.br
.RS
.TP
Types
Port = integer()
.br
Address = {A, B, C, D} | string() | undefined
.br
Dir = string()
.br
Users = list() = [string()]
.br
.RE
.RS
.LP
\fIlist_auth_users/1\fR, \fIlist_auth_users/2\fR and \fIlist_auth_users/3\fR returns a list of users that are currently authenticated\&. Authentications are stored for SecurityAuthTimeout seconds, and are then discarded\&.
.RE
.LP
.B
list_blocked_users(Port) -> Users | []
.br
.B
list_blocked_users(Address, Port) -> Users | []
.br
.B
list_blocked_users(Port, Dir) -> Users | []
.br
.B
list_blocked_users(Address, Port, Dir) -> Users | []
.br
.RS
.TP
Types
Port = integer()
.br
Address = {A, B, C, D} | string() | undefined
.br
Dir = string()
.br
Users = list() = [string()]
.br
.RE
.RS
.LP
\fIlist_blocked_users/1\fR, \fIlist_blocked_users/2\fR and \fIlist_blocked_users/3\fR returns a list of users that are currently blocked from access\&.
.RE
.LP
.B
block_user(User, Port, Dir, Seconds) -> true | {error, Reason}
.br
.B
block_user(User, Address, Port, Dir, Seconds) -> true | {error, Reason}
.br
.RS
.TP
Types
User = string()
.br
Port = integer()
.br
Address = {A, B, C, D} | string() | undefined
.br
Dir = string()
.br
Seconds = integer() | infinity
.br
Reason = no_such_directory
.br
.RE
.RS
.LP
\fIblock_user/4\fR and \fIblock_user/5\fR blocks the user \fIUser\fR from the directory \fIDir\fR for a specified amount of time\&.
.RE
.LP
.B
unblock_user(User, Port) -> true | {error, Reason}
.br
.B
unblock_user(User, Address, Port) -> true | {error, Reason}
.br
.B
unblock_user(User, Port, Dir) -> true | {error, Reason}
.br
.B
unblock_user(User, Address, Port, Dir) -> true | {error, Reason}
.br
.RS
.TP
Types
User = string()
.br
Port = integer()
.br
Address = {A, B, C, D} | string() | undefined
.br
Dir = string()
.br
Reason = term()
.br
.RE
.RS
.LP
\fIunblock_user/2\fR, \fIunblock_user/3\fR and \fIunblock_user/4\fR removes the user \fIUser\fR from the list of blocked users for the Port (and Dir) specified\&.
.RE
.SH THE SECURITYCALLBACKMODULE
.LP
The SecurityCallbackModule is a user written module that can receive events from the mod_security Erlang Webserver API module\&. This module only exports one function, event/4, which is described below\&.
.SH EXPORTS
.LP
.B
event(What, Port, Dir, Data) -> ignored
.br
.B
event(What, Address, Port, Dir, Data) -> ignored
.br
.RS
.TP
Types
What = atom()
.br
Port = integer()
.br
Address = {A, B, C, D} | string() <v>Dir = string()
.br
What = [Info]
.br
Info = {Name, Value}
.br
.RE
.RS
.LP
\fIevent/4\fR or \fIevent/4\fR is called whenever an event occurs in the mod_security Erlang Webserver API module (\fIevent/4\fR is called if Address is undefined and \fIevent/5\fR otherwise)\&. The \fIWhat\fR argument specifies the type of event that has occurred, and should be one of the following reasons; \fIauth_fail\fR (a failed user authentication), \fIuser_block\fR (a user is being blocked from access) or \fIuser_unblock\fR (a user is being removed from the block list)\&.
.SS Note:
.LP
Note that the \fIuser_unblock\fR event is not triggered when a user is removed from the block list explicitly using the \fIunblock_user\fR function\&.
.RE
|
