/mandos/trunk : revision 117

1

<?xml version='1.0' encoding='UTF-8'?>

1

<?xml version="1.0" encoding="UTF-8"?>

2

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

3

"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

4

<!ENTITY VERSION "1.0">

5

<!ENTITY COMMANDNAME "mandos-keygen">

6

<!ENTITY OVERVIEW SYSTEM "overview.xml">

6

<!ENTITY TIMESTAMP "2008-08-30">

7

]>

8

9

9

10

11

<title>&COMMANDNAME;</title>

12

13

<productname>&COMMANDNAME;</productname>

11

<title>Mandos Manual</title>

12

13

<productname>Mandos</productname>

14

<productnumber>&VERSION;</productnumber>

15

<date>&TIMESTAMP;</date>

15

16

16

17

17

18

<firstname>Björn</firstname>

30

31

</authorgroup>

31

32

32

33

33

<holder>Teddy Hogeborn & Björn Påhlsson</holder>

34

<holder>Teddy Hogeborn</holder>

35

<holder>Björn Påhlsson</holder>

34

36

</copyright>

35

37

36

38

<para>

86

88

87

89

</group>

88

90

91

<arg choice="plain"><option>--subtype</option>

92

93

</group>

94

95

<arg choice="plain"><option>--sublength</option>

96

97

</group>

98

89

99

90

100

91

101

</group>

120

130

121

131

</group>

122

132

133

134

135

</group>

136

137

138

139

</group>

140

123

141

124

142

125

143

</group>

142

160

143

161

<command>&COMMANDNAME;</command>

144

162

145

146

147

</group>

148

</cmdsynopsis>

149

150

<command>&COMMANDNAME;</command>

151

152

153

<arg choice='plain'><option>--version</option></arg>

163

164

<arg choice="plain"><option>--password</option></arg>

165

</group>

166

167

168

<replaceable>directory</replaceable></arg>

169

</group>

170

171

172

173

</group>

174

</cmdsynopsis>

175

176

<command>&COMMANDNAME;</command>

177

178

179

180

</group>

181

</cmdsynopsis>

182

183

<command>&COMMANDNAME;</command>

184

185

186

<arg choice="plain"><option>--version</option></arg>

154

187

</group>

155

188

</cmdsynopsis>

156

189

</refsynopsisdiv>

166

199

initrd image, but this, like most things, can be changed with

167

200

command line options.

168

201

</para>

202

<para>

203

It can also be used to generate ready-made sections for

204

<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>

205

<manvolnum>5</manvolnum></citerefentry> using the

206

<option>--password</option> option.

207

</para>

169

208

</refsect1>

170

209

171

210

198

237

<replaceable>directory</replaceable></literal></term>

199

238

200

239

<para>

201

Target directory for key files.

240

Target directory for key files. Default is

241

<filename>/etc/mandos</filename>.

202

242

</para>

203

243

</listitem>

204

244

</varlistentry>

208

248

209

249

210

250

<para>

211

Key type. Default is DSA.

251

Key type. Default is <quote>DSA</quote>.

212

252

</para>

213

253

</listitem>

214

254

</varlistentry>

218

258

219

259

220

260

<para>

221

Key length in bits. Default is 1024.

261

Key length in bits. Default is 2048.

262

</para>

263

</listitem>

264

</varlistentry>

265

266

267

<term><literal>-s</literal>, <literal>--subtype

268

269

270

<para>

271

Subkey type. Default is <quote>ELG-E</quote> (Elgamal

272

encryption-only).

273

</para>

274

</listitem>

275

</varlistentry>

276

277

278

<term><literal>-L</literal>, <literal>--sublength

279

280

281

<para>

282

Subkey length in bits. Default is 2048.

222

283

</para>

223

284

</listitem>

224

285

</varlistentry>

239

300

240

301

<para>

241

302

Comment field for key. The default value is

242

"<literal>Mandos client key</literal>".

303

<quote><literal>Mandos client key</literal></quote>.

243

304

</para>

244

305

</listitem>

245

306

</varlistentry>

264

325

</para>

265

326

</listitem>

266

327

</varlistentry>

328

329

<term><literal>-p</literal>, <literal>--password</literal

330

></term>

331

332

<para>

333

Prompt for a password and encrypt it with the key already

334

present in either <filename>/etc/mandos</filename> or the

335

