/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.65 to 184)
• stop comparing with revision 184

Show diffs side-by-side

added

removed

mandos.xml

1

1

<?xml version="1.0" encoding="UTF-8"?>

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

 

<!ENTITY VERSION "1.0">

5

4

<!ENTITY COMMANDNAME "mandos">

6

 

<!ENTITY TIMESTAMP "2008-09-12">

 

5

<!ENTITY TIMESTAMP "2016-02-28">

 

6

<!ENTITY % common SYSTEM "common.ent">

 

7

%common;

7

8

]>

8

9

 

9

10

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">

10

 

  <refentryinfo>

 

11

   <refentryinfo>

11

12

    <title>Mandos Manual</title>

12

13

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

13

14

    <productname>Mandos</productname>

14

 

    <productnumber>&VERSION;</productnumber>

 

15

    <productnumber>&version;</productnumber>

15

16

    <date>&TIMESTAMP;</date>

16

17

    <authorgroup>

17

18

      <author>

18

19

        <firstname>Björn</firstname>

19

20

        <surname>Påhlsson</surname>

20

21

        <address>

21

 

          <email>belorn@fukt.bsnet.se</email>

 

22

          <email>belorn@recompile.se</email>

22

23

        </address>

23

24

      </author>

24

25

      <author>

25

26

        <firstname>Teddy</firstname>

26

27

        <surname>Hogeborn</surname>

27

28

        <address>

28

 

          <email>teddy@fukt.bsnet.se</email>

 

29

          <email>teddy@recompile.se</email>

29

30

        </address>

30

31

      </author>

31

32

    </authorgroup>

32

33

    <copyright>

33

34

      <year>2008</year>

 

35

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

 

39

      <year>2013</year>

 

40

      <year>2014</year>

 

41

      <year>2015</year>

 

42

      <year>2016</year>

34

43

      <holder>Teddy Hogeborn</holder>

35

44

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

36

45

    </copyright>

83

92

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

84

93

      <sbr/>

85

94

      <arg><option>--debug</option></arg>

 

95

      <sbr/>

 

96

      <arg><option>--debuglevel

 

97

      <replaceable>LEVEL</replaceable></option></arg>

 

98

      <sbr/>

 

99

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

 

100

      <sbr/>

 

101

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

 

102

      <sbr/>

 

103

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

 

104

      <sbr/>

 

105

      <arg><option>--statedir

 

106

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

 

107

      <sbr/>

 

108

      <arg><option>--socket

 

109

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

 

110

      <sbr/>

 

111

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

 

112

      <sbr/>

 

113

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

86

114

    </cmdsynopsis>

87

115

    <cmdsynopsis>

88

116

      <command>&COMMANDNAME;</command>

106

134

    <para>

107

135

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

108

136

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

109

 

      client host computers.  The Mandos server uses Zeroconf to

110

 

      announce itself on the local network, and uses TLS to

111

 

      communicate securely with and to authenticate the clients.  The

112

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

113

 

      link-local addresses, since the clients will probably not have

114

 

      any other addresses configured (see <xref linkend="overview"/>).

115

 

      Any authenticated client is then given the stored pre-encrypted

116

 

      password for that specific client.

 

137

      client host computers. For an introduction, see

 

138

      <citerefentry><refentrytitle>intro</refentrytitle>

 

139

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

 

140

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

 

141

      TLS to communicate securely with and to authenticate the

 

142

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

 

143

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

 

