Debian Codegraph @

upstream/mageia-cauldron/man7/systemd.system-credentials.7

raw
1 '\" t
2 .TH "SYSTEMD\&.SYSTEM\-CREDENTIALS" "7" "" "systemd 258.7" "systemd.system-credentials"
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.system-credentials \- System Credentials
24 .SH "DESCRIPTION"
25 .PP
26 \m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[1]\d\s+2
27 are data objects that may be passed into booted systems or system services as they are invoked\&. They can be acquired from various external sources, and propagated into the system and from there into system services\&. Credentials may optionally be encrypted with a machine\-specific key and/or locked to the local TPM2 device, and are only decrypted when the consuming service is invoked\&.
28 .PP
29 System credentials may be used to provision and configure various aspects of the system\&. Depending on the consuming component credentials are only used on initial invocations or are needed for all invocations\&.
30 .PP
31 Credentials may be used for any kind of data, binary or text, and may carry passwords, secrets, certificates, cryptographic key material, identity information, configuration, and more\&.
32 .SH "WELL KNOWN SYSTEM CREDENTIALS"
33 .PP
34 \fIfirstboot\&.keymap\fR
35 .RS 4
36 The console key mapping to set (e\&.g\&.
37 "de")\&. Read by
38 \fBsystemd-firstboot\fR(1), and only honoured if no console keymap has been configured before\&.
39 .sp
40 Added in version 252\&.
41 .RE
42 .PP
43 \fIfirstboot\&.locale\fR, \fIfirstboot\&.locale\-messages\fR
44 .RS 4
45 The system locale to set (e\&.g\&.
46 "de_DE\&.UTF\-8")\&. Read by
47 \fBsystemd-firstboot\fR(1), and only honoured if no locale has been configured before\&.
48 \fIfirstboot\&.locale\fR
49 sets
50 "LANG", while
51 \fIfirstboot\&.locale\-message\fR
52 sets
53 "LC_MESSAGES"\&.
54 .sp
55 Added in version 252\&.
56 .RE
57 .PP
58 \fIfirstboot\&.timezone\fR
59 .RS 4
60 The system timezone to set (e\&.g\&.
61 "Europe/Berlin")\&. Read by
62 \fBsystemd-firstboot\fR(1), and only honoured if no system timezone has been configured before\&.
63 .sp
64 Added in version 252\&.
65 .RE
66 .PP
67 \fIlogin\&.issue\fR
68 .RS 4
69 The data of this credential is written to
70 /etc/issue\&.d/50\-provision\&.conf, if the file does not exist yet\&.
71 \fBagetty\fR(8)
72 reads this file and shows its contents at the login prompt of terminal logins\&. See
73 \fBissue\fR(5)
74 for details\&.
75 .sp
76 Consumed by
77 /usr/lib/tmpfiles\&.d/provision\&.conf, see
78 \fBtmpfiles.d\fR(5)\&.
79 .sp
80 Added in version 252\&.
81 .RE
82 .PP
83 \fIlogin\&.motd\fR
84 .RS 4
85 The data of this credential is written to
86 /etc/motd\&.d/50\-provision\&.conf, if the file does not exist yet\&.
87 \fBpam_motd\fR(8)
88 reads this file and shows its contents as "message of the day" during terminal logins\&. See
89 \fBmotd\fR(5)
90 for details\&.
91 .sp
92 Consumed by
93 /usr/lib/tmpfiles\&.d/provision\&.conf, see
94 \fBtmpfiles.d\fR(5)\&.
95 .sp
96 Added in version 252\&.
97 .RE
98 .PP
99 \fInetwork\&.hosts\fR
100 .RS 4
101 The data of this credential is written to
102 /etc/hosts, if the file does not exist yet\&. See
103 \fBhosts\fR(5)
104 for details\&.
105 .sp
106 Consumed by
107 /usr/lib/tmpfiles\&.d/provision\&.conf, see
108 \fBtmpfiles.d\fR(5)\&.
109 .sp
110 Added in version 252\&.
111 .RE
112 .PP
113 \fInetwork\&.dns\fR, \fInetwork\&.search_domains\fR
114 .RS 4
115 DNS server information and search domains\&. Read by
116 \fBsystemd-resolved.service\fR(8)\&.
117 .sp
118 Added in version 253\&.
119 .RE
120 .PP
121 \fInetwork\&.conf\&.*\fR, \fInetwork\&.link\&.*\fR, \fInetwork\&.netdev\&.*\fR, \fInetwork\&.network\&.*\fR
122 .RS 4
123 Configures network devices\&. Read by
124 \fBsystemd-network-generator.service\fR(8)\&. These credentials should contain valid
125 \fBnetworkd.conf\fR(5),
126 \fBsystemd.link\fR(5),
127 \fBsystemd.netdev\fR(5),
128 \fBsystemd.network\fR(5)
129 configuration data\&. From each matching credential a separate file is created\&. Example: the contents of a credential
130 network\&.link\&.50\-foobar
131 will be copied into a file
132 50\-foobar\&.link\&.
133 .sp
134 Note that the resulting files are created world\-readable, it is hence recommended to not include secrets in these credentials, but supply them via separate credentials directly to
135 systemd\-networkd\&.service, e\&.g\&.
136 \fInetwork\&.wireguard\&.*\fR
137 as described below\&.
138 .sp
139 Added in version 256\&.
140 .RE
141 .PP
142 \fInetwork\&.wireguard\&.*\fR
143 .RS 4
144 Configures secrets for WireGuard netdevs\&. Read by
145 \fBsystemd-networkd.service\fR(8)\&. For more information, refer to the
146 \fB[WireGuard]\fR
147 section of
148 \fBsystemd.netdev\fR(5)\&.
149 .sp
150 Added in version 256\&.
151 .RE
152 .PP
153 \fIpasswd\&.hashed\-password\&.root\fR, \fIpasswd\&.plaintext\-password\&.root\fR
154 .RS 4
155 May contain the password (either in UNIX hashed format, or in plaintext) for the root users\&. Read by both
156 \fBsystemd-firstboot\fR(1)
157 and
158 \fBsystemd-sysusers\fR(8), and only honoured if no root password has been configured before\&.
159 .sp
160 Added in version 252\&.
161 .RE
162 .PP
163 \fIpasswd\&.shell\&.root\fR
164 .RS 4
165 The path to the shell program (e\&.g\&.
166 "/bin/bash") for the root user\&. Read by both
167 \fBsystemd-firstboot\fR(1)
168 and
169 \fBsystemd-sysusers\fR(8), and only honoured if no root shell has been configured before\&.
170 .sp
171 Added in version 252\&.
172 .RE
173 .PP
174 \fIssh\&.ephemeral\-authorized_keys\-all\fR
175 .RS 4
176 Provides additional public keys, given in the customary
177 authorized_keys
178 format, for all users, for incoming connections via the generated
179 \fBAF_VSOCK\fR
180 and
181 \fBAF_UNIX\fR
182 socket units\&.
183 .sp
184 The intended use of this is for a host system (in either VM or container configurations) to generate a keypair and inject the public key into the guest, using the private key to connect to any user account on the guest via ssh, without further authentication\&.
185 .sp
186 Consumed by
187 \fBsystemd-ssh-generator\fR(8)\&.
188 .sp
189 Added in version 256\&.
190 .RE
191 .PP
192 \fIssh\&.authorized_keys\&.root\fR
193 .RS 4
194 The data of this credential is written to
195 /root/\&.ssh/authorized_keys, if the file does not exist yet\&. This allows provisioning SSH access for the system\*(Aqs root user\&.
196 .sp
197 Consumed by
198 /usr/lib/tmpfiles\&.d/provision\&.conf, see
199 \fBtmpfiles.d\fR(5)\&.
200 .sp
201 Added in version 252\&.
202 .RE
203 .PP
204 \fIssh\&.listen\fR
205 .RS 4
206 May be used to configure SSH sockets the system shall be reachable on\&. See
207 \fBsystemd-ssh-generator\fR(8)
208 for details\&.
209 .sp
210 Added in version 256\&.
211 .RE
212 .PP
213 \fIsysusers\&.extra\fR
214 .RS 4
215 Additional
216 \fBsysusers.d\fR(5)
217 lines to process during boot\&.
218 .sp
219 Added in version 252\&.
220 .RE
221 .PP
222 \fIsysctl\&.extra\fR
223 .RS 4
224 Additional
225 \fBsysctl.d\fR(5)
226 lines to process during boot\&.
227 .sp
228 Added in version 252\&.
229 .RE
230 .PP
231 \fItmpfiles\&.extra\fR
232 .RS 4
233 Additional
234 \fBtmpfiles.d\fR(5)
235 lines to process during boot\&.
236 .sp
237 Added in version 252\&.
238 .RE
239 .PP
240 \fIfstab\&.extra\fR
241 .RS 4
242 Additional mounts to establish at boot\&. For details, see
243 \fBsystemd-fstab-generator\fR(8)\&.
244 .sp
245 Added in version 254\&.
246 .RE
247 .PP
248 \fIvconsole\&.keymap\fR, \fIvconsole\&.keymap_toggle\fR, \fIvconsole\&.font\fR, \fIvconsole\&.font_map\fR, \fIvconsole\&.font_unimap\fR
249 .RS 4
250 Console settings to apply, see
251 \fBsystemd-vconsole-setup.service\fR(8)
252 for details\&.
253 .sp
254 Added in version 253\&.
255 .RE
256 .PP
257 \fIgetty\&.auto\fR
258 .RS 4
259 Used for controlling the execution mode of
260 systemd\-getty\-generator\&. See
261 \fBsystemd-getty-generator\fR(8)
262 for details\&.
263 .sp
264 Added in version 258\&.
265 .RE
266 .PP
267 \fIgetty\&.ttys\&.serial\fR, \fIgetty\&.ttys\&.container\fR
268 .RS 4
269 Used for spawning additional login prompts, see
270 \fBsystemd-getty-generator\fR(8)
271 for details\&.
272 .sp
273 Added in version 254\&.
274 .RE
275 .PP
276 \fIjournal\&.forward_to_socket\fR
277 .RS 4
278 Used by
279 \fBsystemd-journald\fR(8)
280 to determine where to forward log messages for socket forwarding, see
281 \fBjournald.conf\fR(5)
282 for details\&.
283 .sp
284 Added in version 256\&.
285 .RE
286 .PP
287 \fIjournal\&.storage\fR
288 .RS 4
289 Used by
290 \fBsystemd-journald\fR(8)
291 to determine where to store journal files, see
292 \fBjournald.conf\fR(5)
293 for details\&.
294 .sp
295 Added in version 256\&.
296 .RE
297 .PP
298 \fIvmm\&.notify_socket\fR
299 .RS 4
300 Configures an
301 \fBsd_notify\fR(3)
302 compatible
303 \fBAF_VSOCK\fR
304 socket the service manager will report status information, ready notification and exit status on\&. For details see
305 \fBsystemd\fR(1)\&.
306 .sp
307 Added in version 253\&.
308 .RE
309 .PP
310 \fIshell\&.prompt\&.prefix\fR, \fIshell\&.prompt\&.suffix\fR
311 .RS 4
312 Defines strings to prefix and suffix any interactive UNIX shell prompt with\&. For details see
313 \fBpam_systemd\fR(8)\&.
314 .sp
315 Added in version 257\&.
316 .RE
317 .PP
318 \fIshell\&.welcome\fR
319 .RS 4
320 Define a string to print when an interactive UNIX shell initializes\&. For details see
321 \fBpam_systemd\fR(8)\&.
322 .sp
323 Added in version 257\&.
324 .RE
325 .PP
326 \fIsystem\&.machine_id\fR
327 .RS 4
328 Takes a 128bit ID to initialize the machine ID from (if it is not set yet)\&. Interpreted by the service manager (PID 1)\&. For details see
329 \fBsystemd\fR(1)\&.
330 .sp
331 Added in version 254\&.
332 .RE
333 .PP
334 \fIsystem\&.hostname\fR
335 .RS 4
336 Accepts a (transient) hostname to configure during early boot\&. The static hostname specified in
337 /etc/hostname, if configured, takes precedence over this setting\&. Interpreted by the service manager (PID 1)\&. For details see
338 \fBsystemd\fR(1)\&.
339 .sp
340 Added in version 254\&.
341 .RE
342 .PP
343 \fIhome\&.add\-signing\-key\&.*\fR
344 .RS 4
345 Adds a new signing key for user records to the system\&. The credential contents should contain a user signing key, for example as reported by
346 \fBhomectl get\-signing\-key\fR\&. Multiple keys may be specified, and they will be put in place under the name of the credential name suffix (which must itself carry the
347 \&.public
348 suffix)\&. For details see
349 \fBhomectl\fR(1)\&.
350 .sp
351 Added in version 258\&.
352 .RE
353 .PP
354 \fIhome\&.create\&.*\fR
355 .RS 4
356 Creates a new home area for the specified user with the user record data passed in\&. For details see
357 \fBhomectl\fR(1)\&.
358 .sp
359 Added in version 256\&.
360 .RE
361 .PP
362 \fIhome\&.register\&.*\fR
363 .RS 4
364 Registers an existing home area for the specified user with the user record data passed in\&. For details see
365 \fBhomectl\fR(1)\&.
366 .sp
367 Added in version 258\&.
368 .RE
369 .PP
370 \fIcryptsetup\&.passphrase\fR, \fIcryptsetup\&.tpm2\-pin\fR, \fIcryptsetup\&.fido2\-pin\fR, \fIcryptsetup\&.pkcs11\-pin\fR, \fIcryptsetup\&.luks2\-pin\fR
371 .RS 4
372 Specifies the passphrase/PINs to use for unlock encrypted storage volumes\&. For details see
373 \fBsystemd-cryptsetup\fR(8)\&.
374 .sp
375 Added in version 256\&.
376 .RE
377 .PP
378 \fIsystemd\&.extra\-unit\&.*\fR, \fIsystemd\&.unit\-dropin\&.*\fR
379 .RS 4
380 These credentials specify extra units and drop\-ins to add to the system\&. For details see
381 \fBsystemd-debug-generator\fR(8)\&.
382 .sp
383 Added in version 256\&.
384 .RE
385 .PP
386 \fIudev\&.conf\&.*\fR, \fIudev\&.rules\&.*\fR
387 .RS 4
388 Configures udev configuration file and udev rules\&. Read by
389 systemd\-udev\-load\-credentials\&.service, which invokes
390 \fBudevadm control \-\-load\-credentials\fR\&. These credentials directly translate to a matching
391 \fBudev.conf\fR(5)
392 or
393 \fBudev\fR(7)
394 rules file\&. Example: the contents of a credential
395 udev\&.conf\&.50\-foobar
396 will be copied into a file
397 /run/udev/udev\&.conf\&.d/50\-foobar\&.conf, and
398 udev\&.rules\&.50\-foobar
399 will be copied into a file
400 /run/udev/rules\&.d/50\-foobar\&.rules\&. See
401 \fBudev\fR(7),
402 \fBudev.conf\fR(5), and
403 \fBudevadm\fR(8)
404 for details\&.
405 .sp
406 Added in version 256\&.
407 .RE
408 .PP
409 \fIimport\&.pull\fR
410 .RS 4
411 Specified disk images (tarballs and DDIs) to automatically download and install at boot\&. For details see
412 \fBsystemd-import-generator\fR(8)\&.
413 .sp
414 Added in version 257\&.
415 .RE
416 .PP
417 \fIuserdb\&.user\&.*\fR, \fIuserdb\&.group\&.*\fR, \fIuserdb\&.transient\&.user\&.*\fR, \fIuserdb\&.transient\&.group\&.*\fR
418 .RS 4
419 Configure JSON user and group records\&. Read by
420 systemd\-userdb\-load\-credentials\&.service, which invokes
421 \fBuserdbctl load\-credentials\fR\&. These credentials directly translate to matching
422 \m[blue]\fBJSON User\fR\m[]\&\s-2\u[2]\d\s+2
423 and
424 \m[blue]\fBJSON Group\fR\m[]\&\s-2\u[3]\d\s+2
425 records\&. Example: the contents of a credential
426 userdb\&.user\&.foobar
427 will be copied into a file
428 /etc/userdb/foobar\&.user, and
429 userdb\&.group\&.foobar
430 will be copied into a file
431 /etc/userdb/foobar\&.group\&. Symlinks for the uid/gid will also be created in
432 /etc/userdb/, as well as the corresponding\&.membership
433 files\&. See
434 \fBsystemd-userdbd.service\fR(7),
435 \fBnss-systemd\fR(8), and
436 \fBuserdbctl\fR(1)
437 for details\&.
438 .sp
439 Any passed user records must contain uid and gid fields\&. Any passed group records must contain a gid field\&. For both user and group records, the credential suffix (for
440 "userdb\&.user\&.foobar"
441 the suffix is
442 "foobar") must match the user or group name field from the user or group record\&.
443 .sp
444 Note that the records created for
445 \fIuserdb\&.user\&.*\fR
446 and
447 \fIuserdb\&.group\&.*\fR
448 credentials are created in
449 /etc/userdb/
450 and the records created for
451 \fIuserdb\&.transient\&.user\&.*\fR
452 and
453 \fIuserdb\&.transient\&.group\&.*\fR
454 are created in
455 /run/userdb/
456 (/etc/passwd
457 and
458 /etc/group
459 are not modified)\&.
460 .sp
461 Added in version 258\&.
462 .RE
463 .PP
464 \fIfsck\&.*\fR
465 .RS 4
466 Read by
467 systemd\-fsck@\&.service,
468 systemd\-fsck\-root\&.service, and
469 systemd\-fsck\-usr\&.service\&. See
470 \[email protected]\fR(8)
471 for more details\&.
472 .sp
473 Added in version 258\&.
474 .RE
475 .PP
476 \fIquotacheck\&.*\fR
477 .RS 4
478 Read by
479 systemd\-quotacheck@\&.service
480 and
481 systemd\-quotacheck\-root\&.service\&. See
482 \fBsystemd-quotacheck\fR(8)
483 for more details\&.
484 .sp
485 Added in version 258\&.
486 .RE
487 .SH "SEE ALSO"
488 .PP
489 \fBsystemd\fR(1), \fBkernel-command-line\fR(7), \fBsmbios-type-11\fR(7)
490 .SH "NOTES"
491 .IP " 1." 4
492 System and Service Credentials
493 .RS 4
494 \%https://systemd.io/CREDENTIALS
495 .RE
496 .IP " 2." 4
497 JSON User
498 .RS 4
499 \%https://systemd.io/USER_RECORD
500 .RE
501 .IP " 3." 4
502 JSON Group
503 .RS 4
504 \%https://systemd.io/GROUP_RECORD
505 .RE