From patchwork Sun Jul 3 10:52:16 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Ricardo Wurmus X-Patchwork-Id: 40484 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 28C9E27BBEA; Sun, 3 Jul 2022 11:53:12 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 59D4C27BBE9 for ; Sun, 3 Jul 2022 11:53:11 +0100 (BST) Received: from localhost ([::1]:56214 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1o7xDy-0004Nf-Ij for patchwork@mira.cbaines.net; Sun, 03 Jul 2022 06:53:10 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47864) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o7xDp-0004NX-Tq for guix-patches@gnu.org; Sun, 03 Jul 2022 06:53:01 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:49500) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1o7xDp-0001fZ-Kz for guix-patches@gnu.org; Sun, 03 Jul 2022 06:53:01 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1o7xDp-0005Fo-JM for guix-patches@gnu.org; Sun, 03 Jul 2022 06:53:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#56330] [PATCH v2] services: Add anonip-service-type. References: <20220630231551.16188-1-rekado@elephly.net> In-Reply-To: <20220630231551.16188-1-rekado@elephly.net> Resent-From: Ricardo Wurmus Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 03 Jul 2022 10:53:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 56330 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 56330@debbugs.gnu.org Cc: Ricardo Wurmus Received: via spool by 56330-submit@debbugs.gnu.org id=B56330.165684555820161 (code B ref 56330); Sun, 03 Jul 2022 10:53:01 +0000 Received: (at 56330) by debbugs.gnu.org; 3 Jul 2022 10:52:38 +0000 Received: from localhost ([127.0.0.1]:43397 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1o7xDN-0005F0-Ip for submit@debbugs.gnu.org; Sun, 03 Jul 2022 06:52:38 -0400 Received: from sender4-of-o51.zoho.com ([136.143.188.51]:21163) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1o7xDL-0005Eo-1U for 56330@debbugs.gnu.org; Sun, 03 Jul 2022 06:52:32 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1656845547; cv=none; d=zohomail.com; s=zohoarc; b=cnJnhLPnDUfmLN/5hSZfrYJ+yPpnqGEoMXw/MwWa3LopCrRH0v/ZSU9QzKi2k7sLJSLoM+5/SS522xVsoqgzwPpQKO8M1PS0tnYG/2jAUbzdFhnvVn71/vn0ppREzQSo2B7BcVdA8TVWdKTnmh6k2d8qboUAjrdf7zTJEnIpk/s= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1656845547; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:MIME-Version:Message-ID:Subject:To; bh=EN6eK1sXXKFKMUH5Q7g9OboipZh/Z48K2+eakavv0Ds=; b=mub7Xs/Xv92qyIZKcH5RjbrfLrJx4ySDx7OgeEoKphXV+0RZOuBrbQW6dxn1oHiuu5HQYQhg7VWY99TkxmBOYNxyZk4F8J0rt/MoyGYFRn1eiqlVg4PHh/M6qf7zi4IUN082mQKTtvCkhUPNrm5kmR0WqeIyD/iRezhqUbUostQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=elephly.net; spf=pass smtp.mailfrom=rekado@elephly.net; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1656845547; s=zoho; d=elephly.net; i=rekado@elephly.net; h=From:From:To:To:Cc:Cc:Subject:Subject:Date:Date:Message-Id:Message-Id:MIME-Version:Content-Type:Content-Transfer-Encoding:Reply-To; bh=EN6eK1sXXKFKMUH5Q7g9OboipZh/Z48K2+eakavv0Ds=; b=H8qgVrjdwQEAcHd1kDgez329i3NcOfM9U6hwiBNjQHblHkHzGB9p/KyemWB7nkPQ 4O8PS4u4gU0Y8WITQYqimNRw1zjDAm5btIZhLC3Jj9fqh3LLViZ50V4j/WZpbl0bzGf 5KBBrurmyjVXwXQDl2Ipy3lZ96AvANWRx499Pejk= Received: from localhost (104-110-142-46.pool.kielnet.net [46.142.110.104]) by mx.zohomail.com with SMTPS id 1656845543815240.46853199210238; Sun, 3 Jul 2022 03:52:23 -0700 (PDT) From: Ricardo Wurmus Date: Sun, 3 Jul 2022 12:52:16 +0200 Message-Id: <20220703105216.8843-1-rekado@elephly.net> X-Mailer: git-send-email 2.36.1 MIME-Version: 1.0 X-ZohoMailClient: External X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * gnu/services/web.scm (anonip-configuration): New record type. (anonip-configuration?, anonip-configuration-anonip, anonip-configuration-input, anonip-configuration-output, anonip-configuration-skip-private?, anonip-configuration-column, anonip-configuration-replacement, anonip-configuration-ipv4mask, anonip-configuration-ipv6mask, anonip-configuration-increment, anonip-configuration-delimiter, anonip-configuration-regex): New procedures. (anonip-service-type): New service type. * doc/guix.texi (Log Rotation): Add subheading for Anonip Service. --- doc/guix.texi | 71 +++++++++++++++++++++++++++- gnu/services/web.scm | 110 ++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 179 insertions(+), 2 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index cf373b6cbd..a22a7f59ec 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -30,7 +30,7 @@ Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021 Leo Famulari@* -Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020, 2021 Ricardo Wurmus@* +Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021, 2022 Efraim Flashner@* @@ -18700,6 +18700,75 @@ String or gexp denoting the corresponding mcron job schedule @end table @end deftp +@cindex logging, anonymization +@subheading Anonip Service + +Anonip is a privacy filter that removes IP address from web server logs. +This service creates a FIFO and filters any written lines with anonip +before writing the filtered log to a target file. + +The following example sets up the FIFO +@file{/var/run/anonip/https.access.log} and writes the filtered log file +@file{/var/log/anonip/https.access.log}. + +@lisp +(service anonip-service-type + (anonip-configuration + (input "/var/run/anonip/https.access.log") + (output "/var/log/anonip/https.access.log"))) +@end lisp + +Configure your web server to write its logs to the FIFO at +@file{/var/run/anonip/https.access.log} and collect the anonymized log +file at @file{/var/web-logs/https.access.log}. + +@deftp {Data Type} anonip-configuration +This data type represents the configuration of anonip. +It has the following parameters: + +@table @asis +@item @code{anonip} (default: @code{anonip}) +The anonip package to use. + +@item @code{input} +The file name of the input log file to process. The service creates a +FIFO of this name. The web server should write its logs to this FIFO. + +@item @code{output} +The file name of the processed log file. +@end table + +The following optional settings may be provided: + +@table @asis +@item @code{skip-private?} +When @code{#true} do not mask addresses in private ranges. + +@item @code{column} +A 1-based indexed column number. Assume IP address is in the specified +column (default is 1). + +@item @code{replacement} +Replacement string in case address parsing fails, e.g. @code{"0.0.0.0"}. + +@item @code{ipv4mask} +Number of bits to mask in IPv4 addresses. + +@item @code{ipv6mask} +Number of bits to mask in IPv6 addresses. + +@item @code{increment} +Increment the IP address by the given number. By default this is zero. + +@item @code{delimiter} +Log delimiter string. + +@item @code{regex} +Regular expression for detecting IP addresses. Use this instead of @code{column}. +@end table +@end deftp + + @node Networking Setup @subsection Networking Setup diff --git a/gnu/services/web.scm b/gnu/services/web.scm index 4434fecf02..1480a751e2 100644 --- a/gnu/services/web.scm +++ b/gnu/services/web.scm @@ -9,7 +9,7 @@ ;;; Copyright © 2018 Pierre-Antoine Rouby ;;; Copyright © 2018 Marius Bakke ;;; Copyright © 2019, 2020 Florian Pelz -;;; Copyright © 2020 Ricardo Wurmus +;;; Copyright © 2020, 2022 Ricardo Wurmus ;;; Copyright © 2020 Tobias Geerinckx-Rice ;;; Copyright © 2020 Arun Isaac ;;; Copyright © 2020 Oleg Pykhalov @@ -205,6 +205,21 @@ (define-module (gnu services web) tailon-service-type + anonip-configuration + anonip-configuration? + anonip-configuration-anonip + anonip-configuration-input + anonip-configuration-output + anonip-configuration-skip-private? + anonip-configuration-column + anonip-configuration-replacement + anonip-configuration-ipv4mask + anonip-configuration-ipv6mask + anonip-configuration-increment + anonip-configuration-delimiter + anonip-configuration-regex + anonip-service-type + varnish-configuration varnish-configuration? varnish-configuration-package @@ -1355,6 +1370,99 @@ (define tailon-service-type files)))))))) (default-value (tailon-configuration)))) + + +;;; +;;; Log anonymization +;;; + +(define-record-type* + anonip-configuration make-anonip-configuration + anonip-configuration? + (anonip anonip-configuration-anonip ;file-like + (default anonip)) + (input anonip-configuration-input) ;string + (output anonip-configuration-output) ;string + (skip-private? anonip-configuration-skip-private? ;boolean + (default #f)) + (column anonip-configuration-column ;number + (default #f)) + (replacement anonip-configuration-replacement ;string + (default #f)) + (ipv4mask anonip-configuration-ipv4mask ;number + (default #f)) + (ipv6mask anonip-configuration-ipv6mask ;number + (default #f)) + (increment anonip-configuration-increment ;number + (default #f)) + (delimiter anonip-configuration-delimiter ;string + (default #f)) + (regex anonip-configuration-regex ;string + (default #f))) + +(define (anonip-activation config) + (with-imported-modules '((guix build utils)) + #~(begin + (use-modules (guix build utils)) + (for-each + (lambda (directory) + (mkdir-p directory) + (chmod directory #o755)) + (list (dirname #$(anonip-configuration-input config)) + (dirname #$(anonip-configuration-output config))))))) + +(define (anonip-shepherd-service config) + (let ((input (anonip-configuration-input config)) + (output (anonip-configuration-output config))) + (list (shepherd-service + (provision (list (symbol-append 'anonip- (string->symbol output)))) + (requirement '(user-processes)) + (documentation "Anonimyze the given log file location with anonip.") + (start #~(lambda _ + (let ((optional + (lambda (accessor option) + (or (and=> (accessor config) + (lambda (value) + (list + (format #false "~a=~a" + option (accessor config))))) + (list))))) + (unless (file-exists? input) + (mknod input 'fifo #o600 0)) + (let ((pid (fork+exec-command + (append + (list #$(file-append (anonip-configuration-anonip config) + "/bin/anonip") + (string-append "--input=" input) + (string-append "--output=" output)) + (if (anonip-configuration-skip-private? config) + '("--skip-private") (list)) + (optional anonip-configuration-column "--column") + (optional anonip-configuration-ipv4mask "--ipv4mask") + (optional anonip-configuration-ipv6mask "--ipv6mask") + (optional anonip-configuration-increment "--increment") + (optional anonip-configuration-replacement "--replacement") + (optional anonip-configuration-delimiter "--delimiter") + (optional anonip-configuration-regex "--regex")) + ;; Run in a UTF-8 locale + #:environment-variables + (list (string-append "GUIX_LOCPATH=" #$glibc-utf8-locales + "/lib/locale") + "LC_ALL=en_US.utf8")))) + pid)))) + (stop #~(make-kill-destructor)))))) + +(define anonip-service-type + (service-type + (name 'anonip) + (extensions + (list (service-extension shepherd-root-service-type + anonip-shepherd-service) + (service-extension activation-service-type + anonip-activation))) + (description + "Provide web server log anonymization with @command{anonip}."))) + ;;; ;;; Varnish