/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-monitor.xml

  • Committer: Teddy Hogeborn
  • Date: 2009-02-09 02:01:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090209020113-726hq380zvp8zt97
Four new interrelated features:

1. Support using a different network interface via both initramfs.conf
   (the DEVICE setting) and the kernel command line (sixth field of
   the "ip=" option as in Linux' Documentation/nfsroot.txt).

2. Support connecting to a specified Mandos server directly using a
   kernel command line option ("mandos=connect:<ADDRESS>:<PORT>").

3. Support connecting directly to an IPv4 address (and port) using the
   "--connect" option of mandos-client.

4. Support an empty string to the --interface option to mandos-client.

* Makefile (WARN): Increase strictness by changing to
                   "-Wstrict-aliasing=1".

* debian/mandos-client.README.Debian (Use the Correct Network
  Interface): Changed to refer to initramfs.conf and nfsroot.txt.
  (Test the Server): Improve wording.
  (Non-local Connection): New section.
* initramfs-tools-script: Obey DEVICE environment variable and setting
                          from "/conf/initramfs.conf".  Also let any
                          "ip=" kernel command line option override
                          it.  Support new "mandos=connect" option.
                          Call "configure_networking" to set up IP
                          address on interface if necessary.
* plugin-runner.conf: Change example.
* plugins.d/mandos-client.c: Some whitespace and comment changes.
  (start_mandos_communication): Take an additional argument for
                                address family, all callers changed.
                                Connect to an IPv4 address if address
                                family is AF_INET.  Only set IPv6
                                scope_id for link-local addresses.
  (main): Accept empty interface name; this will not bring up any
         interface and leave the interface as unspecified.  Also do
         not restore kernel log level if lowering it failed.
* plugins.d/mandos-client.xml (OPTIONS): Document that the
                                         "--interface" option accepts
                                         an empty string.
  (EXAMPLE): Change example IPv6 address to a link-local address.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY COMMANDNAME "mandos-monitor">
5
 
<!ENTITY TIMESTAMP "2010-09-14">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
 
]>
9
 
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
 
    <authorgroup>
18
 
      <author>
19
 
        <firstname>Björn</firstname>
20
 
        <surname>Påhlsson</surname>
21
 
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
23
 
        </address>
24
 
      </author>
25
 
      <author>
26
 
        <firstname>Teddy</firstname>
27
 
        <surname>Hogeborn</surname>
28
 
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
30
 
        </address>
31
 
      </author>
32
 
    </authorgroup>
33
 
    <copyright>
34
 
      <year>2010</year>
35
 
      <holder>Teddy Hogeborn</holder>
36
 
      <holder>Björn Påhlsson</holder>
37
 
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
39
 
  </refentryinfo>
40
 
  
41
 
  <refmeta>
42
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
 
    <manvolnum>8</manvolnum>
44
 
  </refmeta>
45
 
  
46
 
  <refnamediv>
47
 
    <refname><command>&COMMANDNAME;</command></refname>
48
 
    <refpurpose>
49
 
      Text-based GUI to control the Mandos server.
50
 
    </refpurpose>
51
 
  </refnamediv>
52
 
  
53
 
  <refsynopsisdiv>
54
 
    <cmdsynopsis>
55
 
      <command>&COMMANDNAME;</command>
56
 
    </cmdsynopsis>
57
 
  </refsynopsisdiv>
58
 
  
59
 
  <refsect1 id="description">
60
 
    <title>DESCRIPTION</title>
61
 
    <para>
62
 
      <command>&COMMANDNAME;</command> is an interactive program to
63
 
      monitor and control the operations of the Mandos server (see
64
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
65
 
      >8</manvolnum></citerefentry>).
66
 
    </para>
67
 
  </refsect1>
68
 
  
69
 
  <refsect1 id="purpose">
70
 
    <title>PURPOSE</title>
71
 
    <para>
72
 
      The purpose of this is to enable <emphasis>remote and unattended
73
 
      rebooting</emphasis> of client host computer with an
74
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
75
 
      linkend="overview"/> for details.
76
 
    </para>
77
 
  </refsect1>
78
 
  
79
 
  <refsect1 id="overview">
80
 
    <title>OVERVIEW</title>
81
 
    <xi:include href="overview.xml"/>
82
 
    <para>
83
 
      This program is used to monitor and control the Mandos server.
84
 
      In particular, it can be used to approve Mandos clients which
85
 
      have been configured to require approval.  It also shows all
86
 
      significant events reported by the Mandos server.
87
 
    </para>
88
 
  </refsect1>
89
 
  
90
 
  <refsect1 id="keys">
91
 
    <title>KEYS</title>
92
 
    <para>
93
 
      This program is used to monitor and control the Mandos server.
94
 
      In particular, it can be used to approve Mandos clients which
95
 
      have been configured to require approval.  It also shows all
96
 
      significant events reported by the Mandos server.
97
 
    </para>
