/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (535 to 476)
• stop comparing with revision 476

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

 

5

<!ENTITY TIMESTAMP "2011-11-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>

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>

97

102

    </cmdsynopsis>

98

103

    <cmdsynopsis>

99

104

      <command>&COMMANDNAME;</command>

117

122

    <para>

118

123

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

119

124

      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.

 

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.

128

135

    </para>

129

136

  </refsect1>

130

137

  

273

280

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

274

281

        </listitem>

275

282

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

276

298

    </variablelist>

277

299

  </refsect1>

278

300

  

352

374

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

353

375

      longer eligible to receive the encrypted password.  (Manual

354

376

      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>

 

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>

358

380

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

359

381

      receiving its password will also be treated as a successful

360

382

      checker run.

385

407

    <title>LOGGING</title>

386

408

    <para>

387

409

      The server will send log message with various severity levels to

388

 

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

 

410

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

389

411

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

390

412

      and also show them on the console.

391

413

    </para>

467

489

        </listitem>

468

490

      </varlistentry>

469

491

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

470

506

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

471

507

        <listitem>

472

508

          <para>

496

532

      backtrace.  This could be considered a feature.

497

533

    </para>

498

534

    <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

535

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

505

536

    </para>

506

537

    <para>

507

538

      Debug mode is conflated with running in the foreground.

508

539

    </para>

509

540

    <para>

510

 

      The console log messages do not show a time stamp.

511

 

    </para>

512

 

    <para>

513

541

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

514

542

      keys.

515

543

    </para>

528

556

    <informalexample>

529

557

      <para>

530

558

        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:

 

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:

534

562

      </para>

535

563

      <para>

536

564

 

585

613

        compromised if they are gone for too long.

586

614

      </para>

587

615

      <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

616

        For more details on client-side security, see

604

617

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

605

618

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

610

623

  <refsect1 id="see_also">

611

624

    <title>SEE ALSO</title>

612

625

    <para>

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>

 

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>

622

636

    </para>

623

637

    <variablelist>

624

638

      <varlistentry>

• Older »

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