/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (966 to 266)
• stop comparing with revision 266

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 "2009-01-04">

 

5

<!ENTITY TIMESTAMP "2019-02-09">

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>

33

33

    <copyright>

34

34

      <year>2008</year>

35

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>

36

45

      <holder>Teddy Hogeborn</holder>

37

46

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

38

47

    </copyright>

86

95

      <sbr/>

87

96

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

88

97

      <sbr/>

 

98

      <arg><option>--debuglevel

 

99

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

 

100

      <sbr/>

89

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>

90

116

    </cmdsynopsis>

91

117

    <cmdsynopsis>

92

118

      <command>&COMMANDNAME;</command>

110

136

    <para>

111

137

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

112

138

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

113

 

      client host computers.  The Mandos server uses Zeroconf to

114

 

      announce itself on the local network, and uses TLS to

115

 

      communicate securely with and to authenticate the clients.  The

116

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

117

 

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

118

 

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

119

 

      Any authenticated client is then given the stored pre-encrypted

120

 

      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.

121

149

    </para>

122

150

  </refsect1>

123

151

  

192

220

      </varlistentry>

193

221

      

194

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>

195

241

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

196

242

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

197

243

        <listitem>

241

287

          </para>

242

288

        </listitem>

243

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

      

244

339

    </variablelist>

245

340

  </refsect1>

246

341

  

266

361

      start a TLS protocol handshake with a slight quirk: the Mandos

267

362

      server program acts as a TLS <quote>client</quote> while the

268

363

      connecting Mandos client acts as a TLS <quote>server</quote>.

269

 

      The Mandos client must supply an OpenPGP certificate, and the

270

 

      fingerprint of this certificate is used by the Mandos server to

271

 

      look up (in a list read from <filename>clients.conf</filename>

272

 

      at start time) which binary blob to give the client.  No other

273

 

      authentication or authorization is done by the server.

 

364

      The Mandos client must supply a TLS public key, and the key ID

 

365

      of this public key is used by the Mandos server to look up (in a

 

366

      list read from <filename>clients.conf</filename> at start time)

 

367

      which binary blob to give the client.  No other authentication

 

368

      or authorization is done by the server.

274

369

    </para>

275

370

    <table>

276

371

      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>

296

391

        </emphasis></entry>

297

392

      </row>

298

393

      <row>

299

 

        <entry>OpenPGP public key (part of TLS handshake)</entry>

 

394

        <entry>Public key (part of TLS handshake)</entry>

300

395

        <entry>-><!-- &rarr; --></entry>

301

396

      </row>

302

397

      <row>

318

413

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

319

414

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

320

415

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

321

 

      longer eligible to receive the encrypted password.  The timeout,

322

 

      checker program, and interval between checks can be configured

323

 

      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>

324

432

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

325

 

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

326

 

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

    

327

443

  </refsect1>

328

444

  

329

445

  <refsect1 id="logging">

330

446

    <title>LOGGING</title>

331

447

    <para>

332

448

      The server will send log message with various severity levels to

333

 

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

 

449

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

334

450

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

335

451

      and also show them on the console.

336

452

    </para>

337

453

  </refsect1>

338

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

  

339

467

  <refsect1 id="dbus_interface">

340

468

    <title>D-BUS INTERFACE</title>

341

469

    <para>

342

470

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

343

471

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

344

 

      Mandos-specific user, if such a user exists.

345

 

      <!-- XXX -->

 

472

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

 

473

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

346

474

    </para>

347

475

  </refsect1>

348

 

 

 

476

  

349

477

  <refsect1 id="exit_status">

350

478

    <title>EXIT STATUS</title>

351

479

    <para>

403

531

        </listitem>

404

532

      </varlistentry>

405

533

      <varlistentry>

406

 

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

407

 

        <listitem>

408

 

          <para>

409

 

            The file containing the process id of

410

 

            <command>&COMMANDNAME;</command>.

411

 

          </para>

412

 

        </listitem>

413

 

      </varlistentry>

414

 

      <varlistentry>

415

 

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

416

559

        <listitem>

417

560

          <para>

418

561

            The Unix domain socket to where local syslog messages are

441

584

      backtrace.  This could be considered a feature.

442

585

    </para>

443

586

    <para>

444

 

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

445

 

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

446

 

      permanent storage.  This has some security implications, see

447

 

      <xref linkend="clients"/>.

448

 

    </para>

449

 

    <para>

450

 

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

451

 

      status of clients, other than analyzing its <systemitem

452

 

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

453

 

    </para>

454

 

    <para>

455

587

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

456

588

    </para>

457

 

    <para>

458

 

      Debug mode is conflated with running in the foreground.

459

 

    </para>

460

 

    <para>

461

 

      The console log messages does not show a time stamp.

462

 

    </para>

463

 

    <para>

464

 

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

465

 

      keys.

466

 

    </para>

 

589

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

467

590

  </refsect1>

468

591

  

469

