/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-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-09 02:53:48 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080809025348-2xk3e41pptc3hsl6
* mandos: Make syslog use "/dev/log" instead of UDP to localhost.
          Include "Mandos" in the log message.
  (AvahiService.max_renames): Increased to 32768.
  (AvahiService.rename): Alter the syslogger message.
  (main): Only log debug messages if in debug mode.  If different from
          "Mandos" include service name in syslog message.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-client.xml
4
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
6
<!ENTITY VERSION "1.0">
7
 
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-31">
 
7
<!ENTITY COMMANDNAME "mandos-client">
9
8
]>
10
9
 
11
10
<refentry>
12
11
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
12
    <title>&COMMANDNAME;</title>
14
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
 
14
    <productname>&COMMANDNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
16
    <authorgroup>
19
17
      <author>
20
18
        <firstname>Björn</firstname>
68
66
  <refnamediv>
69
67
    <refname><command>&COMMANDNAME;</command></refname>
70
68
    <refpurpose>
71
 
      Run Mandos plugins.  Pass data from first succesful one.
 
69
      get password for encrypted rootdisk
72
70
    </refpurpose>
73
71
  </refnamediv>
74
72
 
75
73
  <refsynopsisdiv>
76
74
    <cmdsynopsis>
77
75
      <command>&COMMANDNAME;</command>
78
 
      <group rep="repeat">
79
 
        <arg choice="plain"><option>--global-envs=<replaceable
80
 
        >VAR</replaceable><literal>=</literal><replaceable
81
 
        >value</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-e
83
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
84
 
        >value</replaceable> </option></arg>
85
 
      </group>
86
 
      <sbr/>
87
 
      <group rep="repeat">
88
 
        <arg choice="plain"><option>--envs-for=<replaceable
89
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
90
 
        >ENV</replaceable><literal>=</literal><replaceable
91
 
        >value</replaceable></option></arg>
92
 
        <arg choice="plain"><option>-f<replaceable>
93
 
        PLUGIN</replaceable><literal>:</literal><replaceable
94
 
        >ENV</replaceable><literal>=</literal><replaceable
95
 
        >value</replaceable> </option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <group rep="repeat">
99
 
        <arg choice="plain"><option>--global-options=<replaceable
100
 
        >OPTIONS</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-g<replaceable>
102
 
        OPTIONS</replaceable> </option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <group rep="repeat">
106
 
        <arg choice="plain"><option>--options-for=<replaceable
107
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
108
 
        >OPTIONS</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-f<replaceable>
110
 
        PLUGIN</replaceable><literal>:</literal><replaceable
111
 
        >OPTIONS</replaceable> </option></arg>
112
 
      </group>
113
 
      <sbr/>
114
 
      <group rep="repeat">
115
 
        <arg choice="plain"><option>--disable=<replaceable
116
 
        >PLUGIN</replaceable></option></arg>
117
 
        <arg choice="plain"><option>-d
118
 
        <replaceable>PLUGIN</replaceable> </option></arg>
119
 
      </group>
120
 
      <sbr/>
121
 
      <arg><option>--groupid=<replaceable
122
 
      >ID</replaceable></option></arg>
123
 
      <sbr/>
124
 
      <arg><option>--userid=<replaceable
125
 
      >ID</replaceable></option></arg>
126
 
      <sbr/>
127
 
      <arg><option>--plugin-dir=<replaceable
128
 
      >DIRECTORY</replaceable></option></arg>
129
 
      <sbr/>
130
 
      <arg><option>--debug</option></arg>
131
 
    </cmdsynopsis>
132
 
    <cmdsynopsis>
133
 
      <command>&COMMANDNAME;</command>
134
 
      <group choice="req">
135
 
        <arg choice='plain'><option>--help</option></arg>
136
 
        <arg choice='plain'><option>-?</option></arg>
137
 
      </group>
138
 
    </cmdsynopsis>
139
 
    <cmdsynopsis>
