| 1 |
'\" t |
| 2 |
.TH "SYSTEMD\-HOMED\&.SERVICE" "8" "" "systemd 261~rc3" "systemd-homed.service" |
| 3 |
.\" ----------------------------------------------------------------- |
| 4 |
.\" * Define some portability stuff |
| 5 |
.\" ----------------------------------------------------------------- |
| 6 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 7 |
.\" http://bugs.debian.org/507673 |
| 8 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 9 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 |
.ie \n(.g .ds Aq \(aq |
| 11 |
.el .ds Aq ' |
| 12 |
.\" ----------------------------------------------------------------- |
| 13 |
.\" * set default formatting |
| 14 |
.\" ----------------------------------------------------------------- |
| 15 |
.\" disable hyphenation |
| 16 |
.nh |
| 17 |
.\" disable justification (adjust text to left margin only) |
| 18 |
.ad l |
| 19 |
.\" ----------------------------------------------------------------- |
| 20 |
.\" * MAIN CONTENT STARTS HERE * |
| 21 |
.\" ----------------------------------------------------------------- |
| 22 |
.SH "NAME" |
| 23 |
systemd-homed.service, systemd-homed \- Home Area/User Account Manager |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.PP |
| 26 |
systemd\-homed\&.service |
| 27 |
.PP |
| 28 |
/usr/lib/systemd/systemd\-homed |
| 29 |
.SH "DESCRIPTION" |
| 30 |
.PP |
| 31 |
\fBsystemd\-homed\fR |
| 32 |
is a system service that may be used to create, remove, change or inspect home areas (directories and network mounts and real or loopback block devices with a filesystem, optionally encrypted)\&. |
| 33 |
.PP |
| 34 |
Most of |
| 35 |
\fBsystemd\-homed\fR\*(Aqs functionality is accessible through the |
| 36 |
\fBhomectl\fR(1) |
| 37 |
command\&. |
| 38 |
.PP |
| 39 |
See the |
| 40 |
\m[blue]\fBHome Directories\fR\m[]\&\s-2\u[1]\d\s+2 |
| 41 |
documentation for details about the format and design of home areas managed by |
| 42 |
systemd\-homed\&.service\&. |
| 43 |
.PP |
| 44 |
Each home directory managed by |
| 45 |
systemd\-homed\&.service |
| 46 |
synthesizes a local user and group\&. These are made available to the system using the |
| 47 |
\m[blue]\fBUser/Group Record Lookup API via Varlink\fR\m[]\&\s-2\u[2]\d\s+2, and thus may be browsed with |
| 48 |
\fBuserdbctl\fR(1)\&. |
| 49 |
.PP |
| 50 |
systemd\-homed\&.service |
| 51 |
also manages blob directories for each home directory it manages\&. See |
| 52 |
\m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[3]\d\s+2 |
| 53 |
for more details\&. |
| 54 |
.SH "KEY MANAGEMENT" |
| 55 |
.PP |
| 56 |
User records are cryptographically signed with a public/private key pair (the signature is part of the JSON record itself)\&. For a user to be permitted to log in locally the public key matching the signature of their user record must be installed\&. For a user record to be modified locally the private key matching the signature must be installed locally, too\&. The keys are stored in the |
| 57 |
/var/lib/systemd/home/ |
| 58 |
directory: |
| 59 |
.PP |
| 60 |
/var/lib/systemd/home/local\&.private |
| 61 |
.RS 4 |
| 62 |
The private key of the public/private key pair used for local records\&. Currently, only a single such key may be installed\&. |
| 63 |
.sp |
| 64 |
Added in version 246\&. |
| 65 |
.RE |
| 66 |
.PP |
| 67 |
/var/lib/systemd/home/local\&.public |
| 68 |
.RS 4 |
| 69 |
The public key of the public/private key pair used for local records\&. Currently, only a single such key may be installed\&. |
| 70 |
.sp |
| 71 |
Added in version 246\&. |
| 72 |
.RE |
| 73 |
.PP |
| 74 |
/var/lib/systemd/home/*\&.public |
| 75 |
.RS 4 |
| 76 |
Additional public keys\&. Any users whose user records are signed with any of these keys are permitted to log in locally\&. An arbitrary number of keys may be installed this way\&. |
| 77 |
.sp |
| 78 |
Added in version 246\&. |
| 79 |
.RE |
| 80 |
.PP |
| 81 |
All key files listed above are in PEM format\&. |
| 82 |
.PP |
| 83 |
In order to migrate a home directory from a host |
| 84 |
"foobar" |
| 85 |
to another host |
| 86 |
"quux" |
| 87 |
it is hence sufficient to copy |
| 88 |
/var/lib/systemd/home/local\&.public |
| 89 |
from the host |
| 90 |
"foobar" |
| 91 |
to |
| 92 |
"quux", maybe calling the file on the destination |
| 93 |
/var/lib/systemd/home/foobar\&.public, reflecting the origin of the key\&. If the user record should be modifiable on |
| 94 |
"quux" |
| 95 |
the pair |
| 96 |
/var/lib/systemd/home/local\&.public |
| 97 |
and |
| 98 |
/var/lib/systemd/home/local\&.private |
| 99 |
need to be copied from |
| 100 |
"foobar" |
| 101 |
to |
| 102 |
"quux", and placed under the identical paths there, as currently only a single private key is supported per host\&. Note of course that the latter means that user records generated/signed before the key pair is copied in, lose their validity\&. |
| 103 |
.SH "SIGNALS" |
| 104 |
.PP |
| 105 |
\fBSIGUSR1\fR |
| 106 |
.RS 4 |
| 107 |
Upon reception of the |
| 108 |
\fBSIGUSR1\fR |
| 109 |
process signal |
| 110 |
\fBsystemd\-homed\fR |
| 111 |
will reestablish its file watches on |
| 112 |
/home/ |
| 113 |
and rescan the directory for home directories\&. |
| 114 |
.sp |
| 115 |
Added in version 258\&. |
| 116 |
.RE |
| 117 |
.SH "SEE ALSO" |
| 118 |
.PP |
| 119 |
\fBsystemd\fR(1), \fBhomed.conf\fR(5), \fBhomectl\fR(1), \fBpam_systemd_home\fR(8), \fBuserdbctl\fR(1), \fBorg.freedesktop.home1\fR(5) |
| 120 |
.SH "NOTES" |
| 121 |
.IP " 1." 4 |
| 122 |
Home Directories |
| 123 |
.RS 4 |
| 124 |
\%https://systemd.io/HOME_DIRECTORY |
| 125 |
.RE |
| 126 |
.IP " 2." 4 |
| 127 |
User/Group Record Lookup API via Varlink |
| 128 |
.RS 4 |
| 129 |
\%https://systemd.io/USER_GROUP_API |
| 130 |
.RE |
| 131 |
.IP " 3." 4 |
| 132 |
User Record Blob Directories |
| 133 |
.RS 4 |
| 134 |
\%https://systemd.io/USER_RECORD_BLOB_DIRS |
| 135 |
.RE |