/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (933 to 208)
• stop comparing with revision 208

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

 

5

<!ENTITY TIMESTAMP "2018-02-08">

 

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>

 

43

      <year>2017</year>

 

44

      <year>2018</year>

34

45

      <holder>Teddy Hogeborn</holder>

35

46

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

36

47

    </copyright>

83

94

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

84

95

      <sbr/>

85

96

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

 

97

      <sbr/>

 

98

      <arg><option>--debuglevel

 

99

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

 

100

      <sbr/>

 

101

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

 

102

      <sbr/>

 

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>

86

116

    </cmdsynopsis>

87

117

    <cmdsynopsis>

88

118

      <command>&COMMANDNAME;</command>

106

136

    <para>

107

137

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

108

138

      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.

 

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.

117

149

    </para>

118

150

  </refsect1>

119

151

  

188

220

      </varlistentry>

189

221

      

190

222

      <varlistentry>

 

223

        <term><option>--debuglevel

 

224

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

 

225

        <listitem>

 

226

          <para>

 

227

            Set the debugging log level.

 

228

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

 

229

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

 

230

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

 

231

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

 

232

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

 

233

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

 

234

            increasing verbosity.  The default level is

 

235

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

 

236

          </para>

 

237

        </listitem>

 

238

      </varlistentry>

 

239

      

 

240

      <varlistentry>

191

241

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

192

242

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

193

243

        <listitem>

227

277

          </para>

228

278

        </listitem>

229

279

      </varlistentry>

 

280

      

 

281

      <varlistentry>

 

282

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

 

283

        <listitem>

 

284

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

 

285

          <para>

 

286

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

 

287

          </para>

 

288

        </listitem>

 

289

      </varlistentry>

 

290

      

 

291

      <varlistentry>

 

292

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

 

293

        <listitem>

 

294

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

 

295

        </listitem>

 

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

      

230

339

    </variablelist>

231

340

  </refsect1>

232

341

  

304

413

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

305

414

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

306

415

      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>

 

416

      longer eligible to receive the encrypted password.  (Manual

 

417

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

 

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

 

422

    </para>

 

423

  </refsect1>

 

424

  

 

425

  <refsect1 id="approval">

 

426

    <title>APPROVAL</title>

 

427

    <para>

 

428

      The server can be configured to require manual approval for a

 

429

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

 

430

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

 

431

      configured both globally and per client; see <citerefentry>

310

432

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

311

 

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

312

 

    </para>

 

433

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

 

434

      will be approved immediately without delay.

 

435

    </para>

 

436

    <para>

 

437

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

 

438

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

 

439

      the server delay before giving a client its secret, allowing

 

440

      optional manual denying of this specific client.

 

441

    </para>

 

442

    

313

443

  </refsect1>

314

444

  

315

445

  <refsect1 id="logging">

316

446

    <title>LOGGING</title>

317

447

    <para>

318

448

      The server will send log message with various severity levels to

319

 

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

 

449

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

320

450

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

321

451

      and also show them on the console.

322

452

    </para>

323

453

  </refsect1>

324

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

  

 

467

  <refsect1 id="dbus_interface">

 

468

    <title>D-BUS INTERFACE</title>

 

469

    <para>

 

470

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

 

471

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

 

472

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

 

473

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

 

474

    </para>

 

475

  </refsect1>

 

476

  

325

477

  <refsect1 id="exit_status">

326

478

    <title>EXIT STATUS</title>

327

479

    <para>

350

502

    </variablelist>

351

503

  </refsect1>

352

504

  

353

 

  <refsect1 id="file">

 

505

  <refsect1 id="files">

354

506

    <title>FILES</title>

355

507

    <para>

356

508

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

379

531

        </listitem>

380

532

      </varlistentry>

381

533

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

 

534

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

 

535

        <listitem>

 

536

          <para>

 

537

            The file containing the process id of the

 

538

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

 

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>

392

559

        <listitem>

393

560

          <para>

394

561

            The Unix domain socket to where local syslog messages are

417

584

      backtrace.  This could be considered a feature.

418

585

    </para>

419

586

    <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

587

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

432

588

    </para>

433

589

    <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

590

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

441

591

      keys.

442

592

    </para>

 

593

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

443

594

  </refsect1>

444

595

  

445

596

  <refsect1 id="example">

455

606

    <informalexample>

456

607

      <para>

457

608

        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:

 

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:

461

612

      </para>

462

613

      <para>

463

614

 

482

633

  

483

634

  <refsect1 id="security">

484

635

    <title>SECURITY</title>

485

 

    <refsect2 id="SERVER">

 

636

    <refsect2 id="server">

486

637

      <title>SERVER</title>

487

638

      <para>

488

639

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

491

642

        soon after startup.

492

643

      </para>

493

644

    </refsect2>

494

 

    <refsect2 id="CLIENTS">

 

645

    <refsect2 id="clients">

495

646

      <title>CLIENTS</title>

496

647

      <para>

497

648

        The server only gives out its stored data to clients which

512

663

        compromised if they are gone for too long.

513

664

      </para>

514

665

      <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

666

        For more details on client-side security, see

532

667

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

533

668

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

538

673

  <refsect1 id="see_also">

539

674

    <title>SEE ALSO</title>

540

675

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

 

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>

550

686

    </para>

551

687

    <variablelist>

552

688

      <varlistentry>

573

709

      </varlistentry>

574

710

      <varlistentry>

575

711

        <term>

576

 

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

577

 

          >GnuTLS</ulink>

 

712

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

578

713

        </term>

579

714

      <listitem>

580

715

        <para>

618

753

      </varlistentry>

619

754

      <varlistentry>

620

755

        <term>

621

 

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

622

 

          Protocol Version 1.1</citetitle>

 

756

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

 

757

          Protocol Version 1.2</citetitle>

623

758

        </term>

624

759

      <listitem>

625

760

        <para>

626

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

761

          TLS 1.2 is the protocol implemented by GnuTLS.

627

762

        </para>

628

763

      </listitem>

629

764

      </varlistentry>

639

774

      </varlistentry>

640

775

      <varlistentry>

641

776

        <term>

642

 

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

643

 

          Security</citetitle>

 

777

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

 

778

          Security (TLS) Authentication</citetitle>

644

779

        </term>

645

780

      <listitem>

646

781

        <para>

• Older »

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