/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (361 to 283)
• stop comparing with revision 283

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 "2017-02-23">

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>

38

44

      <holder>Teddy Hogeborn</holder>

39

45

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

40

46

    </copyright>

94

100

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

95

101

      <sbr/>

96

102

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

 

103

      <sbr/>

 

104

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

 

105

      <sbr/>

 

106

      <arg><option>--statedir

 

107

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

 

108

      <sbr/>

 

109

      <arg><option>--socket

 

110

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

 

111

      <sbr/>

 

112

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

 

113

      <sbr/>

 

114

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

97

115

    </cmdsynopsis>

98

116

    <cmdsynopsis>

99

117

      <command>&COMMANDNAME;</command>

117

135

    <para>

118

136

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

119

137

      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.

 

138

      client host computers. For an introduction, see

 

139

      <citerefentry><refentrytitle>intro</refentrytitle>

 

140

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

 

141

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

 

142

      TLS to communicate securely with and to authenticate the

 

143

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

 

144

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

 

145

      not have any other addresses configured (see <xref

 

146

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

 

147

      the stored pre-encrypted password for that specific client.

128

148

    </para>

129

149

  </refsect1>

130

150

  

273

293

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

274

294

        </listitem>

275

295

      </varlistentry>

 

296

      

 

297

      <varlistentry>

 

298

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

 

299

        <listitem>

 

300

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

 

301

          <para>

 

302

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

 

303

          </para>

 

304

        </listitem>

 

305

      </varlistentry>

 

306

      

 

307

      <varlistentry>

 

308

        <term><option>--statedir

 

309

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

 

310

        <listitem>

 

311

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

 

312

        </listitem>

 

313

      </varlistentry>

 

314

      

 

315

      <varlistentry>

 

316

        <term><option>--socket

 

317

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

 

318

        <listitem>

 

319

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

 

320

        </listitem>

 

321

      </varlistentry>

 

322

      

 

323

      <varlistentry>

 

324

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

 

325

        <listitem>

 

326

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

 

327

                      xpointer="foreground"/>

 

328

        </listitem>

 

329

      </varlistentry>

 

330

      

 

331

      <varlistentry>

 

332

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

 

333

        <listitem>

 

334

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

 

335

        </listitem>

 

336

      </varlistentry>

 

337

      

276

338

    </variablelist>

277

339

  </refsect1>

278

340

  

352

414

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

353

415

      longer eligible to receive the encrypted password.  (Manual

354

416

      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.

 

417

      extended timeout, checker program, and interval between checks

 

418

      can be configured both globally and per client; see

 

419

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

 

420

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

361

421

    </para>

362

422

  </refsect1>

363

423

  

385

445

    <title>LOGGING</title>

386

446

    <para>

387

447

      The server will send log message with various severity levels to

388

 

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

 

448

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

389

449

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

390

450

      and also show them on the console.

391

451

    </para>

392

452

  </refsect1>

393

453

  

 

454

  <refsect1 id="persistent_state">

 

455

    <title>PERSISTENT STATE</title>

 

456

    <para>

 

457

      Client settings, initially read from

 

458

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

 

459

      restarts, and run-time changes will override settings in

 

460

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

 

461

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

 

462

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

 

463

    </para>

 

464

  </refsect1>

 

465

  

394

466

  <refsect1 id="dbus_interface">

395

467

    <title>D-BUS INTERFACE</title>

396

468

    <para>

458

530

        </listitem>

459

531

      </varlistentry>

460

532

      <varlistentry>

461

 

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

 

533

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

462

534

        <listitem>

463

535

          <para>

464

536

            The file containing the process id of the

465

537

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

466

 

          </para>

467

 

        </listitem>

468

 

      </varlistentry>

469

 

      <varlistentry>

470

 

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

 

538

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

 

539

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

 

540

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

 

541

            used instead.

 

542

          </para>

 

543

        </listitem>

 

544

      </varlistentry>

 

545

      <varlistentry>

 

546

        <term><filename

 

547

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

 

548

        <listitem>

 

549

          <para>

 

550

            Directory where persistent state will be saved.  Change

 

551

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

 

552

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

 

553

          </para>

 

554

        </listitem>

 

555

      </varlistentry>

 

556

      <varlistentry>

 

557

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

471

558

        <listitem>

472

559

          <para>

473

560

            The Unix domain socket to where local syslog messages are

496

583

      backtrace.  This could be considered a feature.

497

584

    </para>

498

585

    <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

586

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

505

587

    </para>

506

588

    <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

589

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

514

590

      keys.

515

591

    </para>

 

592

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

516

593

  </refsect1>

517

594

  

518

595

  <refsect1 id="example">

528

605

    <informalexample>

529

606

      <para>

530

607

        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:

 

608

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

 

609

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

 

610

        collide with any other official Mandos server on this host:

534

611

      </para>

535

612

      <para>

536

613

 

585

662

        compromised if they are gone for too long.

586

663

      </para>

587

664

      <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

665

        For more details on client-side security, see

604

666

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

605

667

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

610

672

  <refsect1 id="see_also">

611

673

    <title>SEE ALSO</title>

612

674

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

 

675

      <citerefentry><refentrytitle>intro</refentrytitle>

 

676

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

 

677

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

 

678

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

 

679

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

 

680

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

 

681

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

 

682

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

 

683

      <citerefentry><refentrytitle>sh</refentrytitle>

 

684

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

622

685

    </para>

623

686

    <variablelist>

624

687

      <varlistentry>

645

708

      </varlistentry>

646

709

      <varlistentry>

647

710

        <term>

648

 

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

649

 

          >GnuTLS</ulink>

 

711

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

650

712

        </term>

651

713

      <listitem>

652

714

        <para>

690

752

      </varlistentry>

691

753

      <varlistentry>

692

754

        <term>

693

 

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

694

 

          Protocol Version 1.1</citetitle>

 

755

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

 

756

          Protocol Version 1.2</citetitle>

695

757

        </term>

696

758

      <listitem>

697

759

        <para>

698

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

760

          TLS 1.2 is the protocol implemented by GnuTLS.

699

761

        </para>

700

762

      </listitem>

701

763

      </varlistentry>

711

773

      </varlistentry>

712

774

      <varlistentry>

713

775

        <term>

714

 

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

715

 

          Security</citetitle>

 

776

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

 

777

          Security (TLS) Authentication</citetitle>

716

778

        </term>

717

779

      <listitem>

718

780

        <para>

• Older »

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