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-keygen.xml
- browse files at revision 483
- compare with another revision
- download diff
- download tarball
- view history from revision 483
- Committer: Teddy Hogeborn
- Date: 2011-04-03 00:46:51 UTC
- Revision ID: teddy@fukt.bsnet.se-20110403004651-yyrzgwwkoq4ts2vi
* mandos: Never call .Reset() on a defunct Avahi entry group.
(AvahiService.remove): Only do group.Reset(), as before.
(AvahiService.add): Only create new group if necessary.
(AvahiService.cleanup): Also do group.Free() if a group exists.
(AvahiService.server_state_changed): Call .cleanup() on errors.
Also log error parameter, if
passed.
(AvahiService.remove): Only do group.Reset(), as before.
(AvahiService.add): Only create new group if necessary.
(AvahiService.cleanup): Also do group.Free() if a group exists.
(AvahiService.server_state_changed): Call .cleanup() on errors.
Also log error parameter, if
passed.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- files removed:
- plugins.d/usplash
- files renamed:
- plugins.d/password-request.c => plugins.d/mandos-client.c
- plugins.d/password-request.xml => plugins.d/mandos-client.xml
- files modified:
- Makefile
added
removed
mandos-keygen.xml
1
<?xml version='1.0' encoding='UTF-8'?>
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
5
<!ENTITY TIMESTAMP "2009-01-04">
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
6
8
]>
7
9
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
11
<refentryinfo>
10
<title>&COMMANDNAME;</title>
11
<!-- NWalsh's docbook scripts use this to generate the footer: -->
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
12
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
14
17
<authorgroup>
15
18
<author>
16
19
<firstname>Björn</firstname>
29
32
</authorgroup>
30
33
<copyright>
31
34
<year>2008</year>
32
<holder>Teddy Hogeborn & Björn Påhlsson</holder>
35
<year>2009</year>
36
<holder>Teddy Hogeborn</holder>
37
<holder>Björn Påhlsson</holder>
33
38
</copyright>
34
<legalnotice>
35
<para>
36
This manual page is free software: you can redistribute it
37
and/or modify it under the terms of the GNU General Public
38
License as published by the Free Software Foundation,
39
either version 3 of the License, or (at your option) any
40
later version.
41
</para>
42
43
<para>
44
This manual page is distributed in the hope that it will
45
be useful, but WITHOUT ANY WARRANTY; without even the
46
implied warranty of MERCHANTABILITY or FITNESS FOR A
47
PARTICULAR PURPOSE. See the GNU General Public License
48
for more details.
49
</para>
50
51
<para>
52
You should have received a copy of the GNU General Public
53
License along with this program; If not, see
54
<ulink url="http://www.gnu.org/licenses/"/>.
55
</para>
56
</legalnotice>
39
<xi:include href="legalnotice.xml"/>
57
40
</refentryinfo>
58
41
59
42
<refmeta>
60
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
61
44
<manvolnum>8</manvolnum>
64
47
<refnamediv>
65
48
<refname><command>&COMMANDNAME;</command></refname>
66
49
<refpurpose>
67
Generate keys for <citerefentry><refentrytitle>password-request
68
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
50
Generate key and password for Mandos client and server.
69
51
</refpurpose>
70
52
</refnamediv>
71
53
72
54
<refsynopsisdiv>
73
55
<cmdsynopsis>
74
56
<command>&COMMANDNAME;</command>
75
<group choice="opt">
76
<arg choice="plain"><option>--dir</option>
77
<replaceable>directory</replaceable></arg>
78
</group>
79
<group choice="opt">
80
<arg choice="plain"><option>--type</option>
81
<replaceable>type</replaceable></arg>
82
</group>
83
<group choice="opt">
84
<arg choice="plain"><option>--length</option>
85
<replaceable>bits</replaceable></arg>
86
</group>
87
<group choice="opt">
88
<arg choice="plain"><option>--name</option>
89
<replaceable>NAME</replaceable></arg>
90
</group>
91
<group choice="opt">
92
<arg choice="plain"><option>--email</option>
93
<replaceable>EMAIL</replaceable></arg>
94
</group>
95
<group choice="opt">
96
<arg choice="plain"><option>--comment</option>
97
<replaceable>COMMENT</replaceable></arg>
98
</group>
99
<group choice="opt">
100
<arg choice="plain"><option>--expire</option>
101
<replaceable>TIME</replaceable></arg>
102
</group>
103
<group choice="opt">
104
<arg choice="plain"><option>--force</option></arg>
105
</group>
106
</cmdsynopsis>
107
<cmdsynopsis>
108
<command>&COMMANDNAME;</command>
109
<group choice="opt">
110
<arg choice="plain"><option>-d</option>
111
<replaceable>directory</replaceable></arg>
112
</group>
113
<group choice="opt">
114
<arg choice="plain"><option>-t</option>
115
<replaceable>type</replaceable></arg>
116
</group>
117
<group choice="opt">
118
<arg choice="plain"><option>-l</option>
119
<replaceable>bits</replaceable></arg>
120
</group>
121
<group choice="opt">
122
<arg choice="plain"><option>-n</option>
123
<replaceable>NAME</replaceable></arg>
124
</group>
125
<group choice="opt">
126
<arg choice="plain"><option>-e</option>
127
<replaceable>EMAIL</replaceable></arg>
128
</group>
129
<group choice="opt">
130
<arg choice="plain"><option>-c</option>
131
<replaceable>COMMENT</replaceable></arg>
132
</group>
133
<group choice="opt">
134
<arg choice="plain"><option>-x</option>
135
<replaceable>TIME</replaceable></arg>
136
</group>
137
<group choice="opt">
138
<arg choice="plain"><option>-f</option></arg>
139
</group>
140
</cmdsynopsis>
141
<cmdsynopsis>
142
<command>&COMMANDNAME;</command>
143
<group choice="req">
144
<arg choice='plain'><option>-h</option></arg>
145
<arg choice='plain'><option>--help</option></arg>
146
</group>
147
</cmdsynopsis>
148
<cmdsynopsis>
149
<command>&COMMANDNAME;</command>
150
<group choice="req">
151
<arg choice='plain'><option>-v</option></arg>
152
<arg choice='plain'><option>--version</option></arg>
57
<group>
58
<arg choice="plain"><option>--dir
59
<replaceable>DIRECTORY</replaceable></option></arg>
60
<arg choice="plain"><option>-d
61
<replaceable>DIRECTORY</replaceable></option></arg>
62
</group>
63
<sbr/>
64
<group>
65
<arg choice="plain"><option>--type
66
<replaceable>KEYTYPE</replaceable></option></arg>
67
<arg choice="plain"><option>-t
68
<replaceable>KEYTYPE</replaceable></option></arg>
69
</group>
70
<sbr/>
71
<group>
72
<arg choice="plain"><option>--length
73
<replaceable>BITS</replaceable></option></arg>
74
<arg choice="plain"><option>-l
75
<replaceable>BITS</replaceable></option></arg>
76
</group>
77
<sbr/>
78
<group>
79
<arg choice="plain"><option>--subtype
80
<replaceable>KEYTYPE</replaceable></option></arg>
81
<arg choice="plain"><option>-s
82
<replaceable>KEYTYPE</replaceable></option></arg>
83
</group>
84
<sbr/>
85
<group>
86
<arg choice="plain"><option>--sublength
87
<replaceable>BITS</replaceable></option></arg>
88
<arg choice="plain"><option>-L
89
<replaceable>BITS</replaceable></option></arg>
90
</group>
91
<sbr/>
92
<group>
93
<arg choice="plain"><option>--name
94
<replaceable>NAME</replaceable></option></arg>
95
<arg choice="plain"><option>-n
96
<replaceable>NAME</replaceable></option></arg>
97
</group>
98
<sbr/>
99
<group>
100
<arg choice="plain"><option>--email
101
<replaceable>ADDRESS</replaceable></option></arg>
102
<arg choice="plain"><option>-e
103
<replaceable>ADDRESS</replaceable></option></arg>
104
</group>
105
<sbr/>
106
<group>
107
<arg choice="plain"><option>--comment
108
<replaceable>TEXT</replaceable></option></arg>
109
<arg choice="plain"><option>-c
110
<replaceable>TEXT</replaceable></option></arg>
111
</group>
112
<sbr/>
113
<group>
114
<arg choice="plain"><option>--expire
115
<replaceable>TIME</replaceable></option></arg>
116
<arg choice="plain"><option>-x
117
<replaceable>TIME</replaceable></option></arg>
118
</group>
119
<sbr/>
120
<arg><option>--force</option></arg>
121
</cmdsynopsis>
122
<cmdsynopsis>
123
<command>&COMMANDNAME;</command>
124
<group choice="req">
125
<arg choice="plain"><option>--password</option></arg>
126
<arg choice="plain"><option>-p</option></arg>
127
<arg choice="plain"><option>--passfile
128
<replaceable>FILE</replaceable></option></arg>
129
<arg choice="plain"><option>-F</option>
130
<replaceable>FILE</replaceable></arg>
131
</group>
132
<sbr/>
133
<group>
134
<arg choice="plain"><option>--dir
135
<replaceable>DIRECTORY</replaceable></option></arg>
136
<arg choice="plain"><option>-d
137
<replaceable>DIRECTORY</replaceable></option></arg>
138
</group>
139
<sbr/>
140
<group>
141
<arg choice="plain"><option>--name
142
<replaceable>NAME</replaceable></option></arg>
143
<arg choice="plain"><option>-n
144
<replaceable>NAME</replaceable></option></arg>
145
</group>
146
</cmdsynopsis>
147
<cmdsynopsis>
148
<command>&COMMANDNAME;</command>
149
<group choice="req">
150
<arg choice="plain"><option>--help</option></arg>
151
<arg choice="plain"><option>-h</option></arg>
152
</group>
153
</cmdsynopsis>
154
<cmdsynopsis>
155
<command>&COMMANDNAME;</command>
156
<group choice="req">
157
<arg choice="plain"><option>--version</option></arg>
158
<arg choice="plain"><option>-v</option></arg>
153
159
</group>
154
160
</cmdsynopsis>
155
161
</refsynopsisdiv>
156
162
157
163
<refsect1 id="description">
158
164
<title>DESCRIPTION</title>
159
165
<para>
160
166
<command>&COMMANDNAME;</command> is a program to generate the
161
OpenPGP keys used by
162
<citerefentry><refentrytitle>password-request</refentrytitle>
163
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
167
OpenPGP key used by
168
<citerefentry><refentrytitle>mandos-client</refentrytitle>
169
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
164
170
normally written to /etc/mandos for later installation into the
165
initrd image, but this, like most things, can be changed with
166
command line options.
171
initrd image, but this, and most other things, can be changed
172
with command line options.
173
</para>
174
<para>
175
This program can also be used with the
176
<option>--password</option> or <option>--passfile</option>
177
options to generate a ready-made section for
178
<filename>clients.conf</filename> (see
179
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
180
<manvolnum>5</manvolnum></citerefentry>).
167
181
</para>
168
182
</refsect1>
169
183
170
184
<refsect1 id="purpose">
171
185
<title>PURPOSE</title>
172
173
186
<para>
174
187
The purpose of this is to enable <emphasis>remote and unattended
175
188
rebooting</emphasis> of client host computer with an
176
189
<emphasis>encrypted root file system</emphasis>. See <xref
177
190
linkend="overview"/> for details.
178
191
</para>
179
180
192
</refsect1>
181
193
182
194
<refsect1 id="options">
183
195
<title>OPTIONS</title>
184
196
185
197
<variablelist>
186
198
<varlistentry>
187
<term><literal>-h</literal>, <literal>--help</literal></term>
199
<term><option>--help</option></term>
200
<term><option>-h</option></term>
188
201
<listitem>
189
202
<para>
190
203
Show a help message and exit
191
204
</para>
192
205
</listitem>
193
206
</varlistentry>
194
195
<varlistentry>
196
<term><literal>-d</literal>, <literal>--dir
197
<replaceable>directory</replaceable></literal></term>
198
<listitem>
199
<para>
200
Target directory for key files.
201
</para>
202
</listitem>
203
</varlistentry>
204
205
<varlistentry>
206
<term><literal>-t</literal>, <literal>--type
207
<replaceable>type</replaceable></literal></term>
208
<listitem>
209
<para>
210
Key type. Default is DSA.
211
</para>
212
</listitem>
213
</varlistentry>
214
215
<varlistentry>
216
<term><literal>-l</literal>, <literal>--length
217
<replaceable>bits</replaceable></literal></term>
218
<listitem>
219
<para>
220
Key length in bits. Default is 1024.
221
</para>
222
</listitem>
223
</varlistentry>
224
225
<varlistentry>
226
<term><literal>-e</literal>, <literal>--email</literal>
227
<replaceable>address</replaceable></term>
207
208
<varlistentry>
209
<term><option>--dir
210
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><option>-d
212
<replaceable>DIRECTORY</replaceable></option></term>
213
<listitem>
214
<para>
215
Target directory for key files. Default is
216
<filename>/etc/mandos</filename>.
217
</para>
218
</listitem>
219
</varlistentry>
220
221
<varlistentry>
222
<term><option>--type
223
<replaceable>TYPE</replaceable></option></term>
224
<term><option>-t
225
<replaceable>TYPE</replaceable></option></term>
226
<listitem>
227
<para>
228
Key type. Default is <quote>DSA</quote>.
229
</para>
230
</listitem>
231
</varlistentry>
232
233
<varlistentry>
234
<term><option>--length
235
<replaceable>BITS</replaceable></option></term>
236
<term><option>-l
237
<replaceable>BITS</replaceable></option></term>
238
<listitem>
239
<para>
240
Key length in bits. Default is 2048.
241
</para>
242
</listitem>
243
</varlistentry>
244
245
<varlistentry>
246
<term><option>--subtype
247
<replaceable>KEYTYPE</replaceable></option></term>
248
<term><option>-s
249
<replaceable>KEYTYPE</replaceable></option></term>
250
<listitem>
251
<para>
252
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
253
encryption-only).
254
</para>
255
</listitem>
256
</varlistentry>
257
258
<varlistentry>
259
<term><option>--sublength
260
<replaceable>BITS</replaceable></option></term>
261
<term><option>-L
262
<replaceable>BITS</replaceable></option></term>
263
<listitem>
264
<para>
265
Subkey length in bits. Default is 2048.
266
</para>
267
</listitem>
268
</varlistentry>
269
270
<varlistentry>
271
<term><option>--email
272
<replaceable>ADDRESS</replaceable></option></term>
273
<term><option>-e
274
<replaceable>ADDRESS</replaceable></option></term>
228
275
<listitem>
229
276
<para>
230
277
Email address of key. Default is empty.
231
278
</para>
232
279
</listitem>
233
280
</varlistentry>
234
281
235
282
<varlistentry>
236
<term><literal>-c</literal>, <literal>--comment</literal>
237
<replaceable>comment</replaceable></term>
283
<term><option>--comment
284
<replaceable>TEXT</replaceable></option></term>
285
<term><option>-c
286
<replaceable>TEXT</replaceable></option></term>
238
287
<listitem>
239
288
<para>
240
289
Comment field for key. The default value is
241
"<literal>Mandos client key</literal>".
290
<quote><literal>Mandos client key</literal></quote>.
242
291
</para>
243
292
</listitem>
244
293
</varlistentry>
245
294
246
295
<varlistentry>
247
<term><literal>-x</literal>, <literal>--expire</literal>
248
<replaceable>time</replaceable></term>
296
<term><option>--expire
297
<replaceable>TIME</replaceable></option></term>
298
<term><option>-x
299
<replaceable>TIME</replaceable></option></term>
249
300
<listitem>
250
301
<para>
251
302
Key expire time. Default is no expiration. See
254
305
</para>
255
306
</listitem>
256
307
</varlistentry>
257
258
<varlistentry>
259
<term><literal>-f</literal>, <literal>--force</literal></term>
260
<listitem>
261
<para>
262
Force overwriting old keys.
308
309
<varlistentry>
310
<term><option>--force</option></term>
311
<term><option>-f</option></term>
312
<listitem>
313
<para>
314
Force overwriting old key.
315
</para>
316
</listitem>
317
</varlistentry>
318
<varlistentry>
319
<term><option>--password</option></term>
320
<term><option>-p</option></term>
321
<listitem>
322
<para>
323
Prompt for a password and encrypt it with the key already
324
present in either <filename>/etc/mandos</filename> or the
325
directory specified with the <option>--dir</option>
326
option. Outputs, on standard output, a section suitable
327
for inclusion in <citerefentry><refentrytitle
328
>mandos-clients.conf</refentrytitle><manvolnum
329
>8</manvolnum></citerefentry>. The host name or the name
330
specified with the <option>--name</option> option is used
331
for the section header. All other options are ignored,
332
and no key is created.
333
</para>
334
</listitem>
335
</varlistentry>
336
<varlistentry>
337
<term><option>--passfile
338
<replaceable>FILE</replaceable></option></term>
339
<term><option>-F
340
<replaceable>FILE</replaceable></option></term>
341
<listitem>
342
<para>
343
The same as <option>--password</option>, but read from
344
<replaceable>FILE</replaceable>, not the terminal.
263
345
</para>
264
346
</listitem>
265
347
</varlistentry>
266
348
</variablelist>
267
349
</refsect1>
268
350
269
351
<refsect1 id="overview">
270
352
<title>OVERVIEW</title>
271
353
<xi:include href="overview.xml"/>
272
354
<para>
273
This program is a small program to generate new OpenPGP keys for
274
new Mandos clients.
355
This program is a small utility to generate new OpenPGP keys for
356
new Mandos clients, and to generate sections for inclusion in
357
<filename>clients.conf</filename> on the server.
275
358
</para>
276
359
</refsect1>
277
360
278
361
<refsect1 id="exit_status">
279
362
<title>EXIT STATUS</title>
280
363
<para>
281
The exit status will be 0 if new keys were successfully created,
282
otherwise not.
364
The exit status will be 0 if a new key (or password, if the
365
<option>--password</option> option was used) was successfully
366
created, otherwise not.
283
367
</para>
284
368
</refsect1>
285
369
287
371
<title>ENVIRONMENT</title>
288
372
<variablelist>
289
373
<varlistentry>
290
<term><varname>TMPDIR</varname></term>
374
<term><envar>TMPDIR</envar></term>
291
375
<listitem>
292
376
<para>
293
377
If set, temporary files will be created here. See
299
383
</variablelist>
300
384
</refsect1>
301
385
302
<refsect1 id="file">
386
<refsect1 id="files">
303
387
<title>FILES</title>
304
388
<para>
305
389
Use the <option>--dir</option> option to change where
336
420
</varlistentry>
337
421
</variablelist>
338
422
</refsect1>
339
340
<refsect1 id="bugs">
341
<title>BUGS</title>
342
<para>
343
None are known at this time.
344
</para>
345
</refsect1>
346
423
424
<!-- <refsect1 id="bugs"> -->
425
<!-- <title>BUGS</title> -->
426
<!-- <para> -->
427
<!-- </para> -->
428
<!-- </refsect1> -->
429
347
430
<refsect1 id="example">
348
431
<title>EXAMPLE</title>
349
432
<informalexample>
351
434
Normal invocation needs no options:
352
435
</para>
353
436
<para>
354
<userinput>mandos-keygen</userinput>
437
<userinput>&COMMANDNAME;</userinput>
355
438
</para>
356
439
</informalexample>
357
440
<informalexample>
358
441
<para>
359
Create keys in another directory and of another type. Force
442
Create key in another directory and of another type. Force
360
443
overwriting old key files:
361
444
</para>
362
445
<para>
363
446
364
447
<!-- do not wrap this line -->
365
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
448
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
449
450
</para>
451
</informalexample>
452
<informalexample>
453
<para>
454
Prompt for a password, encrypt it with the key in
455
<filename>/etc/mandos</filename> and output a section suitable
456
for <filename>clients.conf</filename>.
457
</para>
458
<para>
459
<userinput>&COMMANDNAME; --password</userinput>
460
</para>
461
</informalexample>
462
<informalexample>
463
<para>
464
Prompt for a password, encrypt it with the key in the
465
<filename>client-key</filename> directory and output a section
466
suitable for <filename>clients.conf</filename>.
467
</para>
468
<para>
469
470
<!-- do not wrap this line -->
471
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
366
472
367
473
</para>
368
474
</informalexample>
369
475
</refsect1>
370
476
371
477
<refsect1 id="security">
372
478
<title>SECURITY</title>
373
479
<para>
374
The <option>--type</option> and <option>--length</option>
375
options can be used to create keys of insufficient security. If
376
in doubt, leave them to the default values.
480
The <option>--type</option>, <option>--length</option>,
481
<option>--subtype</option>, and <option>--sublength</option>
482
options can be used to create keys of low security. If in
483
doubt, leave them to the default values.
377
484
</para>
378
485
<para>
379
The key expire time is not guaranteed to be honored by
380
<citerefentry><refentrytitle>mandos</refentrytitle>
486
The key expire time is <emphasis>not</emphasis> guaranteed to be
487
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
381
488
<manvolnum>8</manvolnum></citerefentry>.
382
489
</para>
383
490
</refsect1>
384
491
385
492
<refsect1 id="see_also">
386
493
<title>SEE ALSO</title>
387
494
<para>
388
<citerefentry><refentrytitle>password-request</refentrytitle>
389
<manvolnum>8mandos</manvolnum></citerefentry>,
495
<citerefentry><refentrytitle>gpg</refentrytitle>
496
<manvolnum>1</manvolnum></citerefentry>,
497
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
498
<manvolnum>5</manvolnum></citerefentry>,
390
499
<citerefentry><refentrytitle>mandos</refentrytitle>
391
500
<manvolnum>8</manvolnum></citerefentry>,
392
<citerefentry><refentrytitle>gpg</refentrytitle>
393
<manvolnum>1</manvolnum></citerefentry>
501
<citerefentry><refentrytitle>mandos-client</refentrytitle>
502
<manvolnum>8mandos</manvolnum></citerefentry>
394
503
</para>
395
504
</refsect1>
396
505
397
506
</refentry>
507
<!-- Local Variables: -->
508
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
509
<!-- time-stamp-end: "[\"']>" -->
510
<!-- time-stamp-format: "%:y-%02m-%02d" -->
511
<!-- End: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0