man/systemd.system-credentials.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd.system-credentials">
   7
   8   <refentryinfo>
   9     <title>systemd.system-credentials</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd.system-credentials</refentrytitle>
  15     <manvolnum>7</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd.system-credentials</refname>
  20     <refpurpose>System Credentials</refpurpose>
  21   </refnamediv>
  22
  23   <refsect1>
  24     <title>Description</title>
  25
  26     <para><ulink url="https://systemd.io/CREDENTIALS">System and Service Credentials</ulink> are data objects
  27     that may be passed into booted systems or system services as they are invoked. They can be acquired from
  28     various external sources, and propagated into the system and from there into system services. Credentials
  29     may optionally be encrypted with a machine-specific key and/or locked to the local TPM2 device, and are
  30     only decrypted when the consuming service is invoked.</para>
  31
  32     <para>System credentials may be used to provision and configure various aspects of the system. Depending
  33     on the consuming component credentials are only used on initial invocations or are needed for all
  34     invocations.</para>
  35
  36     <para>Credentials may be used for any kind of data, binary or text, and may carry passwords, secrets,
  37     certificates, cryptographic key material, identity information, configuration, and more.</para>
  38   </refsect1>
  39
  40   <refsect1>
  41     <title>Well known system credentials</title>
  42
  43     <variablelist>
  44       <varlistentry>
  45         <term><varname>firstboot.keymap</varname></term>
  46         <listitem>
  47           <para>The console key mapping to set (e.g. <literal>de</literal>).  Read by
  48           <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  49           and only honoured if no console keymap has been configured before.</para>
  50         </listitem>
  51       </varlistentry>
  52
  53       <varlistentry>
  54         <term><varname>firstboot.locale</varname></term>
  55         <term><varname>firstboot.locale-message</varname></term>
  56         <listitem>
  57           <para>The system locale to set (e.g. <literal>de_DE.UTF-8</literal>). Read by
  58           <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  59           and only honoured if no locale has been configured before. <varname>firstboot.locale</varname> sets
  60           <literal>LANG</literal>, while <varname>firstboot.locale-message</varname> sets
  61           <literal>LC_MESSAGES</literal>.</para>
  62         </listitem>
  63       </varlistentry>
  64
  65       <varlistentry>
  66         <term><varname>firstboot.timezone</varname></term>
  67         <listitem>
  68           <para>The system timezone to set (e.g. <literal>Europe/Berlin</literal>).  Read by
  69           <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  70           and only honoured if no system timezone has been configured before.</para>
  71         </listitem>
  72       </varlistentry>
  73
  74       <varlistentry>
  75         <term><varname>login.issue</varname></term>
  76         <listitem>
  77           <para>The data of this credential is written to
  78           <filename>/etc/issue.d/50-provision.conf</filename>, if the file doesn't exist
  79           yet. <citerefentry><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  80           reads this file and shows its contents at the login prompt of terminal logins. See <citerefentry
  81           project='man-pages'><refentrytitle>issue</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
  82           details.</para>
  83
  84           <para>Consumed by <filename>/usr/lib/tmpfiles.d/provision.conf</filename>, see
  85           <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  86         </listitem>
  87       </varlistentry>
  88
  89       <varlistentry>
  90         <term><varname>login.motd</varname></term>
  91         <listitem>
  92           <para>The data of this credential is written to <filename>/etc/motd.d/50-provision.conf</filename>,
  93           if the file doesn't exist
  94           yet. <citerefentry><refentrytitle>pam_motd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  95           reads this file and shows its contents as "message of the day" during terminal logins. See
  96           <citerefentry
  97           project='man-pages'><refentrytitle>motd</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
  98           details.</para>
  99
 100           <para>Consumed by <filename>/usr/lib/tmpfiles.d/provision.conf</filename>, see
 101           <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><varname>network.hosts</varname></term>
 107         <listitem>
 108           <para>The data of this credential is written to <filename>/etc/hosts</filename>, if the file
 109           doesn't exist yet. See <citerefentry
 110           project='man-pages'><refentrytitle>hosts</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
 111           details.</para>
 112
 113           <para>Consumed by <filename>/usr/lib/tmpfiles.d/provision.conf</filename>, see
 114           <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 115         </listitem>
 116       </varlistentry>
 117
 118       <varlistentry>
 119         <term><varname>network.dns</varname></term>
 120         <term><varname>network.search_domains</varname></term>
 121         <listitem>
 122           <para>DNS server information and search domains. Read by
 123           <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 124         </listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term><varname>passwd.hashed-password.root</varname></term>
 129         <term><varname>passwd.plaintext-password.root</varname></term>
 130         <listitem>
 131           <para>May contain the password (either in UNIX hashed format, or in plaintext) for the root users.
 132           Read by both
 133           <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 134           and
 135           <citerefentry><refentrytitle>systemd-sysusers</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 136           and only honoured if no root password has been configured before.</para>
 137         </listitem>
 138       </varlistentry>
 139
 140       <varlistentry>
 141         <term><varname>passwd.shell.root</varname></term>
 142         <listitem>
 143           <para>The path to the shell program (e.g. <literal>/bin/bash</literal>) for the root user.  Read by
 144           both
 145           <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 146           and
 147           <citerefentry><refentrytitle>systemd-sysusers</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 148           and only honoured if no root shell has been configured before.</para>
 149         </listitem>
 150       </varlistentry>
 151
 152       <varlistentry>
 153         <term><varname>ssh.authorized_keys.root</varname></term>
 154         <listitem>
 155           <para>The data of this credential is written to <filename>/root/.ssh/authorized_keys</filename>, if
 156           the file doesn't exist yet. This allows provisioning SSH access for the system's root user.</para>
 157
 158           <para>Consumed by <filename>/usr/lib/tmpfiles.d/provision.conf</filename>, see
 159           <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 160         </listitem>
 161       </varlistentry>
 162
 163       <varlistentry>
 164         <term><varname>sysusers.extra</varname></term>
 165         <listitem>
 166           <para>Additional
 167           <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 168           lines to process during boot.</para>
 169         </listitem>
 170       </varlistentry>
 171
 172       <varlistentry>
 173         <term><varname>sysctl.extra</varname></term>
 174         <listitem>
 175           <para>Additional
 176           <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> lines
 177           to process during boot.</para>
 178         </listitem>
 179       </varlistentry>
 180
 181       <varlistentry>
 182         <term><varname>tmpfiles.extra</varname></term>
 183         <listitem>
 184           <para>Additional
 185           <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 186           lines to process during boot.</para>
 187         </listitem>
 188       </varlistentry>
 189
 190       <varlistentry>
 191         <term><varname>vconsole.keymap</varname></term>
 192         <term><varname>vconsole.keymap_toggle</varname></term>
 193         <term><varname>vconsole.font</varname></term>
 194         <term><varname>vconsole.font_map</varname></term>
 195         <term><varname>vconsole.font_unimap</varname></term>
 196         <listitem>
 197           <para>Console settings to apply, see
 198           <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details.</para>
 199         </listitem>
 200       </varlistentry>
 201
 202       <varlistentry>
 203         <term><varname>vmm.notify_socket</varname></term>
 204         <listitem>
 205           <para>This credential is parsed looking for an <constant>AF_VSOCK</constant> or
 206           <constant>AF_UNIX</constant> address where to send a <constant>READY=1</constant>
 207           notification datagram when the system has finished booting. See:
 208           <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 209           This is useful for hypervisors/VMMs or other processes on the host
 210           to receive a notification via VSOCK when a virtual machine has finished booting.
 211           Note that in case the hypervisor does not support <constant>SOCK_DGRAM</constant>
 212           over <constant>AF_VSOCK</constant>, <constant>SOCK_SEQPACKET</constant> will be
 213           tried instead. The credential payload for <constant>AF_VSOCK</constant> should be
 214           in the form: <literal>vsock:CID:PORT</literal>, where <literal>CID</literal> is
 215           optional and if omitted will default to talking to the hypervisor
 216           (<constant>0</constant>).</para>
 217         </listitem>
 218       </varlistentry>
 219
 220     </variablelist>
 221   </refsect1>
 222
 223   <refsect1>
 224       <title>See Also</title>
 225       <para>
 226         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 227         <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 228       </para>
 229   </refsect1>
 230
 231 </refentry>