/mandos/release

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

« back to all changes in this revision

Viewing changes to plugins.d/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-02 17:42:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902174253-p3wxrq7z6ccnv7fs
* plugins.d/password-request.c (main): Change default GnuTLS priority
                                       string to
                             "SECURE256":!CTYPE-X.509:+CTYPE-OPENPGP".

* plugins.d/password-request.xml (DESCRIPTION): Improve wording.
  (PURPOSE, OVERVIEW): New sections.
  (OPTIONS): Improved wording.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Commented out.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-03">
 
6
<!ENTITY TIMESTAMP "2008-09-02">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
137
137
      This program is not meant to be run directly; it is really meant
138
138
      to run as a plugin of the <application>Mandos</application>
139
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.
 
140
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn
 
141
      runs as a <quote>keyscript</quote> specified in the
 
142
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
143
      <manvolnum>5</manvolnum></citerefentry> file.
145
144
    </para>
146
145
  </refsect1>
147
146
  
155
154
    </para>
156
155
  </refsect1>
157
156
  
 
157
  <refsect1 id="overview">
 
158
    <title>OVERVIEW</title>
 
159
    <xi:include href="overview.xml"/>
 
160
    <para>
 
161
      This program is the client part.  It is a plugin started by
 
162
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
163
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
164
      an initial <acronym>RAM</acronym> disk environment.
 
165
    </para>
 
166
    <para>
 
167
      This program could, theoretically, be used as a keyscript in
 
168
      <filename>/etc/crypttab</filename>, but it would then be
 
169
      impossible to enter the encrypted root disk password at the
 
170
      console, since this program does not read from the console at
 
171
      all.  This is why a separate plugin does that, which will be run
 
172
      in parallell to this one.
 
173
    </para>
 
174
  </refsect1>
 
175
  
158
176
  <refsect1 id="options">
159
177
    <title>OPTIONS</title>
160
178
    <para>
170
188
    <variablelist>
171
189
      <varlistentry>
172
190
        <term><option>--connect=<replaceable
173
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
 
191
        >IPADDR</replaceable><literal>:</literal><replaceable
174
192
        >PORT</replaceable></option></term>
175
193
        <term><option>-c
176
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
194
        <replaceable>IPADDR</replaceable><literal>:</literal
177
195
        ><replaceable>PORT</replaceable></option></term>
178
196
        <listitem>
179
197
          <para>
184
202
            assumed to separate the address from the port number.
185
203
          </para>
186
204
          <para>
187
 
            This option is normally only useful for testing and
188
 
            debugging.
 
205
            This option is normally only useful for debugging.
189
206
          </para>
190
207
        </listitem>
191
208
      </varlistentry>
227
244
        <replaceable>FILE</replaceable></option></term>
228
245
        <listitem>
229
246
          <para>
230
 
            OpenPGP public key file base name.  This will be combined
231
 
            with the directory from the <option>--keydir</option>
232
 
            option to form an absolute file name.  The default name is
 
247
            OpenPGP public key file name.  This will be combined with
 
248
            the directory from the <option>--keydir</option> option to
 
249
            form an absolute file name.  The default name is
233
250
            <quote><literal>pubkey.txt</literal></quote>.
234
251
          </para>
235
252
        </listitem>
242
259
        <replaceable>FILE</replaceable></option></term>
243
260
        <listitem>
244
261
          <para>
245
 
            OpenPGP secret key file base name.  This will be combined
246
 
            with the directory from the <option>--keydir</option>
247
 
            option to form an absolute file name.  The default name is
 
262
            OpenPGP secret key file name.  This will be combined with
 
263
            the directory from the <option>--keydir</option> option to
 
264
            form an absolute file name.  The default name is
248
265
            <quote><literal>seckey.txt</literal></quote>.
249
266
          </para>
250
267
        </listitem>
254
271
        <term><option>--priority=<replaceable
255
272
        >STRING</replaceable></option></term>
256
273
        <listitem>
257
 
          <xi:include href="../mandos-options.xml"
258
 
                      xpointer="priority"/>
 
274
          <xi:include href="mandos-options.xml" xpointer="priority"/>
259
275
        </listitem>
260
276
      </varlistentry>
261
277
 
317
333
    </variablelist>
318
334
  </refsect1>
319
335
 
320
 
  <refsect1 id="overview">
321
 
    <title>OVERVIEW</title>
322
 
    <xi:include href="../overview.xml"/>
323
 
    <para>
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.
328
 
    </para>
329
 
    <para>
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.
336
 
    </para>
337
 
  </refsect1>
338
 
  
339
336
  <refsect1 id="exit_status">
340
337
    <title>EXIT STATUS</title>
341
338
    <para>
349
346
    </para>
350
347
  </refsect1>
351
348
  
352
 
  <refsect1 id="environment">
353
 
    <title>ENVIRONMENT</title>
354
 
    <para>
355
 
      This program does not use any environment variables, not even
356
 
      the ones provided by <citerefentry><refentrytitle
357
 
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
358
 
    </citerefentry>.
359
 
    </para>
360
 
  </refsect1>
 
349
<!--   <refsect1 id="environment"> -->
 
350
<!--     <title>ENVIRONMENT</title> -->
 
351
<!--     <para> -->
 
352
<!--       This program does not use any environment variables. -->
 
353
<!--     </para> -->
 
354
<!--   </refsect1> -->
361
355
  
362
356
  <refsect1 id="file">
363
357
    <title>FILES</title>
409
403
      
410
404
      <listitem><para>
411
405
        <ulink
412
 
        url="http://www.gnupg.org/related_software/gpgme/"
413
 
        >GPGME</ulink>
 
406
        url="http://www.gnupg.org/related_software/gpgme/">
 
407
        GPGME</ulink>
414
408
      </para></listitem>
415
409
      
416
410
      <listitem><para>