/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 518.1.8)
• stop comparing with revision 518.1.8

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

94

94

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

95

95

      <sbr/>

96

96

      <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

97

    </cmdsynopsis>

103

98

    <cmdsynopsis>

104

99

      <command>&COMMANDNAME;</command>

122

117

    <para>

123

118

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

124

119

      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.

 

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.

135

128

    </para>

136

129

  </refsect1>

137

130

  

280

273

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

281

274

        </listitem>

282

275

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

276

    </variablelist>

299

277

  </refsect1>

300

278

  

374

352

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

375

353

      longer eligible to receive the encrypted password.  (Manual

376

354

      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>

 

355

      checker program, and interval between checks can be configured

 

356

      both globally and per client; see <citerefentry>

 

357

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

380

358

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

381

359

      receiving its password will also be treated as a successful

382

360

      checker run.

489

467

        </listitem>

490

468

      </varlistentry>

491

469

      <varlistentry>

492

 

        <term><filename

493

 

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

494

 

        <listitem>

495

 

          <para>

496

 

            Directory where persistent state will be saved.  Change

497

 

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

498

 

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

499

 

          </para>

500

 

        </listitem>

501

 

      </varlistentry>

502

 

      <varlistentry>

503

470

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

504

471

        <listitem>

505

472

          <para>

529

496

      backtrace.  This could be considered a feature.

530

497

    </para>

531

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>

532

504

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

533

505

    </para>

534

506

    <para>

535

507

      Debug mode is conflated with running in the foreground.

536

508

    </para>

537

509

    <para>

 

510

      The console log messages do not show a time stamp.

 

511

    </para>

 

512

    <para>

538

513

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

539

514

      keys.

540

515

    </para>

553

528

    <informalexample>

554

529

      <para>

555

530

        Run the server in debug mode, read configuration files from

556

 

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

557

 

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

558

 

        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:

559

534

      </para>

560

535

      <para>

561

536

 

610

585

        compromised if they are gone for too long.

611

586

      </para>

612

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>

613

603

        For more details on client-side security, see

614

604

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

615

605

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

620

610

  <refsect1 id="see_also">

621

611

    <title>SEE ALSO</title>

622

612

    <para>

623

 

      <citerefentry><refentrytitle>intro</refentrytitle>

624

 

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

625

 

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

626

 

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

627

 

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

628

 

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

629

 

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

630

 

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

631

 

      <citerefentry><refentrytitle>sh</refentrytitle>

632

 

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

633

622

    </para>

634

623

    <variablelist>

635

624

      <varlistentry>

• Older »

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