-
Notifications
You must be signed in to change notification settings - Fork 0
/
cryptmount.8.html
182 lines (182 loc) · 9.62 KB
/
cryptmount.8.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
cryptmount(8) manual page
See COPYING and COPYRIGHT files for corresponding information.
-->
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
<title>CRYPTMOUNT(8)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">CRYPTMOUNT(8)</td>
<td class="head-vol">System Manager's Manual</td>
<td class="head-rtitle">CRYPTMOUNT(8)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">cryptmount</code> — <span class="Nd">parse
crypttab for use by cryptsetup</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<table class="Nm">
<tr>
<td><code class="Nm">cryptmount</code></td>
<td>[<code class="Fl">-Vfhnvq</code>] [<code class="Fl">-c</code>
<var class="Ar">crypttab</var>] [<code class="Fl">-w</code>
<var class="Ar">num</var>] [<code class="Fl">-o</code>
<var class="Ar">options</var>] [<code class="Fl">-O</code>
<var class="Ar">filters</var>] [{<code class="Fl">-L</code> |
<code class="Fl">-M</code> [<var class="Ar">name</var> |
<var class="Ar">device</var> | <var class="Ar">name device</var>
[<var class="Ar">key</var>]] | <code class="Fl">-U</code>
[<var class="Ar">name</var>[,...]]}]</td>
</tr>
</table>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">cryptmount</code> utility uses
<a class="Xr" href="crypttab.5.html">crypttab(5)</a> for calling
<a class="Xr" href="cryptsetup.8.html">cryptsetup(8)</a>; it can also be
used to define a <b class="Sy">volume</b> on the command line without
<b class="Sy">crypttab</b>.</p>
<section class="Ss">
<h2 class="Ss" id="Actions"><a class="permalink" href="#Actions">Actions</a></h2>
<dl class="Bl-tag">
<dt id="L"><a class="permalink" href="#L"><code class="Fl">-L</code></a></dt>
<dd>List the <var class="Ar">name</var>(s) (first column) of
<b class="Sy">volumes</b> from <b class="Sy">crypttab</b>. Use with
<code class="Fl">-O</code> to manipulate which
<var class="Ar">name</var>(s) are listed.</dd>
<dt id="M"><a class="permalink" href="#M"><code class="Fl">-M</code></a></dt>
<dd>Perform a mapping. The first form of this command finds a
<b class="Sy">volume</b> from <b class="Sy">crypttab</b> either by its
<var class="Ar">name</var> or <var class="Ar">device</var>, or if nothing
is given then map all <b class="Sy">volumes</b> (use with
<code class="Fl">-O</code> to manipulate which <b class="Sy">volumes</b>
are mapped). The second form defines a <b class="Sy">volume</b> entirely
on the command line, <b class="Sy">crypttab</b> is not used.</dd>
<dt id="U"><a class="permalink" href="#U"><code class="Fl">-U</code></a></dt>
<dd>Unmap <b class="Sy">volume</b>(s). If a list of
<var class="Ar">name</var>(s) is given, unmap them. Otherwise unmap all
<b class="Sy">volume</b>(s) from <b class="Sy">crypttab</b> (with
<code class="Fl">-O</code> to manipulate which <b class="Sy">volume</b>(s)
are unmapped).</dd>
</dl>
</section>
<section class="Ss">
<h2 class="Ss" id="Options"><a class="permalink" href="#Options">Options</a></h2>
<dl class="Bl-tag">
<dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a>
<var class="Ar">crypttab</var></dt>
<dd>Specify an alternate configuration file instead of the default
<span class="Pa">/etc/crypttab</span>.</dd>
<dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a></dt>
<dd>Force potentially destructive mappings. For plain mappings (which are used
with the <b class="Sy">swap</b> and
<a class="permalink" href="#tmp"><b class="Sy" id="tmp">tmp</b></a>
options), there is a lot of potential to accidentally lose data. Because
of this, <b class="Sy">cryptmount</b> performs a check with
<a class="Xr" href="blkid.8.html">blkid(8)</a> to see if there is anything
identifiable on <var class="Ar">device</var>. Use
<code class="Fl">-f</code> to bypass this check.</dd>
<dt id="w"><a class="permalink" href="#w"><code class="Fl">-w</code></a>
<var class="Ar">num</var></dt>
<dd>Time (in seconds) to wait for <var class="Ar">device</var> if it is not
already available. If <a class="Xr" href="udevd.8.html">udevd(8)</a> is
not running, then <b class="Sy">cryptmount</b> does not bother to wait and
this option is a no-op. This also affects the wait time for
<var class="Ar">keydevice</var> if your key is a block device or a file on
a block device.</dd>
<dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
<dd>Dry run, useful with <code class="Fl">-v</code> to see how
<a class="Xr" href="cryptsetup.8.html">cryptsetup(8)</a> will be
called.</dd>
<dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt>
<dd>Increase verbosity. This prints the commands which are being called (e.g.
<a class="Xr" href="cryptsetup.8.html">cryptsetup(8)</a>,
<a class="Xr" href="mkswap.8.html">mkswap(8)</a>, etc).</dd>
<dt id="q"><a class="permalink" href="#q"><code class="Fl">-q</code></a></dt>
<dd>Decrease verbosity.</dd>
<dt id="o"><a class="permalink" href="#o"><code class="Fl">-o</code></a>
<var class="Ar">options</var></dt>
<dd>An options list with items such as <b class="Sy">swap</b>,
<a class="permalink" href="#cipher"><b class="Sy" id="cipher">cipher</b></a>,
etc. This may be given multiple times with a cumulative effect. See
<a class="Xr" href="crypttab.5.html">crypttab(5)</a> for the full
<var class="Ar">options</var> syntax.</dd>
<dt id="O"><a class="permalink" href="#O"><code class="Fl">-O</code></a>
<var class="Ar">filters</var></dt>
<dd>Similar to <var class="Ar">options</var>, this is used to manipulate which
<b class="Sy">volume</b>(s) are used with <code class="Fl">-L</code> and
with <code class="Fl">-M</code>/<code class="Fl">-U</code> without
arguments. If an option is present in <var class="Ar">filters</var>, then
the <b class="Sy">volume</b> in <b class="Sy">crypttab</b> must contain
the option. For example <b class="Sy">-O swap,size</b> matches all
<b class="Sy">volume</b>(s) with the <b class="Sy">swap</b> option and any
<b class="Sy">size</b>=size option; or <b class="Sy">-O swap,size=512</b>
matches only those <b class="Sy">volume</b>(s) with the
<b class="Sy">swap</b> option and specifically
<a class="permalink" href="#size=512"><b class="Sy" id="size=512">size=512</b></a>.
<p class="Pp" id="without">A filter option may also be negated by prefixing
it with an exclamation mark (‘<code class="Li">!</code>’).
For example, <b class="Sy">-O swap,!size</b> includes all
<b class="Sy">volume</b>(s) with the <b class="Sy">swap</b> option but
<a class="permalink" href="#without"><b class="Sy">without</b></a> the
<i class="Em">size</i> option. There is a built-in filter
<a class="permalink" href="#!noauto"><b class="Sy" id="!noauto">!noauto</b></a>.</p>
<p class="Pp" id="_">Filters are especially useful with
<a class="permalink" href="#_"><b class="Sy">%</b></a>tag options. For
example, <b class="Sy">-O !%random</b> can be used to map all
<b class="Sy">volumes</b> which don’t use
<a class="permalink" href="#/dev/urandom"><b class="Sy" id="/dev/urandom">/dev/urandom</b></a>
for a password and <b class="Sy">-O %random</b> to map the remainder
once your system’s random seed has been restored.</p>
<p class="Pp" id="no">The <code class="Fl">-O</code> option has
<a class="permalink" href="#no"><b class="Sy">no effect</b></a> when
calling <b class="Sy">cryptmount</b> in a way that does not use
<b class="Sy">crypttab</b>.</p>
</dd>
<dt id="V"><a class="permalink" href="#V"><code class="Fl">-V</code></a></dt>
<dd>Print version and exit.</dd>
<dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a></dt>
<dd>Print help and exit.</dd>
</dl>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr" href="crypttab.5.html">crypttab(5)</a>,
<a class="Xr" href="cryptsetup.8.html">cryptsetup(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The original implementation of <code class="Nm">cryptmount</code>
was done by <span class="An">Matthew Monaco</span>
<<a class="Mt" href="mailto:dgbaley27@0x01b.net">dgbaley27@0x01b.net</a>>
and maintained for <a class="Lk" href="http://sabo.xyz">Sabotage Linux</a>
by <span class="An">rofl0r</span>
<<a class="Mt" href="mailto:retnyg@gmx.net">retnyg@gmx.net</a>>.</p>
<p class="Pp">This implementation was re-worked for
<a class="Lk" href="https://zeppe-lin.github.io">Zeppe-Lin</a> by
<span class="An">Alexandr Savca</span>
<<a class="Mt" href="mailto:alexandr.savca89@gmail.com">alexandr.savca89@gmail.com</a>>.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">September 7, 2023</td>
<td class="foot-os">Zeppe-Lin</td>
</tr>
</table>
</body>
</html>