systemd.system-credentialssystemdsystemd.system-credentials7systemd.system-credentialsSystem CredentialsDescriptionSystem and Service Credentials 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.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.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.Well known system credentialsfirstboot.keymapThe console key mapping to set (e.g. de). Read by
systemd-firstboot1,
and only honoured if no console keymap has been configured before.firstboot.localefirstboot.locale-messagesThe system locale to set (e.g. de_DE.UTF-8). Read by
systemd-firstboot1,
and only honoured if no locale has been configured before. firstboot.locale sets
LANG, while firstboot.locale-message sets
LC_MESSAGES.firstboot.timezoneThe system timezone to set (e.g. Europe/Berlin). Read by
systemd-firstboot1,
and only honoured if no system timezone has been configured before.login.issueThe data of this credential is written to
/etc/issue.d/50-provision.conf, if the file does not exist yet.
agetty8
reads this file and shows its contents at the login prompt of terminal logins. See
issue5
for details.Consumed by /usr/lib/tmpfiles.d/provision.conf, see
tmpfiles.d5.login.motdThe data of this credential is written to /etc/motd.d/50-provision.conf,
if the file does not exist yet.
pam_motd8
reads this file and shows its contents as "message of the day" during terminal logins. See
motd5
for details.Consumed by /usr/lib/tmpfiles.d/provision.conf, see
tmpfiles.d5.network.hostsThe data of this credential is written to /etc/hosts, if the file
does not exist yet. See
hosts5
for details.Consumed by /usr/lib/tmpfiles.d/provision.conf, see
tmpfiles.d5.network.dnsnetwork.search_domainsDNS server information and search domains. Read by
systemd-resolved.service8.network.conf.*network.link.*network.netdev.*network.network.*Configures network devices. Read by
systemd-network-generator.service8.
These credentials should contain valid
networkd.conf5,
systemd.link5,
systemd.netdev5,
systemd.network5
configuration data. From each matching credential a separate file is created. Example: the contents
of a credential network.link.50-foobar will be copied into a file
50-foobar.link.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
systemd-networkd.service, e.g. network.wireguard.*
as described below.network.wireguard.*Configures secrets for WireGuard netdevs. Read by
systemd-networkd.service8.
For more information, refer to the section of
systemd.netdev5.
passwd.hashed-password.rootpasswd.plaintext-password.rootMay contain the password (either in UNIX hashed format, or in plaintext) for the root users.
Read by both
systemd-firstboot1
and
systemd-sysusers8,
and only honoured if no root password has been configured before.passwd.shell.rootThe path to the shell program (e.g. /bin/bash) for the root user. Read by
both
systemd-firstboot1
and
systemd-sysusers8,
and only honoured if no root shell has been configured before.ssh.ephemeral-authorized_keys-allProvides additional public keys, given in the customary authorized_keys
format, for all users, for incoming connections via the generated AF_VSOCK
and AF_UNIX socket units.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.Consumed by
systemd-ssh-generator8.ssh.authorized_keys.rootThe data of this credential is written to /root/.ssh/authorized_keys, if
the file does not exist yet. This allows provisioning SSH access for the system's root user.Consumed by /usr/lib/tmpfiles.d/provision.conf, see
tmpfiles.d5.ssh.listenMay be used to configure SSH sockets the system shall be reachable on. See
systemd-ssh-generator8
for details.sysusers.extraAdditional
sysusers.d5
lines to process during boot.sysctl.extraAdditional
sysctl.d5 lines
to process during boot.tmpfiles.extraAdditional
tmpfiles.d5
lines to process during boot.fstab.extraAdditional mounts to establish at boot. For details, see
systemd-fstab-generator8.vconsole.keymapvconsole.keymap_togglevconsole.fontvconsole.font_mapvconsole.font_unimapConsole settings to apply, see
systemd-vconsole-setup.service8 for details.getty.autoUsed for controlling the execution mode of systemd-getty-generator. See
systemd-getty-generator8 for details.getty.ttys.serialgetty.ttys.containerUsed for spawning additional login prompts, see
systemd-getty-generator8 for details.journal.forward_to_socketUsed by
systemd-journald8
to determine where to forward log messages for socket forwarding, see
journald.conf5 for details.journal.storageUsed by
systemd-journald8
to determine where to store journal files, see
journald.conf5 for details.vmm.notify_socketConfigures an
sd_notify3
compatible AF_VSOCK socket the service manager will report status information,
ready notification and exit status on. For details see
systemd1.shell.prompt.prefixshell.prompt.suffixDefines strings to prefix and suffix any interactive UNIX shell prompt with. For details see
pam_systemd8.shell.welcomeDefine a string to print when an interactive UNIX shell initializes. For details see
pam_systemd8.system.machine_idTakes 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
systemd1.system.hostnameAccepts a (transient) hostname to configure during early boot. The static hostname specified
in /etc/hostname, if configured, takes precedence over this setting.
Interpreted by the service manager (PID 1). For details see
systemd1.home.add-signing-key.*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 homectl get-signing-key. 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 .public suffix). For details see
homectl1.home.create.*Creates a new home area for the specified user with the user record data passed in. For
details see
homectl1.home.register.*Registers an existing home area for the specified user with the user record data passed in. For details
see
homectl1.cryptsetup.passphrasecryptsetup.tpm2-pincryptsetup.fido2-pincryptsetup.pkcs11-pincryptsetup.luks2-pinSpecifies the passphrase/PINs to use for unlock encrypted storage volumes. For details see
systemd-cryptsetup8.systemd.extra-unit.*systemd.unit-dropin.*These credentials specify extra units and drop-ins to add to the system. For details
see systemd-debug-generator8.udev.conf.*udev.rules.*Configures udev configuration file and udev rules. Read by
systemd-udev-load-credentials.service, which invokes
udevadm control --load-credentials. These credentials directly translate to a
matching
udev.conf5 or
udev7 rules
file. Example: the contents of a credential
udev.conf.50-foobar will be copied into a file
/run/udev/udev.conf.d/50-foobar.conf, and
udev.rules.50-foobar will be copied into a file
/run/udev/rules.d/50-foobar.rules. See
udev7,
udev.conf5, and
udevadm8
for details.import.pullSpecified disk images (tarballs and DDIs) to automatically download and install at boot. For details see
systemd-import-generator8.userdb.user.*userdb.group.*userdb.transient.user.*userdb.transient.group.*Configure JSON user and group records. Read by
systemd-userdb-load-credentials.service, which invokes
userdbctl load-credentials. These credentials directly translate to
matching
JSON User and
JSON Group records. Example: the contents of a
credential userdb.user.foobar will be copied into a file
/etc/userdb/foobar.user, and
userdb.group.foobar will be copied into a file
/etc/userdb/foobar.group. Symlinks for the uid/gid will also be created in
/etc/userdb/, as well as the corresponding.membership
files. See
systemd-userdbd.service7,
nss-systemd8, and
userdbctl1
for details.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
userdb.user.foobar the suffix is foobar) must match the user
or group name field from the user or group record.Note that the records created for userdb.user.* and
userdb.group.* credentials are created in /etc/userdb/ and
the records created for userdb.transient.user.* and
userdb.transient.group.* are created in /run/userdb/
(/etc/passwd and /etc/group are not modified).fsck.*Read by systemd-fsck@.service,
systemd-fsck-root.service, and systemd-fsck-usr.service.
See
systemd-fsck@.service8
for more details.quotacheck.*Read by systemd-quotacheck@.service and
systemd-quotacheck-root.service. See
systemd-quotacheck8
for more details.See Alsosystemd1kernel-command-line7smbios-type-117