/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.7.1 to 457)
• stop comparing with revision 457

Show diffs side-by-side

added

removed

mandos.xml

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

4

<!ENTITY COMMANDNAME "mandos">

5

 

<!ENTITY TIMESTAMP "2010-09-26">

 

5

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

6

6

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

7

7

%common;

8

8

]>

19

19

        <firstname>Björn</firstname>

20

20

        <surname>Påhlsson</surname>

21

21

        <address>

22

 

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

 

22

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

23

23

        </address>

24

24

      </author>

25

25

      <author>

26

26

        <firstname>Teddy</firstname>

27

27

        <surname>Hogeborn</surname>

28

28

        <address>

29

 

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

 

29

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

30

30

        </address>

31

31

      </author>

32

32

    </authorgroup>

34

34

      <year>2008</year>

35

35

      <year>2009</year>

36

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

37

39

      <holder>Teddy Hogeborn</holder>

38

40

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

39

41

    </copyright>

93

95

      <arg><option>--no-dbus</option></arg>

94

96

      <sbr/>

95

97

      <arg><option>--no-ipv6</option></arg>

 

98

      <sbr/>

 

99

      <arg><option>--no-restore</option></arg>

 

100

      <sbr/>

 

101

      <arg><option>--statedir

 

102

      <replaceable>DIRECTORY</replaceable></option></arg>

96

103

    </cmdsynopsis>

97

104

    <cmdsynopsis>

98

105

      <command>&COMMANDNAME;</command>

116

123

    <para>

117

124

      <command>&COMMANDNAME;</command> is a server daemon which

118

125

      handles incoming request for passwords for a pre-defined list of

119

 

      client host computers.  The Mandos server uses Zeroconf to

120

 

      announce itself on the local network, and uses TLS to

121

 

      communicate securely with and to authenticate the clients.  The

122

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

123

 

      link-local addresses, since the clients will probably not have

124

 

      any other addresses configured (see <xref linkend="overview"/>).

125

 

      Any authenticated client is then given the stored pre-encrypted

126

 

      password for that specific client.

 

126

      client host computers. For an introduction, see

 

127

      <citerefentry><refentrytitle>intro</refentrytitle>

 

128

      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server

 

129

      uses Zeroconf to announce itself on the local network, and uses

 

130

      TLS to communicate securely with and to authenticate the

 

131

      clients.  The Mandos server uses IPv6 to allow Mandos clients to

 

132

      use IPv6 link-local addresses, since the clients will probably

 

133

      not have any other addresses configured (see <xref

 

134

      linkend="overview"/>).  Any authenticated client is then given

 

135

      the stored pre-encrypted password for that specific client.

127

136

    </para>

128

137

  </refsect1>

129

138

  

272

281

          <xi:include href="mandos-options.xml" xpointer="ipv6"/>

273

282

        </listitem>

274

283

      </varlistentry>

 

284

      

 

285

      <varlistentry>

 

286

        <term><option>--no-restore</option></term>

 

287

        <listitem>

 

288

          <xi:include href="mandos-options.xml" xpointer="restore"/>

 

289

          <para>

 

290

            See also <xref linkend="persistent_state"/>.

 

291

          </para>

 

292

        </listitem>

 

293

      </varlistentry>

 

294

      

 

295

      <varlistentry>

 

296

        <term><option>--statedir

 

297

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

 

298

        <listitem>

 

299

          <xi:include href="mandos-options.xml" xpointer="statedir"/>

 

300

        </listitem>

 

301

      </varlistentry>

275

302

    </variablelist>

276

303

  </refsect1>

277

304

  

351

378

      for some time, the client is assumed to be compromised and is no

352

379

      longer eligible to receive the encrypted password.  (Manual

353

380

      intervention is required to re-enable a client.)  The timeout,

354

 

      checker program, and interval between checks can be configured

355

 

      both globally and per client; see <citerefentry>

356

 

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

357

 

      <manvolnum>5</manvolnum></citerefentry>.  A client successfully

358

 

      receiving its password will also be treated as a successful

359

 

      checker run.

 

381

      extended timeout, checker program, and interval between checks

 

382

      can be configured both globally and per client; see

 

383

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

 

384

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

360

385

    </para>

361

386

  </refsect1>

362

387

  

384

409

    <title>LOGGING</title>

385

410

    <para>

386

411

      The server will send log message with various severity levels to

387

 

      <filename>/dev/log</filename>.  With the

 

412

      <filename class="devicefile">/dev/log</filename>.  With the

388

413

      <option>--debug</option> option, it will log even more messages,

389

