/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 plugins.d/password-request.xml

  • Committer: Björn Påhlsson
  • Date: 2008-07-20 02:52:20 UTC
  • Revision ID: belorn@braxen-20080720025220-r5u0388uy9iu23h6
Added following support:
Pluginbased client handler
rewritten Mandos client
       Avahi instead of udp server discovery
       openpgp encrypted key support
Passprompt stand alone application for direct console input
Added logging for Mandos server

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
 
]>
9
 
 
10
 
<refentry>
11
 
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
16
 
    <authorgroup>
17
 
      <author>
18
 
        <firstname>Björn</firstname>
19
 
        <surname>Påhlsson</surname>
20
 
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
22
 
        </address>
23
 
      </author>
24
 
      <author>
25
 
        <firstname>Teddy</firstname>
26
 
        <surname>Hogeborn</surname>
27
 
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
29
 
        </address>
30
 
      </author>
31
 
    </authorgroup>
32
 
    <copyright>
33
 
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
35
 
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
59
 
  </refentryinfo>
60
 
 
61
 
  <refmeta>
62
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
 
    <manvolnum>8mandos</manvolnum>
64
 
  </refmeta>
65
 
  
66
 
  <refnamediv>
67
 
    <refname><command>&COMMANDNAME;</command></refname>
68
 
    <refpurpose>
69
 
      Client for mandos
70
 
    </refpurpose>
71
 
  </refnamediv>
72
 
 
73
 
  <refsynopsisdiv>
74
 
    <cmdsynopsis>
75
 
      <command>&COMMANDNAME;</command>
76
 
      <arg choice='opt' rep='repeat'>OPTION</arg>
77
 
    </cmdsynopsis>
78
 
  </refsynopsisdiv>
79
 
 
80
 
  <refsect1 id="description">
81
 
    <title>DESCRIPTION</title>
82
 
    <para>
83
 
      <command>&COMMANDNAME;</command> is a mandos plugin that works
84
 
      like a client program that through avahi detects mandos servers,
85
 
      sets up a gnutls connect and request a encrypted password. Any
86
 
      passwords given is automaticly decrypted and passed to
87
 
      cryptsetup.
88
 
    </para>
89
 
 
90
 
    <variablelist>
91
 
      <varlistentry>
92
 
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
93
 
        IP</replaceable></literal></term>
94
 
        <listitem>
95
 
          <para>
96
 
            Connect directly to a sepcified mandos server
97
 
          </para>
98
 
        </listitem>
99
 
      </varlistentry>
100
 
 
101
 
      <varlistentry>
102
 
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
103
 
        KEYDIR</replaceable></literal></term>
104
 
        <listitem>
105
 
          <para>
106
 
            Directory where the openpgp keyring is
107
 
          </para>
108
 
        </listitem>
109
 
      </varlistentry>      
110
 
 
111
 
      <varlistentry>
112
 
        <term><literal>-i</literal>, <literal>--interface=
113
 
        <replaceable>INTERFACE</replaceable></literal></term>
114
 
        <listitem>
115
 
          <para>
116
 
            Interface that Avahi will conntect through
117
 
          </para>
118
 
        </listitem>
119
 
      </varlistentry>      
120
 
 
121
 
      <varlistentry>
122
 
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
123
 
        PUBKEY</replaceable></literal></term>
124
 
        <listitem>
125
 
          <para>
126
 
            Public openpgp key for gnutls authentication
127
 
          </para>
128
 
        </listitem>
129
 
      </varlistentry>      
130
 
 
131
 
      <varlistentry>
132
 
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
133
 
        SECKEY</replaceable></literal></term>
134
 
        <listitem>
135
 
          <para>
136
 
            Secret openpgp key for gnutls authentication
137
 
          </para>
138
 
        </listitem>
139
 
      </varlistentry>            
140
 
      
141
 
      <varlistentry>
142
 
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
143
 
        </literal></term>
144
 
        <listitem>
145
 
          <para>
146
 
            GNUTLS priority
147
 
          </para>
148
 
        </listitem>
149
 
      </varlistentry>            
150
 
 
151
 
      <varlistentry>
152
 
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
153
 
        </literal></term>
154
 
        <listitem>
155
 
          <para>
156
 
            dh-bits to use in gnutls communication
157
 
          </para>
158
 
        </listitem>
159
 
      </varlistentry>      
160
 
      
161
 
      <varlistentry>
162
 
        <term><literal>--debug</literal></term>
163
 
        <listitem>
164
 
          <para>
165
 
            Debug mode
166
 
          </para>
167
 
        </listitem>
168
 
      </varlistentry>
169
 
      
170
 
      <varlistentry>
171
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
172
 
        <listitem>
173
 
          <para>
174
 
            Gives a help message
175
 
          </para>
176
 
        </listitem>
177
 
      </varlistentry>
178
 
      
179
 
      <varlistentry>
180
 
        <term><literal>--usage</literal></term>
181
 
        <listitem>
182
 
          <para>
183
 
            Gives a short usage message
184
 
          </para>
185
 
        </listitem>
186
 
      </varlistentry>
187
 
 
188
 
      <varlistentry>
189
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
190
 
        <listitem>
191
 
          <para>
192
 
            Prints the program version
193
 
          </para>
194
 
        </listitem>
195
 
      </varlistentry>            
196
 
    </variablelist>
197
 
  </refsect1>
198
 
</refentry>