-
Notifications
You must be signed in to change notification settings - Fork 0
/
logger_mod.html
253 lines (188 loc) · 8.04 KB
/
logger_mod.html
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta name="keywords" content="Yaws"/>
<title>Yaws</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="stylesheet" type="text/css" href="stil.css"/>
<link rel="shortcut icon" href="/icons/yaws_y.gif" type="image/x-icon"/>
</head>
<body>
<div class="logo">
<img src="icons/yaws_head.gif" width="600" alt="YAWS"/>
</div>
<div id="sidebar">
<h4> Yaws </h4>
<div class=""> <a href="index.html" id="index" >Top Page</a> </div>
<div class=""> <a href="configuration.html" id="configuration">Build Config and Run</a></div>
<div class=""> <a href="dynamic.html" id="dynamic" >Dynamic Content</a> </div>
<div class=""> <a href="https://github.com/erlyaws/yaws/releases/" id="download">Download </a> </div>
<div class=""> <a href="contact.html" id="contact">Contact </a> </div>
<div class=""> <a href="doc.html" id="doc">Documentation</a> </div>
<div class=""> <a href="articles.html" id="resources">Articles</a> </div>
<h4> Examples </h4>
<div class=""> <a href="/json_intro.html">AJAX/JSON RPC</a></div>
<div class=""> <a href="/appmods.html">Appmods</a> </div>
<div class=""> <a href="/arg.html">Arg</a> </div>
<div class=""> <a href="/privbind.html">Binding to Privileged Ports</a></div>
<div class=""> <a href="/bindings.html">Bindings</a> </div>
<div class=""> <a href="/cgi.html">CGI</a></div>
<div class=""> <a href="/session.html">Cookie Sessions</a> </div>
<div class=""> <a href="/cookies.html">Cookies</a> </div>
<div class=""> <a href="/dynamic.html">Dynamic Content</a> </div>
<div class=""> <a href="/embed.html">Embedding Yaws</a></div>
<div class=""> <a href="/upload0.html">File Upload</a> </div>
<div class=""> <a href="/form.html">Forms</a> </div>
<div class=""> <a href="/haxe_intro.html">haXe Remoting</a></div>
<div class=""> <a href="/pcookie.html">Persistent Cookies</a> </div>
<div class=""> <a href="/query.html">Query Part of URL</a></div>
<div class=""> <a href="/rebar_release.html">Rebar Releases</a></div>
<div class=""> <a href="/redirect.html">Redirect</a> </div>
<div class=""> <a href="/server_sent_events.html">Server-Sent Events</a> </div>
<div class=""> <a href="/ssi.html">Server Side Includes</a> </div>
<div class=""> <a href="/simple.html">Simple</a> </div>
<div class=""> <a href="/soap_intro.html">SOAP with Yaws</a></div>
<div class=""> <a href="/stream.html">Streaming Data</a> </div>
<div class=""> <a href="/websockets.html">Web Sockets</a> </div>
<a href="/shoppingcart/index.html">Tiny Shopping Cart</a>
<div class=""> <a href="/yapp_intro.html">Yaws Applications (yapps)</a></div>
<div class="choosen"> <a href="/logger_mod.html">Write Your Own Logger</a></div>
<h4> Misc </h4>
<div class=""> <a href="/internals.html">Internals</a> </div>
</div>
<div id="entry">
<h1>Write your own logger</h1>
<p>
To illustrate how to write a module that handles auth and access logging in
Yaws, we will get a concrete example: How to log the original client IP behind a
HTTP reverse proxy.
</p>
<p>
When Yaws is running behind a HTTP reverse proxy, the source IP of a connection
is always the proxy's IP address. It is also this IP address that you will find
in your log files. In this situation, it may be desirable to log the real client
IP address by extracting it from the "<a
href="https://en.wikipedia.org/wiki/X-Forwarded-For"
target="_blank">X-Forwarded-For</a>" header.
</p>
<p>
It can easily be done by writting a simple module to handle access and auth
logging on top of yaws_log. yaws_log is the default logger of Yaws and it can be
overridden by using the directive "logger_mod" in yaws.conf:
</p>
<div class="box">
<pre>
<server www.hyber.org>
port = 80
listen = 0.0.0.0
logger_mod = simple_logger
...
</server>
</pre>
</div>
<p>
In this example, "simple_logger" will be used in place of yaws_log. This module
must implement the behaviour yaws_logger by exporting the following functions:
</p>
<div class="box">
<pre>
Module:open_log(ServerName, Type, LogDir) -> {true, State} | false.
ServerName :: string()
Type :: access | auth
LogDir :: string()
State :: term()
Module:close_log(ServerName, Type, State) -> ok.
ServerName :: string()
Type :: access | auth
State :: term()
Module:wrap_log(ServerName, Type, State, LogWrapSize) -> NewState.
ServerName :: string()
Type :: access | auth
State, NewState :: term()
Module:write_log(ServerName, Type, State, Infos) -> ok.
ServerName :: string()
Type :: access | auth
State :: term()
Infos :: {Ip,Req,InHdrs,OutHdrs,Time} | %% when type =:= access
{Ip,Path,Item} %% when type =:= auth
Ip :: inet:ip_address() | inet:hostname() | unknown
Req :: #http_request{} %% defined in yaws_api.hrl
InHdrs :: #headers{} %% defined in yaws_api.hrl
OutHdrs :: #outh{} %% defined in yaws.hrl
Time :: non_neg_integer() %% The time taken to serve the request, in microseconds
Path :: string() %% the URI path of the request
Item :: {ok, User} | 403 | {401, Realm} %% the result of an auth request
</pre>
</div>
<p>
Back to our example. The only thing we want to do is read the "X-Forwarded-For"
header to extract the real client IP address. The logging will be delegated to
yaws_log.
</p>
<p>
If the "X-Forwarded-For" header is defined, then the originating IP address of a
client is the left-most IP address. But, because this header can be falsified,
we will define a list of trustworthy proxies. For simplicity, we will use a
macro. Here is our logger:
</p>
<div class="box">
<pre>
-module(yaws_revproxy_logger).
-behaviour(yaws_logger).
-include_lib("yaws/include/yaws.hrl").
-include_lib("yaws/include/yaws_api.hrl").
-export([open_log/3, close_log/3, wrap_log/4, write_log/4]).
-define(REVPROXY_WHITELIST, [{192,168,0,1}, {192,168,0,2}]).
%% ===================================================================
open_log(ServerName, Type, Dir) ->
yaws_log:open_log(ServerName, Type, Dir).
close_log(ServerName, Type, State) ->
yaws_log:close_log(ServerName, Type, State).
wrap_log(ServerName, Type, Data, LogWrapSize) ->
yaws_log:wrap_log(ServerName, Type, Data, LogWrapSize).
write_log(ServerName, auth, State, {Ip, Path, Item}) ->
yaws_log:write_log(ServerName, auth, State, {Ip, Path, Item});
write_log(ServerName, access, State, {Ip, Req, InH, OutH, Time}) ->
RealIp = real_client_ip(Ip, ?REVPROXY_WHITELIST, InH),
yaws_log:write_log(ServerName, access, State, {RealIp, Req, InH, OutH, Time}).
real_client_ip(Ip, ProxyWhitelist, Hdrs) ->
case lists:member(Ip, ProxyWhitelist) of
true ->
FwdFor = Hdrs#headers.x_forwarded_for,
case yaws:split_sep(FwdFor, $,) of
[FirstIp|_Proxies] ->
%% We might check if the last proxy is the remote
%% address of the request, i.e hd(_Proxies) =:= Ip.
case inet_parse:address(FirstIp) of
{error, _} -> unknown;
{ok, ClientIp} -> ClientIp
end;
[] ->
Ip
end;
false ->
Ip
end.
</pre>
</div>
<p>
Now, we just need to compile this module and update yaws.conf accordingly.
</p>
<p>
<i>Note: In previous version of Yaws, we could use
"x_forwarded_for_log_proxy_whitelist" to do the same thing. This parameter is
now deprecated.</i>
</p>
</div>
<div class="logo">
<img src="/icons/yaws_pb.gif" alt="pbyaws" />
</div>
<p>
<a href="https://validator.w3.org/check?uri=referer"><img
src="https://www.w3.org/Icons/valid-xhtml10"
alt="Valid XHTML 1.0!" height="31" width="88" /></a>
</p>
</body>
</html>