Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 169 lines (131 sloc) 5.127 kb
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
<erl>
out(A) ->
       {ssi, "TAB.inc", "%%",[{"logger_mod", "choosen"}]}.
</erl>


<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="http://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
override by using the directive "logger_mod" in yaws.conf:
</p>

<div class="box">
     <verbatim>
<server www.hyber.org>
        port = 80
        listen = 0.0.0.0
        logger_mod = simple_logger
        ...
</server>

     </verbatim>
</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">
     <verbatim>
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

     </verbatim>
</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">
     <verbatim>
-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.

     </verbatim>
</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>
<erl>
out(A) -> {ssi, "END2",[],[]}.
</erl>
Something went wrong with that request. Please try again.