98
 
    <table>
99
 
      <title>Global Keys</title><tgroup cols="2"><thead>
100
 
      <row>
101
 
        <entry>Keys</entry>
102
 
        <entry>Function</entry>
103
 
      </row>
104
 
      </thead><tbody>
105
 
      <row>
106
 
        <entry>q, Q</entry>
107
 
        <entry>Quit</entry>
108
 
      </row>
109
 
      <row>
110
 
        <entry>Ctrl-L</entry>
111
 
        <entry>Redraw screen</entry>
112
 
      </row>
113
 
      <row>
114
 
        <entry>?, F1</entry>
115
 
        <entry>Show help</entry>
116
 
      </row>
117
 
      <row>
118
 
        <entry>l, D</entry>
119
 
        <entry>Toggle log window</entry>
120
 
      </row>
121
 
      <row>
122
 
        <entry>TAB</entry>
123
 
        <entry>Switch window</entry>
124
 
      </row>
125
 
      <row>
126
 
        <entry>w, i</entry>
127
 
        <entry>Toggle log window line wrap</entry>
128
 
      </row>
129
 
      <row>
130
 
        <entry>Up, Ctrl-P, k</entry>
131
 
        <entry>Move up a line</entry>
132
 
      </row>
133
 
      <row>
134
 
        <entry>Down, Ctrl-N, j</entry>
135
 
        <entry>Move down a line</entry>
136
 
      </row>
137
 
      <row>
138
 
        <entry>PageUp, Meta-V, b</entry>
139
 
        <entry>Move up a page</entry>
140
 
      </row>
141
 
      <row>
142
 
        <entry>PageDown, Ctrl-V, SPACE, f</entry>
143
 
        <entry>Move down a page</entry>
144
 
      </row>
145
 
    </tbody></tgroup></table>
146
 
    <table>
147
 
      <title>Client List Keys</title><tgroup cols="2"><thead>
148
 
      <row>
149
 
        <entry>Keys</entry>
150
 
        <entry>Function</entry>
151
 
      </row>
152
 
      </thead><tbody>
153
 
      <row>
154
 
        <entry>+</entry>
155
 
        <entry>Enable client</entry>
156
 
      </row>
157
 
      <row>
158
 
        <entry>-</entry>
159
 
        <entry>Disable client</entry>
160
 
      </row>
161
 
      <row>
162
 
        <entry>a</entry>
163
 
        <entry>Approve client</entry>
164
 
      </row>
165
 
      <row>
166
 
        <entry>d</entry>
167
 
        <entry>Deny client</entry>
168
 
      </row>
169
 
      <row>
170
 
        <entry>r, _, Ctrl-K</entry>
171
 
        <entry>Remove client</entry>
172
 
      </row>
173
 
      <row>
174
 
        <entry>s</entry>
175
 
        <entry>Start checker for client</entry>
176
 
      </row>
177
 
      <row>
178
 
        <entry>S</entry>
179
 
        <entry>Stop checker for client</entry>
180
 
      </row>
181
 
      <row>
182
 
        <entry>C</entry>
183
 
        <entry>Force a successful check for this client.</entry>
184
 
      </row>
185
 
    </tbody></tgroup></table>
186
 
  </refsect1>
187
 
  
188
 
  <refsect1 id="bugs">
189
 
    <title>BUGS</title>
190
 
    <para>
191
 
      This program can currently only be used to monitor and control a
192
 
      Mandos server with the default D-Bus service name of
193
 
      <quote>Mandos</quote>.
194
 
    </para>
195
 
  </refsect1>
196
 
  
197
 
  <refsect1 id="example">
198
 
    <title>EXAMPLE</title>
199
 
    <informalexample>
200
 
      <para>
201
 
        This program takes no options:
202
 
      </para>
203
 
      <para>
204
 
        <userinput>&COMMANDNAME;</userinput>
205
 
      </para>
206
 
    </informalexample>
207
 
  </refsect1>
208
 
  
209
 
  <refsect1 id="security">
210
 
    <title>SECURITY</title>
211
 
    <para>
212
 
      This program must be permitted to access the Mandos server via
213
 
      the D-Bus interface.  This normally requires the root user, but
214
 
      could be configured otherwise by reconfiguring the D-Bus server.
215
 
    </para>
216
 
  </refsect1>
217
 
  
218
 
  <refsect1 id="see_also">
219
 
    <title>SEE ALSO</title>
220
 
    <para>
221
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
222
 
      <manvolnum>8</manvolnum></citerefentry>,
223
 
      <citerefentry><refentrytitle>mandos-ctl</refentrytitle>
224
 
      <manvolnum>8</manvolnum></citerefentry>
225
 
    </para>
226
 
  </refsect1>
227
 
  
228
 
</refentry>
229
 
<!-- Local Variables: -->
230
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
231
 
<!-- time-stamp-end: "[\"']>" -->
232
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
233
 
<!-- End: -->