/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (577 to 475)
• stop comparing with revision 475

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 "2011-02-27">

 

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>

35

35

      <year>2009</year>

36

36

      <year>2010</year>

37

37

      <year>2011</year>

 

38

      <year>2012</year>

38

39

      <holder>Teddy Hogeborn</holder>

39

40

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

40

41

    </copyright>

94

95

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

95

96

      <sbr/>

96

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>

97

103

    </cmdsynopsis>

98

104

    <cmdsynopsis>

99

105

      <command>&COMMANDNAME;</command>

117

123

    <para>

118

124

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

119

125

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

120

 

      client host computers.  The Mandos server uses Zeroconf to

121

 

      announce itself on the local network, and uses TLS to

122

 

      communicate securely with and to authenticate the clients.  The

123

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

124

 

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

125

 

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

126

 

      Any authenticated client is then given the stored pre-encrypted

127

 

      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.

128

136

    </para>

129

137

  </refsect1>

130

138

  

273

281

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

274

282

        </listitem>

275

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>

276

302

    </variablelist>

277

303

  </refsect1>

278

304

  

352

378

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

353

379

      longer eligible to receive the encrypted password.  (Manual

354

380

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

355

 

      checker program, and interval between checks can be configured

356

 

      both globally and per client; see <citerefentry>

357

 

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

358

 

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

359

 

      receiving its password will also be treated as a successful

360

 

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

361

385

    </para>

362

386

  </refsect1>

363

387

  

385

409

    <title>LOGGING</title>

386

410

    <para>

387

411

      The server will send log message with various severity levels to

388

 

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

 

412

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

389

413

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

390

414

      and also show them on the console.

391

415

    </para>

392

416

  </refsect1>

393

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

  

394

430

  <refsect1 id="dbus_interface">

395

431

    <title>D-BUS INTERFACE</title>

396

432

    <para>

467

503

        </listitem>

468

504

      </varlistentry>

469

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>

470

520

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

471

521

        <listitem>

472

522

          <para>

496

546

      backtrace.  This could be considered a feature.

497

547

    </para>

498

548

    <para>

499

 

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

500

 

      server does not record this fact onto permanent storage.  This

501

 

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

502

 

    </para>

503

 

    <para>

504

549

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

505

550

    </para>

506

551

    <para>

507

552

      Debug mode is conflated with running in the foreground.

508

553

    </para>

509

554

    <para>

510

 

      The console log messages do not show a time stamp.

511

 

    </para>

512

 

    <para>

513

555

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

514

556

      keys.

515

557

    </para>

528

570

    <informalexample>

529

571

      <para>

530

572

        Run the server in debug mode, read configuration files from

531

 

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

532

 

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

533

 

        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:

534

576

      </para>

535

577

      <para>

536

578

 

585

627

        compromised if they are gone for too long.

586

628

      </para>

587

629

      <para>

588

 

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

589

 

        by the server which would therefore disable the client.  But

590

 

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

591

 

        list from its configuration file and again regard all clients

592

 

        therein as enabled, and hence eligible to receive their

593

 

        passwords.  Therefore, be careful when restarting servers if

594

 

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

595

 

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

596

 

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

597

 

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

598

 

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

599

 

        stop the server program, edit the configuration file to omit

600

 

        any suspect clients, and restart the server program.

601

 

      </para>

602

 

      <para>

603

630

        For more details on client-side security, see

604

631

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

605

632

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

610

637

  <refsect1 id="see_also">

611

638

    <title>SEE ALSO</title>

612

639

    <para>

613

 

      <citerefentry>

614

 

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

615

 

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

616

 

        <refentrytitle>mandos.conf</refentrytitle>

617

 

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

618

 

        <refentrytitle>mandos-client</refentrytitle>

619

 

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

620

 

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

621

 

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

622

650

    </para>

623

651

    <variablelist>

624

652

      <varlistentry>

• Older »

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