From patchwork Mon May 15 16:13:02 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Maxim Cournoyer X-Patchwork-Id: 50022 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 6FA3327BBE9; Mon, 15 May 2023 17:14:40 +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=-3.7 required=5.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,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 B5FC927BBE2 for ; Mon, 15 May 2023 17:14:36 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pyaq3-0007Wv-16; Mon, 15 May 2023 12:14:19 -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 1pyapy-0007QI-K5 for guix-patches@gnu.org; Mon, 15 May 2023 12:14:15 -0400 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 1pyapm-0003i4-Pk for guix-patches@gnu.org; Mon, 15 May 2023 12:14:12 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pyapm-0004QG-AA for guix-patches@gnu.org; Mon, 15 May 2023 12:14:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#63402] [PATCH v2] services: wireguard: Implement a dynamic IP monitoring feature. References: In-Reply-To: Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 15 May 2023 16:14:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 63402 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 63402@debbugs.gnu.org Cc: Maxim Cournoyer Received: via spool by 63402-submit@debbugs.gnu.org id=B63402.168416720416938 (code B ref 63402); Mon, 15 May 2023 16:14:02 +0000 Received: (at 63402) by debbugs.gnu.org; 15 May 2023 16:13:24 +0000 Received: from localhost ([127.0.0.1]:44192 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pyap9-0004P6-FT for submit@debbugs.gnu.org; Mon, 15 May 2023 12:13:24 -0400 Received: from mail-qt1-f177.google.com ([209.85.160.177]:53341) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pyap4-0004Op-6C for 63402@debbugs.gnu.org; Mon, 15 May 2023 12:13:21 -0400 Received: by mail-qt1-f177.google.com with SMTP id d75a77b69052e-3f5279cc284so6987831cf.2 for <63402@debbugs.gnu.org>; Mon, 15 May 2023 09:13:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1684167192; x=1686759192; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=YN+cM8K/UhOmbNRyiwFL2AzOlKefFB1abWWR05flHM4=; b=o6PEXwnFABvEp9iMZsyQEC1kfMS4CUWY44LUiwr558vH/oyamXaxtz62Hmw2NV9nQf hceDrIqXBtC65plO+B5HrdEJRO+R/sxRh9dSPPP7kMIqR2Dw4T/VemiU3zpthDNLufOa nQXDBhKc32zML8QovwsF4eKEC2oEWvKPTG0oP9qEDKWUGWCjF78nSw30Pvrw9YICzOF7 ATXuTnxYDxlJKJeALlGH2K5Auhf2rMNABT7pyz7retqDNP+yHoJpQj0WsTatKZhf5UtM +tVr6OyJVcviw8OfXDyW7VhFIx3vMNghvwBysAEtExtHf1SD+GSUc2u95rnSKMhfRyYQ JfVg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684167192; x=1686759192; 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=YN+cM8K/UhOmbNRyiwFL2AzOlKefFB1abWWR05flHM4=; b=j9MeVciFQyuwa9vMjJqhEz5UhlfvviqEZro1DR1FIJKHMlGeZbk2FFGnUTagRQyT+8 4mmodXhHwEaUX3WEIsV2lYAmaeeDSayxAITSPXEcHJExvspFBXMtp+0nxgMkIAGiwFsZ EGbrep2oIeP0rHA4hyci1sOInx94EarbLyPCY6BSOAfkTqjrM2eVw8PLbEopV3DVL08A XL83D5pZTUOAGGHqOHYavDrSbT8w1cqkrotIAaiwZlZed+/F+BhUy0vThoyn//T6ZLBv eVZuZ/2Z95kjVcgBg/EAnHNxLg2YQ6GbMuWVoY00isqm3gsDPaY7p1C3eZYlpBSiHMo0 qPNg== X-Gm-Message-State: AC+VfDzDGUfw1PaMU+S5OjUuuRGbcVPAIPwEQXTGUeMmBrfz0HvQ7UQ+ 7fntuxeMcWpoq4MYfZ15Phfwy+V86S+0BELB X-Google-Smtp-Source: ACHHUZ6BSJEOp4wl+BT0uO5Fk/ucL74Mw5UyABkrfGEKQJTPZqtz7o1/uiwdSOwpNc2Z2mcmBxE5vw== X-Received: by 2002:a05:622a:1008:b0:3f1:fd6b:2a00 with SMTP id d8-20020a05622a100800b003f1fd6b2a00mr54190804qte.24.1684167192122; Mon, 15 May 2023 09:13:12 -0700 (PDT) Received: from localhost.localdomain (dsl-205-236-230-106.b2b2c.ca. [205.236.230.106]) by smtp.gmail.com with ESMTPSA id a17-20020ac86111000000b003e4c6b2cc35sm5451292qtm.24.2023.05.15.09.13.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 May 2023 09:13:11 -0700 (PDT) From: Maxim Cournoyer Date: Mon, 15 May 2023 12:13:02 -0400 Message-Id: X-Mailer: git-send-email 2.39.2 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 * gnu/services/vpn.scm () [monitor-ips?, monitor-ips-internal]: New fields. * gnu/services/vpn.scm (define-with-source): New syntax. (wireguard-service-name, strip-port/maybe) (ipv4-address?, ipv6-address?, host-name?) (peers->endpoint-host-names) (wireguard-monitoring-jobs): New procedures. (wireguard-service-type): Register it. * tests/services/vpn.scm: New file. * Makefile.am (SCM_TESTS): Register it. * doc/guix.texi (VPN Services): Update doc. --- Makefile.am | 1 + doc/guix.texi | 18 +++++- gnu/services/vpn.scm | 123 +++++++++++++++++++++++++++++++++++++++-- tests/services/vpn.scm | 80 +++++++++++++++++++++++++++ 4 files changed, 216 insertions(+), 6 deletions(-) create mode 100644 tests/services/vpn.scm base-commit: 7b00b155d8f474d493a22ff7cccbeec311b9bbc8 diff --git a/Makefile.am b/Makefile.am index 13718e4353..fb6e4f57cd 100644 --- a/Makefile.am +++ b/Makefile.am @@ -553,6 +553,7 @@ SCM_TESTS = \ tests/services/lightdm.scm \ tests/services/linux.scm \ tests/services/telephony.scm \ + tests/services/vpn.scm \ tests/sets.scm \ tests/size.scm \ tests/status.scm \ diff --git a/doc/guix.texi b/doc/guix.texi index 60972f408d..4499a911d6 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -32591,9 +32591,23 @@ VPN Services @item @code{dns} (default: @code{#f}) The DNS server(s) to announce to VPN clients via DHCP. +@item @code{monitor-ips?} (default: @code{#f}) +@cindex Dynamic IP, with Wireguard +@cindex dyndns, usage with Wireguard +Whether to monitor the resolved Internet addresses (IPs) of the +endpoints of the configured peers, restarting the service when there is +a mismatch between the endpoint IPs in actual use versus those freshly +resolved from their host names. Set this to @code{#t} if one or more +endpoints use host names provided by a dynamic DNS service to keep +connections working. + +@item @code{monitor-ips-internal} (default: @code{'(next-minute (range 0 60 5))}) +The time interval at which the IP monitoring job should run, provided as +an mcron time specification (@pxref{Guile Syntax,,,mcron}). + @item @code{private-key} (default: @code{"/etc/wireguard/private.key"}) -The private key file for the interface. It is automatically generated if -the file does not exist. +The private key file for the interface. It is automatically generated +if the file does not exist. @item @code{peers} (default: @code{'()}) The authorized peers on this interface. This is a list of diff --git a/gnu/services/vpn.scm b/gnu/services/vpn.scm index a884d71eb2..e21f999bc0 100644 --- a/gnu/services/vpn.scm +++ b/gnu/services/vpn.scm @@ -11,6 +11,7 @@ ;;; Copyright © 2021 Nathan Dehnel ;;; Copyright © 2022 Cameron V Chaparro ;;; Copyright © 2022 Timo Wilken +;;; Copyright © 2023 Maxim Cournoyer ;;; ;;; This file is part of GNU Guix. ;;; @@ -31,10 +32,12 @@ (define-module (gnu services vpn) #:use-module (gnu services) #:use-module (gnu services configuration) #:use-module (gnu services dbus) + #:use-module (gnu services mcron) #:use-module (gnu services shepherd) #:use-module (gnu system shadow) #:use-module (gnu packages admin) #:use-module (gnu packages vpn) + #:use-module (guix modules) #:use-module (guix packages) #:use-module (guix records) #:use-module (guix gexp) @@ -73,6 +76,8 @@ (define-module (gnu services vpn) wireguard-configuration-addresses wireguard-configuration-port wireguard-configuration-dns + wireguard-configuration-monitor-ips? + wireguard-configuration-monitor-ips-interval wireguard-configuration-private-key wireguard-configuration-peers wireguard-configuration-pre-up @@ -741,6 +746,10 @@ (define-record-type* (default '())) (dns wireguard-configuration-dns ;list of strings (default #f)) + (monitor-ips? wireguard-configuration-monitor-ips? ;boolean + (default #f)) + (monitor-ips-interval wireguard-configuration-monitor-ips-interval + (default '(next-minute (range 0 60 5)))) ;string | list (pre-up wireguard-configuration-pre-up ;list of strings (default '())) (post-up wireguard-configuration-post-up ;list of strings @@ -871,6 +880,49 @@ (define (wireguard-activation config) (chmod #$private-key #o400) (close-pipe pipe)))))) +;;; XXX: Copied from (guix scripts pack), changing define to define*. +(define-syntax-rule (define-with-source (variable args ...) body body* ...) + "Bind VARIABLE to a procedure accepting ARGS defined as BODY, also setting +its source property." + (begin + (define* (variable args ...) + body body* ...) + (eval-when (load eval) + (set-procedure-property! variable 'source + '(define* (variable args ...) body body* ...))))) + +(define (wireguard-service-name interface) + "Return the WireGuard service name (a symbol) configured to use INTERFACE." + (symbol-append 'wireguard- (string->symbol interface))) + +(define-with-source (strip-port/maybe endpoint #:key ipv6?) + "Strip the colon and port, if present in ENDPOINT, a string." + (if ipv6? + (if (string-prefix? "[" endpoint) + (first (string-split (string-drop endpoint 1) #\])) ;ipv6 + endpoint) + (first (string-split endpoint #\:)))) ;ipv4 + +(define (ipv4-address? str) + "Return true if STR denotes an IPv4 address." + (false-if-exception + (->bool (inet-pton AF_INET (strip-port/maybe str))))) + +(define (ipv6-address? str) + "Return true if STR denotes an IPv6 address." + (false-if-exception + (->bool (inet-pton AF_INET6 (strip-port/maybe str #:ipv6? #t))))) + +(define (host-name? name) + "Predicate to check whether NAME is a host name, i.e. not an IP address." + (not (or (ipv6-address? name) (ipv4-address? name)))) + +(define (peers->endpoint-host-names peers) + "Return host names used as the endpoints of PEERS, if any. Any \":PORT\" +suffixes are stripped." + (map strip-port/maybe + (filter host-name? (filter-map wireguard-peer-endpoint peers)))) + (define (wireguard-shepherd-service config) (match-record config (wireguard interface) @@ -878,9 +930,7 @@ (define (wireguard-shepherd-service config) (config (wireguard-configuration-file config))) (list (shepherd-service (requirement '(networking)) - (provision (list - (symbol-append 'wireguard- - (string->symbol interface)))) + (provision (list (wireguard-service-name interface))) (start #~(lambda _ (invoke #$wg-quick "up" #$config))) (stop #~(lambda _ @@ -888,6 +938,69 @@ (define (wireguard-shepherd-service config) #f)) ;stopped! (documentation "Run the Wireguard VPN tunnel")))))) +(define (wireguard-monitoring-jobs config) + (match-record config + (interface monitor-ips? monitor-ips-interval peers) + (let ((host-names (peers->endpoint-host-names peers))) + (if monitor-ips? + (if (null? host-names) + (begin + (warn "monitor-ips? is #t but no host name to monitor") + '()) + ;; The mcron monitor job may be a string or a list; ungexp strips + ;; one quote level, which must be added back when a list is + ;; provided. + (list + #~(job + (if (string? #$monitor-ips-interval) + #$monitor-ips-interval + '#$monitor-ips-interval) + #$(program-file + (format #f "wireguard-~a-monitoring" interface) + (with-imported-modules (source-module-closure + '((gnu services herd))) + #~(begin + (use-modules (gnu services herd) + (ice-9 popen) + (ice-9 textual-ports) + (srfi srfi-1) + (srfi srfi-26)) + + (define (host-name->ip name) + "Return the IP address resolved from NAME." + (let* ((ai (car (getaddrinfo name))) + (sa (addrinfo:addr ai))) + (inet-ntop (sockaddr:fam sa) + (sockaddr:addr sa)))) + + #$(procedure-source strip-port/maybe) + + (define service-name '#$(wireguard-service-name + interface)) + + (when (start-service service-name) + (let* ((resolved-ips (map host-name->ip + '#$host-names)) + (pipe (open-pipe* + OPEN_READ + #$(file-append wireguard-tools + "/bin/wg") + "show" #$interface "endpoints")) + (lines (string-split (get-string-all pipe) + #\newline)) + (used-ips (map (compose + strip-port/maybe + last + (cut string-split <> #\tab)) + lines))) + (close-pipe pipe) + (unless (every (cut member <> used-ips) + resolved-ips) + (format #t "restarting ~a service due to \ +stale endpoint IPs~%" service-name) + (restart-service service-name)))))))))) + '())))) ;monitor-ips? is #f + (define wireguard-service-type (service-type (name 'wireguard) @@ -898,6 +1011,8 @@ (define wireguard-service-type wireguard-activation) (service-extension profile-service-type (compose list - wireguard-configuration-wireguard)))) + wireguard-configuration-wireguard)) + (service-extension mcron-service-type + wireguard-monitoring-jobs))) (description "Set up Wireguard @acronym{VPN, Virtual Private Network} tunnels."))) diff --git a/tests/services/vpn.scm b/tests/services/vpn.scm new file mode 100644 index 0000000000..9c6fa65df6 --- /dev/null +++ b/tests/services/vpn.scm @@ -0,0 +1,80 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2023 Maxim Cournoyer +;;; +;;; This file is part of GNU Guix. +;;; +;;; GNU Guix is free software; you can redistribute it and/or modify it +;;; under the terms of the GNU General Public License as published by +;;; the Free Software Foundation; either version 3 of the License, or (at +;;; your option) any later version. +;;; +;;; GNU Guix is distributed in the hope that it will be useful, but +;;; WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;; GNU General Public License for more details. +;;; +;;; You should have received a copy of the GNU General Public License +;;; along with GNU Guix. If not, see . + +(define-module (tests services vpn) + #:use-module (gnu packages vpn) + #:use-module (gnu services vpn) + #:use-module (guix gexp) + #:use-module (ice-9 match) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-64)) + +;;; Commentary: +;;; +;;; Unit tests for the (gnu services vpn) module. +;;; +;;; Code: + +;;; Access some internals for whitebox testing. +(define ipv4-address? (@@ (gnu services vpn) ipv4-address?)) +(define ipv6-address? (@@ (gnu services vpn) ipv6-address?)) +(define host-name? (@@ (gnu services vpn) host-name?)) +(define peers->endpoint-host-names + (@@ (gnu services vpn) peers->endpoint-host-names)) + +(test-begin "vpn-services") + +(test-assert "ipv4-address?" + (every ipv4-address? + (list "192.95.5.67:1234" + "10.0.0.1"))) + +(test-assert "ipv6-address?" + (every ipv6-address? + (list "[2607:5300:60:6b0::c05f:543]:2468" + "2607:5300:60:6b0::c05f:543" + "2345:0425:2CA1:0000:0000:0567:5673:23b5" + "2345:0425:2CA1::0567:5673:23b5"))) + +(define %wireguard-peers + (list (wireguard-peer + (name "dummy1") + (public-key "VlesLiEB5BFd//OD2ILKXviolfz+hodG6uZ+XjoalC8=") + (endpoint "some.dynamic-dns.service:53281") + (allowed-ips '())) + (wireguard-peer + (name "dummy2") + (public-key "AlesLiEB5BFd//OD2ILKXviolfz+hodG6uZ+XgoalC9=") + (endpoint "example.org") + (allowed-ips '())) + (wireguard-peer + (name "dummy3") + (public-key "BlesLiEB5BFd//OD2ILKXviolfz+hodG6uZ+XgoalC7=") + (endpoint "10.0.0.7:7777") + (allowed-ips '())) + (wireguard-peer + (name "dummy4") + (public-key "ClesLiEB5BFd//OD2ILKXviolfz+hodG6uZ+XgoalC6=") + (endpoint "[2345:0425:2CA1::0567:5673:23b5]:44444") + (allowed-ips '())))) + +(test-equal "peers->endpoint-host-names" + '("some.dynamic-dns.service" "example.org") + (peers->endpoint-host-names %wireguard-peers)) + +(test-end "vpn-services")