414

      and also show them on the console.

390

415

    </para>

391

416

  </refsect1>

392

417

  

 

418

  <refsect1 id="persistent_state">

 

419

    <title>PERSISTENT STATE</title>

 

420

    <para>

 

421

      Client settings, initially read from

 

422

      <filename>clients.conf</filename>, are persistent across

 

423

      restarts, and run-time changes will override settings in

 

424

      <filename>clients.conf</filename>.  However, if a setting is

 

425

      <emphasis>changed</emphasis> (or a client added, or removed) in

 

426

      <filename>clients.conf</filename>, this will take precedence.

 

427

    </para>

 

428

  </refsect1>

 

429

  

393

430

  <refsect1 id="dbus_interface">

394

431

    <title>D-BUS INTERFACE</title>

395

432

    <para>

466

503

        </listitem>

467

504

      </varlistentry>

468

505

      <varlistentry>

 

506

        <term><filename class="devicefile">/dev/log</filename></term>

 

507

      </varlistentry>

 

508

      <varlistentry>

 

509

        <term><filename

 

510

        class="directory">/var/lib/mandos</filename></term>

 

511

        <listitem>

 

512

          <para>

 

513

            Directory where persistent state will be saved.  Change

 

514

            this with the <option>--statedir</option> option.  See

 

515

            also the <option>--no-restore</option> option.

 

516

          </para>

 

517

        </listitem>

 

518

      </varlistentry>

 

519

      <varlistentry>

469

520

        <term><filename>/dev/log</filename></term>

470

521

        <listitem>

471

522

          <para>

495

546

      backtrace.  This could be considered a feature.

496

547

    </para>

497

548

    <para>

498

 

      Currently, if a client is disabled due to having timed out, the

499

 

      server does not record this fact onto permanent storage.  This

500

 

      has some security implications, see <xref linkend="clients"/>.

501

 

    </para>

502

 

    <para>

503

549

      There is no fine-grained control over logging and debug output.

504

550

    </para>

505

551

    <para>

506

552

      Debug mode is conflated with running in the foreground.

507

553

    </para>

508

554

    <para>

509

 

      The console log messages do not show a time stamp.

510

 

    </para>

511

 

    <para>

512

555

      This server does not check the expire time of clients’ OpenPGP

513

556

      keys.

514

557

    </para>

527

570

    <informalexample>

528

571

      <para>

529

572

        Run the server in debug mode, read configuration files from

530

 

        the <filename>~/mandos</filename> directory, and use the

531

 

        Zeroconf service name <quote>Test</quote> to not collide with

532

 

        any other official Mandos server on this host:

 

573

        the <filename class="directory">~/mandos</filename> directory,

 

574

        and use the Zeroconf service name <quote>Test</quote> to not

 

575

        collide with any other official Mandos server on this host:

533

576

      </para>

534

577

      <para>

535

578

 

584

627

        compromised if they are gone for too long.

585

628

      </para>

586

629

      <para>

587

 

        If a client is compromised, its downtime should be duly noted

588

 

        by the server which would therefore disable the client.  But

589

 

        if the server was ever restarted, it would re-read its client

590

 

        list from its configuration file and again regard all clients

591

 

        therein as enabled, and hence eligible to receive their

592

 

        passwords.  Therefore, be careful when restarting servers if

593

 

        it is suspected that a client has, in fact, been compromised

594

 

        by parties who may now be running a fake Mandos client with

595

 

        the keys from the non-encrypted initial <acronym>RAM</acronym>

596

 

        image of the client host.  What should be done in that case

597

 

        (if restarting the server program really is necessary) is to

598

 

        stop the server program, edit the configuration file to omit

599

 

        any suspect clients, and restart the server program.

600

 

      </para>

601

 

      <para>

602

630

        For more details on client-side security, see

603

631

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

604

632

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

609

637

  <refsect1 id="see_also">

610

638

    <title>SEE ALSO</title>

611

639

    <para>

612

 

      <citerefentry>

613

 

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

614

 

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

615

 

        <refentrytitle>mandos.conf</refentrytitle>

616

 

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

617

 

        <refentrytitle>mandos-client</refentrytitle>

618

 

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

619

 

        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>

620

 

      </citerefentry>

 

640

      <citerefentry><refentrytitle>intro</refentrytitle>

 

641

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

 

642

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

 

643

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

 

644

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

 

645

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

 

646

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

 

647

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

 

648

      <citerefentry><refentrytitle>sh</refentrytitle>

 

649

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

621

650

    </para>

622

651

    <variablelist>

623

652

      <varlistentry>

• Older »

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