/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (606 to 486)
• stop comparing with revision 486

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 "2012-06-17">

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>

 

106

      <sbr/>

 

107

      <arg><option>--foreground</option></arg>

97

108

    </cmdsynopsis>

98

109

    <cmdsynopsis>

99

110

      <command>&COMMANDNAME;</command>

117

128

    <para>

118

129

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

119

130

      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.

 

131

      client host computers. For an introduction, see

 

132

      <citerefentry><refentrytitle>intro</refentrytitle>

 

133

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

 

134

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

 

135

      TLS to communicate securely with and to authenticate the

 

136

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

 

137

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

 

138

      not have any other addresses configured (see <xref

 

139

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

 

140

      the stored pre-encrypted password for that specific client.

128

141

    </para>

129

142

  </refsect1>

130

143

  

273

286

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

274

287

        </listitem>

275

288

      </varlistentry>

 

289

      

 

290

      <varlistentry>

 

291

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

 

292

        <listitem>

 

293

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

 

294

          <para>

 

295

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

 

296

          </para>

 

297

        </listitem>

 

298

      </varlistentry>

 

299

      

 

300

      <varlistentry>

 

301

        <term><option>--statedir

 

302

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

 

303

        <listitem>

 

304

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

 

305

        </listitem>

 

306

      </varlistentry>

 

307

      

 

308

      <varlistentry>

 

309

        <term><option>--socket

 

310

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

 

311

        <listitem>

 

312

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

 

313

        </listitem>

 

314

      </varlistentry>

 

315

      

 

316

      <varlistentry>

 

317

        <term><option>--foreground</option></term>

 

318

        <listitem>

 

319

          <xi:include href="mandos-options.xml"

 

320

                      xpointer="foreground"/>

 

321

        </listitem>

 

322

      </varlistentry>

 

323

      

276

324

    </variablelist>

277

325

  </refsect1>

278

326

  

352

400

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

353

401

      longer eligible to receive the encrypted password.  (Manual

354

402

      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.

 

403

      extended timeout, checker program, and interval between checks

 

404

      can be configured both globally and per client; see

 

405

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

 

406

      <manvolnum>5</manvolnum></citerefentry>.

361

407

    </para>

362

408

  </refsect1>

363

409

  

385

431

    <title>LOGGING</title>

386

432

    <para>

387

433

      The server will send log message with various severity levels to

388

 

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

 

434

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

389

435

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

390

436

      and also show them on the console.

391

437

    </para>

392

438

  </refsect1>

393

439

  

 

440

  <refsect1 id="persistent_state">

 

441

    <title>PERSISTENT STATE</title>

 

442

    <para>

 

443

      Client settings, initially read from

 

444

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

 

445

      restarts, and run-time changes will override settings in

 

446

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

 

447

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

 

448

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

 

449

    </para>

 

450

  </refsect1>

 

451

  

394

452

  <refsect1 id="dbus_interface">

395

453

    <title>D-BUS INTERFACE</title>

396

454

    <para>

467

525

        </listitem>

468

526

      </varlistentry>

469

527

      <varlistentry>

 

528

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

 

529

      </varlistentry>

 

530

      <varlistentry>

 

531

        <term><filename

 

532

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

 

533

        <listitem>

 

534

          <para>

 

535

            Directory where persistent state will be saved.  Change

 

536

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

 

537

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

 

538

          </para>

 

539

        </listitem>

 

540

      </varlistentry>

 

541

      <varlistentry>

470

542

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

471

543

        <listitem>

472

544

          <para>

496

568

      backtrace.  This could be considered a feature.

497

569

    </para>

498

570

    <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

571

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

505

572

    </para>

506

573

    <para>

507

 

      Debug mode is conflated with running in the foreground.

508

 

    </para>

509

 

    <para>

510

 

      The console log messages do not show a time stamp.

511

 

    </para>

512

 

    <para>

513

574

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

514

575

      keys.

515

576

    </para>

528

589

    <informalexample>

529

590

      <para>

530

591

        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:

 

592

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

 

593

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

 

594

        collide with any other official Mandos server on this host:

534

595

      </para>

535

596

      <para>

536

597

 

585

646

        compromised if they are gone for too long.

586

647

      </para>

587

648

      <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

649

        For more details on client-side security, see

604

650

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

605

651

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

610

656

  <refsect1 id="see_also">

611

657

    <title>SEE ALSO</title>

612

658

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

 

659

      <citerefentry><refentrytitle>intro</refentrytitle>

 

660

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

 

661

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

 

662

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

 

663

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

 

664

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

 

665

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

 

666

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

 

667

      <citerefentry><refentrytitle>sh</refentrytitle>

 

668

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

622

669

    </para>

623

670

    <variablelist>

624

671

      <varlistentry>

• Older »

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