/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.100 to 472)
• stop comparing with revision 472

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 "2018-02-08">

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>

 

39

      <year>2013</year>

 

40

      <year>2014</year>

 

41

      <year>2015</year>

 

42

      <year>2016</year>

 

43

      <year>2017</year>

 

44

      <year>2018</year>

38

45

      <holder>Teddy Hogeborn</holder>

39

46

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

40

47

    </copyright>

94

101

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

95

102

      <sbr/>

96

103

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

 

104

      <sbr/>

 

105

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

 

106

      <sbr/>

 

107

      <arg><option>--statedir

 

108

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

 

109

      <sbr/>

 

110

      <arg><option>--socket

 

111

      <replaceable>FD</replaceable></option></arg>

 

112

      <sbr/>

 

113

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

 

114

      <sbr/>

 

115

      <arg><option>--no-zeroconf</option></arg>

97

116

    </cmdsynopsis>

98

117

    <cmdsynopsis>

99

118

      <command>&COMMANDNAME;</command>

117

136

    <para>

118

137

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

119

138

      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.

 

139

      client host computers. For an introduction, see

 

140

      <citerefentry><refentrytitle>intro</refentrytitle>

 

141

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

 

142

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

 

143

      TLS to communicate securely with and to authenticate the

 

144

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

 

145

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

 

146

      not have any other addresses configured (see <xref

 

147

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

 

148

      the stored pre-encrypted password for that specific client.

128

149

    </para>

129

150

  </refsect1>

130

151

  

273

294

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

274

295

        </listitem>

275

296

      </varlistentry>

 

297

      

 

298

      <varlistentry>

 

299

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

 

300

        <listitem>

 

301

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

 

302

          <para>

 

303

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

 

304

          </para>

 

305

        </listitem>

 

306

      </varlistentry>

 

307

      

 

308

      <varlistentry>

 

309

        <term><option>--statedir

 

310

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

 

311

        <listitem>

 

312

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

 

313

        </listitem>

 

314

      </varlistentry>

 

315

      

 

316

      <varlistentry>

 

317

        <term><option>--socket

 

318

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

 

319

        <listitem>

 

320

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

 

321

        </listitem>

 

322

      </varlistentry>

 

323

      

 

324

      <varlistentry>

 

325

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

 

326

        <listitem>

 

327

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

 

328

                      xpointer="foreground"/>

 

329

        </listitem>

 

330

      </varlistentry>

 

331

      

 

332

      <varlistentry>

 

333

        <term><option>--no-zeroconf</option></term>

 

334

        <listitem>

 

335

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

 

336

        </listitem>

 

337

      </varlistentry>

 

338

      

276

339

    </variablelist>

277

340

  </refsect1>

278

341

  

352

415

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

353

416

      longer eligible to receive the encrypted password.  (Manual

354

417

      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.

 

418

      extended timeout, checker program, and interval between checks

 

419

      can be configured both globally and per client; see

 

420

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

 

421

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

361

422

    </para>

362

423

  </refsect1>

363

424

  

385

446

    <title>LOGGING</title>

386

447

    <para>

387

448

      The server will send log message with various severity levels to

388

 

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

 

449

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

389

450

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

390

451

      and also show them on the console.

391

452

    </para>

392

453

  </refsect1>

393

454

  

 

455

  <refsect1 id="persistent_state">

 

456

    <title>PERSISTENT STATE</title>

 

457

    <para>

 

458

      Client settings, initially read from

 

459

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

 

460

      restarts, and run-time changes will override settings in

 

461

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

 

462

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

 

463

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

 

464

    </para>

 

465

  </refsect1>

 

466

  

394

467

  <refsect1 id="dbus_interface">

395

468

    <title>D-BUS INTERFACE</title>

396

469

    <para>

458

531

        </listitem>

459

532

      </varlistentry>

460

533

      <varlistentry>

461

 

        <term><filename>/var/run/mandos.pid</filename></term>

 

534

        <term><filename>/run/mandos.pid</filename></term>

462

535

        <listitem>

463

536

          <para>

464

537

            The file containing the process id of the

465

538

            <command>&COMMANDNAME;</command> process started last.

466

 

          </para>

467

 

        </listitem>

468

 

      </varlistentry>

469

 

      <varlistentry>

470

 

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

 

539

            <emphasis >Note:</emphasis> If the <filename

 

540

            class="directory">/run</filename> directory does not

 

541

            exist, <filename>/var/run/mandos.pid</filename> will be

 

542

            used instead.

 

543

          </para>

 

544

        </listitem>

 

545

      </varlistentry>

 

546

      <varlistentry>

 

547

        <term><filename

 

548

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

 

549

        <listitem>

 

550

          <para>

 

551

            Directory where persistent state will be saved.  Change

 

552

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

 

553

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

 

554

          </para>

 

555

        </listitem>

 

556

      </varlistentry>

 

557

      <varlistentry>

 

558

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

471

559

        <listitem>

472

560

          <para>

473

561

            The Unix domain socket to where local syslog messages are

496

584

      backtrace.  This could be considered a feature.

497

585

    </para>

498

586

    <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

587

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

505

588

    </para>

506

589

    <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

590

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

514

591

      keys.

515

592

    </para>

 

593

    <xi:include href="bugs.xml"/>

516

594

  </refsect1>

517

595

  

518

596

  <refsect1 id="example">

528

606

    <informalexample>

529

607

      <para>

530

608

        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:

 

609

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

 

610

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

 

611

        collide with any other official Mandos server on this host:

534

612

      </para>

535

613

      <para>

536

614

 

585

663

        compromised if they are gone for too long.

586

664

      </para>

587

665

      <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

666

        For more details on client-side security, see

604

667

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

605

668

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

610

673

  <refsect1 id="see_also">

611

674

    <title>SEE ALSO</title>

612

675

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

 

676

      <citerefentry><refentrytitle>intro</refentrytitle>

 

677

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

 

678

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

 

679

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

 

680

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

 

681

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

 

682

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

 

683

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

 

684

      <citerefentry><refentrytitle>sh</refentrytitle>

 

685

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

622

686

    </para>

623

687

    <variablelist>

624

688

      <varlistentry>

645

709

      </varlistentry>

646

710

      <varlistentry>

647

711

        <term>

648

 

          <ulink url="http://www.gnu.org/software/gnutls/"

649

 

          >GnuTLS</ulink>

 

712

          <ulink url="https://gnutls.org/">GnuTLS</ulink>

650

713

        </term>

651

714

      <listitem>

652

715

        <para>

690

753

      </varlistentry>

691

754

      <varlistentry>

692

755

        <term>

693

 

          RFC 4346: <citetitle>The Transport Layer Security (TLS)

694

 

          Protocol Version 1.1</citetitle>

 

756

          RFC 5246: <citetitle>The Transport Layer Security (TLS)

 

757

          Protocol Version 1.2</citetitle>

695

758

        </term>

696

759

      <listitem>

697

760

        <para>

698

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

761

          TLS 1.2 is the protocol implemented by GnuTLS.

699

762

        </para>

700

763

      </listitem>

701

764

      </varlistentry>

711

774

      </varlistentry>

712

775

      <varlistentry>

713

776

        <term>

714

 

          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer

715

 

          Security</citetitle>

 

777

          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer

 

778

          Security (TLS) Authentication</citetitle>

716

779

        </term>

717

780

      <listitem>

718

781

        <para>

• Older »

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