34
34
<holder>Teddy Hogeborn</holder>
35
35
<holder>Björn Påhlsson</holder>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
37
<xi:include href="../legalnotice.xml"/>
146
124
<refsect1 id="description">
147
125
<title>DESCRIPTION</title>
149
<command>&COMMANDNAME;</command> is a mandos plugin that works
150
like a client program that through avahi detects mandos servers,
151
sets up a gnutls connect and request a encrypted password. Any
152
passwords given is automaticly decrypted and passed to
127
<command>&COMMANDNAME;</command> is a client program that
128
communicates with <citerefentry><refentrytitle
129
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
to get a password. It uses IPv6 link-local addresses to get
131
network connectivity, Zeroconf to find the server, and TLS with
132
an OpenPGP key to ensure authenticity and confidentiality. It
133
keeps running, trying all servers on the network, until it
134
receives a satisfactory reply.
137
This program is not meant to be run directly; it is really meant
138
to run as a plugin of the <application>Mandos</application>
139
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
140
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
141
initial <acronym>RAM</acronym> disk environment because it is
142
specified as a <quote>keyscript</quote> in the <citerefentry>
143
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
144
</citerefentry> file.
148
<refsect1 id="purpose">
149
<title>PURPOSE</title>
151
The purpose of this is to enable <emphasis>remote and unattended
152
rebooting</emphasis> of client host computer with an
153
<emphasis>encrypted root file system</emphasis>. See <xref
154
linkend="overview"/> for details.
157
158
<refsect1 id="options">
158
159
<title>OPTIONS</title>
160
Commonly not invoked as command lines but from configuration
161
file of plugin runner.
161
This program is commonly not invoked from the command line; it
162
is normally started by the <application>Mandos</application>
163
plugin runner, see <citerefentry><refentrytitle
164
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
165
</citerefentry>. Any command line options this program accepts
166
are therefore normally provided by the plugin runner, and not
166
172
<term><option>--connect=<replaceable
167
>IPADDR</replaceable><literal>:</literal><replaceable
173
>ADDRESS</replaceable><literal>:</literal><replaceable
168
174
>PORT</replaceable></option></term>
170
<replaceable>IPADDR</replaceable><literal>:</literal
176
<replaceable>ADDRESS</replaceable><literal>:</literal
171
177
><replaceable>PORT</replaceable></option></term>
174
Connect directly to a specified mandos server
180
Do not use Zeroconf to locate servers. Connect directly
181
to only one specified <application>Mandos</application>
182
server. Note that an IPv6 address has colon characters in
183
it, so the <emphasis>last</emphasis> colon character is
184
assumed to separate the address from the port number.
187
This option is normally only useful for testing and
180
194
<term><option>--keydir=<replaceable
181
195
>DIRECTORY</replaceable></option></term>
277
310
<term><option>-V</option></term>
280
Prints the program version
313
Prints the program version.
320
<refsect1 id="overview">
321
<title>OVERVIEW</title>
322
<xi:include href="../overview.xml"/>
324
This program is the client part. It is a plugin started by
325
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
326
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
327
an initial <acronym>RAM</acronym> disk environment.
330
This program could, theoretically, be used as a keyscript in
331
<filename>/etc/crypttab</filename>, but it would then be
332
impossible to enter the encrypted root disk password at the
333
console, since this program does not read from the console at
334
all. This is why a separate plugin does that, which will be run
335
in parallell to this one.
287
339
<refsect1 id="exit_status">
288
340
<title>EXIT STATUS</title>
342
This program will exit with a successful (zero) exit status if a
343
server could be found and the password received from it could be
344
successfully decrypted and output on standard output. The
345
program will exit with a non-zero exit status only if a critical
346
error occurs. Otherwise, it will forever connect to new
347
<application>Mandosservers</application> servers as they appear,
348
trying to get a decryptable password.
293
352
<refsect1 id="environment">
294
353
<title>ENVIRONMENT</title>
355
This program does not use any environment variables, not even
356
the ones provided by <citerefentry><refentrytitle
357
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
299
362
<refsect1 id="file">
300
363
<title>FILES</title>