From debbugs-submit-bounces@debbugs.gnu.org Thu Jun 30 19:16:15 2022 Received: (at submit) by debbugs.gnu.org; 30 Jun 2022 23:16:15 +0000 Received: from localhost ([127.0.0.1]:35902 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1o73OM-000148-3H for submit@debbugs.gnu.org; Thu, 30 Jun 2022 19:16:15 -0400 Received: from lists.gnu.org ([209.51.188.17]:56210) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1o73OH-00013w-K4 for submit@debbugs.gnu.org; Thu, 30 Jun 2022 19:16:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49328) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o73OH-0005JK-EB for guix-patches@gnu.org; Thu, 30 Jun 2022 19:16:05 -0400 Received: from sender4-of-o51.zoho.com ([136.143.188.51]:21166) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o73OF-0002Uo-3J for guix-patches@gnu.org; Thu, 30 Jun 2022 19:16:05 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1656630959; cv=none; d=zohomail.com; s=zohoarc; b=YCVmBBIj0AKXVxHZBC7chiN470Se9EPy2NKc2hYV1nGH5ntX1/GNHOpUQRHV+A+vGI6Ffz6UwjvFQPa+BgVPcCNAksOB3u65KUhOPla//I4DiQBPhNYBwmsL8N6zQp6P0tQBmMmHj9n8Jjf7adcFqPDtVrP/Nnrcn9f9QR9Jcw4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1656630959; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:MIME-Version:Message-ID:Subject:To; bh=5i69xYd7vWnfsAKV2fcics6NtUo1Vl9CzSByb/KQHpU=; b=PQt/0fkuJ2sMSt4lh85dGxlTMj27R3sKeBtfYTvbNXYAtZ1Oi9p8RHYBLmsLJKb/rBsT59PxCGlOkFGzp81MjamGi8b+1O7BWNWtQ9odubomKSmi1GdVFifmHbRbWgtF/s8yN16pi5pcGFgiKrHHK5dWSKtVAZMi+A/jiWMno4c= 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=1656630959; 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=5i69xYd7vWnfsAKV2fcics6NtUo1Vl9CzSByb/KQHpU=; b=VVcTYR1WFqVTwcUC6GI/tE2pfDSTTiHeQwx2aDUDv/XffnzPmlM3t3dsYoQGNTdM thJznJ20ExqkdbOQUn5vTjxrQyfd5TUbGp+0JUlvMqF8GiSY97qgPSz9x4TsJX5MptB B+mlU5HDeewvCk/gRmh4bgqm+D0+ixxADcuz46Mw= Received: from localhost (72-109-142-46.pool.kielnet.net [46.142.109.72]) by mx.zohomail.com with SMTPS id 1656630956919398.26272021632406; Thu, 30 Jun 2022 16:15:56 -0700 (PDT) From: Ricardo Wurmus To: guix-patches@gnu.org Subject: [PATCH] services: Add anonip-service-type. Date: Fri, 1 Jul 2022 01:15:51 +0200 Message-Id: <20220630231551.16188-1-rekado@elephly.net> X-Mailer: git-send-email 2.36.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-ZohoMailClient: External Received-SPF: pass client-ip=136.143.188.51; envelope-from=rekado@elephly.net; helo=sender4-of-o51.zoho.com X-Spam_score_int: -16 X-Spam_score: -1.7 X-Spam_bar: - X-Spam_report: (-1.7 / 5.0 requ) BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.3 (-) X-Debbugs-Envelope-To: submit Cc: Ricardo Wurmus X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) * gnu/services/web.scm (anonip-configuration): New record type. (anonip-configuration?, anonip-configuration-anonip, anonip-configuration-log-file, anonip-configuration-fifo-directory, anonip-configuration-output-directory): New procedures. (anonip-service-type): New service type. * doc/guix.texi (Log Rotation): Add subheading for Anonip Service. --- doc/guix.texi | 58 +++++++++++++++++++++++++++++++++- gnu/services/web.scm | 74 +++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 130 insertions(+), 2 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index b8c49099a4..d23d3b1fbc 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,62 @@ 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 + (log-file "https.access.log"))) +@end lisp + +The directories to store the FIFO and the filtered log can be changed +with @code{fifo-directory} and @code{output-directory}, respectively. +In the following example the filtered log file would be written to +@file{/var/web-logs/https.access.log}. + +@lisp +(service anonip-service-type + (anonip-configuration + (log-file "https.access.log") + (output-directory "/var/web-logs/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{log-file} +The file name of the log file to process. This name is used in the FIFO +as well as in the filtered log file. This must not be an absolute file +name. + +@item @code{fifo-directory} (default: @code{"/var/run/anonip"}) +The directory where the FIFO file is created. + +@item @code{output-directory} (default: @code{"/var/log/anonip"}) +The directory to which the filtered log file will be written. + +@end table +@end deftp + + @node Networking Setup @subsection Networking Setup diff --git a/gnu/services/web.scm b/gnu/services/web.scm index 4f06d4e0bb..641a928e41 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 @@ -204,6 +204,14 @@ (define-module (gnu services web) tailon-service-type + anonip-configuration + anonip-configuration? + anonip-configuration-anonip + anonip-configuration-log-file + anonip-configuration-fifo-directory + anonip-configuration-output-directory + anonip-service-type + varnish-configuration varnish-configuration? varnish-configuration-package @@ -1343,6 +1351,70 @@ (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)) + (log-file anonip-configuration-log-file) ;string + (fifo-directory anonip-configuration-fifo-directory + (default "/var/run/anonip")) ;string + (output-directory anonip-configuration-output-directory + (default "/var/log/anonip"))) ;string + +(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 #$(anonip-configuration-output-directory config) + #$(anonip-configuration-fifo-directory config)))))) + +(define (anonip-shepherd-service config) + (let ((log-file (anonip-configuration-log-file config)) + (fifos (anonip-configuration-fifo-directory config)) + (outputs (anonip-configuration-output-directory config))) + (list (shepherd-service + (provision (list (symbol-append 'anonip- (string->symbol log-file)))) + (requirement '(user-processes)) + (documentation "Anonimyze the given log file location with anonip.") + (start #~(lambda _ + (let ((fifo #$(format #false "~a/~a" fifos log-file))) + (unless (file-exists? fifo) + (mknod fifo 'fifo #o600 0)) + (let ((pid (fork+exec-command + (list #$(file-append (anonip-configuration-anonip config) + "/bin/anonip") + (string-append "--input=" fifo) + (string-append "--output=" #$(format #false "~a/~a" outputs log-file))) + ;; 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 -- 2.36.1