From patchwork Fri May 31 05:43:11 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Nigko Yerden X-Patchwork-Id: 65011 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 7B39D27BBE2; Fri, 31 May 2024 06:46:15 +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_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM,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 CD48C27BBE9 for ; Fri, 31 May 2024 06:46:13 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sCv5T-00007u-3E; Fri, 31 May 2024 01:45:59 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sCv5P-000063-L1 for guix-patches@gnu.org; Fri, 31 May 2024 01:45:55 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sCv5N-0001XD-ST; Fri, 31 May 2024 01:45:54 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sCv5V-0006Xe-Q8; Fri, 31 May 2024 01:46:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#70341] [PATCH v5] services: tor: Add support for pluggable transports. References: <11e72216f4be8b6559ecc04646fd722daa5dd09d.1712846897.git.nigko.yerden@gmail.com> In-Reply-To: <11e72216f4be8b6559ecc04646fd722daa5dd09d.1712846897.git.nigko.yerden@gmail.com> Resent-From: Nigko Yerden Original-Sender: "Debbugs-submit" Resent-CC: pelzflorian@pelzflorian.de, ludo@gnu.org, matt@excalamus.com, maxim.cournoyer@gmail.com, guix-patches@gnu.org Resent-Date: Fri, 31 May 2024 05:46:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 70341 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 70341@debbugs.gnu.org Cc: Nigko Yerden , Florian Pelz , Ludovic =?utf-8?q?Court=C3=A8s?= , Matthew Trzcinski , Maxim Cournoyer X-Debbugs-Original-Xcc: Florian Pelz , Ludovic =?utf-8?q?Court=C3=A8s?= , Matthew Trzcinski , Maxim Cournoyer Received: via spool by 70341-submit@debbugs.gnu.org id=B70341.171713434525122 (code B ref 70341); Fri, 31 May 2024 05:46:01 +0000 Received: (at 70341) by debbugs.gnu.org; 31 May 2024 05:45:45 +0000 Received: from localhost ([127.0.0.1]:52981 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sCv5E-0006X7-EX for submit@debbugs.gnu.org; Fri, 31 May 2024 01:45:45 -0400 Received: from mail-lf1-f66.google.com ([209.85.167.66]:57779) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sCv5B-0006Wt-CT for 70341@debbugs.gnu.org; Fri, 31 May 2024 01:45:42 -0400 Received: by mail-lf1-f66.google.com with SMTP id 2adb3069b0e04-52b88740a93so357044e87.3 for <70341@debbugs.gnu.org>; Thu, 30 May 2024 22:45:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1717134264; x=1717739064; darn=debbugs.gnu.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=eSGjI6QfbrlqDo5oNwsE6SBP0X2CNPaqk9WA0p46S+8=; b=Ivm/rKhYo6OuPCuQeqUiC9UxBdhpAjsYgsp5T2YSG4Th6vy10YzdPD6qyCgg03q/Do DjFc55OcEdluFGbTpA2B4u1NdJyxZLt9FGdHYH6e3YmtRdGzKNhd7Do9ni2HOaQumYyZ O1TnbkUwIX3q4nI3TAkF0OuRwid9nTOSobrFvR48YpAPGLI7KEibxjz78ya1NFOgrYY7 5vh5RRRNPvBvhe27UeOVH8ZbKLdWuk5RMVwGXIiXOKqP7aM2h7UDxpptbvfm+8rcK2t+ 8syQcg66jtdzruUgEv4/6Mmweb81A7yUMAYdwLrRtKU5XrqteVqSNya13LiKPzS2FCZo Z+mA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1717134264; x=1717739064; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=eSGjI6QfbrlqDo5oNwsE6SBP0X2CNPaqk9WA0p46S+8=; b=xMvdDeW8GWutOSRrrTQr+FrIZjyfUhDGFZ/sRArCOCOs9s1hKVEyGGxY6TubvcGxDZ YhBsgQkUMxDpp4vZolYc2Mw+ib11K+LgQ75r9TpjwWEVO1OFVaw4VgIC5M0cIQwsUNl+ JXcNscsDTbxu6Ee0tctkMcjDTCBGgvID1N6hMmgbHmD81EmOKej2+gUaylYgGTyp4065 wYIH7tOdV5KFU9EWrpW3Gi5txgGWe6Xomxth5VKyW4x5QEpZMlo39FRdRsL/k3FvWCxM +yXF/f0uGqy75W5gm2Jj58Pz7PoVXwnDatxdGiH+fCiXk4bOcKxNBWFKhzou1fAI6zGS 0t9g== X-Gm-Message-State: AOJu0YxVMNfN3jTF8w2siSjtuEe/33OTV1xPR1aTFuhNoXVKrxxmQ2Ef vgwtDaBeFE7e3vZ4rqML7n/hQzmWow0b2OLH4w68N3kySkM51+lov+uPDwrm X-Google-Smtp-Source: AGHT+IF6P98hgonDB8T3KJ0RiuwYgJhGtGtuiBCMRxDFbaSmFJunKKNRf42gbX6fWvMNpYiszIIAAg== X-Received: by 2002:ac2:4316:0:b0:520:c2c1:153a with SMTP id 2adb3069b0e04-52b896d2716mr570849e87.58.1717134263450; Thu, 30 May 2024 22:44:23 -0700 (PDT) Received: from localhost.localdomain ([188.68.134.234]) by smtp.gmail.com with ESMTPSA id 2adb3069b0e04-52b84d892bdsm208848e87.250.2024.05.30.22.44.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 30 May 2024 22:44:22 -0700 (PDT) From: Nigko Yerden Date: Fri, 31 May 2024 10:43:11 +0500 Message-ID: <1c519115fbb093a4a581e9b8a7efa591bebd72b4.1717134191.git.nigko.yerden@gmail.com> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 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-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches Pluggable transports are programs that disguise Tor traffic, which can be useful in case Tor is censored. Pluggable transports cannot be configured by #:config-file file exclusively because Tor process is run via 'least-authority-wrapper' and cannot have access to transport plugin, which is a separate executable (Bug#70302, Bug#70332). Example configuration snippet to be appended to operation-system services (see https://bridges.torproject.org/ to get full bridge's lines): (service tor-service-type (tor-configuration (config-file (plain-file "torrc" "\ UseBridges 1 Bridge obfs4 ... Bridge obfs4 ...")) (transport-plugins (list (tor-transport-plugin (path-to-binary (file-append go-gitlab-torproject-org-tpo-anti-censorship-pluggable-transports-lyrebird "/bin/lyrebird"))))))) * doc/guix.texi (Networking Services): Document 'tor-transport-plugin' data type and 'transport-plugins' option for 'tor-configuration. * gnu/services/networking.scm: Export 'tor-configuration-transport-plugins', 'tor-transport-plugin', 'tor-transport-plugin?', 'tor-transport-plugin-role', 'tor-transport-plugin-protocol', and 'tor-transport-plugin-path'. (): Add 'transport-plugins' field. (): New variable. (tor-configuration->torrc): Add content to 'torrc' computed-file. (tor-shepherd-service): Add file-system-mapping(s). Change-Id: I1b0319358778c7aee650bc843e021a6803a1cf3a --- doc/guix.texi | 48 +++++++++++++++++++++++ gnu/services/networking.scm | 76 +++++++++++++++++++++++++++++-------- 2 files changed, 108 insertions(+), 16 deletions(-) base-commit: 8144c587f89641d5976d5b3832297d391d489fbd diff --git a/doc/guix.texi b/doc/guix.texi index 1224104038..b997e6d4d7 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -128,6 +128,7 @@ Copyright @copyright{} 2024 Matthew Trzcinski@* Copyright @copyright{} 2024 Richard Sent@* Copyright @copyright{} 2024 Dariqq@* +Copyright @copyright{} 2024 Nigko Yerden@* Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -21960,6 +21961,13 @@ Networking Services @file{/var/run/tor/control-sock}, which will be made writable by members of the @code{tor} group. +@item @code{transport-plugins} (default: @code{'()}) +The list of @code{} records to use. +For any transport plugin you include in this list, appropriate +configuration line to enable transport plugin will be automatically +added to the default configuration file. + + @end table @end deftp @@ -21988,6 +21996,46 @@ Networking Services @end table @end deftp +@cindex pluggable transports, tor +@deftp {Data Type} tor-transport-plugin +Data type representing a Tor pluggable transport plugin in +@code{tor-configuration}. Plugguble transports are programs +that disguise Tor traffic, which can be useful in case Tor is +censored. See the the Tor project's +@url{https://tb-manual.torproject.org/circumvention/, +documentation} and +@url{https://spec.torproject.org/pt-spec/index.html, +specification} for more information. + +Each transport plugin corresponds either to +``ClientTransportPlugin ...'' or to +``ServerTransportPlugin ...'' line in the default +configuration file, see the @code{man tor}. +Available @code{tor-transport-plugin} fields are: + +@table @asis +@item @code{role} (default: @code{'client}) +This must be either @code{'client} or @code{'server}. Otherwise, +an error is raised. Set the @code{'server} value if you want to +run a bridge to help censored users connect to the Tor network, see +@url{https://community.torproject.org/relay/setup/bridge/, +the Tor project's brige guide}. Set the @code{'client} value +if you want to connect to somebody else's bridge, see +@url{https://bridges.torproject.org/, the Tor project's +``Get Bridges'' page}. In both cases the required +additional configuration should be provided via +@code{#:config-file} option of @code{tor-configuration}. +@item @code{protocol} (default: @code{"obfs4"}) +A string that specifies a pluggable transport protocol. +@item @code{path-to-binary} +This must be a ``file-like'' object or a string +pointing to the pluggable transport plugin executable. +This option allows the Tor daemon run inside the container +to access the executable and all the references +(e.g. package dependencies) attached to it. +@end table +@end deftp + The @code{(gnu services rsync)} module provides the following services: You might want an rsync daemon if you have files that you want available diff --git a/gnu/services/networking.scm b/gnu/services/networking.scm index 8e64e529ab..cb1749ffe6 100644 --- a/gnu/services/networking.scm +++ b/gnu/services/networking.scm @@ -22,6 +22,7 @@ ;;; Copyright © 2023 Declan Tsien ;;; Copyright © 2023 Bruno Victal ;;; Copyright © 2023 muradm +;;; Copyright © 2024 Nigko Yerden ;;; ;;; This file is part of GNU Guix. ;;; @@ -159,10 +160,16 @@ (define-module (gnu services networking) tor-configuration-hidden-services tor-configuration-socks-socket-type tor-configuration-control-socket-path + tor-configuration-transport-plugins tor-onion-service-configuration tor-onion-service-configuration? tor-onion-service-configuration-name tor-onion-service-configuration-mapping + tor-transport-plugin + tor-transport-plugin? + tor-transport-plugin-role + tor-transport-plugin-protocol + tor-transport-plugin-path tor-hidden-service ; deprecated tor-service-type @@ -955,7 +962,9 @@ (define-record-type* (socks-socket-type tor-configuration-socks-socket-type ; 'tcp or 'unix (default 'tcp)) (control-socket? tor-configuration-control-socket-path - (default #f))) + (default #f)) + (transport-plugins tor-configuration-transport-plugins + (default '()))) (define %tor-accounts ;; User account and groups for Tor. @@ -985,10 +994,24 @@ (define-configuration/no-serialization tor-onion-service-configuration @end lisp maps ports 22 and 80 of the Onion Service to the local ports 22 and 8080.")) +(define-record-type* + tor-transport-plugin make-tor-transport-plugin + tor-transport-plugin? + (role tor-transport-plugin-role + (default 'client) + (sanitize (lambda (value) + (if (memq value '(client server)) + value + (configuration-field-error #f 'role value))))) + (protocol tor-transport-plugin-protocol + (default "obfs4")) + (path-to-binary tor-transport-plugin-path)) + (define (tor-configuration->torrc config) "Return a 'torrc' file for CONFIG." (match-record config - (tor config-file hidden-services socks-socket-type control-socket?) + (tor config-file hidden-services socks-socket-type control-socket? + transport-plugins) (computed-file "torrc" (with-imported-modules '((guix build utils)) @@ -1027,6 +1050,20 @@ (define (tor-configuration->torrc config) (cons name mapping))) hidden-services)) + (for-each (match-lambda + ((role-string protocol path) + (format port "\ +~aTransportPlugin ~a exec ~a~%" + role-string protocol path))) + '#$(map (match-lambda + (($ role protocol path) + (list (if (eq? role 'client) + "Client" + "Server") + protocol + path))) + transport-plugins)) + (display "\ ### End of automatically generated lines.\n\n" port) @@ -1039,23 +1076,30 @@ (define (tor-configuration->torrc config) (define (tor-shepherd-service config) "Return a running Tor." (let* ((torrc (tor-configuration->torrc config)) + (transport-plugins (tor-configuration-transport-plugins config)) (tor (least-authority-wrapper (file-append (tor-configuration-tor config) "/bin/tor") #:name "tor" - #:mappings (list (file-system-mapping - (source "/var/lib/tor") - (target source) - (writable? #t)) - (file-system-mapping - (source "/dev/log") ;for syslog - (target source)) - (file-system-mapping - (source "/var/run/tor") - (target source) - (writable? #t)) - (file-system-mapping - (source torrc) - (target source))) + #:mappings (append + (list (file-system-mapping + (source "/var/lib/tor") + (target source) + (writable? #t)) + (file-system-mapping + (source "/dev/log") ;for syslog + (target source)) + (file-system-mapping + (source "/var/run/tor") + (target source) + (writable? #t)) + (file-system-mapping + (source torrc) + (target source))) + (map (lambda (plugin) + (file-system-mapping + (source (tor-transport-plugin-path plugin)) + (target source))) + transport-plugins)) #:namespaces (delq 'net %namespaces)))) (list (shepherd-service (provision '(tor))