/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (466 to 586)
• stop comparing with revision 586

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 "2012-01-15">

 

5

<!ENTITY TIMESTAMP "2011-02-27">

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@recompile.se</email>

 

22

          <email>belorn@fukt.bsnet.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@recompile.se</email>

 

29

          <email>teddy@fukt.bsnet.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>

39

38

      <holder>Teddy Hogeborn</holder>

40

39

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

41

40

    </copyright>

95

94

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

96

95

      <sbr/>

97

96

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

103

97

    </cmdsynopsis>

104

98

    <cmdsynopsis>

105

99

      <command>&COMMANDNAME;</command>

123

117

    <para>

124

118

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

125

119

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

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.

 

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.

136

128

    </para>

137

129

  </refsect1>

138

130

  

281

273

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

282

274

        </listitem>

283

275

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

302

276

    </variablelist>

303

277

  </refsect1>

304

278

  

378

352

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

379

353

      longer eligible to receive the encrypted password.  (Manual

380

354

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

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

 

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.

385

361

    </para>

386

362

  </refsect1>

387

363

  

409

385

    <title>LOGGING</title>

410

386

    <para>

411

387

      The server will send log message with various severity levels to

412

 

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

 

388

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

413

389

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

414

390

      and also show them on the console.

415

391

    </para>

416

392

  </refsect1>

417

393

  

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

 

  

430

394

  <refsect1 id="dbus_interface">

431

395

    <title>D-BUS INTERFACE</title>

432

396

    <para>

503

467

        </listitem>

504

468

      </varlistentry>

505

469

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

520

470

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

521

471

        <listitem>

522

472

          <para>

546

496

      backtrace.  This could be considered a feature.

547

497

    </para>

548

498

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

549

504

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

550

505

    </para>

551

506

    <para>

552

507

      Debug mode is conflated with running in the foreground.

553

508

    </para>

554

509

    <para>

 

510

      The console log messages do not show a time stamp.

 

511

    </para>

 

512

    <para>

555

513

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

556

514

      keys.

557

515

    </para>

570

528

    <informalexample>

571

529

      <para>

572

530

        Run the server in debug mode, read configuration files from

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:

 

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:

576

534

      </para>

577

535

      <para>

578

536

 

627

585

        compromised if they are gone for too long.

628

586

      </para>

629

587

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

630

603

        For more details on client-side security, see

631

604

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

632

605

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

637

610

  <refsect1 id="see_also">

638

611

    <title>SEE ALSO</title>

639

612

    <para>

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>

 

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>

650

622

    </para>

651

623

    <variablelist>

652

624

      <varlistentry>

• Older »

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