From patchwork Mon Mar 6 17:24:54 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruno Victal X-Patchwork-Id: 47743 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 6BF8816D75; Mon, 6 Mar 2023 17:26:38 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham 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 D67BF16D53 for ; Mon, 6 Mar 2023 17:26:36 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pZEbD-0003Sm-Rv; Mon, 06 Mar 2023 12:26:11 -0500 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 1pZEb5-0003RF-2H for guix-patches@gnu.org; Mon, 06 Mar 2023 12:26:04 -0500 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pZEb4-0000lR-PO; Mon, 06 Mar 2023 12:26:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pZEb4-0006jz-Kt; Mon, 06 Mar 2023 12:26:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#62005] [PATCH] services: tor: Deprecate 'tor-hidden-service' procedure. Resent-From: Bruno Victal Original-Sender: "Debbugs-submit" Resent-CC: ludo@gnu.org, guix-patches@gnu.org Resent-Date: Mon, 06 Mar 2023 17:26:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 62005 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 62005@debbugs.gnu.org Cc: Bruno Victal , ludo@gnu.org X-Debbugs-Original-To: guix-patches@gnu.org X-Debbugs-Original-Xcc: ludo@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.167812351125829 (code B ref -1); Mon, 06 Mar 2023 17:26:02 +0000 Received: (at submit) by debbugs.gnu.org; 6 Mar 2023 17:25:11 +0000 Received: from localhost ([127.0.0.1]:43545 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pZEaF-0006iW-5v for submit@debbugs.gnu.org; Mon, 06 Mar 2023 12:25:11 -0500 Received: from lists.gnu.org ([209.51.188.17]:54732) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pZEaD-0006iP-El for submit@debbugs.gnu.org; Mon, 06 Mar 2023 12:25:10 -0500 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 1pZEaD-0002jO-88 for guix-patches@gnu.org; Mon, 06 Mar 2023 12:25:09 -0500 Received: from smtpm1.myservices.hosting ([185.26.105.232]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pZEaA-0000Pf-U0 for guix-patches@gnu.org; Mon, 06 Mar 2023 12:25:08 -0500 Received: from mail1.netim.hosting (unknown [185.26.106.173]) by smtpm1.myservices.hosting (Postfix) with ESMTP id CE30420495 for ; Mon, 6 Mar 2023 18:25:00 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by mail1.netim.hosting (Postfix) with ESMTP id 88AE380097; Mon, 6 Mar 2023 18:25:00 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at mail1.netim.hosting Received: from mail1.netim.hosting ([127.0.0.1]) by localhost (mail1-2.netim.hosting [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id p9RDlMPA35PQ; Mon, 6 Mar 2023 18:25:00 +0100 (CET) Received: from guix-nuc.home.arpa (bl9-119-177.dsl.telepac.pt [85.242.119.177]) (Authenticated sender: lumen@makinata.eu) by mail1.netim.hosting (Postfix) with ESMTPSA id C7ABF8009C; Mon, 6 Mar 2023 18:24:59 +0100 (CET) From: Bruno Victal Date: Mon, 6 Mar 2023 17:24:54 +0000 Message-Id: <6254896f46b35816c7784569724d82248e4b7acf.1678123306.git.mirai@makinata.eu> X-Mailer: git-send-email 2.39.1 MIME-Version: 1.0 Received-SPF: pass client-ip=185.26.105.232; envelope-from=mirai@makinata.eu; helo=smtpm1.myservices.hosting X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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 Due to (now renamed) 'hidden-service' record type not being exported, the only way hidden services could have worked is through the now deprecated 'tor-hidden-service' procedure which also had the issue that it can only be used once since the returned service always had the same name. This commit fixes the Tor service documentation and deprecates 'tor-hidden-service' procedure, correcting some inconsistencies along the way. * doc/guix.texi (Networking Services): Add examples for Tor hidden services. Document . Remove mention of 'tor-hidden-service' procedure. * gnu/services/networking.scm: Export tor-configuration-tor, tor-configuration-config-file, tor-configuration-hidden-services, tor-configuration-socks-socket-type, tor-configuration-control-socket-path, tor-hidden-service-configuration, tor-hidden-service-configuration?, tor-hidden-service-configuration-name, tor-hidden-service-configuration-mapping. ()[control-socket?]: Rename accessor. (): Rename to ... (): ... this. (tor-configuration->torrc): Update record-type name. (tor-activation): Ditto. (tor-service-type): Tweak comment. (tor-hidden-service-type): Remove variable. (tor-hidden-service): Deprecate procedure. --- Split from #61789. To be decided: whether hidden-services should be renamed to onion-services. doc/guix.texi | 55 +++++++++++++++++++++++-------------- gnu/services/networking.scm | 47 +++++++++++++++++-------------- 2 files changed, 61 insertions(+), 41 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 6671ba9305..51fe0a6119 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -20494,11 +20494,21 @@ Networking Services @cindex Tor @defvar tor-service-type -This is the type for a service that runs the @uref{https://torproject.org, -Tor} anonymous networking daemon. The service is configured using a +Type for a service that runs the @uref{https://torproject.org, Tor} +anonymous networking daemon. The service is configured using a @code{} record. By default, the Tor daemon runs as the @code{tor} unprivileged user, which is a member of the @code{tor} group. +In addition to adding Tor @dfn{hidden service}s records to the service +configuration directly, this service can be extended by other services to add +hidden services, as in this example: + +@lisp +(simple-service 'my-extra-hidden-service tor-service-type + (list (tor-hidden-service-configuration + (name "extra-hidden-service") + (mapping '((80 "127.0.0.1:8080")))))) +@end lisp @end defvar @deftp {Data Type} tor-configuration @@ -20517,11 +20527,10 @@ Networking Services syntax. @item @code{hidden-services} (default: @code{'()}) -The list of @code{} records to use. For any hidden service -you include in this list, appropriate configuration to enable the hidden -service will be automatically added to the default configuration file. You -may conveniently create @code{} records using the -@code{tor-hidden-service} procedure described below. +The list of @code{} records to use. +For any hidden service you include in this list, appropriate +configuration to enable the hidden service will be automatically added to +the default configuration file. @item @code{socks-socket-type} (default: @code{'tcp}) The default socket type that Tor should use for its SOCKS socket. This must @@ -20546,26 +20555,32 @@ Networking Services @end table @end deftp -@cindex hidden service -@deffn {Scheme Procedure} tor-hidden-service @var{name} @var{mapping} -Define a new Tor @dfn{hidden service} called @var{name} and implementing -@var{mapping}. @var{mapping} is a list of port/host tuples, such as: +@cindex hidden service, tor +@deftp {Data Type} tor-hidden-service-configuration +Data Type representing a Tor @dfn{hidden service} configuration. +See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor +project's documentation} for more information. + +@table @asis +@item @code{name} (type: string) +Name for the Tor @dfn{hidden service}. +This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, +where the @file{hostname} file contains the @samp{.onion} host name for +the hidden service. + +@item @code{mapping} (type: list-of-list) +List of host---@dfn{hidden-service} port mappings, such as: @example - '((22 "127.0.0.1:22") - (80 "127.0.0.1:8080")) +'((22 "127.0.0.1:22") + (80 "127.0.0.1:8080")) @end example In this example, port 22 of the hidden service is mapped to local port 22, and port 80 is mapped to local port 8080. -This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, where -the @file{hostname} file contains the @code{.onion} host name for the hidden -service. - -See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor -project's documentation} for more information. -@end deffn +@end table +@end deftp The @code{(gnu services rsync)} module provides the following services: diff --git a/gnu/services/networking.scm b/gnu/services/networking.scm index dacf64c2d1..d6e1877ef5 100644 --- a/gnu/services/networking.scm +++ b/gnu/services/networking.scm @@ -138,7 +138,16 @@ (define-module (gnu services networking) tor-configuration tor-configuration? - tor-hidden-service + tor-configuration-tor + tor-configuration-config-file + tor-configuration-hidden-services + tor-configuration-socks-socket-type + tor-configuration-control-socket-path + tor-hidden-service-configuration + tor-hidden-service-configuration? + tor-hidden-service-configuration-name + tor-hidden-service-configuration-mapping + tor-hidden-service ; deprecated tor-service-type network-manager-configuration @@ -919,7 +928,7 @@ (define-record-type* (default '())) (socks-socket-type tor-configuration-socks-socket-type ; 'tcp or 'unix (default 'tcp)) - (control-socket? tor-control-socket-path + (control-socket? tor-configuration-control-socket-path (default #f))) (define %tor-accounts @@ -933,11 +942,11 @@ (define %tor-accounts (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin"))))) -(define-record-type - (hidden-service name mapping) - hidden-service? - (name hidden-service-name) ;string - (mapping hidden-service-mapping)) ;list of port/address tuples +(define-record-type + (tor-hidden-service-configuration name mapping) + tor-hidden-service-configuration? + (name tor-hidden-service-configuration-name) ;string + (mapping tor-hidden-service-configuration-mapping)) ;list of port/address tuples (define (tor-configuration->torrc config) "Return a 'torrc' file for CONFIG." @@ -977,7 +986,7 @@ (define (tor-configuration->torrc config) tcp-port host)) ports hosts))) '#$(map (match-lambda - (($ name mapping) + (($ name mapping) (cons name mapping))) hidden-services)) @@ -1064,7 +1073,7 @@ (define (tor-activation config) (chmod "/var/lib" #o755) (for-each initialize - '#$(map hidden-service-name + '#$(map tor-hidden-service-configuration-name (tor-configuration-hidden-services config))))) (define tor-service-type @@ -1077,7 +1086,7 @@ (define tor-service-type (service-extension activation-service-type tor-activation))) - ;; This can be extended with hidden services. + ;; This can be extended with tor hidden services. (compose concatenate) (extend (lambda (config services) (tor-configuration @@ -1090,15 +1099,8 @@ (define tor-service-type "Run the @uref{https://torproject.org, Tor} anonymous networking daemon."))) -(define tor-hidden-service-type - ;; A type that extends Tor with hidden services. - (service-type (name 'tor-hidden-service) - (extensions - (list (service-extension tor-service-type list))) - (description - "Define a new Tor @dfn{hidden service}."))) - -(define (tor-hidden-service name mapping) +(define-deprecated (tor-hidden-service name mapping) + #f "Define a new Tor @dfn{hidden service} called @var{name} and implementing @var{mapping}. @var{mapping} is a list of port/host tuples, such as: @@ -1116,8 +1118,11 @@ (define (tor-hidden-service name mapping) See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor project's documentation} for more information." - (service tor-hidden-service-type - (hidden-service name mapping))) + (simple-service 'tor-hidden-service + tor-service-type + (list (tor-hidden-service-configuration + (name name) + (mapping mapping))))) ;;;