services: setuid: More configurable setuid support.

New record <setuid-program> with fields for setting the specific user
and group, as well as specifically selecting the setuid and setgid bits,
for a program within the setuid-program-service.

* gnu/services.scm (setuid-program-file-like-deprecated): New function.
  (setuid-program-service-type): Make use of
  setuid-program->activation-gexp.  Adjust the extend property to handle
  <setuid-program>.
* gnu/build/activation.scm (activate-setuid-programs): Update to expect a
  <setuid-record> list for each program entry.
* gnu/system.scm: (operating-system-setuid-programs): Renamed to
  %operating-system-setuid-programs and replace it with new procedure.
  (operating-system-default-essential-services,
  hurd-default-essential-services): Replace
  operating-system-setuid-programs with
  %operating-system-setuid-programs.
* gnu/system/setuid.scm: New file.
* doc/guix.texi (Setuid Programs): Document <setuid-program>.

Co-authored-by: Brice Waegeneire <brice@waegenei.re>
This commit is contained in:
Chris Lemmer-Webber 2021-07-06 22:03:19 +02:00 committed by Christopher Lemmer Webber
parent 5a1ce6cf70
commit a7ac19851b
No known key found for this signature in database
GPG key ID: 4BC025925FF8F4D3
4 changed files with 104 additions and 19 deletions

View file

