To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to plugins.d/mandos-client.xml
- browse files at revision 550
- compare with another revision
- download diff
- download tarball
- view history from revision 550
- Committer: Teddy Hogeborn
- Date: 2012-01-01 20:45:53 UTC
- Revision ID: teddy@recompile.se-20120101204553-f1zlty873gswtf5n
* README: Hint that the intro(8mandos) manual page is in the server
package.
package.
- files removed:
- debian/mandos-client.examples
- debian/upstream
- plugin-helpers
- files modified:
- .bzrignore
added
removed
plugins.d/mandos-client.xml
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
4
<!ENTITY COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2014-06-22">
5
<!ENTITY TIMESTAMP "2012-01-01">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
34
34
<year>2008</year>
35
35
<year>2009</year>
36
36
<year>2012</year>
37
<year>2013</year>
38
<year>2014</year>
39
37
<holder>Teddy Hogeborn</holder>
40
38
<holder>Björn Påhlsson</holder>
41
39
</copyright>
66
64
><replaceable>PORT</replaceable></option></arg>
67
65
</group>
68
66
<sbr/>
69
<group rep='repeat'>
67
<group>
70
68
<arg choice="plain"><option>--interface
71
<replaceable>NAME</replaceable><arg rep='repeat'
72
>,<replaceable>NAME</replaceable></arg></option></arg>
73
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
74
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
75
></option></arg>
69
<replaceable>NAME</replaceable></option></arg>
70
<arg choice="plain"><option>-i
71
<replaceable>NAME</replaceable></option></arg>
76
72
</group>
77
73
<sbr/>
78
74
<group>
141
137
communicates with <citerefentry><refentrytitle
142
138
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
143
139
to get a password. In slightly more detail, this client program
144
brings up network interfaces, uses the interfaces’ IPv6
145
link-local addresses to get network connectivity, uses Zeroconf
146
to find servers on the local network, and communicates with
147
servers using TLS with an OpenPGP key to ensure authenticity and
140
brings up a network interface, uses the interface’s IPv6
141
link-local address to get network connectivity, uses Zeroconf to
142
find servers on the local network, and communicates with servers
143
using TLS with an OpenPGP key to ensure authenticity and
148
144
confidentiality. This client program keeps running, trying all
149
145
servers on the network, until it receives a satisfactory reply
150
146
or a TERM signal. After all servers have been tried, all
152
148
will wait indefinitely for new servers to appear.
153
149
</para>
154
150
<para>
155
The network interfaces are selected like this: If any interfaces
156
are specified using the <option>--interface</option> option,
157
those interface are used. Otherwise,
158
<command>&COMMANDNAME;</command> will use all interfaces that
159
are not loopback interfaces, are not point-to-point interfaces,
160
are capable of broadcasting and do not have the NOARP flag (see
151
The network interface is selected like this: If an interface is
152
specified using the <option>--interface</option> option, that
153
interface is used. Otherwise, <command>&COMMANDNAME;</command>
154
will choose any interface that is up and running and is not a
155
loopback interface, is not a point-to-point interface, is
156
capable of broadcasting and does not have the NOARP flag (see
161
157
<citerefentry><refentrytitle>netdevice</refentrytitle>
162
158
<manvolnum>7</manvolnum></citerefentry>). (If the
163
159
<option>--connect</option> option is used, point-to-point
164
interfaces and non-broadcast interfaces are accepted.) If any
165
used interfaces are not up and running, they are first taken up
166
(and later taken down again on program exit).
160
interfaces and non-broadcast interfaces are accepted.) If no
161
acceptable interfaces are found, re-run the check but without
162
the <quote>up and running</quote> requirement, and manually take
163
the selected interface up (and later take it down on program
164
exit).
167
165
</para>
168
166
<para>
169
Before network interfaces are selected, all <quote>network
167
Before a network interface is selected, all <quote>network
170
168
hooks</quote> are run; see <xref linkend="network-hooks"/>.
171
169
</para>
172
170
<para>
220
218
assumed to separate the address from the port number.
221
219
</para>
222
220
<para>
223
Normally, Zeroconf would be used to locate Mandos servers,
224
in which case this option would only be used when testing
225
and debugging.
221
This option is normally only useful for testing and
222
debugging.
226
223
</para>
227
224
</listitem>
228
225
</varlistentry>
229
226
230
227
<varlistentry>
231
228
<term><option>--interface=<replaceable
232
>NAME</replaceable><arg rep='repeat'>,<replaceable
233
>NAME</replaceable></arg></option></term>
229
>NAME</replaceable></option></term>
234
230
<term><option>-i
235
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
236
>NAME</replaceable></arg></option></term>
231
<replaceable>NAME</replaceable></option></term>
237
232
<listitem>
238
233
<para>
239
Comma separated list of network interfaces that will be
240
brought up and scanned for Mandos servers to connect to.
241
The default is the empty string, which will automatically
242
use all appropriate interfaces.
234
Network interface that will be brought up and scanned for
235
Mandos servers to connect to. The default is the empty
236
string, which will automatically choose an appropriate
237
interface.
243
238
</para>
244
239
<para>
245
If the <option>--connect</option> option is used, and
246
exactly one interface name is specified (except
247
<quote><literal>none</literal></quote>), this specifies
248
the interface to use to connect to the address given.
240
If the <option>--connect</option> option is used, this
241
specifies the interface to use to connect to the address
242
given.
249
243
</para>
250
244
<para>
251
245
Note that since this program will normally run in the
252
246
initial RAM disk environment, the interface must be an
253
247
interface which exists at that stage. Thus, the interface
254
can normally not be a pseudo-interface such as
255
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
256
will not exist until much later in the boot process, and
257
can not be used by this program, unless created by a
258
<quote>network hook</quote> — see <xref
259
linkend="network-hooks"/>.
248
can not be a pseudo-interface such as <quote>br0</quote>
249
or <quote>tun0</quote>; such interfaces will not exist
250
until much later in the boot process, and can not be used
251
by this program, unless created by a <quote>network
252
hook</quote> — see <xref linkend="network-hooks"/>.
260
253
</para>
261
254
<para>
262
255
<replaceable>NAME</replaceable> can be the string
263
<quote><literal>none</literal></quote>; this will make
264
<command>&COMMANDNAME;</command> only bring up interfaces
265
specified <emphasis>before</emphasis> this string. This
266
is not recommended, and only meant for advanced users.
256
<quote><literal>none</literal></quote>; this will not use
257
any specific interface, and will not bring up an interface
258
on startup. This is not recommended, and only meant for
259
advanced users.
267
260
</para>
268
261
</listitem>
269
262
</varlistentry>
321
314
>SECONDS</replaceable></option></term>
322
315
<listitem>
323
316
<para>
324
After bringing a network interface up, the program waits
317
After bringing the network interface up, the program waits
325
318
for the interface to arrive in a <quote>running</quote>
326
319
state before proceeding. During this time, the kernel log
327
320
level will be lowered to reduce clutter on the system
514
507
It is not necessary to print any non-executable files
515
508
already in the network hook directory, these will be
516
509
copied implicitly if they otherwise satisfy the name
517
requirements.
510
requirement.
518
511
</para>
519
512
</listitem>
520
513
</varlistentry>
554
547
<term><envar>DEVICE</envar></term>
555
548
<listitem>
556
549
<para>
557
The network interfaces, as specified to
550
The network interface, as specified to
558
551
<command>&COMMANDNAME;</command> by the
559
<option>--interface</option> option, combined to one
560
string and separated by commas. If this is set, and
561
does not contain the interface a hook will bring up,
562
there is no reason for a hook to continue.
552
<option>--interface</option> option. If this is not the
553
interface a hook will bring up, there is no reason for a
554
hook to continue.
563
555
</para>
564
556
</listitem>
565
557
</varlistentry>
668
660
</para>
669
661
<informalexample>
670
662
<para>
671
Normal invocation needs no options, if the network interfaces
672
can be automatically determined:
663
Normal invocation needs no options, if the network interface
664
is <quote>eth0</quote>:
673
665
</para>
674
666
<para>
675
667
<userinput>&COMMANDNAME;</userinput>
677
669
</informalexample>
678
670
<informalexample>
679
671
<para>
680
Search for Mandos servers (and connect to them) using one
681
specific interface:
672
Search for Mandos servers (and connect to them) using another
673
interface:
682
674
</para>
683
675
<para>
684
676
<!-- do not wrap this line -->
748
740
<para>
749
741
It will also help if the checker program on the server is
750
742
configured to request something from the client which can not be
751
spoofed by someone else on the network, like SSH server key
752
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
753
echo (<quote>ping</quote>) replies.
743
spoofed by someone else on the network, unlike unencrypted
744
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
754
745
</para>
755
746
<para>
756
747
<emphasis>Note</emphasis>: This makes it completely insecure to
849
840
<para>
850
841
This client uses IPv6 link-local addresses, which are
851
842
immediately usable since a link-local addresses is
852
automatically assigned to a network interface when it
843
automatically assigned to a network interfaces when it
853
844
is brought up.
854
845
</para>
855
846
</listitem>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0