From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:57342) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ddIrz-0007EF-Gu for guix-patches@gnu.org; Thu, 03 Aug 2017 12:21:09 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ddIru-000404-Ex for guix-patches@gnu.org; Thu, 03 Aug 2017 12:21:07 -0400 Received: from debbugs.gnu.org ([208.118.235.43]:37530) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ddIru-0003zm-8z for guix-patches@gnu.org; Thu, 03 Aug 2017 12:21:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ddIru-0003A0-3G for guix-patches@gnu.org; Thu, 03 Aug 2017 12:21:02 -0400 Subject: [bug#27855] [PATCH] gnu: Add rsync service. Resent-Message-ID: From: Oleg Pykhalov References: <20170727220151.2116-1-go.wigust@gmail.com> <20170728231747.5eae3af9@cbaines.net> <874ltvh5d6.fsf@gmail.com> <20170729125554.29836b28@cbaines.net> <87r2wszni8.fsf@gmail.com> <20170803163322.3e87b004@cbaines.net> Date: Thu, 03 Aug 2017 19:20:08 +0300 In-Reply-To: <20170803163322.3e87b004@cbaines.net> (Christopher Baines's message of "Thu, 3 Aug 2017 16:33:22 +0100") Message-ID: <87fud8zkqv.fsf@gmail.com> MIME-Version: 1.0 Content-Type: text/x-patch; charset=utf-8 Content-Disposition: inline; filename=0001-gnu-Add-rsync-service.patch Content-Transfer-Encoding: quoted-printable List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" To: Christopher Baines Cc: 27855@debbugs.gnu.org >From 1ca5dab9f0a05205a85cc78d9a099bbe991ce884 Mon Sep 17 00:00:00 2001 From: Oleg Pykhalov Date: Thu, 27 Jul 2017 04:01:01 +0300 Subject: [PATCH] gnu: Add rsync service. * doc/guix.texi (Incremental file transfer): Add documentation. * gnu/services/rsync.scm (): New record type. (rsync-accounts, rsync-shepherd-service): New service extensions. (rsync-service-type): New service type. --- doc/guix.texi | 67 +++++++++++++++++++++++ gnu/local.mk | 1 + gnu/services/rsync.scm | 140 +++++++++++++++++++++++++++++++++++++++++++++= ++++ 3 files changed, 208 insertions(+) create mode 100644 gnu/services/rsync.scm diff --git a/doc/guix.texi b/doc/guix.texi index cda131557..cb5b59615 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -16528,6 +16528,73 @@ Extra options will be passed to @code{git daemon},= please run @end table @end deftp =20 +@subsubsection File transfer + +The @code{(gnu services rsync)} module provides the following services: + +@subsubheading Rsync service + +You might want an rsync daemon if you have files that you want available +so anyone (or just yourself) can download existing files or upload new +files. + +@deffn {Scheme Variable} rsync-service-type +This is the type for the @uref{https://rsync.samba.org} rsync daemon, +@command{rsync-configuration} record as in this example: + +@example +(service rsync-service-type + (rsync-configuration)) +@end example + +See below for details about @code{rsync-configuration}. +@end deffn + +@deftp {Data Type} rsync-configuration +Data type representing the configuration for @code{rsync-service}. + +@table @asis +@item @code{package} (default: @var{rsync}) +@code{rsync} package to use. + +@item @code{port-number} (default: @code{873}) +TCP port on which @command{rsync} listens for incoming connections. If +port is less than @code{1024} @command{rsync} will be started as the +@code{root} user and group. + +@item @code{pid-file} (default: @code{"/var/run/rsyncd.pid"}) +Name of the file where @command{rsync} writes its PID. + +@item @code{lock-file} (default: @code{"/var/run/rsyncd.lock"}) +Name of the file where @command{rsync} writes its lock file. + +@item @code{log-file} (default: @code{"/var/log/rsyncd.log"}) +Name of the file where @command{rsync} writes its log file. + +@item @code{use-choot?} (default: @var{#f}) +Whether to use chroot for @command{rsync} shared directory. + +@item @code{share-path} (default: @file{/srv/rsync}) +Location of the @command{rsync} shared directory. + +@item @code{share-comment} (default: @code{"Rsync share"}) +Comment of the @command{rsync} shared directory. + +@item @code{read-only?} (default: @var{#f}) +Read-write permissions to shared directory. + +@item @code{timeout} (default: @code{300}) +I/O timeout in seconds. + +@item @code{user} (default: @code{"rsyncd"}) +Privilege separation user. + +@item @code{group} (default: @code{"rsyncd"}) +Privilege separation group. + +@end table +@end deftp + @node Setuid Programs @subsection Setuid Programs =20 diff --git a/gnu/local.mk b/gnu/local.mk index f48e6638b..bc445b731 100644 --- a/gnu/local.mk +++ b/gnu/local.mk @@ -445,6 +445,7 @@ GNU_SYSTEM_MODULES =3D \ %D%/services/shepherd.scm \ %D%/services/herd.scm \ %D%/services/pm.scm \ + %D%/services/rsync.scm \ %D%/services/sddm.scm \ %D%/services/spice.scm \ %D%/services/ssh.scm \ diff --git a/gnu/services/rsync.scm b/gnu/services/rsync.scm new file mode 100644 index 000000000..b5ba68291 --- /dev/null +++ b/gnu/services/rsync.scm @@ -0,0 +1,140 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright =C2=A9 2017 Oleg Pykhalov +;;; +;;; 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 (gnu services rsync) + #:use-module (gnu services) + #:use-module (gnu services base) + #:use-module (gnu services shepherd) + #:use-module (gnu system shadow) + #:use-module (gnu packages rsync) + #:use-module (gnu packages admin) + #:use-module (guix records) + #:use-module (guix gexp) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-26) + #:use-module (ice-9 match) + #:export (rsync-configuration + rsync-configuration? + rsync-service-type)) + +;;;; Commentary: +;;; +;;; This module implements a service that to run instance of Rsync, +;;; files synchronization tool. +;;; +;;;; Code: + +(define-record-type* + rsync-configuration make-rsync-configuration + rsync-configuration? + (package rsync-configuration-package ;package + (default rsync)) + (port-number rsync-configuration-port-number ;integer + (default 873)) + (pid-file rsync-configuration-pid-file ;string + (default "/var/run/rsyncd.pid")) + (lock-file rsync-configuration-lock-file ;string + (default "/var/run/rsyncd.lock")) + (log-file rsync-configuration-log-file ;string + (default "/var/log/rsyncd.log")) + (use-chroot? rsync-configuration-use-chroot? ;boolean + (default #f)) + (share-path rsync-configuration-share-path ;string + (default "/srv/rsync")) + (share-comment rsync-configuration-share-comment ;string + (default "Rsync share")) + (read-only? rsync-configuration-read-only? ;boolean + (default #f)) + (timeout rsync-configuration-timeout ;integer + (default 300)) + (user rsync-configuration-user ;string + (default "rsyncd")) + (group rsync-configuration-group ;string + (default "rsyncd"))) + +(define (rsync-account config) + "Return the user accounts and user groups for CONFIG." + (let ((rsync-user (rsync-configuration-user config)) + (rsync-group (rsync-configuration-group config))) + (list (user-group (name "rsyncd") (system? #t)) + (user-account + (name rsync-user) + (system? #t) + (group rsync-group) + (comment "rsyncd privilege separation user") + (home-directory "/var/run/rsyncd") + (shell #~(string-append #$shadow "/sbin/nologin")))))) + +(define (rsync-activation config) + "Return the activation GEXP for CONFIG." + #~(begin + (use-modules (guix build utils)) + (let ((share-path #$(rsync-configuration-share-path config)) + (user (getpw #$(rsync-configuration-user config))) + (group (getpw #$(rsync-configuration-group config)))) + (and=3D> share-path mkdir-p) + (chown share-path + (passwd:uid user) + (group:gid group))))) + +(define (rsync-config-file config) + "Return the rsync configuration file corresponding to CONFIG." + (match config + (($ package port-number pid-file + lock-file log-file use-chroot? share-path + share-comment read-only? timeout user group) + (mixed-text-file "rsync.conf" + "pid file =3D " pid-file "\n" + "lock file =3D " lock-file "\n" + "log file =3D " log-file "\n" + "port =3D " (number->string port-number) "\n" + "use chroot =3D " (if use-chroot? "true" "false") "\= n" + "gid =3D " group "\n" + "[files]\n" + "path =3D " share-path "\n" + "comment =3D " share-comment "\n" + "read only =3D " (if read-only? "true" "false") "\n" + "timeout =3D " (number->string timeout) "\n")))) + +(define (rsync-shepherd-service config) + "Return a for rsync with CONFIG." + (let* ((rsync (rsync-configuration-package config)) + (pid-file (rsync-configuration-pid-file config)) + (port (rsync-configuration-port-number config)) + (user (if (> port 1024) (rsync-configuration-user config) "root"= )) + (group (if (> port 1024) (rsync-configuration-group config) "roo= t"))) + (list (shepherd-service + (provision '(rsync)) + (documentation "Run rsync daemon.") + (start #~(make-forkexec-constructor + (list (string-append #$rsync "/bin/rsync") + "--config" #$(rsync-config-file config) + "--daemon") + #:pid-file #$pid-file + #:user #$user + #:group #$group)) + (stop #~(make-kill-destructor)))))) + +(define rsync-service-type + (service-type + (name 'rsync) + (extensions + (list (service-extension shepherd-root-service-type rsync-shepherd-ser= vice) + (service-extension account-service-type rsync-account) + (service-extension activation-service-type rsync-activation))) + (default-value (rsync-configuration)))) --=20 2.13.3