/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/xsl"
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY VERSION "1.0">
<!ENTITY COMMANDNAME "mandos">
]>

<refentry>
  <refentryinfo>
    <title>&COMMANDNAME;</title>
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
    <productname>&COMMANDNAME;</productname>
    <productnumber>&VERSION;</productnumber>
    <authorgroup>
      <author>
	<firstname>Björn</firstname>
	<surname>Påhlsson</surname>
	<address>
	  <email>belorn@fukt.bsnet.se</email>
	</address>
      </author>
      <author>
	<firstname>Teddy</firstname>
	<surname>Hogeborn</surname>
	<address>
	  <email>teddy@fukt.bsnet.se</email>
	</address>
      </author>
    </authorgroup>
    <copyright>
      <year>2008</year>
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
    </copyright>
    <legalnotice>
      <para>
	This manual page is free software: you can redistribute it
	and/or modify it under the terms of the GNU General Public
	License as published by the Free Software Foundation,
	either version 3 of the License, or (at your option) any
	later version.
      </para>

      <para>
	This manual page is distributed in the hope that it will
	be useful, but WITHOUT ANY WARRANTY; without even the
	implied warranty of MERCHANTABILITY or FITNESS FOR A
	PARTICULAR PURPOSE.  See the GNU General Public License
	for more details.
      </para>

      <para>
	You should have received a copy of the GNU General Public
	License along with this program; If not, see
	<ulink url="http://www.gnu.org/licenses/"/>.
      </para>
    </legalnotice>
  </refentryinfo>

  <refmeta>
    <refentrytitle>&COMMANDNAME;</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  
  <refnamediv>
    <refname><command>&COMMANDNAME;</command></refname>
    <refpurpose>
      Sends encrypted passwords to authenticated mandos clients
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
      <arg choice='opt'>--debug</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='plain'>--help</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='plain'>--version</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='plain'>--check</arg>
    </cmdsynopsis>    
  </refsynopsisdiv>

  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>
      <command>&COMMANDNAME;</command> is a server daemon that handels
      incomming passwords request for passwords. Mandos use avahi to
      announce the service, and through gnutls authenticates
      clients. Any authenticated client is then given its encrypted
      password.
    </para>

    <variablelist>
      <varlistentry>
	<term><literal>-h</literal>, <literal>--help</literal></term>
	<listitem>
	  <para>
	    show a help message and exit
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-i</literal>, <literal>--interface <replaceable>
	IF</replaceable></literal></term>
	<listitem>
	  <para>
	    Bind to interface IF
	  </para>
	</listitem>
      </varlistentry>      

      <varlistentry>
	<term><literal>-a</literal>, <literal>--address <replaceable>
	ADDRESS</replaceable></literal></term>
	<listitem>
	  <para>
	    Address to listen for requests on
	  </para>
	</listitem>
      </varlistentry>          

      <varlistentry>
	<term><literal>-p</literal>, <literal>--port <replaceable>
	PORT</replaceable></literal></term>
	<listitem>
	  <para>
	    Port number to receive requests on
	  </para>
	</listitem>
      </varlistentry>          

      <varlistentry>
	<term><literal>--check</literal></term>
	<listitem>
	  <para>
	    Run self-test on the server
	  </para>
	</listitem>
      </varlistentry>      

      <varlistentry>
	<term><literal>--debug</literal></term>
	<listitem>
	  <para>
	    Debug mode
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>--priority <replaceable>
	PRIORITY</replaceable></literal></term>
	<listitem>
	  <para>
	    GnuTLS priority string. See <citerefentry>
	    <refentrytitle>gnutls_priority_init</refentrytitle>
	    <manvolnum>3</manvolnum></citerefentry>
	  </para>
	</listitem>
      </varlistentry>      

      <varlistentry>
	<term><literal>--servicename <replaceable>NAME</replaceable>
	</literal></term>
	<listitem>
	  <para>
	    Zeroconf service name
	  </para>
	</listitem>
      </varlistentry>     

      <varlistentry>
	<term><literal>--configdir <replaceable>DIR</replaceable>
	</literal></term>
	<listitem>
	  <para>
	    Directory to search for configuration files
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>--version</literal></term>
	<listitem>
	  <para>
	    Prints the program version
	  </para>
	</listitem>
      </varlistentry>      
      
    </variablelist>
  </refsect1>
</refentry>