/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (596 to 495)
• stop comparing with revision 495

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

 

5

<!ENTITY TIMESTAMP "2012-05-26">

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>

 

103

      <sbr/>

 

104

      <arg><option>--socket

 

105

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

97

106

    </cmdsynopsis>

98

107

    <cmdsynopsis>

99

108

      <command>&COMMANDNAME;</command>

117

126

    <para>

118

127

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

119

128

      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.

 

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.

128

139

    </para>

129

140

  </refsect1>

130

141

  

273

284

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

274

285

        </listitem>

275

286

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

      

276

314

    </variablelist>

277

315

  </refsect1>

278

316

  

352

390

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

353

391

      longer eligible to receive the encrypted password.  (Manual

354

392

      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.

 

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

361

397

    </para>

362

398

  </refsect1>

363

399

  

385

421

    <title>LOGGING</title>

386

422

    <para>

387

423

      The server will send log message with various severity levels to

388

 

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

 

424

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

389

425

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

390

426

      and also show them on the console.

391

427

    </para>

392

428

  </refsect1>

393

429

  

 

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

  

394

442

  <refsect1 id="dbus_interface">

395

443

    <title>D-BUS INTERFACE</title>

396

444

    <para>

467

515

        </listitem>

468

516

      </varlistentry>

469

517

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

470

532

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

471

533

        <listitem>

472

534

          <para>

496

558

      backtrace.  This could be considered a feature.

497

559

    </para>

498

560

    <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

561

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

505

562

    </para>

506

563

    <para>

507

564

      Debug mode is conflated with running in the foreground.

508

565

    </para>

509

566

    <para>

510

 

      The console log messages do not show a time stamp.

511

 

    </para>

512

 

    <para>

513

567

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

514

568

      keys.

515

569

    </para>

528

582

    <informalexample>

529

583

      <para>

530

584

        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:

 

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:

534

588

      </para>

535

589

      <para>

536

590

 

585

639

        compromised if they are gone for too long.

586

640

      </para>

587

641

      <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

642

        For more details on client-side security, see

604

643

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

605

644

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

• Older »

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