592

  <refsect1 id="example">

479

602

    <informalexample>

480

603

      <para>

481

604

        Run the server in debug mode, read configuration files from

482

 

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

483

 

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

484

 

        any other official Mandos server on this host:

 

605

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

 

606

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

 

607

        collide with any other official Mandos server on this host:

485

608

      </para>

486

609

      <para>

487

610

 

519

642

      <title>CLIENTS</title>

520

643

      <para>

521

644

        The server only gives out its stored data to clients which

522

 

        does have the OpenPGP key of the stored fingerprint.  This is

523

 

        guaranteed by the fact that the client sends its OpenPGP

524

 

        public key in the TLS handshake; this ensures it to be

525

 

        genuine.  The server computes the fingerprint of the key

526

 

        itself and looks up the fingerprint in its list of

527

 

        clients. The <filename>clients.conf</filename> file (see

 

645

        does have the correct key ID of the stored key ID.  This is

 

646

        guaranteed by the fact that the client sends its public key in

 

647

        the TLS handshake; this ensures it to be genuine.  The server

 

648

        computes the key ID of the key itself and looks up the key ID

 

649

        in its list of clients. The <filename>clients.conf</filename>

 

650

        file (see

528

651

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

529

652

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

530

653

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

536

659

        compromised if they are gone for too long.

537

660

      </para>

538

661

      <para>

539

 

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

540

 

        by the server which would therefore declare the client

541

 

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

542

 

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

543

 

        regard all clients therein as valid, and hence eligible to

544

 

        receive their passwords.  Therefore, be careful when

545

 

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

546

 

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

547

 

        fake Mandos client with the keys from the non-encrypted

548

 

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

549

 

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

550

 

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

551

 

        configuration file to omit any suspect clients, and restart

552

 

        the server program.

553

 

      </para>

554

 

      <para>

555

662

        For more details on client-side security, see

556

663

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

557

664

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

562

669

  <refsect1 id="see_also">

563

670

    <title>SEE ALSO</title>

564

671

    <para>

565

 

      <citerefentry>

566

 

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

567

 

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

568

 

        <refentrytitle>mandos.conf</refentrytitle>

569

 

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

570

 

        <refentrytitle>mandos-client</refentrytitle>

571

 

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

572

 

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

573

 

      </citerefentry>

 

672

      <citerefentry><refentrytitle>intro</refentrytitle>

 

673

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

 

674

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

 

675

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

 

676

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

 

677

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

 

678

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

 

679

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

 

680

      <citerefentry><refentrytitle>sh</refentrytitle>

 

681

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

574

682

    </para>

575

683

    <variablelist>

576

684

      <varlistentry>

597

705

      </varlistentry>

598

706

      <varlistentry>

599

707

        <term>

600

 

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

601

 

          >GnuTLS</ulink>

 

708

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

602

709

        </term>

603

710

      <listitem>

604

711

        <para>

605

712

          GnuTLS is the library this server uses to implement TLS for

606

713

          communicating securely with the client, and at the same time

607

 

          confidently get the client’s public OpenPGP key.

 

714

          confidently get the client’s public key.

608

715

        </para>

609

716

      </listitem>

610

717

      </varlistentry>

642

749

      </varlistentry>

643

750

      <varlistentry>

644

751

        <term>

645

 

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

646

 

          Protocol Version 1.1</citetitle>

 

752

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

 

753

          Protocol Version 1.2</citetitle>

647

754

        </term>

648

755

      <listitem>

649

756

        <para>

650

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

757

          TLS 1.2 is the protocol implemented by GnuTLS.

651

758

        </para>

652

759

      </listitem>

653

760

      </varlistentry>

663

770

      </varlistentry>

664

771

      <varlistentry>

665

772

        <term>

666

 

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

667

 

          Security</citetitle>

668

 

        </term>

669

 

      <listitem>

670

 

        <para>

671

 

          This is implemented by GnuTLS and used by this server so

672

 

          that OpenPGP keys can be used.

 

773

          RFC 7250: <citetitle>Using Raw Public Keys in Transport

 

774

          Layer Security (TLS) and Datagram Transport Layer Security

 

775

          (DTLS)</citetitle>

 

776

        </term>

 

777

      <listitem>

 

778

        <para>

 

779

          This is implemented by GnuTLS version 3.6.6 and is, if

 

780

          present, used by this server so that raw public keys can be

 

781

          used.

 

782

        </para>

 

783

      </listitem>

 

784

      </varlistentry>

 

785

      <varlistentry>

 

786

        <term>

 

787

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

 

788

          Security (TLS) Authentication</citetitle>

 

789

        </term>

 

790

      <listitem>

 

791

        <para>

 

792

          This is implemented by GnuTLS before version 3.6.0 and is,

 

793

          if present, used by this server so that OpenPGP keys can be

 

794

          used.

673

795

        </para>

674

796

      </listitem>

675

797

      </varlistentry>

• Older »

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