'\" t
.\"     Title: clevis-luks-list
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/30/2024
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "CLEVIS\-LUKS\-LIST" "1" "03/30/2024" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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"
clevis-luks-list \- Lists pins bound to a LUKS device
.SH "SYNOPSIS"
.sp
\fBclevis luks list\fR \-d DEV [\-s SLT]
.SH "OVERVIEW"
.sp
The \fBclevis luks list\fR command list the pins bound to LUKS device\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks list \-d /dev/sda1
.fi
.if n \{\
.RE
.\}
.SH "OPTIONS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-d\fR
\fIDEV\fR
: The LUKS device on which to list bound pins
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-s\fR
\fISLT\fR
: The slot to use for listing the pin from
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks list \-d /dev/sda1
1: sss \*(Aq{"t":1,"pins":{"tang":[{"url":"addr1"},{"url":"addr2"}],"tpm2":[{"hash":"sha256","key":"ecc"}],"sss":{"t":1,"pins":{"tang":[{"url":"addr3"}]}}}}\*(Aq
2: tang \*(Aq{"url":"addr"}\*(Aq
3: tpm2 \*(Aq{"hash":"sha256","key":"ecc","pcr_bank":"sha1","pcr_ids":"7"}\*(Aq
.fi
.if n \{\
.RE
.\}
.sp
As we can see in the example above, \fB/dev/sda1\fR has three slots bound each with a different pin\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Slot #1 is bound with the
\fIsss\fR
pin, and uses also tang and tpm2 pins in its policy\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Slot #2 is bound using the
\fItang\fR
pin
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Slot #3 is bound with the
\fItpm2\fR
pin
.RE
.sp
Note that the output of \fBclevis luks list\fR can be used with the \fBclevis luks bind\fR command, such as:
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks bind \-d /dev/sda1 tpm2 \*(Aq{"hash":"sha256","key":"ecc","pcr_bank":"sha1","pcr_ids":"7"}\*(Aq
.fi
.if n \{\
.RE
.\}
.sp
And we will bind another slot with a policy similar to the one we have in slot #3\&. Also note that if you are interested in a particular slot, you can pass the \fI\-s SLT\fR argument to \fBclevis luks list\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
clevis luks list \-d /dev/sda1 \-s 2
2: tang \*(Aq{"url":"addr"}\*(Aq
.fi
.if n \{\
.RE
.\}
.sp
In the above example, we listed only the pin bound to slot #2\&.
.SH "SEE ALSO"
.sp
\fBclevis\-luks\-bind\fR(1), \fBclevis\-encrypt\-tang\fR(1), \fBclevis\-encrypt\-tpm2\fR(1), \fBclevis\-encrypt\-sss\fR(1),