/mandos/release

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

• browse files at revision 299
• compare with another revision
• download diff
• download tarball
• view history from revision 299

• reverse the comparison (299 to 129)
• stop comparing with revision 129

Show diffs side-by-side

added

removed

mandos-keygen.xml

1

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">

6

 

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

 

5

<!ENTITY TIMESTAMP "2012-01-01">

 

6

<!ENTITY % common SYSTEM "common.ent">

 

7

%common;

7

8

]>

8

9

 

9

10

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">

11

12

    <title>Mandos Manual</title>

12

13

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

13

14

    <productname>Mandos</productname>

14

 

    <productnumber>&VERSION;</productnumber>

 

15

    <productnumber>&version;</productnumber>

15

16

    <date>&TIMESTAMP;</date>

16

17

    <authorgroup>

17

18

      <author>

18

19

        <firstname>Björn</firstname>

19

20

        <surname>Påhlsson</surname>

20

21

        <address>

21

 

          <email>belorn@fukt.bsnet.se</email>

 

22

          <email>belorn@recompile.se</email>

22

23

        </address>

23

24

      </author>

24

25

      <author>

25

26

        <firstname>Teddy</firstname>

26

27

        <surname>Hogeborn</surname>

27

28

        <address>

28

 

          <email>teddy@fukt.bsnet.se</email>

 

29

          <email>teddy@recompile.se</email>

29

30

        </address>

30

31

      </author>

31

32

    </authorgroup>

32

33

    <copyright>

33

34

      <year>2008</year>

 

35

      <year>2009</year>

 

36

      <year>2011</year>

 

37

      <year>2012</year>

34

38

      <holder>Teddy Hogeborn</holder>

35

39

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

36

40

    </copyright>

37

 

    <legalnotice>

38

 

      <para>

39

 

        This manual page is free software: you can redistribute it

40

 

        and/or modify it under the terms of the GNU General Public

41

 

        License as published by the Free Software Foundation,

42

 

        either version 3 of the License, or (at your option) any

43

 

        later version.

44

 

      </para>

45

 

 

46

 

      <para>

47

 

        This manual page is distributed in the hope that it will

48

 

        be useful, but WITHOUT ANY WARRANTY; without even the

49

 

        implied warranty of MERCHANTABILITY or FITNESS FOR A

50

 

        PARTICULAR PURPOSE.  See the GNU General Public License

51

 

        for more details.

52

 

      </para>

53

 

 

54

 

      <para>

55

 

        You should have received a copy of the GNU General Public

56

 

        License along with this program; If not, see

57

 

        <ulink url="http://www.gnu.org/licenses/"/>.

58

 

      </para>

59

 

    </legalnotice>

 

41

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

60

42

  </refentryinfo>

61

 

 

 

43

  

62

44

  <refmeta>

63

45

    <refentrytitle>&COMMANDNAME;</refentrytitle>

64

46

    <manvolnum>8</manvolnum>

70

52

      Generate key and password for Mandos client and server.

71

53

    </refpurpose>

72

54

  </refnamediv>

73

 

 

 

55

  

74

56

  <refsynopsisdiv>

75

57

    <cmdsynopsis>

76

58

      <command>&COMMANDNAME;</command>

144

126

      <group choice="req">

145

127

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

146

128

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

 

129

        <arg choice="plain"><option>--passfile

 

130

        <replaceable>FILE</replaceable></option></arg>

 

131

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

 

132

        <replaceable>FILE</replaceable></arg>

147

133

      </group>

148

134

      <sbr/>

149

135

      <group>

181

167

    <para>

182

168

      <command>&COMMANDNAME;</command> is a program to generate the

183

169

      OpenPGP key used by

184

 

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

 

170

      <citerefentry><refentrytitle>mandos-client</refentrytitle>

185

171

      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is

186

172

      normally written to /etc/mandos for later installation into the

187

173

      initrd image, but this, and most other things, can be changed

189

175

    </para>

190

176

    <para>

191

177

      This program can also be used with the

192

 

      <option>--password</option> option to generate a ready-made