@ -46,7 +46,7 @@ Copyright @copyright{} 2017 Federico Beffa@*
Copyright @copyright{} 2017, 2018 Carlo Zancanaro@* Copyright @copyright{} 2017, 2018 Carlo Zancanaro@*
Copyright @copyright{} 2017 Thomas Danckaert@* Copyright @copyright{} 2017 Thomas Danckaert@*
Copyright @copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017 humanitiesNerd@*
Copyright @copyright{} 2017, 2021 Christopher Lemmer Webber@* Copyright @copyright{} 2017, 2021 Christine Lemmer-Webber@*
Copyright @copyright{} 2017, 2018, 2019, 2020 Marius Bakke@* Copyright @copyright{} 2017, 2018, 2019, 2020 Marius Bakke@*
Copyright @copyright{} 2017, 2019, 2020 Hartmut Goebel@* Copyright @copyright{} 2017, 2019, 2020 Hartmut Goebel@*
Copyright @copyright{} 2017, 2019, 2020, 2021 Maxim Cournoyer@* Copyright @copyright{} 2017, 2019, 2020, 2021 Maxim Cournoyer@*
@ -32398,6 +32398,30 @@ package, can be designated by this G-expression (@pxref{G-Expressions}):
#~(string-append #$shadow "/bin/passwd") #~(string-append #$shadow "/bin/passwd")
@end example @end example
@deftp {Data Type} setuid-program
This data type represents a program with a setuid or setgid bit set.
@table @asis
@item @code{program}
A file-like object having its setuid and/or setgid bit set.
@item @code{setuid?} (default: @code{#t})
Whether to set user setuid bit.
@item @code{setgid?} (default: @code{#f})
Whether to set group setgid bit.
@item @code{user} (default: @code{0})
UID (integer) or user name (string) for the user owner of the program,
defaults to root.
@item @code{group} (default: @code{0})
GID (integer) goup name (string) for the group owner of the program,
defaults to root.
@end table
@end deftp
A default set of setuid programs is defined by the A default set of setuid programs is defined by the
@code{%setuid-programs} variable of the @code{(gnu system)} module. @code{%setuid-programs} variable of the @code{(gnu system)} module.

View file

@ -6,6 +6,8 @@
;;; Copyright © 2018 Arun Isaac <arunisaac@systemreboot.net> ;;; Copyright © 2018 Arun Isaac <arunisaac@systemreboot.net>
;;; Copyright © 2018, 2019 Ricardo Wurmus <rekado@elephly.net> ;;; Copyright © 2018, 2019 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be> ;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be>
;;; Copyright © 2020 Christine Lemmer-Webber <cwebber@dustycloud.org>
;;; Copyright © 2021 Brice Waegeneire <brice@waegenei.re>
;;; ;;;
;;; This file is part of GNU Guix. ;;; This file is part of GNU Guix.
;;; ;;;
@ -24,6 +26,7 @@
(define-module (gnu build activation) (define-module (gnu build activation)
#:use-module (gnu system accounts) #:use-module (gnu system accounts)
#:use-module (gnu system setuid)
#:use-module (gnu build accounts) #:use-module (gnu build accounts)
#:use-module (gnu build linux-boot) #:use-module (gnu build linux-boot)
#:use-module (guix build utils) #:use-module (guix build utils)
@ -279,14 +282,17 @@ (define %setuid-directory
"/run/setuid-programs") "/run/setuid-programs")
(define (activate-setuid-programs programs) (define (activate-setuid-programs programs)
"Turn PROGRAMS, a list of file names, into setuid programs stored under "Turn PROGRAMS, a list of file setuid-programs record, into setuid programs
%SETUID-DIRECTORY." stored under %SETUID-DIRECTORY."
(define (make-setuid-program prog) (define (make-setuid-program program setuid? setgid? uid gid)
(let ((target (string-append %setuid-directory (let ((target (string-append %setuid-directory
"/" (basename prog)))) "/" (basename program)))
(copy-file prog target) (mode (+ #o0555 ; base permissions
(chown target 0 0) (if setuid? #o4000 0) ; setuid bit
(chmod target #o4555))) (if setgid? #o2000 0)))) ; setgid bit
(copy-file program target)
(chown target uid gid)
(chmod target mode)))
(format #t "setting up setuid programs in '~a'...~%" (format #t "setting up setuid programs in '~a'...~%"
%setuid-directory) %setuid-directory)
@ -302,15 +308,27 @@ (define (make-setuid-program prog)
(for-each (lambda (program) (for-each (lambda (program)
(catch 'system-error (catch 'system-error
(lambda () (lambda ()
(make-setuid-program program)) (let* ((program-name (setuid-program-program program))
(setuid? (setuid-program-setuid? program))
(setgid? (setuid-program-setgid? program))
(user (setuid-program-user program))
(group (setuid-program-group program))
(uid (match user
((? string?) (passwd:uid (getpwnam user)))
((? integer?) user)))
(gid (match group
((? string?) (group:gid (getgrnam group)))
((? integer?) group))))
(make-setuid-program program-name setuid? setgid? uid gid)))
(lambda args (lambda args
;; If we fail to create a setuid program, better keep going ;; If we fail to create a setuid program, better keep going
;; so that we don't leave %SETUID-DIRECTORY empty or ;; so that we don't leave %SETUID-DIRECTORY empty or
;; half-populated. This can happen if PROGRAMS contains ;; half-populated. This can happen if PROGRAMS contains
;; incorrect file names: <https://bugs.gnu.org/38800>. ;; incorrect file names: <https://bugs.gnu.org/38800>.
(format (current-error-port) (format (current-error-port)
"warning: failed to make '~a' setuid-root: ~a~%" "warning: failed to make ~s setuid/setgid: ~a~%"
program (strerror (system-error-errno args)))))) (setuid-program-program program)
(strerror (system-error-errno args))))))
programs)) programs))
(define (activate-special-files special-files) (define (activate-special-files special-files)

View file

@ -4,6 +4,8 @@
;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <janneke@gnu.org> ;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
;;; Copyright © 2020, 2021 Ricardo Wurmus <rekado@elephly.net> ;;; Copyright © 2020, 2021 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2021 raid5atemyhomework <raid5atemyhomework@protonmail.com> ;;; Copyright © 2021 raid5atemyhomework <raid5atemyhomework@protonmail.com>
;;; Copyright © 2020 Christine Lemmer-Webber <cwebber@dustycloud.org>
;;; Copyright © 2020, 2021 Brice Waegeneire <brice@waegenei.re>
;;; ;;;
;;; This file is part of GNU Guix. ;;; This file is part of GNU Guix.
;;; ;;;
@ -40,6 +42,7 @@ (define-module (gnu services)
#:use-module (gnu packages base) #:use-module (gnu packages base)
#:use-module (gnu packages bash) #:use-module (gnu packages bash)
#:use-module (gnu packages hurd) #:use-module (gnu packages hurd)
#:use-module (gnu system setuid)
#:use-module (srfi srfi-1) #:use-module (srfi srfi-1)
#:use-module (srfi srfi-9) #:use-module (srfi srfi-9)
#:use-module (srfi srfi-9 gnu) #:use-module (srfi srfi-9 gnu)
@ -801,15 +804,49 @@ (define (etc-service files)
FILES must be a list of name/file-like object pairs." FILES must be a list of name/file-like object pairs."
(service etc-service-type files)) (service etc-service-type files))
(define (setuid-program->activation-gexp programs)
"Return an activation gexp for setuid-program from PROGRAMS."
(let ((programs (map (lambda (program)
;; FIXME This is really ugly, I didn't managed to use
;; "inherit"
(let ((program-name (setuid-program-program program))
(setuid? (setuid-program-setuid? program))
(setgid? (setuid-program-setgid? program))
(user (setuid-program-user program))
(group (setuid-program-group program)) )
#~(setuid-program
(setuid? #$setuid?)
(setgid? #$setgid?)
(user #$user)
(group #$group)
(program #$program-name))))
programs)))
(with-imported-modules (source-module-closure
'((gnu system setuid)))
#~(begin
(use-modules (gnu system setuid))
(activate-setuid-programs (list #$@programs))))))
(define (setuid-program-file-like-deprecated file-like)
(match file-like
((? file-like? program)
(warning
(G_ "representing setuid programs with '~a' is \
deprecated; use 'setuid-program' instead~%") program)
(setuid-program (program program)))
((? setuid-program? program)
program)))
(define setuid-program-service-type (define setuid-program-service-type
(service-type (name 'setuid-program) (service-type (name 'setuid-program)
(extensions (extensions
(list (service-extension activation-service-type (list (service-extension activation-service-type
(lambda (programs) setuid-program->activation-gexp)))
#~(activate-setuid-programs
(list #$@programs))))))
(compose concatenate) (compose concatenate)
(extend append) (extend (lambda (config extensions)
(map setuid-program-file-like-deprecated
(append config extensions))))
(description (description
"Populate @file{/run/setuid-programs} with the specified "Populate @file{/run/setuid-programs} with the specified
executables, making them setuid-root."))) executables, making them setuid-root.")))

View file

@ -7,7 +7,7 @@
;;; Copyright © 2019 Meiyo Peng <meiyo.peng@gmail.com> ;;; Copyright © 2019 Meiyo Peng <meiyo.peng@gmail.com>
;;; Copyright © 2019, 2020 Miguel Ángel Arruga Vivas <rosen644835@gmail.com> ;;; Copyright © 2019, 2020 Miguel Ángel Arruga Vivas <rosen644835@gmail.com>
;;; Copyright © 2020 Danny Milosavljevic <dannym@scratchpost.org> ;;; Copyright © 2020 Danny Milosavljevic <dannym@scratchpost.org>
;;; Copyright © 2020 Brice Waegeneire <brice@waegenei.re> ;;; Copyright © 2020, 2021 Brice Waegeneire <brice@waegenei.re>
;;; Copyright © 2020 Florian Pelz <pelzflorian@pelzflorian.de> ;;; Copyright © 2020 Florian Pelz <pelzflorian@pelzflorian.de>
;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com> ;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <jannek@gnu.org> ;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <jannek@gnu.org>
@ -74,6 +74,7 @@ (define-module (gnu system)
#:use-module (gnu system locale) #:use-module (gnu system locale)
#:use-module (gnu system pam) #:use-module (gnu system pam)
#:use-module (gnu system linux-initrd) #:use-module (gnu system linux-initrd)
#:use-module (gnu system setuid)
#:use-module (gnu system uuid) #:use-module (gnu system uuid)
#:use-module (gnu system file-systems) #:use-module (gnu system file-systems)
#:use-module (gnu system mapped-devices) #:use-module (gnu system mapped-devices)
@ -267,7 +268,7 @@ (define-record-type* <operating-system> operating-system
(pam-services operating-system-pam-services ; list of PAM services (pam-services operating-system-pam-services ; list of PAM services
(default (base-pam-services))) (default (base-pam-services)))
(setuid-programs operating-system-setuid-programs (setuid-programs %operating-system-setuid-programs
(default %setuid-programs)) ; list of string-valued gexps (default %setuid-programs)) ; list of string-valued gexps
(sudoers-file operating-system-sudoers-file ; file-like (sudoers-file operating-system-sudoers-file ; file-like
@ -671,7 +672,7 @@ (define known-fs
(operating-system-environment-variables os)) (operating-system-environment-variables os))
host-name procs root-fs host-name procs root-fs
(service setuid-program-service-type (service setuid-program-service-type
(operating-system-setuid-programs os)) (%operating-system-setuid-programs os))
(service profile-service-type (service profile-service-type
(operating-system-packages os)) (operating-system-packages os))
other-fs other-fs
@ -701,7 +702,7 @@ (define (hurd-default-essential-services os)
(pam-root-service (operating-system-pam-services os)) (pam-root-service (operating-system-pam-services os))
(operating-system-etc-service os) (operating-system-etc-service os)
(service setuid-program-service-type (service setuid-program-service-type
(operating-system-setuid-programs os)) (%operating-system-setuid-programs os))
(service profile-service-type (operating-system-packages os))))) (service profile-service-type (operating-system-packages os)))))
(define* (operating-system-services os) (define* (operating-system-services os)
@ -1065,6 +1066,11 @@ (define (operating-system-environment-variables os)
;; TODO: Remove when glibc@2.23 is long gone. ;; TODO: Remove when glibc@2.23 is long gone.
("GUIX_LOCPATH" . "/run/current-system/locale"))) ("GUIX_LOCPATH" . "/run/current-system/locale")))
(define (operating-system-setuid-programs os)
"Return the setuid programs for OS, as a list of setuid-program record."
(map file-like->setuid-program
(%operating-system-setuid-programs os)))
(define %setuid-programs (define %setuid-programs
;; Default set of setuid-root programs. ;; Default set of setuid-root programs.
(let ((shadow (@ (gnu packages admin) shadow))) (let ((shadow (@ (gnu packages admin) shadow)))