path: root/upstream/fedora-40/man1/systemd-creds.1

'\" t
.TH "SYSTEMD\-CREDS" "1" "" "systemd 255" "systemd-creds"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
systemd-creds \- Lists, shows, encrypts and decrypts service credentials
.SH "SYNOPSIS"
.HP \w'\fBsystemd\-creds\fR\ 'u
\fBsystemd\-creds\fR [OPTIONS...] COMMAND [ARGS...]
.SH "DESCRIPTION"
.PP
\fBsystemd\-creds\fR
is a tool for listing, showing, encrypting and decrypting unit credentials\&. Credentials are limited\-size binary or textual objects that may be passed to unit processes\&. They are primarily used for passing cryptographic keys (both public and private) or certificates, user account information or identity information from the host to services\&.
.PP
Credentials are configured in unit files via the
\fIImportCredential=\fR,
\fILoadCredential=\fR,
\fISetCredential=\fR,
\fILoadCredentialEncrypted=\fR, and
\fISetCredentialEncrypted=\fR
settings, see
\fBsystemd.exec\fR(5)
for details\&.
.PP
For further information see
\m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[1]\d\s+2
documentation\&.
.SH "COMMANDS"
.PP
The following commands are understood:
.PP
\fBlist\fR
.RS 4
Show a list of credentials passed into the current execution context\&. This command shows the files in the directory referenced by the
\fI$CREDENTIALS_DIRECTORY\fR
environment variable, and is intended to be executed from within service context\&.
.sp
Along with each credential name, the size and security state is shown\&. The latter is one of
"secure"
(in case the credential is backed by unswappable memory, i\&.e\&.
"ramfs"),
"weak"
(in case it is backed by any other type of memory), or
"insecure"
(if having any access mode that is not 0400, i\&.e\&. if readable by anyone but the owner)\&.
.sp
Added in version 250\&.
.RE
.PP
\fBcat\fR \fIcredential\&.\&.\&.\fR
.RS 4
Show contents of specified credentials passed into the current execution context\&. Takes one or more credential names, whose contents shall be written to standard output\&.
.sp
When combined with
\fB\-\-json=\fR
or
\fB\-\-transcode=\fR
the output is transcoded in simple ways before outputting\&.
.sp
Added in version 250\&.
.RE
.PP
\fBsetup\fR
.RS 4
Generates a host encryption key for credentials, if one has not been generated already\&. This ensures the
/var/lib/systemd/credential\&.secret
file is initialized with a random secret key if it doesn\*(Aqt exist yet\&. This secret key is used when encrypting/decrypting credentials with
\fBencrypt\fR
or
\fBdecrypt\fR, and is only accessible to the root user\&. Note that there\*(Aqs typically no need to invoke this command explicitly as it is implicitly called when
\fBencrypt\fR
is invoked, and credential host key encryption selected\&.
.sp
Added in version 250\&.
.RE
.PP
\fBencrypt\fR \fIinput|\-\fR \fIoutput|\-\fR
.RS 4
Loads the specified (unencrypted plaintext) input credential file, encrypts it and writes the (encrypted ciphertext) output to the specified target credential file\&. The resulting file may be referenced in the
\fILoadCredentialEncrypted=\fR
setting in unit files, or its contents used literally in
\fISetCredentialEncrypted=\fR
settings\&.
.sp
Takes two file system paths\&. The file name part of the output path is embedded as name in the encrypted credential, to ensure encrypted credentials cannot be renamed and reused for different purposes without this being noticed\&. The credential name to embed may be overridden with the
\fB\-\-name=\fR
setting\&. The input or output paths may be specified as
"\-", in which case the credential data is read from/written to standard input and standard output\&. If the output path is specified as
"\-"
the credential name cannot be derived from the file system path, and thus should be specified explicitly via the
\fB\-\-name=\fR
switch\&.
.sp
The credential data is encrypted and authenticated symmetrically with one of the following encryption keys:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
A secret key automatically derived from the system\*(Aqs TPM2 chip\&. This encryption key is not stored on the host system and thus decryption is only possible with access to the original TPM2 chip\&. Or in other words, the credential secured in this way can only be decrypted again by the local machine\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
A secret key stored in the
/var/lib/systemd/credential\&.secret
file which is only accessible to the root user\&. This "host" encryption key is stored on the host file system, and thus decryption is possible with access to the host file system and sufficient privileges\&. The key is automatically generated when needed, but can also be created explicitly with the
\fBsetup\fR
command, see above\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
A combination of the above: an encryption key derived from both the TPM2 chip and the host file system\&. This means decryption requires both access to the original TPM2 chip and the OS installation\&. This is the default mode of operation if a TPM2 chip is available and
/var/lib/systemd/
resides on persistent media\&.
.RE
.sp
Which of the three keys shall be used for encryption may be configured with the
\fB\-\-with\-key=\fR
switch\&. Depending on the use\-case for the encrypted credential the key to use may differ\&. For example, for credentials that shall be accessible from the initrd, encryption with the host key is not appropriate, since access to the host key is typically not available from the initrd\&. Thus, for such credentials only the TPM2 key should be used\&.
.sp
Encrypted credentials are always encoded in Base64\&.
.sp
Use
\fBdecrypt\fR
(see below) to undo the encryption operation, and acquire the decrypted plaintext credential from the encrypted ciphertext credential\&.
.sp
The credential data is encrypted using AES256\-GCM, i\&.e\&. providing both confidentiality and integrity, keyed by a SHA256 hash of one or both of the secret keys described above\&.
.sp
Added in version 250\&.
.RE
.PP
\fBdecrypt\fR \fIinput|\-\fR [\fIoutput|\-\fR]
.RS 4
Undoes the effect of the
\fBencrypt\fR
operation: loads the specified (encrypted ciphertext) input credential file, decrypts and authenticates it and writes the (decrypted plaintext) output to the specified target credential file\&.
.sp
Takes one or two file system paths\&. The file name part of the input path is compared with the credential name embedded in the encrypted file\&. If it does not match decryption fails\&. This is done in order to ensure that encrypted credentials are not re\-purposed without this being detected\&. The credential name to compare with the embedded credential name may also be overridden with the
\fB\-\-name=\fR
switch\&. If the input path is specified as
"\-", the encrypted credential is read from standard input\&. If only one path is specified or the output path specified as
"\-", the decrypted credential is written to standard output\&. In this mode, the expected name embedded in the credential cannot be derived from the path and should be specified explicitly with
\fB\-\-name=\fR\&.
.sp
Decrypting credentials requires access to the original TPM2 chip and/or credentials host key, see above\&. Information about which keys are required is embedded in the encrypted credential data, and thus decryption is entirely automatic\&.
.sp
Added in version 250\&.
.RE
.PP
\fBhas\-tpm2\fR
.RS 4
Reports whether the system is equipped with a TPM2 device usable for protecting credentials\&. If a TPM2 device has been discovered, is supported, and is being used by firmware, by the OS kernel drivers and by userspace (i\&.e\&. systemd) this prints
"yes"
and exits with exit status zero\&. If no such device is discovered/supported/used, prints
"no"\&. Otherwise prints
"partial"\&. In either of these two cases exits with non\-zero exit status\&. It also shows four lines indicating separately whether firmware, drivers, the system and the kernel discovered/support/use TPM2\&.
.sp
Combine with
\fB\-\-quiet\fR
to suppress the output\&.
.sp
Added in version 251\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print a short help text and exit\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Print a short version string and exit\&.
.RE
.SH "OPTIONS"
.PP
\fB\-\-system\fR
.RS 4
When specified with the
\fBlist\fR
and
\fBcat\fR
commands operates on the credentials passed to system as a whole instead of on those passed to the current execution context\&. This is useful in container environments where credentials may be passed in from the container manager\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-transcode=\fR
.RS 4
When specified with the
\fBcat\fR
or
\fBdecrypt\fR
commands, transcodes the output before showing it\&. Takes one of
"base64",
"unbase64",
"hex"
or
"unhex"
as argument, in order to encode/decode the credential data with Base64 or as series of hexadecimal values\&.
.sp
Note that this has no effect on the
\fBencrypt\fR
command, as encrypted credentials are unconditionally encoded in Base64\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-newline=\fR
.RS 4
When specified with
\fBcat\fR
or
\fBdecrypt\fR
controls whether to add a trailing newline character to the end of the output if it doesn\*(Aqt end in one, anyway\&. Takes one of
"auto",
"yes"
or
"no"\&. The default mode of
"auto"
will suffix the output with a single newline character only when writing credential data to a TTY\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-pretty\fR, \fB\-p\fR
.RS 4
When specified with
\fBencrypt\fR
controls whether to show the encrypted credential as
\fISetCredentialEncrypted=\fR
setting that may be pasted directly into a unit file\&. Has effect only when used together with
\fB\-\-name=\fR
and
"\-"
as the output file\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-name=\fR\fIname\fR
.RS 4
When specified with the
\fBencrypt\fR
command controls the credential name to embed in the encrypted credential data\&. If not specified the name is chosen automatically from the filename component of the specified output path\&. If specified as empty string no credential name is embedded in the encrypted credential, and no verification of credential name is done when the credential is decrypted\&.
.sp
When specified with the
\fBdecrypt\fR
command control the credential name to validate the credential name embedded in the encrypted credential with\&. If not specified the name is chosen automatically from the filename component of the specified input path\&. If no credential name is embedded in the encrypted credential file (i\&.e\&. the
\fB\-\-name=\fR
with an empty string was used when encrypted) the specified name has no effect as no credential name validation is done\&.
.sp
Embedding the credential name in the encrypted credential is done in order to protect against reuse of credentials for purposes they weren\*(Aqt originally intended for, under the assumption the credential name is chosen carefully to encode its intended purpose\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-timestamp=\fR\fItimestamp\fR
.RS 4
When specified with the
\fBencrypt\fR
command controls the timestamp to embed into the encrypted credential\&. Defaults to the current time\&. Takes a timestamp specification in the format described in
\fBsystemd.time\fR(7)\&.
.sp
When specified with the
\fBdecrypt\fR
command controls the timestamp to use to validate the "not\-after" timestamp that was configured with
\fB\-\-not\-after=\fR
during encryption\&. If not specified defaults to the current system time\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-not\-after=\fR\fItimestamp\fR
.RS 4
When specified with the
\fBencrypt\fR
command controls the time when the credential shall not be used anymore\&. This embeds the specified timestamp in the encrypted credential\&. During decryption the timestamp is checked against the current system clock, and if the timestamp is in the past the decryption will fail\&. By default no such timestamp is set\&. Takes a timestamp specification in the format described in
\fBsystemd.time\fR(7)\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-with\-key=\fR, \fB\-H\fR, \fB\-T\fR
.RS 4
When specified with the
\fBencrypt\fR
command controls the encryption/signature key to use\&. Takes one of
"host",
"tpm2",
"host+tpm2",
"tpm2\-absent",
"auto",
"auto\-initrd"\&. See above for details on the three key types\&. If set to
"auto"
(which is the default) the TPM2 key is used if a TPM2 device is found and not running in a container\&. The host key is used if
/var/lib/systemd/
is on persistent media\&. This means on typical systems the encryption is by default bound to both the TPM2 chip and the OS installation, and both need to be available to decrypt the credential again\&. If
"auto"
is selected but neither TPM2 is available (or running in container) nor
/var/lib/systemd/
is on persistent media, encryption will fail\&. If set to
"tpm2\-absent"
a fixed zero length key is used (thus, in this mode no confidentiality nor authenticity are provided!)\&. This logic is useful to cover for systems that lack a TPM2 chip but where credentials shall be generated\&. Note that decryption of such credentials is refused on systems that have a TPM2 chip and where UEFI SecureBoot is enabled (this is done so that such a locked down system cannot be tricked into loading a credential generated this way that lacks authentication information)\&. If set to
"auto\-initrd"
a TPM2 key is used if a TPM2 is found\&. If not a fixed zero length key is used, equivalent to
"tpm2\-absent"
mode\&. This option is particularly useful to generate credentials files that are encrypted/authenticated against TPM2 where available but still work on systems lacking support for this\&.
.sp
The
\fB\-H\fR
switch is a shortcut for
\fB\-\-with\-key=host\fR\&. Similar,
\fB\-T\fR
is a shortcut for
\fB\-\-with\-key=tpm2\fR\&.
.sp
When encrypting credentials that shall be used in the initrd (where
/var/lib/systemd/
is typically not available) make sure to use
\fB\-\-with\-key=auto\-initrd\fR
mode, to disable binding against the host secret\&.
.sp
This switch has no effect on the
\fBdecrypt\fR
command, as information on which key to use for decryption is included in the encrypted credential already\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-tpm2\-device=\fR\fIPATH\fR
.RS 4
Controls the TPM2 device to use\&. Expects a device node path referring to the TPM2 chip (e\&.g\&.
/dev/tpmrm0)\&. Alternatively the special value
"auto"
may be specified, in order to automatically determine the device node of a suitable TPM2 device (of which there must be exactly one)\&. The special value
"list"
may be used to enumerate all suitable TPM2 devices currently discovered\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-tpm2\-pcrs=\fR [PCR...]
.RS 4
Configures the TPM2 PCRs (Platform Configuration Registers) to bind the encryption key to\&. Takes a
"+"
separated list of numeric PCR indexes in the range 0\&...23\&. If not used, defaults to PCR 7 only\&. If an empty string is specified, binds the encryption key to no PCRs at all\&. For details about the PCRs available, see the documentation of the switch of the same name for
\fBsystemd-cryptenroll\fR(1)\&.
.sp
Added in version 250\&.
.RE
.PP
\fB\-\-tpm2\-public\-key=\fR [PATH], \fB\-\-tpm2\-public\-key\-pcrs=\fR [PCR...]
.RS 4
Configures a TPM2 signed PCR policy to bind encryption to, for use with the
\fBencrypt\fR
command\&. The
\fB\-\-tpm2\-public\-key=\fR
option accepts a path to a PEM encoded RSA public key, to bind the encryption to\&. If this is not specified explicitly, but a file
tpm2\-pcr\-public\-key\&.pem
exists in one of the directories
/etc/systemd/,
/run/systemd/,
/usr/lib/systemd/
(searched in this order), it is automatically used\&. The
\fB\-\-tpm2\-public\-key\-pcrs=\fR
option takes a list of TPM2 PCR indexes to bind to (same syntax as
\fB\-\-tpm2\-pcrs=\fR
described above)\&. If not specified defaults to 11 (i\&.e\&. this binds the policy to any unified kernel image for which a PCR signature can be provided)\&.
.sp
Note the difference between
\fB\-\-tpm2\-pcrs=\fR
and
\fB\-\-tpm2\-public\-key\-pcrs=\fR: the former binds decryption to the current, specific PCR values; the latter binds decryption to any set of PCR values for which a signature by the specified public key can be provided\&. The latter is hence more useful in scenarios where software updates shall be possible without losing access to all previously encrypted secrets\&.
.sp
Added in version 252\&.
.RE
.PP
\fB\-\-tpm2\-signature=\fR [PATH]
.RS 4
Takes a path to a TPM2 PCR signature file as generated by the
\fBsystemd-measure\fR(1)
tool and that may be used to allow the
\fBdecrypt\fR
command to decrypt credentials that are bound to specific signed PCR values\&. If this is not specified explicitly, and a credential with a signed PCR policy is attempted to be decrypted, a suitable signature file
tpm2\-pcr\-signature\&.json
is searched for in
/etc/systemd/,
/run/systemd/,
/usr/lib/systemd/
(in this order) and used\&.
.sp
Added in version 252\&.
.RE
.PP
\fB\-\-quiet\fR, \fB\-q\fR
.RS 4
When used with
\fBhas\-tpm2\fR
suppresses the output, and only returns an exit status indicating support for TPM2\&.
.sp
Added in version 251\&.
.RE
.PP
\fB\-\-no\-pager\fR
.RS 4
Do not pipe output into a pager\&.
.RE
.PP
\fB\-\-no\-legend\fR
.RS 4
Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
.RE
.PP
\fB\-\-json=\fR\fIMODE\fR
.RS 4
Shows output formatted as JSON\&. Expects one of
"short"
(for the shortest possible output without any redundant whitespace or line breaks),
"pretty"
(for a pretty version of the same, with indentation and line breaks) or
"off"
(to turn off JSON output, the default)\&.
.RE
.SH "EXIT STATUS"
.PP
On success, 0 is returned\&.
.PP
In case of the
\fBhas\-tpm2\fR
command returns 0 if a TPM2 device is discovered, supported and used by firmware, driver, and userspace (i\&.e\&. systemd)\&. Otherwise returns the OR combination of the value 1 (in case firmware support is missing), 2 (in case driver support is missing) and 4 (in case userspace support is missing)\&. If no TPM2 support is available at all, value 7 is hence returned\&.
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&Encrypt a password for use as credential\fR
.PP
The following command line encrypts the specified password
"hunter2", writing the result to a file
password\&.cred\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# echo \-n hunter2 | systemd\-creds encrypt \- password\&.cred
.fi
.if n \{\
.RE
.\}
.PP
This decrypts the file
password\&.cred
again, revealing the literal password:
.sp
.if n \{\
.RS 4
.\}
.nf
# systemd\-creds decrypt password\&.cred
hunter2
.fi
.if n \{\
.RE
.\}
.PP
\fBExample\ \&2.\ \&Encrypt a password and include it in a unit file\fR
.PP
The following command line prompts the user for a password and generates a
\fISetCredentialEncrypted=\fR
line from it for a credential named
"mysql\-password", suitable for inclusion in a unit file\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# systemd\-ask\-password \-n | systemd\-creds encrypt \-\-name=mysql\-password \-p \- \-
🔐 Password: ****
SetCredentialEncrypted=mysql\-password: \e
        k6iUCUh0RJCQyvL8k8q1UyAAAAABAAAADAAAABAAAAASfFsBoPLIm/dlDoGAAAAAAAAAA \e
        NAAAAAgAAAAAH4AILIOZ3w6rTzYsBy9G7liaCAd4i+Kpvs8mAgArzwuKxd0ABDjgSeO5k \e
        mKQc58zM94ZffyRmuNeX1lVHE+9e2YD87KfRFNoDLS7F3YmCb347gCiSk2an9egZ7Y0Xs \e
        700Kr6heqQswQEemNEc62k9RJnEl2q7SbcEYguegnPQUATgAIAAsAAAASACA/B90W7E+6 \e
        yAR9NgiIJvxr9bpElztwzB5lUJAxtMBHIgAQACCaSV9DradOZz4EvO/LSaRyRSq2Hj0ym \e
        gVJk/dVzE8Uxj8H3RbsT7rIBH02CIgm/Gv1ukSXO3DMHmVQkDG0wEciyageTfrVEer8z5 \e
        9cUQfM5ynSaV2UjeUWEHuz4fwDsXGLB9eELXLztzUU9nsAyLvs3ZRR+eEK/A==
.fi
.if n \{\
.RE
.\}
.PP
The generated line can be pasted 1:1 into a unit file, and will ensure the acquired password will be made available in the
\fI$CREDENTIALS_DIRECTORY\fR/mysql\-password
credential file for the started service\&.
.PP
Utilizing the unit file drop\-in logic this can be used to securely pass a password credential to a unit\&. A similar, more comprehensive set of commands to insert a password into a service
xyz\&.service:
.sp
.if n \{\
.RS 4
.\}
.nf
# mkdir \-p /etc/systemd/system/xyz\&.service\&.d
# systemd\-ask\-password \-n | ( echo "[Service]" && systemd\-creds encrypt \-\-name=mysql\-password \-p \- \- ) >/etc/systemd/system/xyz\&.service\&.d/50\-password\&.conf
# systemctl daemon\-reload
# systemctl restart xyz\&.service
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsystemd.exec\fR(5),
\fBsystemd-measure\fR(1)
.SH "NOTES"
.IP " 1." 4
System and Service Credentials
.RS 4
\%https://systemd.io/CREDENTIALS
.RE