144

      not have any other addresses configured (see <xref

 

145

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

 

146

      the stored pre-encrypted password for that specific client.

117

147

    </para>

118

148

  </refsect1>

119

149

  

188

218

      </varlistentry>

189

219

      

190

220

      <varlistentry>

 

221

        <term><option>--debuglevel

 

222

        <replaceable>LEVEL</replaceable></option></term>

 

223

        <listitem>

 

224

          <para>

 

225

            Set the debugging log level.

 

226

            <replaceable>LEVEL</replaceable> is a string, one of

 

227

            <quote><literal>CRITICAL</literal></quote>,

 

228

            <quote><literal>ERROR</literal></quote>,

 

229

            <quote><literal>WARNING</literal></quote>,

 

230

            <quote><literal>INFO</literal></quote>, or

 

231

            <quote><literal>DEBUG</literal></quote>, in order of

 

232

            increasing verbosity.  The default level is

 

233

            <quote><literal>WARNING</literal></quote>.

 

234

          </para>

 

235

        </listitem>

 

236

      </varlistentry>

 

237

      

 

238

      <varlistentry>

191

239

        <term><option>--priority <replaceable>

192

240

        PRIORITY</replaceable></option></term>

193

241

        <listitem>

227

275

          </para>

228

276

        </listitem>

229

277

      </varlistentry>

 

278

      

 

279

      <varlistentry>

 

280

        <term><option>--no-dbus</option></term>

 

281

        <listitem>

 

282

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

 

283

          <para>

 

284

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

 

285

          </para>

 

286

        </listitem>

 

287

      </varlistentry>

 

288

      

 

289

      <varlistentry>

 

290

        <term><option>--no-ipv6</option></term>

 

291

        <listitem>

 

292

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

 

293

        </listitem>

 

294

      </varlistentry>

 

295

      

 

296

      <varlistentry>

 

297

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

 

298

        <listitem>

 

299

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

 

300

          <para>

 

301

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

 

302

          </para>

 

303

        </listitem>

 

304

      </varlistentry>

 

305

      

 

306

      <varlistentry>

 

307

        <term><option>--statedir

 

308

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

 

309

        <listitem>

 

310

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

 

311

        </listitem>

 

312

      </varlistentry>

 

313

      

 

314

      <varlistentry>

 

315

        <term><option>--socket

 

316

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

 

317

        <listitem>

 

318

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

 

319

        </listitem>

 

320

      </varlistentry>

 

321

      

 

322

      <varlistentry>

 

323

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

 

324

        <listitem>

 

325

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

 

326

                      xpointer="foreground"/>

 

327

        </listitem>

 

328

      </varlistentry>

 

329

      

 

330

      <varlistentry>

 

331

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

 

332

        <listitem>

 

333

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

 

334

        </listitem>

 

335

      </varlistentry>

 

336

      

230

337

    </variablelist>

231

338

  </refsect1>

232

339

  

304

411

      The server will, by default, continually check that the clients

305

412

      are still up.  If a client has not been confirmed as being up

306

413

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

307

 

      longer eligible to receive the encrypted password.  The timeout,

308

 

      checker program, and interval between checks can be configured

309

 

      both globally and per client; see <citerefentry>

 

414

      longer eligible to receive the encrypted password.  (Manual

 

415

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

 

416

      extended timeout, checker program, and interval between checks

 

417

      can be configured both globally and per client; see

 

418

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

 

419

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

 

420

    </para>

 

421

  </refsect1>

 

422

  

 

423

  <refsect1 id="approval">

 

424

    <title>APPROVAL</title>

 

425

    <para>

 

426

      The server can be configured to require manual approval for a

 

427

      client before it is sent its secret.  The delay to wait for such

 

428

      approval and the default action (approve or deny) can be

 

429

      configured both globally and per client; see <citerefentry>

310

430

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

311

 

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

312

 

    </para>

 

431

      <manvolnum>5</manvolnum></citerefentry>.  By default all clients

 

432

      will be approved immediately without delay.

 

433

    </para>

 

434

    <para>

 

435

      This can be used to deny a client its secret if not manually

 

436

      approved within a specified time.  It can also be used to make

 

437

      the server delay before giving a client its secret, allowing

 

438

      optional manual denying of this specific client.

 

439

    </para>

 

440

    

313

441

  </refsect1>

314

442

  

315

443

  <refsect1 id="logging">

316

444

    <title>LOGGING</title>

317

445

    <para>

318

446

      The server will send log message with various severity levels to

319

 

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

 

447

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

320

448

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

321

449

      and also show them on the console.

322

450

    </para>

323

451

  </refsect1>

324

452

  

 

453

  <refsect1 id="persistent_state">

 

454

    <title>PERSISTENT STATE</title>

 

455

    <para>

 

456

      Client settings, initially read from

 

457

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

 

458

      restarts, and run-time changes will override settings in

 

459

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

 

460

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

 

461

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

 

462

    </para>

 

463

  </refsect1>

 

464

  

 

465

  <refsect1 id="dbus_interface">

 

466

    <title>D-BUS INTERFACE</title>

 

467

    <para>

 

468

      The server will by default provide a D-Bus system bus interface.

 

469

      This interface will only be accessible by the root user or a

 

470

      Mandos-specific user, if such a user exists.  For documentation

 

471

      of the D-Bus API, see the file <filename>DBUS-API</filename>.

 

472

    </para>

 

473

  </refsect1>

 

474

  

325

475

  <refsect1 id="exit_status">

326

476

    <title>EXIT STATUS</title>

327

477

    <para>

350

500

    </variablelist>

351

501

  </refsect1>

352

502

  

353

 

  <refsect1 id="file">

 

503

  <refsect1 id="files">

354

504

    <title>FILES</title>

355

505

    <para>

356

506

      Use the <option>--configdir</option> option to change where

379

529

        </listitem>

380

530

      </varlistentry>

381

531

      <varlistentry>

382

 

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

383

 

        <listitem>

384

 

          <para>

385

 

            The file containing the process id of

386

 

            <command>&COMMANDNAME;</command>.

387

 

          </para>

388

 

        </listitem>

389

 

      </varlistentry>

390

 

      <varlistentry>

391

 

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

 

532

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

 

533

        <listitem>

 

534

          <para>

 

535

            The file containing the process id of the

 

536

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

 

537

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

 

538

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

 

539

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

 

540

            used instead.

 

541

          </para>

 

542

        </listitem>

 

543

      </varlistentry>

 

544

      <varlistentry>

 

545

        <term><filename

 

546

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

 

547

        <listitem>

 

548

          <para>

 

549

            Directory where persistent state will be saved.  Change

 

550

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

 

551

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

 

552

          </para>

 

553

        </listitem>

 

554

      </varlistentry>

 

555

      <varlistentry>

 

556

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

392

557

        <listitem>

393

558

          <para>

394

559

            The Unix domain socket to where local syslog messages are

417

582

      backtrace.  This could be considered a feature.

418

583

    </para>

419

584

    <para>

420

 

      Currently, if a client is declared <quote>invalid</quote> due to

421

 

      having timed out, the server does not record this fact onto

422

 

      permanent storage.  This has some security implications, see

423

 

      <xref linkend="CLIENTS"/>.

424

 

    </para>

425

 

    <para>

426

 

      There is currently no way of querying the server of the current

427

 

      status of clients, other than analyzing its <systemitem

428

 

      class="service">syslog</systemitem> output.

429

 

    </para>

430

 

    <para>

431

585

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

432

586

    </para>

433

587

    <para>

434

 

      Debug mode is conflated with running in the foreground.

435

 

    </para>

436

 

    <para>

437

 

      The console log messages does not show a time stamp.

438

 

    </para>

439

 

    <para>

440

588

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

441

589

      keys.

442

590

    </para>

455

603

    <informalexample>

456

604

      <para>

457

605

        Run the server in debug mode, read configuration files from

458

 

        the <filename>~/mandos</filename> directory, and use the

459

 

        Zeroconf service name <quote>Test</quote> to not collide with

460

 

        any other official Mandos server on this host:

 

606

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

 

607

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

 

608

        collide with any other official Mandos server on this host:

461

609

      </para>

462

610

      <para>

463

611

 

482

630

  

483

631

  <refsect1 id="security">

484

632

    <title>SECURITY</title>

485

 

    <refsect2 id="SERVER">

 

633

    <refsect2 id="server">

486

634

      <title>SERVER</title>

487

635

      <para>

488

636

        Running this <command>&COMMANDNAME;</command> server program

491

639

        soon after startup.

492

640

      </para>

493

641

    </refsect2>

494

 

    <refsect2 id="CLIENTS">

 

642

    <refsect2 id="clients">

495

643

      <title>CLIENTS</title>

496

644

      <para>

497

645

        The server only gives out its stored data to clients which

504

652

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

505

653

        <manvolnum>5</manvolnum></citerefentry>)

506

654

        <emphasis>must</emphasis> be made non-readable by anyone

507

 

        except the user running the server.

 

655

        except the user starting the server (usually root).

508

656

      </para>

509

657

      <para>

510

658

        As detailed in <xref linkend="checking"/>, the status of all

512

660

        compromised if they are gone for too long.

513

661

      </para>

514

662

      <para>

515

 

        If a client is compromised, its downtime should be duly noted

516

 

        by the server which would therefore declare the client

517

 

        invalid.  But if the server was ever restarted, it would

518

 

        re-read its client list from its configuration file and again

519

 

        regard all clients therein as valid, and hence eligible to

520

 

        receive their passwords.  Therefore, be careful when

521

 

        restarting servers if it is suspected that a client has, in

522

 

        fact, been compromised by parties who may now be running a

523

 

        fake Mandos client with the keys from the non-encrypted

524

 

        initial <acronym>RAM</acronym> image of the client host.  What

525

 

        should be done in that case (if restarting the server program

526

 

        really is necessary) is to stop the server program, edit the

527

 

        configuration file to omit any suspect clients, and restart

528

 

        the server program.

529

 

      </para>

530

 

      <para>

531

663

        For more details on client-side security, see

532

664

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

533

665

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

538

670

  <refsect1 id="see_also">

539

671

    <title>SEE ALSO</title>

540

672

    <para>

541

 

      <citerefentry>

542

 

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

543

 

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

544

 

        <refentrytitle>mandos.conf</refentrytitle>

545

 

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

546

 

        <refentrytitle>mandos-client</refentrytitle>

547

 

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

548

 

        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>

549

 

      </citerefentry>

 

673

      <citerefentry><refentrytitle>intro</refentrytitle>

 

674

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

 

675

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

 

676

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

 

677

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

 

678

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

 

679

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

 

680

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

 

681

      <citerefentry><refentrytitle>sh</refentrytitle>

 

682

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

550

683

    </para>

551

684

    <variablelist>

552

685

      <varlistentry>

573

706

      </varlistentry>

574

707

      <varlistentry>

575

708

        <term>

576

 

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

577

 

          >GnuTLS</ulink>

 

709

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

578

710

        </term>

579

711

      <listitem>

580

712

        <para>

618

750

      </varlistentry>

619

751

      <varlistentry>

620

752

        <term>

621

 

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

622

 

          Protocol Version 1.1</citetitle>

 

753

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

 

754

          Protocol Version 1.2</citetitle>

623

755

        </term>

624

756

      <listitem>

625

757

        <para>

626

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

758

          TLS 1.2 is the protocol implemented by GnuTLS.

627

759

        </para>

628

760

      </listitem>

629

761

      </varlistentry>

639

771

      </varlistentry>

640

772

      <varlistentry>

641

773

        <term>

642

 

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

643

 

          Security</citetitle>

 

774

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

 

775

          Security (TLS) Authentication</citetitle>

644

776

        </term>

645

777

      <listitem>

646

778

        <para>

• Older »

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