/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-08-29 06:38:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829063827-hbjl6t92tyjl5305
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New.  Automatically
                                              updated by Emacs
                                              time-stamp by using
                                              Emacs local variables.
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
 
7
<!ENTITY COMMANDNAME "password-request">
 
8
<!ENTITY TIMESTAMP "2008-08-29">
 
9
]>
 
10
 
 
11
<refentry>
 
12
  <refentryinfo>
 
13
    <title>&COMMANDNAME;</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>&COMMANDNAME;</productname>
 
16
    <productnumber>&VERSION;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
 
18
    <authorgroup>
 
19
      <author>
 
20
        <firstname>Björn</firstname>
 
21
        <surname>Påhlsson</surname>
 
22
        <address>
 
23
          <email>belorn@fukt.bsnet.se</email>
 
24
        </address>
 
25
      </author>
 
26
      <author>
 
27
        <firstname>Teddy</firstname>
 
28
        <surname>Hogeborn</surname>
 
29
        <address>
 
30
          <email>teddy@fukt.bsnet.se</email>
 
31
        </address>
 
32
      </author>
 
33
    </authorgroup>
 
34
    <copyright>
 
35
      <year>2008</year>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
37
    </copyright>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
 
61
  </refentryinfo>
 
62
 
 
63
  <refmeta>
 
64
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
65
    <manvolnum>8mandos</manvolnum>
 
66
  </refmeta>
 
67
  
 
68
  <refnamediv>
 
69
    <refname><command>&COMMANDNAME;</command></refname>
 
70
    <refpurpose>
 
71
      Client for mandos
 
72
    </refpurpose>
 
73
  </refnamediv>
 
74
 
 
75
  <refsynopsisdiv>
 
76
    <cmdsynopsis>
 
77
      <command>&COMMANDNAME;</command>
 
78
      <arg choice='opt'>--connect<arg choice='plain'>IP</arg></arg>
 
79
      <arg choice='opt'>--keydir<arg choice='plain'>KEYDIR</arg></arg>
 
80
      <arg choice='opt'>--interface<arg choice='plain'>INTERFACE</arg></arg>
 
81
      <arg choice='opt'>--pubkey<arg choice='plain'>PUBKEY</arg></arg>
 
82
      <arg choice='opt'>--seckey<arg choice='plain'>SECKEY</arg></arg>
 
83
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
84
      <arg choice='opt'>--dh-bits<arg choice='plain'>BITS</arg></arg>      
 
85
      <arg choice='opt'>--debug</arg>
 
86
    </cmdsynopsis>
 
87
    <cmdsynopsis>
 
88
      <command>&COMMANDNAME;</command>
 
89
      <arg choice='plain'>--help</arg>
 
90
    </cmdsynopsis>
 
91
    <cmdsynopsis>
 
92
      <command>&COMMANDNAME;</command>
 
93
      <arg choice='plain'>--usage</arg>
 
94
    </cmdsynopsis>
 
95
    <cmdsynopsis>
 
96
      <command>&COMMANDNAME;</command>
 
97
      <arg choice='plain'>--version</arg>
 
98
    </cmdsynopsis>    
 
99
  </refsynopsisdiv>
 
100
 
 
101
  <refsect1 id="description">
 
102
    <title>DESCRIPTION</title>
 
103
    <para>
 
104
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
105
      like a client program that through avahi detects mandos servers,
 
106
      sets up a gnutls connect and request a encrypted password. Any
 
107
      passwords given is automaticly decrypted and passed to
 
108
      cryptsetup.
 
109
    </para>
 
110
  </refsect1>  
 
111
  
 
112
  <refsect1 id="options">
 
113
    <title>OPTIONS</title>
 
114
    <para>
 
115
      Commonly not invoked as command lines but from configuration
 
116
      file of plugin runner.
 
117
    </para>
 
118
 
 
119
    <variablelist>
 
120
      <varlistentry>
 
121
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
122
        IP</replaceable></literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Connect directly to a specified mandos server
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
132
        KEYDIR</replaceable></literal></term>
 
133
        <listitem>
 
134
          <para>
 
135
            Directory where the openpgp keyring is
 
136
          </para>
 
137
        </listitem>
 
138
      </varlistentry>      
 
139
 
 
140
      <varlistentry>
 
141
        <term><literal>-i</literal>, <literal>--interface=
 
142
        <replaceable>INTERFACE</replaceable></literal></term>
 
143
        <listitem>
 
144
          <para>
 
145
            Interface that Avahi will conntect through
 
146
          </para>
 
147
        </listitem>
 
148
      </varlistentry>      
 