directory specified with the <option>--dir</option>

336

option. Outputs, on standard output, a section suitable

337

for inclusion in <citerefentry><refentrytitle

338

>mandos-clients.conf</refentrytitle><manvolnum

339

>8</manvolnum></citerefentry>. The host name or the name

340

specified with the <option>--name</option> option is used

341

for the section header. All other options are ignored,

342

and no keys are created.

343

</para>

344

</listitem>

345

</varlistentry>

267

346

</variablelist>

268

347

</refsect1>

269

348

270

349

271

350

<title>OVERVIEW</title>

272

&OVERVIEW;

351

<xi:include href="overview.xml"/>

273

352

<para>

274

This program is a small program to generate new OpenPGP keys for

353

This program is a small utility to generate new OpenPGP keys for

275

354

new Mandos clients.

276

355

</para>

277

356

</refsect1>

279

358

280

359

<title>EXIT STATUS</title>

281

360

<para>

361

The exit status will be 0 if new keys were successfully created,

362

otherwise not.

282

363

</para>

283

364

</refsect1>

284

365

366

367

<title>ENVIRONMENT</title>

368

369

370

<term><envar>TMPDIR</envar></term>

371

372

<para>

373

If set, temporary files will be created here. See

374

<citerefentry><refentrytitle>mktemp</refentrytitle>

375

<manvolnum>1</manvolnum></citerefentry>.

376

</para>

377

</listitem>

378

</varlistentry>

379

</variablelist>

380

</refsect1>

381

285

382

286

383

<title>FILES</title>

287

384

<para>

385

Use the <option>--dir</option> option to change where

386

<command>&COMMANDNAME;</command> will write the key files. The

387

default file names are shown here.

288

388

</para>

389

390

391

<term><filename>/etc/mandos/seckey.txt</filename></term>

392

393

<para>

394

OpenPGP secret key file which will be created or

395

overwritten.

396

</para>

397

</listitem>

398

</varlistentry>

399

400

<term><filename>/etc/mandos/pubkey.txt</filename></term>

401

402

<para>

403

OpenPGP public key file which will be created or

404

overwritten.

405

</para>

406

</listitem>

407

</varlistentry>

408

409

410

411

<para>

412

Temporary files will be written here if

413

<varname>TMPDIR</varname> is not set.

414

</para>

415

</listitem>

416

</varlistentry>

417

</variablelist>

289

418

</refsect1>

290

419

291

420

292

421

293

422

<para>

423

None are known at this time.

294

424

</para>

295

425

</refsect1>

296

426

297

427

298

428

<title>EXAMPLE</title>

299

<para>

300

</para>

429

430

<para>

431

Normal invocation needs no options:

432

</para>

433

<para>

434

<userinput>&COMMANDNAME;</userinput>

435

</para>

436

</informalexample>

437

438

<para>

439

Create keys in another directory and of another type. Force

440

overwriting old key files:

441

</para>

442

<para>

443

444

445

<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>

446

447

</para>

448

</informalexample>

301

449

</refsect1>

302

450

303

451

304

452

<title>SECURITY</title>

305

453

<para>

454

The <option>--type</option>, <option>--length</option>,

455

<option>--subtype</option>, and <option>--sublength</option>

456

options can be used to create keys of insufficient security. If

457

in doubt, leave them to the default values.

458

</para>

459

<para>

460

The key expire time is not guaranteed to be honored by

461

<citerefentry><refentrytitle>mandos</refentrytitle>

462

<manvolnum>8</manvolnum></citerefentry>.

306

463

</para>

307

464

</refsect1>

308

465

309

466

310

467

311

468

<para>

312

<citerefentry><refentrytitle>password-request</refentrytitle>

313

<manvolnum>8mandos</manvolnum></citerefentry>,

314

<citerefentry><refentrytitle>mandos</refentrytitle>

315

<manvolnum>8</manvolnum></citerefentry>, and

316

469

317

470

<manvolnum>1</manvolnum></citerefentry>,

471

<citerefentry><refentrytitle>mandos</refentrytitle>

472

<manvolnum>8</manvolnum></citerefentry>,

473

<citerefentry><refentrytitle>password-request</refentrytitle>

474

<manvolnum>8mandos</manvolnum></citerefentry>

318

475

</para>

319

476

</refsect1>

320

477

321

478

</refentry>

479

480

481

482

483