/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (453 to 527)
• stop comparing with revision 527

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

 

5

<!ENTITY TIMESTAMP "2010-09-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@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>

34

34

      <year>2008</year>

35

35

      <year>2009</year>

36

36

      <year>2010</year>

37

 

      <year>2011</year>

38

37

      <holder>Teddy Hogeborn</holder>

39

38

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

40

39

    </copyright>

94

93

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

95

94

      <sbr/>

96

95

      <arg><option>--no-ipv6</option></arg>

97

 

      <sbr/>

98

 

      <arg><option>--no-restore</option></arg>

99

 

      <sbr/>

100

 

      <arg><option>--statedir

101

 

      <replaceable>DIRECTORY</replaceable></option></arg>

102

96

    </cmdsynopsis>

103

97

    <cmdsynopsis>

104

98

      <command>&COMMANDNAME;</command>

122

116

    <para>

123

117

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

124

118

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

125

 

      client host computers. For an introduction, see

126

 

      <citerefentry><refentrytitle>intro</refentrytitle>

127

 

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

128

 

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

129

 

      TLS to communicate securely with and to authenticate the

130

 

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

131

 

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

132

 

      not have any other addresses configured (see <xref

133

 

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

134

 

      the stored pre-encrypted password for that specific client.

 

119

      client host computers.  The Mandos server uses Zeroconf to

 

120

      announce itself on the local network, and uses TLS to

 

121

      communicate securely with and to authenticate the clients.  The

 

122

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

 

123

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

 

124

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

 

125

      Any authenticated client is then given the stored pre-encrypted

 

126

      password for that specific client.

135

127

    </para>

136

128

  </refsect1>

137

129

  

280

272

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

281

273

        </listitem>

282

274

      </varlistentry>

283

 

      

284

 

      <varlistentry>

285

 

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

286

 

        <listitem>

287

 

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

288

 

        </listitem>

289

 

      </varlistentry>

290

 

      

291

 

      <varlistentry>

292

 

        <term><option>--statedir

293

 

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

294

 

        <listitem>

295

 

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

296

 

        </listitem>

297

 

      </varlistentry>

298

275

    </variablelist>

299

276

  </refsect1>

300

277

  

374

351

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

375

352

      longer eligible to receive the encrypted password.  (Manual

376

353

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

377

 

      extended timeout, checker program, and interval between checks

378

 

      can be configured both globally and per client; see

379

 

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

 

354

      checker program, and interval between checks can be configured

 

355

      both globally and per client; see <citerefentry>

 

356

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

380

357

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

381

358

      receiving its password will also be treated as a successful

382

359

      checker run.

407

384

    <title>LOGGING</title>

408

385

    <para>

409

386

      The server will send log message with various severity levels to

410

 

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

 

387

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

411

388

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

412

389

      and also show them on the console.

413

390

    </para>

489

466

        </listitem>

490

467

      </varlistentry>

491

468

      <varlistentry>

492

 

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

493

 

      </varlistentry>

494

 

      <varlistentry>

495

 

        <term><filename

496

 

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

497

 

        <listitem>

498

 

          <para>

499

 

            Directory where persistent state will be saved.  Change

500

 

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

501

 

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

502

 

          </para>

503

 

        </listitem>

504

 

      </varlistentry>

505

 

      <varlistentry>

506

469

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

507

470

        <listitem>

508

471

          <para>

532

495

      backtrace.  This could be considered a feature.

533

496

    </para>

534

497

    <para>

 

498

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

 

499

      server does not record this fact onto permanent storage.  This

 

500

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

 

501

    </para>

 

502

    <para>

535

503

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

536

504

    </para>

537

505

    <para>

538

506

      Debug mode is conflated with running in the foreground.

539

507

    </para>

540

508

    <para>

 

509

      The console log messages do not show a time stamp.

 

510

    </para>

 

511

    <para>

541

512

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

542

513

      keys.

543

514

    </para>

556

527

    <informalexample>

557

528

      <para>

558

529

        Run the server in debug mode, read configuration files from

559

 

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

560

 

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

561

 

        collide with any other official Mandos server on this host:

 

530

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

 

531

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

 

532

        any other official Mandos server on this host:

562

533

      </para>

563

534

      <para>

564

535

 

613

584

        compromised if they are gone for too long.

614

585

      </para>

615

586

      <para>

 

587

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

 

588

        by the server which would therefore disable the client.  But

 

589

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

 

590

        list from its configuration file and again regard all clients

 

591

        therein as enabled, and hence eligible to receive their

 

592

        passwords.  Therefore, be careful when restarting servers if

 

593

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

 

594

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

 

595

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

 

596

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

 

597

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

 

598

        stop the server program, edit the configuration file to omit

 

599

        any suspect clients, and restart the server program.

 

600

      </para>

 

601

      <para>

616

602

        For more details on client-side security, see

617

603

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

618

604

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

623

609

  <refsect1 id="see_also">

624

610

    <title>SEE ALSO</title>

625

611

    <para>

626

 

      <citerefentry><refentrytitle>intro</refentrytitle>

627

 

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

628

 

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

629

 

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

630

 

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

631

 

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

632

 

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

633

 

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

634

 

      <citerefentry><refentrytitle>sh</refentrytitle>

635

 

      <manvolnum>1</manvolnum></citerefentry>

 

612

      <citerefentry>

 

613

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

 

614

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

 

615

        <refentrytitle>mandos.conf</refentrytitle>

 

616

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

 

617

        <refentrytitle>mandos-client</refentrytitle>

 

618

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

 

619

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

 

620

      </citerefentry>

636

621

    </para>

637

622

    <variablelist>

638

623

      <varlistentry>

• Older »

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