]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: lift pam_systemd_homed description to Summary
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Wed, 13 Jul 2022 08:19:19 +0000 (10:19 +0200)
committerLuca Boccassi <luca.boccassi@gmail.com>
Wed, 13 Jul 2022 13:00:54 +0000 (14:00 +0100)
Also change the title to describe the module more comprehensively.
Follow-up for 90bc309aa2c1430941f4c50f73e681ab3e488bd3. Suggested
in https://bugzilla.redhat.com/show_bug.cgi?id=2085485#c5.

man/pam_systemd_home.xml

index 93153b57aa0627b86892ad02cc80a724eaec1dfa..9fa0e0a7e7c21ec1776599c552bf3e3a63090239 100644 (file)
@@ -17,8 +17,8 @@
 
   <refnamediv>
     <refname>pam_systemd_home</refname>
-    <refpurpose>Automatically mount home directories managed by <filename>systemd-homed.service</filename> on
-    login, and unmount them on logout</refpurpose>
+    <refpurpose>Authenticate users and mount home directories via <filename>systemd-homed.service</filename>
+    </refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
     <para><command>pam_systemd_home</command> ensures that home directories managed by
     <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
     are automatically activated (mounted) on user login, and are deactivated (unmounted) when the last
-    session of the user ends.</para>
+    session of the user ends. For such users, it also provides authentication (when per-user disk encryption
+    is used, the disk encryption key is derived from the authentication credential supplied at login time),
+    account management (the <ulink url="https://systemd.io/USER_RECORD/">JSON user record</ulink> embedded in
+    the home store contains account details), and implements the updating of the encryption password (which
+    is also used for user authentication).</para>
   </refsect1>
 
   <refsect1>
   <refsect1>
     <title>Module Types Provided</title>
 
-    <para>The module implements all four PAM operations: <option>auth</option> (reason: when per-user
-    disk encryption is used, the disk encryption key is derived from the authentication credential supplied
-    at login time), <option>account</option> (reason: <filename>systemd-homed.service</filename> account
-    validity may be configured in more detail than in the traditional Linux user database, and thus needs to
-    be verified separately), <option>session</option> (user sessions must be tracked, in order to implement
-    automatic release when the last session of a managed user is gone), <option>password</option> (user
-    passwords may be changed through PAM).</para>
+    <para>The module implements all four PAM operations: <option>auth</option> (reason: to allow
+    authentication using the encrypted data), <option>account</option> (reason: users with
+    <filename>systemd-homed.service</filename> user accounts are described in a <ulink
+    url="https://systemd.io/USER_RECORD/">JSON user record</ulink> and may be configured in more detail than
+    in the traditional Linux user database), <option>session</option> (user sessions must be tracked in order
+    to implement automatic release when the last session of the user is gone), <option>password</option> (to
+    change the encryption password — also used for user authentication — through PAM).</para>
   </refsect1>
 
   <refsect1>