140
 
      <command>&COMMANDNAME;</command>
141
 
      <arg choice='plain'><option>--usage</option></arg>
142
 
    </cmdsynopsis>
143
 
    <cmdsynopsis>
144
 
      <command>&COMMANDNAME;</command>
145
 
      <group choice="req">
146
 
        <arg choice='plain'><option>--version</option></arg>
147
 
        <arg choice='plain'><option>-V</option></arg>
148
 
      </group>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
149
77
    </cmdsynopsis>
150
78
  </refsynopsisdiv>
151
79
 
154
82
    <para>
155
83
      <command>&COMMANDNAME;</command> is a plugin runner that waits
156
84
      for any of its plugins to return sucessfull with a password, and
157
 
      passes it to cryptsetup as stdout message. This command is not
158
 
      meant to be invoked directly, but is instead meant to be run by
159
 
      cryptsetup by being specified in /etc/crypttab as a keyscript
160
 
      and subsequlently started in the initrd environment. See
161
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
162
 
      <manvolnum>5</manvolnum></citerefentry> for more information on
163
 
      keyscripts.
 
85
      passes it to cryptsetup. plugins is defined as any executables
 
86
      in the plugins directory will by default will be
 
87
      /conf/conf.d/mandos/plugins.d.  to stdout.
164
88
    </para>
165
89
 
166
 
    <para>
167
 
      plugins is looked for in the plugins directory which by default will be
168
 
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
169
 
    </para>
170
 
  </refsect1>
171
 
  <refsect1>
172
 
    <title>OPTIONS</title>
173
90
    <variablelist>
174
91
      <varlistentry>
175
 
        <term><option>--global-options
176
 
        <replaceable>OPTIONS</replaceable></option></term>
177
 
        <term><option>-g
178
 
        <replaceable>OPTIONS</replaceable></option></term>
 
92
        <term><literal>-g</literal>,<literal>--global-options
 
93
        <replaceable>OPTIONS</replaceable></literal></term>
179
94
        <listitem>
180
95
          <para>
181
96
            Global options given to all plugins as additional start
182
97
            arguments.  Options are specified with a -o flag followed
183
98
            by a comma separated string of options.
184
 
          </para>       
 
99
          </para>         
185
100
        </listitem>
186
101
      </varlistentry>
187
102
 
188
103
      <varlistentry>
189
 
        <term><option>--options-for
190
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
191
 
        ><replaceable>OPTION</replaceable></option></term>
192
 
        <term><option>-o
193
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
194
 
        ><replaceable>OPTION</replaceable></option></term>
 
104
        <term><literal>-o</literal>,<literal> --options-for
 
105
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
106
        </literal></term>
195
107
        <listitem>
196
108
          <para>
197
109
            Plugin specific options given to the plugin as additional
198
110
            start arguments.  Options are specified with a -o flag
199
111
            followed by a comma separated string of options.
200
 
          </para>       
 
112
          </para>         
201
113
        </listitem>
202
 
      </varlistentry>
 
114
      </varlistentry>      
203
115
 
204
116
      <varlistentry>
205
 
        <term><option> --disable
206
 
        <replaceable>PLUGIN</replaceable></option></term>
207
 
        <term><option>-d
208
 
        <replaceable>PLUGIN</replaceable></option></term>
 
117
        <term><literal>-d</literal>,<literal> --disable
 
118
        <replaceable>PLUGIN</replaceable>
 
119
        </literal></term>
209
120
        <listitem>
210
121
          <para>
211
122
            Disable a specific plugin
212
 
          </para>       
 
123
          </para>         
213
124
        </listitem>
214
125
      </varlistentry>
215
126
 
216
127
      <varlistentry>
217
 
        <term><option>--groupid
218
 
        <replaceable>ID</replaceable></option></term>
 
128
        <term><literal>--groupid <replaceable>ID</replaceable>
 
129
        </literal></term>
219
130
        <listitem>
220
131
          <para>
