CODEWITHSUNDEEP
loggingnginxipanonymize
endzeit
endzeit

Reputation: 705

Anonymize IP logging in nginx?

To respect the privacy of my users I'm trying to anonymize their IP addresses in nginx log files.

One way to do this would be defining a custom log format, like so:

log_format noip '127.0.0.1 - [$time_local]  '
    '"$request" $status $body_bytes_sent '
    '"$http_referer" "$http_user_agent" $request_time';

This method has two downsides: I can't distinguish between two users and can't use geo location tools.

The best thing would be to 'shorten' the IP address (87.12.23.55 would become 87.12.23.1).

Is there a possibility to achieve this using nginx config scripting?

Upvotes: 33

Views: 17533

Answers (3)

Michael Gorianskyi
Michael Gorianskyi

Reputation: 364

The accepted answer seems a bit bloated. Since nginx version 1.11 it's possible to do it this way:

map $remote_addr $remote_addr_anon {
    ~(?P<ip>\d+\.\d+\.\d+)\.    $ip.0;
    ~(?P<ip>[^:]+:[^:]+):       $ip::;
    default                     0.0.0.0;
}

Upvotes: 18

XZVASFD
XZVASFD

Reputation: 1048

Here's an nginx module that basically does this (anonymizing IP addresses in your logs): ​https://github.com/masonicboom/ipscrub. It generates a hash of the IP address as $remote_addr_ipscrub. The hash salt cycles every so often (configurable), so you can link requests without logging user IP addresses.

Upvotes: 2

Mike Bretz
Mike Bretz

Reputation: 1986

Even if there is already an accepted answer, the solution seems not to be valid.

nginx has the log_format directive, which has a context of http. This means, the log_format can only be (valid) set within the http {} section of the config file, NOT within the server sections!

On the other hand we have an if directive, which has a context of server and location.

So we can NOT use “if” and “log_format” within a server section (which is done within the accepted solution)

So the if is not helpful here, also if is evil ( http://wiki.nginx.org/IfIsEvil )! We need something which is working at http context because only there the log_format can be defined in a valid way, and this is the only place outside of the server context, where our virtual hosts are defined…

Luckily there is a map feature within nginx! map is remapping some values into new values (accessible within variables which can be used in a log_format directive). And the good message: This also works with regular expressions.

So let’s map our IPv4 and IPv6 addresses into anonymized addresses. This has to be done in 3 steps, since map can not accumulate returned values, it can only return strings or variables, not a combination of both.

So, at first we grab the part of IP we want to have in the logfiles, the second map returns the part which symbolizes the anonymized part, and the 3rd map rule maps them together again.

Here are the rules which go into the http {} context:

map $remote_addr $ip_anonym1 {
 default 0.0.0;
 "~(?P<ip>(\d+)\.(\d+)\.(\d+))\.\d+" $ip;
 "~(?P<ip>[^:]+:[^:]+):" $ip;
}

map $remote_addr $ip_anonym2 {
 default .0;
 "~(?P<ip>(\d+)\.(\d+)\.(\d+))\.\d+" .0;
 "~(?P<ip>[^:]+:[^:]+):" ::;
}

map $ip_anonym1$ip_anonym2 $ip_anonymized {
 default 0.0.0.0;
 "~(?P<ip>.*)" $ip;
}

log_format anonymized '$ip_anonymized - $remote_user [$time_local] ' 
   '"$request" $status $body_bytes_sent ' 
   '"$http_referer" "$http_user_agent"';

access_log /var/log/nginx/access.log anonymized;

After adding this to your nginx.conf config file, remember to reload your nginx. Your log files should now contain anoymized IP addresses, if you are using the “anonymized” log format (this is the format parameter of access_log directive).

Upvotes: 43

Related Questions