/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (467 to 556)
• stop comparing with revision 556

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

 

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>

 

355

      checker program, and interval between checks can be configured

 

356

      both globally and per client; see <citerefentry>

 

357

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

384

358

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

385

359

      receiving its password will also be treated as a successful

386

360

      checker run.

411

385

    <title>LOGGING</title>

412

386

    <para>

413

387

      The server will send log message with various severity levels to

414

 

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

 

388

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

415

389

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

416

390

      and also show them on the console.

417

391

    </para>

418

392

  </refsect1>

419

393

  

420

 

  <refsect1 id="persistent_state">

421

 

    <title>PERSISTENT STATE</title>

422

 

    <para>

423

 

      Client settings, initially read from

424

 

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

425

 

      restarts, and run-time changes will override settings in

426

 

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

427

 

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

428

 

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

429

 

    </para>

430

 

  </refsect1>

431

 

  

432

394

  <refsect1 id="dbus_interface">

433

395

    <title>D-BUS INTERFACE</title>

434

396

    <para>

505

467

        </listitem>

506

468

      </varlistentry>

507

469

      <varlistentry>

508

 

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

509

 

      </varlistentry>

510

 

      <varlistentry>

511

 

        <term><filename

512

 

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

513

 

        <listitem>

514

 

          <para>

515

 

            Directory where persistent state will be saved.  Change

516

 

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

517

 

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

518

 

          </para>

519

 

        </listitem>

520

 

      </varlistentry>

521

 

      <varlistentry>

522

470

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

523

471

        <listitem>

524

472

          <para>

548

496

      backtrace.  This could be considered a feature.

549

497

    </para>

550

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>

551

504

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

552

505

    </para>

553

506

    <para>

554

507

      Debug mode is conflated with running in the foreground.

555

508

    </para>

556

509

    <para>

 

510

      The console log messages do not show a time stamp.

 

511

    </para>

 

512

    <para>

557

513

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

558

514

      keys.

559

515

    </para>

572

528

    <informalexample>

573

529

      <para>

574

530

        Run the server in debug mode, read configuration files from

575

 

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

576

 

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

577

 

        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:

578

534

      </para>

579

535

      <para>

580

536

 

629

585

        compromised if they are gone for too long.

630

586

      </para>

631

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>

632

603

        For more details on client-side security, see

633

604

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

634

605

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

639

610

  <refsect1 id="see_also">

640

611

    <title>SEE ALSO</title>

641

612

    <para>

642

 

      <citerefentry><refentrytitle>intro</refentrytitle>

643

 

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

644

 

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

645

 

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

646

 

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

647

 

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

648

 

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

649

 

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

650

 

      <citerefentry><refentrytitle>sh</refentrytitle>

651

 

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

652

622

    </para>

653

623

    <variablelist>

654

624

      <varlistentry>

• Older »

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