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

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

 

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

 

      <year>2012</year>

39

37

      <holder>Teddy Hogeborn</holder>

40

38

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

41

39

    </copyright>

95

93

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

96

94

      <sbr/>

97

95

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

108

96

    </cmdsynopsis>

109

97

    <cmdsynopsis>

110

98

      <command>&COMMANDNAME;</command>

128

116

    <para>

129

117

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

130

118

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

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.

 

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.

141

127

    </para>

142

128

  </refsect1>

143

129

  

286

272

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

287

273

        </listitem>

288

274

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

 

      

324

275

    </variablelist>

325

276

  </refsect1>

326

277

  

400

351

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

401

352

      longer eligible to receive the encrypted password.  (Manual

402

353

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

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

 

354

      checker program, and interval between checks can be configured

 

355

      both globally and per client; see <citerefentry>

 

356

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

 

357

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

 

358

      receiving its password will also be treated as a successful

 

359

      checker run.

407

360

    </para>

408

361

  </refsect1>

409

362

  

431

384

    <title>LOGGING</title>

432

385

    <para>

433

386

      The server will send log message with various severity levels to

434

 

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

 

387

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

435

388

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

436

389

      and also show them on the console.

437

390

    </para>

438

391

  </refsect1>

439

392

  

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

 

  

452

393

  <refsect1 id="dbus_interface">

453

394

    <title>D-BUS INTERFACE</title>

454

395

    <para>

525

466

        </listitem>

526

467

      </varlistentry>

527

468

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

542

469

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

543

470

        <listitem>

544

471

          <para>

568

495

      backtrace.  This could be considered a feature.

569

496

    </para>

570

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>

571

503

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

572

504

    </para>

573

505

    <para>

 

506

      Debug mode is conflated with running in the foreground.

 

507

    </para>

 

508

    <para>

 

509

      The console log messages do not show a time stamp.

 

510

    </para>

 

511

    <para>

574

512

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

575

513

      keys.

576

514

    </para>

589

527

    <informalexample>

590

528

      <para>

591

529

        Run the server in debug mode, read configuration files from

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:

 

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:

595

533

      </para>

596

534

      <para>

597

535

 

646

584

        compromised if they are gone for too long.

647

585

      </para>

648

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>

649

602

        For more details on client-side security, see

650

603

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

651

604

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

656

609

  <refsect1 id="see_also">

657

610

    <title>SEE ALSO</title>

658

611

    <para>

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>

 

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>

669

621

    </para>

670

622

    <variablelist>

671

623

      <varlistentry>

• Older »

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