193

 

      section for <filename>clients.conf</filename> (see

 

178

      <option>--password</option> or <option>--passfile</option>

 

179

      options to generate a ready-made section for

 

180

      <filename>clients.conf</filename> (see

194

181

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

195

182

      <manvolnum>5</manvolnum></citerefentry>).

196

183

    </para>

219

206

          </para>

220

207

        </listitem>

221

208

      </varlistentry>

222

 

 

 

209

      

223

210

      <varlistentry>

224

211

        <term><option>--dir

225

212

        <replaceable>DIRECTORY</replaceable></option></term>

228

215

        <listitem>

229

216

          <para>

230

217

            Target directory for key files.  Default is

231

 

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

 

218

            <filename class="directory">/etc/mandos</filename>.

232

219

          </para>

233

220

        </listitem>

234

221

      </varlistentry>

235

 

 

 

222

      

236

223

      <varlistentry>

237

224

        <term><option>--type

238

225

        <replaceable>TYPE</replaceable></option></term>

244

231

          </para>

245

232

        </listitem>

246

233

      </varlistentry>

247

 

 

 

234

      

248

235

      <varlistentry>

249

236

        <term><option>--length

250

237

        <replaceable>BITS</replaceable></option></term>

256

243

          </para>

257

244

        </listitem>

258

245

      </varlistentry>

259

 

 

 

246

      

260

247

      <varlistentry>

261

248

        <term><option>--subtype

262

249

        <replaceable>KEYTYPE</replaceable></option></term>

269

256

          </para>

270

257

        </listitem>

271

258

      </varlistentry>

272

 

 

 

259

      

273

260

      <varlistentry>

274

261

        <term><option>--sublength

275

262

        <replaceable>BITS</replaceable></option></term>

281

268

          </para>

282

269

        </listitem>

283

270

      </varlistentry>

284

 

 

 

271

      

285

272

      <varlistentry>

286

273

        <term><option>--email

287

274

        <replaceable>ADDRESS</replaceable></option></term>

293

280

          </para>

294

281

        </listitem>

295

282

      </varlistentry>

296

 

 

 

283

      

297

284

      <varlistentry>

298

285

        <term><option>--comment

299

286

        <replaceable>TEXT</replaceable></option></term>

306

293

          </para>

307

294

        </listitem>

308

295

      </varlistentry>

309

 

 

 

296

      

310

297

      <varlistentry>

311

298

        <term><option>--expire

312

299

        <replaceable>TIME</replaceable></option></term>

320

307

          </para>

321

308

        </listitem>

322

309

      </varlistentry>

323

 

 

 

310

      

324

311

      <varlistentry>

325

312

        <term><option>--force</option></term>

326

313

        <term><option>-f</option></term>

348

335

          </para>

349

336

        </listitem>

350

337

      </varlistentry>

 

338

      <varlistentry>

 

339

        <term><option>--passfile

 

340

        <replaceable>FILE</replaceable></option></term>

 

341

        <term><option>-F

 

342

        <replaceable>FILE</replaceable></option></term>

 

343

        <listitem>

 

344

          <para>

 

345

            The same as <option>--password</option>, but read from

 

346

            <replaceable>FILE</replaceable>, not the terminal.

 

347

          </para>

 

348

        </listitem>

 

349

      </varlistentry>

351

350

    </variablelist>

352

351

  </refsect1>

353

 

 

 

352

  

354

353

  <refsect1 id="overview">

355

354

    <title>OVERVIEW</title>

356

355

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

360

359

      <filename>clients.conf</filename> on the server.

361

360

    </para>

362

361

  </refsect1>

363

 

 

 

362

  

364

363

  <refsect1 id="exit_status">

365

364

    <title>EXIT STATUS</title>

366

365

    <para>

386

385

    </variablelist>

387

386

  </refsect1>

388

387

  

389

 

  <refsect1 id="file">

 

388

  <refsect1 id="files">

390

389

    <title>FILES</title>

391

390

    <para>

392

391

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

413

412

        </listitem>

414

413

      </varlistentry>

415

414

      <varlistentry>

416

 

        <term><filename>/tmp</filename></term>

 

415

        <term><filename class="directory">/tmp</filename></term>

417

416

        <listitem>

418

417

          <para>

419

418

            Temporary files will be written here if

423

422

      </varlistentry>

424

423

    </variablelist>

425

424

  </refsect1>

426

 

 

427

 

  <refsect1 id="bugs">

428

 

    <title>BUGS</title>

429

 

    <para>

430

 

      None are known at this time.

431

 

    </para>

432

 

  </refsect1>

433

 

 

 

425

  

 

426

<!--   <refsect1 id="bugs"> -->

 

427

<!--     <title>BUGS</title> -->

 

428

<!--     <para> -->

 

429

<!--     </para> -->

 

430

<!--   </refsect1> -->

 

431

  

434

432

  <refsect1 id="example">

435

433

    <title>EXAMPLE</title>

436

434

    <informalexample>

455

453

    </informalexample>

456

454

    <informalexample>

457

455

      <para>

458

 

        Prompt for a password, encrypt it with the key in

459

 

        <filename>/etc/mandos</filename> and output a section suitable

460

 

        for <filename>clients.conf</filename>.

 

456

        Prompt for a password, encrypt it with the key in <filename

 

457

        class="directory">/etc/mandos</filename> and output a section

 

458

        suitable for <filename>clients.conf</filename>.

461

459

      </para>

462

460

      <para>

463

461

        <userinput>&COMMANDNAME; --password</userinput>

477

475

      </para>

478

476

    </informalexample>

479

477

  </refsect1>

480

 

 

 

478

  

481

479

  <refsect1 id="security">

482

480

    <title>SECURITY</title>

483

481

    <para>

492

490

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

493

491

    </para>

494

492

  </refsect1>

495

 

 

 

493

  

496

494

  <refsect1 id="see_also">

497

495

    <title>SEE ALSO</title>

498

496

    <para>

 

497

      <citerefentry><refentrytitle>intro</refentrytitle>

 

498

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

499

499

      <citerefentry><refentrytitle>gpg</refentrytitle>

500

500

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

501

501

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

502

502

      <manvolnum>5</manvolnum></citerefentry>,

503

503

      <citerefentry><refentrytitle>mandos</refentrytitle>

504

504

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

505

 

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

 

505

      <citerefentry><refentrytitle>mandos-client</refentrytitle>

506

506

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

507

507

    </para>

508

508

  </refsect1>

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0