1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2009-01-04">
6
<!ENTITY % common SYSTEM "common.ent">
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<title>&COMMANDNAME;</title>
12
<title>Mandos Manual</title>
11
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
16
19
<firstname>Björn</firstname>
32
36
<holder>Teddy Hogeborn</holder>
33
37
<holder>Björn Påhlsson</holder>
37
This manual page is free software: you can redistribute it
38
and/or modify it under the terms of the GNU General Public
39
License as published by the Free Software Foundation,
40
either version 3 of the License, or (at your option) any
45
This manual page is distributed in the hope that it will
46
be useful, but WITHOUT ANY WARRANTY; without even the
47
implied warranty of MERCHANTABILITY or FITNESS FOR A
48
PARTICULAR PURPOSE. See the GNU General Public License
53
You should have received a copy of the GNU General Public
54
License along with this program; If not, see
55
<ulink url="http://www.gnu.org/licenses/"/>.
39
<xi:include href="legalnotice.xml"/>
61
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
62
44
<manvolnum>8</manvolnum>
66
48
<refname><command>&COMMANDNAME;</command></refname>
68
Sends encrypted passwords to authenticated Mandos clients
50
Gives encrypted passwords to authenticated Mandos clients
74
56
<command>&COMMANDNAME;</command>
75
<arg>--interface<arg choice="plain">NAME</arg></arg>
76
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
<arg>--port<arg choice="plain">PORT</arg></arg>
78
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
<arg>--servicename<arg choice="plain">NAME</arg></arg>
80
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
84
<command>&COMMANDNAME;</command>
85
<arg>-i<arg choice="plain">NAME</arg></arg>
86
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
<arg>-p<arg choice="plain">PORT</arg></arg>
88
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
<arg>--servicename<arg choice="plain">NAME</arg></arg>
90
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
58
<arg choice="plain"><option>--interface
59
<replaceable>NAME</replaceable></option></arg>
60
<arg choice="plain"><option>-i
61
<replaceable>NAME</replaceable></option></arg>
65
<arg choice="plain"><option>--address
66
<replaceable>ADDRESS</replaceable></option></arg>
67
<arg choice="plain"><option>-a
68
<replaceable>ADDRESS</replaceable></option></arg>
72
<arg choice="plain"><option>--port
73
<replaceable>PORT</replaceable></option></arg>
74
<arg choice="plain"><option>-p
75
<replaceable>PORT</replaceable></option></arg>
78
<arg><option>--priority
79
<replaceable>PRIORITY</replaceable></option></arg>
81
<arg><option>--servicename
82
<replaceable>NAME</replaceable></option></arg>
84
<arg><option>--configdir
85
<replaceable>DIRECTORY</replaceable></option></arg>
87
<arg><option>--debug</option></arg>
94
90
<command>&COMMANDNAME;</command>
95
91
<group choice="req">
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
92
<arg choice="plain"><option>--help</option></arg>
93
<arg choice="plain"><option>-h</option></arg>
101
97
<command>&COMMANDNAME;</command>
102
<arg choice="plain">--version</arg>
98
<arg choice="plain"><option>--version</option></arg>
105
101
<command>&COMMANDNAME;</command>
106
<arg choice="plain">--check</arg>
102
<arg choice="plain"><option>--check</option></arg>
108
104
</refsynopsisdiv>
110
106
<refsect1 id="description">
111
107
<title>DESCRIPTION</title>
121
117
Any authenticated client is then given the stored pre-encrypted
122
118
password for that specific client.
127
122
<refsect1 id="purpose">
128
123
<title>PURPOSE</title>
131
125
The purpose of this is to enable <emphasis>remote and unattended
132
126
rebooting</emphasis> of client host computer with an
133
127
<emphasis>encrypted root file system</emphasis>. See <xref
134
128
linkend="overview"/> for details.
139
132
<refsect1 id="options">
140
133
<title>OPTIONS</title>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
136
<term><option>--help</option></term>
137
<term><option>-h</option></term>
147
140
Show a help message and exit
153
<term><literal>-i</literal>, <literal>--interface <replaceable
154
>NAME</replaceable></literal></term>
146
<term><option>--interface</option>
147
<replaceable>NAME</replaceable></term>
148
<term><option>-i</option>
149
<replaceable>NAME</replaceable></term>
156
151
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
156
<term><option>--address
157
<replaceable>ADDRESS</replaceable></option></term>
159
<replaceable>ADDRESS</replaceable></option></term>
164
161
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
167
<replaceable>PORT</replaceable></option></term>
169
<replaceable>PORT</replaceable></option></term>
172
171
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><literal>--check</literal></term>
176
<term><option>--check</option></term>
180
179
Run the server’s self-tests. This includes any unit
187
<term><literal>--debug</literal></term>
186
<term><option>--debug</option></term>
189
188
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
193
<term><option>--priority <replaceable>
194
PRIORITY</replaceable></option></term>
197
196
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
201
<term><option>--servicename
202
<replaceable>NAME</replaceable></option></term>
205
204
<xi:include href="mandos-options.xml"
206
205
xpointer="servicename"/>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
210
<term><option>--configdir
211
<replaceable>DIRECTORY</replaceable></option></term>
215
214
Directory to search for configuration files. Default is
423
422
Currently, if a client is declared <quote>invalid</quote> due to
424
423
having timed out, the server does not record this fact onto
425
424
permanent storage. This has some security implications, see
426
<xref linkend="CLIENTS"/>.
425
<xref linkend="clients"/>.
429
428
There is currently no way of querying the server of the current
475
478
<!-- do not wrap this line -->
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
482
</informalexample>
482
485
<refsect1 id="security">
483
486
<title>SECURITY</title>
484
<refsect2 id="SERVER">
487
<refsect2 id="server">
485
488
<title>SERVER</title>
487
490
Running this <command>&COMMANDNAME;</command> server program
488
491
should not in itself present any security risk to the host
489
computer running it. The program does not need any special
490
privileges to run, and is designed to run as a non-root user.
492
computer running it. The program switches to a non-root user
493
<refsect2 id="CLIENTS">
496
<refsect2 id="clients">
494
497
<title>CLIENTS</title>
496
499
The server only gives out its stored data to clients which
503
506
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
507
<manvolnum>5</manvolnum></citerefentry>)
505
508
<emphasis>must</emphasis> be made non-readable by anyone
506
except the user running the server.
509
except the user starting the server (usually root).
509
512
As detailed in <xref linkend="checking"/>, the status of all
520
523
restarting servers if it is suspected that a client has, in
521
524
fact, been compromised by parties who may now be running a
522
525
fake Mandos client with the keys from the non-encrypted
523
initial RAM image of the client host. What should be done in
524
that case (if restarting the server program really is
525
necessary) is to stop the server program, edit the
526
initial <acronym>RAM</acronym> image of the client host. What
527
should be done in that case (if restarting the server program
528
really is necessary) is to stop the server program, edit the
526
529
configuration file to omit any suspect clients, and restart
527
530
the server program.
530
533
For more details on client-side security, see
531
<citerefentry><refentrytitle>password-request</refentrytitle>
534
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
535
<manvolnum>8mandos</manvolnum></citerefentry>.
537
540
<refsect1 id="see_also">
538
541
<title>SEE ALSO</title>
544
<refentrytitle>mandos-clients.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
546
<refentrytitle>mandos.conf</refentrytitle>
542
547
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>password-request</refentrytitle>
548
<refentrytitle>mandos-client</refentrytitle>
546
549
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
550
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
588
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
Unicast Addresses</citation>
591
RFC 4291: <citetitle>IP Version 6 Addressing
592
Architecture</citetitle>
594
The clients use IPv6 link-local addresses, which are
595
immediately usable since a link-local addresses is
596
automatically assigned to a network interfaces when it is
597
<term>Section 2.2: <citetitle>Text Representation of
598
Addresses</citetitle></term>
599
<listitem><para/></listitem>
602
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
603
Address</citetitle></term>
604
<listitem><para/></listitem>
607
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
608
Addresses</citetitle></term>
611
The clients use IPv6 link-local addresses, which are
612
immediately usable since a link-local addresses is
613
automatically assigned to a network interfaces when it
603
<citation>RFC 4346: <citetitle>The Transport Layer Security
604
(TLS) Protocol Version 1.1</citetitle></citation>
623
RFC 4346: <citetitle>The Transport Layer Security (TLS)
624
Protocol Version 1.1</citetitle>