221
132
            Group ID the plugins will run as
222
133
          </para>
223
134
        </listitem>
224
 
      </varlistentry>
 
135
      </varlistentry>      
225
136
 
226
137
      <varlistentry>
227
 
        <term><option>--userid
228
 
        <replaceable>ID</replaceable></option></term>
 
138
        <term><literal>--userid <replaceable>ID</replaceable>
 
139
        </literal></term>
229
140
        <listitem>
230
141
          <para>
231
142
            User ID the plugins will run as
232
143
          </para>
233
144
        </listitem>
234
 
      </varlistentry>
 
145
      </varlistentry>      
235
146
 
236
147
      <varlistentry>
237
 
        <term><option>--plugin-dir
238
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
148
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
149
        </literal></term>
239
150
        <listitem>
240
151
          <para>
241
152
            Specify a different plugin directory
242
153
          </para>
243
154
        </listitem>
244
 
      </varlistentry>
 
155
      </varlistentry>       
245
156
      
246
157
      <varlistentry>
247
 
        <term><option>--debug</option></term>
 
158
        <term><literal>--debug</literal></term>
248
159
        <listitem>
249
160
          <para>
250
161
            Debug mode
253
164
      </varlistentry>
254
165
      
255
166
      <varlistentry>
256
 
        <term><option>--help</option></term>
257
 
        <term><option>-?</option></term>
 
167
        <term><literal>-?</literal>, <literal>--help</literal></term>
258
168
        <listitem>
259
169
          <para>
260
170
            Gives a help message
263
173
      </varlistentry>
264
174
      
265
175
      <varlistentry>
266
 
        <term><option>--usage</option></term>
 
176
        <term><literal>--usage</literal></term>
267
177
        <listitem>
268
178
          <para>
269
179
            Gives a short usage message
272
182
      </varlistentry>
273
183
 
274
184
      <varlistentry>
275
 
        <term><option>--version</option></term>
276
 
        <term><option>-V</option></term>
 
185
        <term><literal>-V</literal>, <literal>--version</literal></term>
277
186
        <listitem>
278
187
          <para>
279
188
            Prints the program version
280
189
          </para>
281
190
        </listitem>
282
 
      </varlistentry>
 
191
      </varlistentry>            
283
192
    </variablelist>
284
193
  </refsect1>
285
 
 
286
 
  <refsect1 id="exit_status">
287
 
    <title>EXIT STATUS</title>
288
 
    <para>
289
 
    </para>
290
 
  </refsect1>
291
 
 
292
 
  <refsect1 id="file">
293
 
    <title>FILES</title>
294
 
    <para>
295
 
    </para>
296
 
  </refsect1>
297
 
 
298
 
  <refsect1 id="notes">
299
 
    <title>NOTES</title>
300
 
    <para>
301
 
    </para>
302
 
  </refsect1>
303
 
  
304
 
  <refsect1 id="bugs">
305
 
    <title>BUGS</title>
306
 
    <para>
307
 
    </para>
308
 
  </refsect1>
309
 
 
310
 
  <refsect1 id="examples">
311
 
    <title>EXAMPLE</title>
312
 
    <para>
313
 
    </para>
314
 
  </refsect1>
315
 
 
316
 
  <refsect1 id="security">
317
 
    <title>SECURITY</title>
318
 
    <para>
319
 
    </para>
320
 
  </refsect1>
321
 
 
322
 
  <refsect1 id="see_also">
323
 
    <title>SEE ALSO</title>
324
 
    <para>
325
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>,
327
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
328
 
      <manvolnum>8</manvolnum></citerefentry>,
329
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
330
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
331
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
332
 
      <manvolnum>8mandos</manvolnum></citerefentry>
333
 
    </para>
334
 
  </refsect1>
335
 
 
336
194
</refentry>
337
 
<!-- Local Variables: -->
338
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
339
 
<!-- time-stamp-end: "[\"']>" -->
340
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
341
 
<!-- End: -->