mirror of
https://git.sr.ht/~nabijaczleweli/tzpfms
synced 2025-05-05 10:31:02 +03:00
90 lines
1.9 KiB
Groff
90 lines
1.9 KiB
Groff
.Dd October 15, 2021
|
|
.ds doc-volume-operating-system
|
|
.Dt ZFS-TPM2-CLEAR-KEY 8
|
|
.Os tzpfms 0.1-5
|
|
.
|
|
.Sh NAME
|
|
.Nm zfs-tpm2-clear-key
|
|
.Nd rewrap ZFS dataset key in passsword and clear tzpfms TPM2 metadata
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Ar dataset
|
|
.
|
|
.Sh DESCRIPTION
|
|
After verifying
|
|
.Ar dataset
|
|
was encrypted with
|
|
.Nm tzpfms
|
|
backend
|
|
.Sy TPM2 :
|
|
.Bl -enum -compact -offset 4n -width ""
|
|
.It
|
|
performs the equivalent of
|
|
.Nm zfs Cm change-key Fl o Li keylocation=prompt Fl o Li keyformat=passphrase Ar dataset ,
|
|
.It
|
|
frees the sealed key previously used to encrypt
|
|
.Ar dataset ,
|
|
.It
|
|
removes the
|
|
.Li xyz.nabijaczleweli:tzpfms.\& Ns Brq Li backend , key
|
|
properties from
|
|
.Ar dataset .
|
|
.El
|
|
.Pp
|
|
See
|
|
.Xr zfs-tpm2-change-key 8
|
|
for a detailed description.
|
|
.
|
|
.Sh TPM2 back-end configuration
|
|
.Ss Environment variables
|
|
.Bl -tag -compact -width "TSS2_LOG"
|
|
.It Ev TSS2_LOG
|
|
Any of:
|
|
.Sy NONE , ERROR , WARNING , INFO , DEBUG , TRACE .
|
|
Default:
|
|
.Sy WARNING .
|
|
.El
|
|
.
|
|
.Ss TPM selection
|
|
The library
|
|
.Nm libtss2-tcti-default.so
|
|
can be linked to any of the
|
|
.Pa libtss2-tcti-*.so
|
|
libraries to select the default, otherwise
|
|
.Pa /dev/tpmrm0 ,
|
|
then
|
|
.Pa /dev/tpm0 ,
|
|
then
|
|
.Pa localhost:2321
|
|
will be tried, in order
|
|
.Pq see Xr ESYS_CONTEXT 3 .
|
|
.
|
|
.Ss See also
|
|
The tpm2-tss git repository at
|
|
.Lk https:/\&/github.com/tpm2-software/tpm2-tss
|
|
and the documentation at
|
|
.Lk https:/\&/tpm2-tss.readthedocs.io .
|
|
.Pp
|
|
The TPM 2.0 specifications, mainly at
|
|
.Lk https:/\&/trustedcomputinggroup.org/wp-content/uploads/TPM-Rev-2.0-Part-1-Architecture-01.38.pdf
|
|
and related pages.
|
|
.
|
|
.Sh SPECIAL THANKS
|
|
To all who support further development, in particular:
|
|
.Bl -bullet -offset 4n -compact -width 0
|
|
.It
|
|
ThePhD
|
|
.It
|
|
Embark Studios
|
|
.El
|
|
.
|
|
.Sh REPORTING BUGS
|
|
.Lk https:/\&/todo.sr.ht/~nabijaczleweli/tzpfms
|
|
.Pp
|
|
.Mt ~nabijaczleweli/tzpfms@lists.sr.ht ,
|
|
archived at
|
|
.Lk https:/\&/lists.sr.ht/~nabijaczleweli/tzpfms .
|
|
.
|
|
.Sh SEE ALSO
|
|
.Lk https:/\&/git.sr.ht/~nabijaczleweli/tzpfms
|