/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (489 to 597)
• stop comparing with revision 597

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

 

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

 

      <sbr/>

104

 

      <arg><option>--socket

105

 

      <replaceable>FD</replaceable></option></arg>

106

97

    </cmdsynopsis>

107

98

    <cmdsynopsis>

108

99

      <command>&COMMANDNAME;</command>

126

117

    <para>

127

118

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

128

119

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

129

 

      client host computers. For an introduction, see

130

 

      <citerefentry><refentrytitle>intro</refentrytitle>

131

 

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

132

 

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

133

 

      TLS to communicate securely with and to authenticate the

134

 

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

135

 

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

136

 

      not have any other addresses configured (see <xref

137

 

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

138

 

      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.

139

128

    </para>

140

129

  </refsect1>

141

130

  

284

273

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

285

274

        </listitem>

286

275

      </varlistentry>

287

 

      

288

 

      <varlistentry>

289

 

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

290

 

        <listitem>

291

 

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

292

 

          <para>

293

 

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

294

 

          </para>

295

 

        </listitem>

296

 

      </varlistentry>

297

 

      

298

 

      <varlistentry>

299

 

        <term><option>--statedir

300

 

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

301

 

        <listitem>

302

 

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

303

 

        </listitem>

304

 

      </varlistentry>

305

 

      

306

 

      <varlistentry>

307

 

        <term><option>--socket

308

 

        <replaceable>FD</replaceable></option></term>

309

 

        <listitem>

310

 

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

311

 

        </listitem>

312

 

      </varlistentry>

313

 

      

314

276

    </variablelist>

315

277

  </refsect1>

316

278

  

390

352

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

391

353

      longer eligible to receive the encrypted password.  (Manual

392

354

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

393

 

      extended timeout, checker program, and interval between checks

394

 

      can be configured both globally and per client; see

395

 

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

396

 

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

397

361

    </para>

398

362

  </refsect1>

399

363

  

421

385

    <title>LOGGING</title>

422

386

    <para>

423

387

      The server will send log message with various severity levels to

424

 

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

 

388

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

425

389

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

426

390

      and also show them on the console.

427

391

    </para>

428

392

  </refsect1>

429

393

  

430

 

  <refsect1 id="persistent_state">

431

 

    <title>PERSISTENT STATE</title>

432

 

    <para>

433

 

      Client settings, initially read from

434

 

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

435

 

      restarts, and run-time changes will override settings in

436

 

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

437

 

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

438

 

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

439

 

    </para>

440

 

  </refsect1>

441

 

  

442

394

  <refsect1 id="dbus_interface">

443

395

    <title>D-BUS INTERFACE</title>

444

396

    <para>

515

467

        </listitem>

516

468

      </varlistentry>

517

469

      <varlistentry>

518

 

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

519

 

      </varlistentry>

520

 

      <varlistentry>

521

 

        <term><filename

522

 

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

523

 

        <listitem>

524

 

          <para>

525

 

            Directory where persistent state will be saved.  Change

526

 

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

527

 

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

528

 

          </para>

529

 

        </listitem>

530

 

      </varlistentry>

531

 

      <varlistentry>

532

470

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

533

471

        <listitem>

534

472

          <para>

558

496

      backtrace.  This could be considered a feature.

559

497

    </para>

560

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>

561

504

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

562

505

    </para>

563

506

    <para>

564

507

      Debug mode is conflated with running in the foreground.

565

508

    </para>

566

509

    <para>

 

510

      The console log messages do not show a time stamp.

 

511

    </para>

 

512

    <para>

567

513

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

568

514

      keys.

569

515

    </para>

582

528

    <informalexample>

583

529

      <para>

584

530

        Run the server in debug mode, read configuration files from

585

 

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

586

 

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

587

 

        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:

588

534

      </para>

589

535

      <para>

590

536

 

639

585

        compromised if they are gone for too long.

640

586

      </para>

641

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>

642

603

        For more details on client-side security, see

643

604

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

644

605

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

649

610

  <refsect1 id="see_also">

650

611

    <title>SEE ALSO</title>

651

612

    <para>

652

 

      <citerefentry><refentrytitle>intro</refentrytitle>

653

 

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

654

 

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

655

 

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

656

 

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

657

 

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

658

 

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

659

 

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

660

 

      <citerefentry><refentrytitle>sh</refentrytitle>

661

 

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

662

622

    </para>

663

623

    <variablelist>

664

624

      <varlistentry>

• Older »

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