149
 
 
150
      <varlistentry>
 
151
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
152
        PUBKEY</replaceable></literal></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Public openpgp key for gnutls authentication
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>      
 
159
 
 
160
      <varlistentry>
 
161
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
162
        SECKEY</replaceable></literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Secret openpgp key for gnutls authentication
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>            
 
169
      
 
170
      <varlistentry>
 
171
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
172
        </literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            GNUTLS priority
 
176
          </para>
 
177
        </listitem>
 
178
      </varlistentry>            
 
179
 
 
180
      <varlistentry>
 
181
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
182
        </literal></term>
 
183
        <listitem>
 
184
          <para>
 
185
            dh-bits to use in gnutls communication
 
186
          </para>
 
187
        </listitem>
 
188
      </varlistentry>      
 
189
      
 
190
      <varlistentry>
 
191
        <term><literal>--debug</literal></term>
 
192
        <listitem>
 
193
          <para>
 
194
            Debug mode
 
195
          </para>
 
196
        </listitem>
 
197
      </varlistentry>
 
198
      
 
199
      <varlistentry>
 
200
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
201
        <listitem>
 
202
          <para>
 
203
            Gives a help message
 
204
          </para>
 
205
        </listitem>
 
206
      </varlistentry>
 
207
      
 
208
      <varlistentry>
 
209
        <term><literal>--usage</literal></term>
 
210
        <listitem>
 
211
          <para>
 
212
            Gives a short usage message
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
 
 
217
      <varlistentry>
 
218
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
219
        <listitem>
 
220
          <para>
 
221
            Prints the program version
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>            
 
225
    </variablelist>
 
226
  </refsect1>
 
227
 
 
228
  <refsect1 id="exit_status">
 
229
    <title>EXIT STATUS</title>
 
230
    <para>
 
231
    </para>
 
232
  </refsect1>
 
233
 
 
234
  <refsect1 id="environment">
 
235
    <title>ENVIRONMENT</title>
 
236
    <para>
 
237
    </para>
 
238
  </refsect1>  
 
239
 
 
240
  <refsect1 id="file">
 
241
    <title>FILES</title>
 
242
    <para>
 
243
    </para>
 
244
  </refsect1>  
 
245
  
 
246
  <refsect1 id="bugs">
 
247
    <title>BUGS</title>
 
248
    <para>
 
249
    </para>
 
250
  </refsect1>  
 
251
 
 
252
  <refsect1 id="example">
 
253
    <title>EXAMPLE</title>
 
254
    <para>
 
255
    </para>
 
256
  </refsect1>
 
257
 
 
258
  <refsect1 id="security">
 
259
    <title>SECURITY</title>
 
260
    <para>
 
261
    </para>
 
262
  </refsect1>
 
263
 
 
264
  <refsect1 id="see_also">
 
265
    <title>SEE ALSO</title>
 
266
    <itemizedlist>
 
267
      <listitem><para>
 
268
        <citerefentry><refentrytitle>mandos</refentrytitle>
 
269
        <manvolnum>8</manvolnum></citerefentry>
 
270
      </para></listitem>
 
271
      
 
272
      <listitem><para>
 
273
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
274
        <manvolnum>8mandos</manvolnum></citerefentry>
 
275
      </para></listitem>
 
276
      
 
277
      <listitem><para>
 
278
        <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
279
        <manvolnum>8mandos</manvolnum></citerefentry>
 
280
      </para></listitem>
 
281
      
 
282
      <listitem><para>
 
283
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
284
      </para></listitem>
 
285
      
 
286
      <listitem><para>
 
287
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
288
      </para></listitem>
 
289
      
 
290
      <listitem><para>
 
291
        <ulink
 
292
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
293
      </para></listitem>
 
294
      
 
295
      <listitem><para>
 
296
        <ulink
 
297
        url="http://www.gnupg.org/related_software/gpgme/">
 
298
        GPGME</ulink>
 
299
      </para></listitem>
 
300
      
 
301
      <listitem><para>
 
302
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
303
        Format</citetitle></citation>
 
304
      </para></listitem>
 
305
      
 
306
      <listitem><para>
 
307
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
308
        Transport Layer Security</citetitle></citation>
 
309
      </para></listitem>
 
310
      
 
311
      <listitem><para>
 
312
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
313
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
314
        Unicast Addresses</citation>
 
315
      </para></listitem>
 
316
    </itemizedlist>
 
317
  </refsect1>
 
318
 
 
319
</refentry>
 
320
<!-- Local Variables: -->
 
321
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
322
<!-- time-stamp-end: "[\"']>" -->
 
323
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
324
<!-- End: -->