1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2016 David Craven <david@craven.ch>
3 ;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org>
4 ;;; Copyright © 2019 Jesse Gildersleve <jessejohngildersleve@protonmail.com>
6 ;;; This file is part of GNU Guix.
8 ;;; GNU Guix is free software; you can redistribute it and/or modify it
9 ;;; under the terms of the GNU General Public License as published by
10 ;;; the Free Software Foundation; either version 3 of the License, or (at
11 ;;; your option) any later version.
13 ;;; GNU Guix is distributed in the hope that it will be useful, but
14 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;;; GNU General Public License for more details.
18 ;;; You should have received a copy of the GNU General Public License
19 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
21 (define-module (gnu services sddm)
22 #:use-module (gnu packages admin)
23 #:use-module (gnu packages display-managers)
24 #:use-module (gnu packages freedesktop)
25 #:use-module (gnu packages xorg)
26 #:use-module (gnu services)
27 #:use-module (gnu services shepherd)
28 #:use-module (gnu services xorg)
29 #:use-module (gnu system pam)
30 #:use-module (gnu system shadow)
31 #:use-module (guix gexp)
32 #:use-module (guix records)
33 #:export (sddm-configuration
38 (define-record-type* <sddm-configuration>
39 sddm-configuration make-sddm-configuration
41 (sddm sddm-configuration-sddm
45 ;; valid values are x11 and wayland
46 ;; currently doesn't do anything is enabled by wayland greeter PR
47 (display-server sddm-configuration-display-server
49 ;; valid values are on, off or none
50 (numlock sddm-configuration-numlock
52 (halt-command sddm-configuration-halt-command
53 (default (file-append shepherd "/sbin/halt")))
54 (reboot-command sddm-configuration-reboot-command
55 (default (file-append shepherd "/sbin/reboot")))
58 ;; valid values are elarun or maldives
59 (theme sddm-configuration-theme
61 (themes-directory sddm-configuration-themes-directory
62 (default "/run/current-system/profile/share/sddm/themes"))
63 (faces-directory sddm-configuration-faces-directory
64 (default "/run/current-system/profile/share/sddm/faces"))
67 (default-path sddm-configuration-default-path
68 (default "/run/current-system/profile/bin"))
69 (minimum-uid sddm-configuration-minimum-uid
71 (maximum-uid sddm-configuration-maximum-uid
73 (remember-last-user? sddm-configuration-remember-last-user?
75 (remember-last-session? sddm-configuration-remember-last-session?
77 (hide-users sddm-configuration-hide-users
79 (hide-shells sddm-configuration-hide-shells
80 (default (file-append shadow "/sbin/nologin")))
83 (session-command sddm-configuration-session-command
84 (default (file-append sddm "/share/sddm/scripts/wayland-session")))
85 (sessions-directory sddm-configuration-sessions-directory
86 (default "/run/current-system/profile/share/wayland-sessions"))
88 (xorg-configuration sddm-configuration-xorg
89 (default (xorg-configuration)))
90 (xauth-path sddm-configuration-xauth-path
91 (default (file-append xauth "/bin/xauth")))
92 (xephyr-path sddm-configuration-xephyr-path
93 (default (file-append xorg-server "/bin/Xephyr")))
94 (xdisplay-start sddm-configuration-xdisplay-start
95 (default (file-append sddm "/share/sddm/scripts/Xsetup")))
96 (xdisplay-stop sddm-configuration-xdisplay-stop
97 (default (file-append sddm "/share/sddm/scripts/Xstop")))
98 (xsession-command sddm-configuration-xsession-command
100 (xsessions-directory sddm-configuration-xsessions-directory
101 (default "/run/current-system/profile/share/xsessions"))
102 (minimum-vt sddm-configuration-minimum-vt
106 (auto-login-user sddm-configuration-auto-login-user
108 ;; valid values are xfce.desktop gnome.desktop weston.desktop hawaii.desktop
109 (auto-login-session sddm-configuration-auto-login-session
111 (relogin? sddm-configuration-relogin?
114 (define (sddm-configuration-file config)
115 (mixed-text-file "sddm.conf" "
117 DisplayServer=" (sddm-configuration-display-server config) "
118 Numlock=" (sddm-configuration-numlock config) "
119 HaltCommand=" (sddm-configuration-halt-command config) "
120 RebootCommand=" (sddm-configuration-reboot-command config) "
123 DefaultPath=" (sddm-configuration-default-path config) "
124 MinimumUid=" (number->string (sddm-configuration-minimum-uid config))"
125 MaximumUid=" (number->string (sddm-configuration-maximum-uid config))"
126 RememberLastUser=" (if (sddm-configuration-remember-last-user? config)
128 RememberLastSession=" (if (sddm-configuration-remember-last-session? config)
130 HideUsers=" (sddm-configuration-hide-users config) "
131 Hideshells=" (sddm-configuration-hide-shells config) "
134 Current=" (sddm-configuration-theme config) "
135 ThemeDir=" (sddm-configuration-themes-directory config) "
136 FacesDir=" (sddm-configuration-faces-directory config) "
139 SessionCommand=" (sddm-configuration-session-command config) "
140 SessionDir=" (sddm-configuration-sessions-directory config) "
143 ServerPath=" (xorg-start-command (sddm-configuration-xorg config)) "
144 XauthPath=" (sddm-configuration-xauth-path config) "
145 XephyrPath=" (sddm-configuration-xephyr-path config) "
146 DisplayCommand=" (sddm-configuration-xdisplay-start config) "
147 DisplayStopCommand=" (sddm-configuration-xdisplay-stop config) "
148 SessionCommand=" (sddm-configuration-xsession-command config) "
149 SessionDir=" (sddm-configuration-xsessions-directory config) "
150 MinimumVT=" (number->string (sddm-configuration-minimum-vt config)) "
151 ServerArguments=" (string-join
152 (xorg-configuration-server-arguments
153 (sddm-configuration-xorg config))) "
156 User=" (sddm-configuration-auto-login-user config) "
157 Session=" (sddm-configuration-auto-login-session config) "
158 Relogin=" (if (sddm-configuration-relogin? config)
162 (define (sddm-shepherd-service config)
163 "Return a <shepherd-service> for sddm with CONFIG."
166 #~(list (string-append #$(sddm-configuration-sddm config) "/bin/sddm")))
168 (list (shepherd-service
169 (documentation "SDDM display manager.")
170 (requirement '(user-processes))
171 (provision '(display-manager))
172 (start #~(make-forkexec-constructor #$sddm-command))
173 (stop #~(make-kill-destructor)))))
175 (define (sddm-etc-service config)
176 (list `("sddm.conf" ,(sddm-configuration-file config))))
178 (define (sddm-pam-service config)
179 "Return a PAM service for @command{sddm}."
185 (control "requisite")
186 (module "pam_nologin.so"))
189 (module "pam_env.so"))
192 (module "pam_succeed_if.so")
193 (arguments (list (string-append "uid >= "
194 (number->string (sddm-configuration-minimum-uid config)))
196 ;; should be factored out into system-auth
199 (module "pam_unix.so"))))
202 ;; should be factored out into system-account
205 (module "pam_unix.so"))))
208 ;; should be factored out into system-password
211 (module "pam_unix.so")
212 (arguments (list "sha512" "shadow" "try_first_pass")))))
215 ;; lfs has a required pam_limits.so
216 ;; should be factored out into system-session
219 (module "pam_unix.so"))))))
221 (define (sddm-greeter-pam-service)
222 "Return a PAM service for @command{sddm-greeter}."
224 (name "sddm-greeter")
227 ;; Load environment from /etc/environment and ~/.pam_environment
230 (module "pam_env.so"))
231 ;; Always let the greeter start without authentication
234 (module "pam_permit.so"))))
237 ;; No action required for account management
240 (module "pam_permit.so"))))
243 ;; Can't change password
246 (module "pam_deny.so"))))
252 (module "pam_unix.so"))))))
254 (define (sddm-autologin-pam-service config)
255 "Return a PAM service for @command{sddm-autologin}"
257 (name "sddm-autologin")
261 (control "requisite")
262 (module "pam_nologin.so"))
265 (module "pam_succeed_if.so")
266 (arguments (list (string-append "uid >= "
267 (number->string (sddm-configuration-minimum-uid config)))
271 (module "pam_permit.so"))))
281 (module "pam_deny.so"))))
288 (define (sddm-pam-services config)
289 (list (sddm-pam-service config)
290 (sddm-greeter-pam-service)
291 (sddm-autologin-pam-service config)))
293 (define %sddm-accounts
294 (list (user-group (name "sddm") (system? #t))
299 (comment "SDDM user")
300 (home-directory "/var/lib/sddm")
301 (shell (file-append shadow "/sbin/nologin")))))
303 ;; Add default themes to profile
304 (define sddm-profile-service
305 (compose list sddm-configuration-sddm))
307 (define sddm-service-type
308 (service-type (name 'sddm)
310 (list (service-extension shepherd-root-service-type
311 sddm-shepherd-service)
312 (service-extension etc-service-type
314 (service-extension pam-root-service-type
316 (service-extension account-service-type
317 (const %sddm-accounts))
318 (service-extension profile-service-type
319 sddm-profile-service)))))
321 (define* (sddm-service #:optional (config (sddm-configuration)))
322 "Run the @uref{https://github.com/sddm/sddm,SSDM display manager}
323 with the given @var{config}, a @code{<sddm-configuration>} object."
324 (service sddm-service-type config))