/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (412 to 243)
• stop comparing with revision 243

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 "2022-04-24">

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>

 

45

      <year>2019</year>

36

46

      <holder>Teddy Hogeborn</holder>

37

47

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

38

48

    </copyright>

85

95

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

86

96

      <sbr/>

87

97

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

 

98

      <sbr/>

 

99

      <arg><option>--debuglevel

 

100

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

 

101

      <sbr/>

 

102

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

 

103

      <sbr/>

 

104

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

 

105

      <sbr/>

 

106

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

 

107

      <sbr/>

 

108

      <arg><option>--statedir

 

109

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

 

110

      <sbr/>

 

111

      <arg><option>--socket

 

112

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

 

113

      <sbr/>

 

114

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

 

115

      <sbr/>

 

116

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

88

117

    </cmdsynopsis>

89

118

    <cmdsynopsis>

90

119

      <command>&COMMANDNAME;</command>

107

136

    <title>DESCRIPTION</title>

108

137

    <para>

109

138

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

110

 

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

111

 

      client host computers.  The Mandos server uses Zeroconf to

112

 

      announce itself on the local network, and uses TLS to

113

 

      communicate securely with and to authenticate the clients.  The

114

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

115

 

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

116

 

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

117

 

      Any authenticated client is then given the stored pre-encrypted

118

 

      password for that specific client.

 

139

      handles incoming requests for passwords for a pre-defined list

 

140

      of client host computers. For an introduction, see

 

141

      <citerefentry><refentrytitle>intro</refentrytitle>

 

142

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

 

143

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

 

144

      TLS to communicate securely with and to authenticate the

 

145

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

 

146

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

 

147

      not have any other addresses configured (see <xref

 

148

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

 

149

      the stored pre-encrypted password for that specific client.

119

150

    </para>

120

151

  </refsect1>

121

152

  

190

221

      </varlistentry>

191

222

      

192

223

      <varlistentry>

 

224

        <term><option>--debuglevel

 

225

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

 

226

        <listitem>

 

227

          <para>

 

228

            Set the debugging log level.

 

229

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

 

230

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

 

231

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

 

232

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

 

233

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

 

234

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

 

235

            increasing verbosity.  The default level is

 

236

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

 

237

          </para>

 

238

        </listitem>

 

239

      </varlistentry>

 

240

      

 

241

      <varlistentry>

193

242

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

194

243

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

195

244

        <listitem>

229

278

          </para>

230

279

        </listitem>

231

280

      </varlistentry>

 

281

      

 

282

      <varlistentry>

 

283

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

 

284

        <listitem>

 

285

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

 

286

          <para>

 

287

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

 

288

          </para>

 

289

        </listitem>

 

290

      </varlistentry>

 

291

      

 

292

      <varlistentry>

 

293

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

 

294

        <listitem>

 

295

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

 

296

        </listitem>

 

297

      </varlistentry>

 

298

      

 

299

      <varlistentry>

 

300

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

 

301

        <listitem>

 

302

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

 

303

          <para>

 

304

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

 

305

          </para>

 

306

        </listitem>

 

307

      </varlistentry>

 

308

      

 

309

      <varlistentry>

 

310

        <term><option>--statedir

 

311

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

 

312

        <listitem>

 

313

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

 

314

        </listitem>

 

315

      </varlistentry>

 

316

      

 

317

      <varlistentry>

 

318

        <term><option>--socket

 

319

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

 

320

        <listitem>

 

321

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

 

322

        </listitem>

 

323

      </varlistentry>

 

324

      

 

325

      <varlistentry>

 

326

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

 

327

        <listitem>

 

328

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

 

329

                      xpointer="foreground"/>

 

330

        </listitem>

 

331

      </varlistentry>

 

332

      

 

333

      <varlistentry>

 

334

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

 

335

        <listitem>

 

336

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

 

337

        </listitem>

 

338

      </varlistentry>

 

339

      

232

340

    </variablelist>

233

341

  </refsect1>

234

342

  

254

362

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

255

363

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

256

364

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

257

 

      The Mandos client must supply an OpenPGP certificate, and the

258

 

      fingerprint of this certificate is used by the Mandos server to

259

 

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

260

 

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

261

 

      authentication or authorization is done by the server.

 

365

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

 

366

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

 

367

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

 

368

      which binary blob to give the client.  No other authentication

 

369

      or authorization is done by the server.

262

370

    </para>

263

371

    <table>

264

372

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

284

392

        </emphasis></entry>

285

393

      </row>

286

394

      <row>

287

 

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

 

395

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

288

396

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

289

397

      </row>

290

398

      <row>

306

414

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

307

415

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

308

416

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

309

 

      longer eligible to receive the encrypted password.  The timeout,

310

 

      checker program, and interval between checks can be configured

311

 

      both globally and per client; see <citerefentry>

 

417

      longer eligible to receive the encrypted password.  (Manual

 

418

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

 

419

      extended timeout, checker program, and interval between checks

 

420

      can be configured both globally and per client; see

 

421

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

 

422

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

 

423

    </para>

 

424

  </refsect1>

 

425

  

 

426

  <refsect1 id="approval">

 

427

    <title>APPROVAL</title>

 

428

    <para>

 

429

      The server can be configured to require manual approval for a

 

430

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

 

431

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

 

432

      configured both globally and per client; see <citerefentry>

312

433

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

313

 

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

314

 

    </para>

 

434

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

 

435

      will be approved immediately without delay.

 

436

    </para>

 

437

    <para>

 

438

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

 

439

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

 

440

      the server delay before giving a client its secret, allowing

 

441

      optional manual denying of this specific client.

 

442

    </para>

 

443

    

315

444

  </refsect1>

316

445

  

317

446

  <refsect1 id="logging">

318

447

    <title>LOGGING</title>

319

448

    <para>

320

449

      The server will send log message with various severity levels to

321

 

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

 

450

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

322

451

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

323

452

      and also show them on the console.

324

453

    </para>

325

454

  </refsect1>

326

455

  

 

456

  <refsect1 id="persistent_state">

 

457

    <title>PERSISTENT STATE</title>

 

458

    <para>

 

459

      Client settings, initially read from

 

460

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

 

461

      restarts, and run-time changes will override settings in

 

462

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

 

463

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

 

464

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

 

465

    </para>

 

466

  </refsect1>

 

467

  

 

468

  <refsect1 id="dbus_interface">

 

469

    <title>D-BUS INTERFACE</title>

 

470

    <para>

 

471

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

 

472

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

 

473

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

 

474

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

 

475

    </para>

 

476

  </refsect1>

 

477

  

327

478

  <refsect1 id="exit_status">

328

479

    <title>EXIT STATUS</title>

329

480

    <para>

381

532

        </listitem>

382

533

      </varlistentry>

383

534

      <varlistentry>

384

 

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

385

 

        <listitem>

386

 

          <para>

387

 

            The file containing the process id of

388

 

            <command>&COMMANDNAME;</command>.

389

 

          </para>

390

 

        </listitem>

391

 

      </varlistentry>

392

 

      <varlistentry>

393

 

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

 

535

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

 

536

        <listitem>

 

537

          <para>

 

538

            The file containing the process id of the

 

539

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

 

540

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

 

541

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

 

542

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

 

543

            used instead.

 

544

          </para>

 

545

        </listitem>

 

546

      </varlistentry>

 

547

      <varlistentry>

 

548

        <term><filename

 

549

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

 

550

        <listitem>

 

551

          <para>

 

552

            Directory where persistent state will be saved.  Change

 

553

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

 

554

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

 

555

          </para>

 

556

        </listitem>

 

557

      </varlistentry>

 

558

      <varlistentry>

 

559

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

394

560

        <listitem>

395

561

          <para>

396

562

            The Unix domain socket to where local syslog messages are

419

585

      backtrace.  This could be considered a feature.

420

586

    </para>

421

587

    <para>

422

 

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

423

 

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

424

 

      permanent storage.  This has some security implications, see

425

 

      <xref linkend="clients"/>.

426

 

    </para>

427

 

    <para>

428

 

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

429

 

      status of clients, other than analyzing its <systemitem

430

 

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

431

 

    </para>

432

 

    <para>

433

588

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

434

589

    </para>

435

 

    <para>

436

 

      Debug mode is conflated with running in the foreground.

437

 

    </para>

438

 

    <para>

439

 

      The console log messages does not show a time stamp.

440

 

    </para>

441

 

    <para>

442

 

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

443

 

      keys.

444

 

    </para>

 

590

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

445

591

  </refsect1>

446

592

  

447

593

  <refsect1 id="example">

457

603

    <informalexample>

458

604

      <para>

459

605

        Run the server in debug mode, read configuration files from

460

 

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

461

 

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

462

 

        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:

463

609

      </para>

464

610

      <para>

465

611

 

497

643

      <title>CLIENTS</title>

498

644

      <para>

499

645

        The server only gives out its stored data to clients which

500

 

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

501

 

        guaranteed by the fact that the client sends its OpenPGP

502

 

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

503

 

        genuine.  The server computes the fingerprint of the key

504

 

        itself and looks up the fingerprint in its list of

505

 

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

 

646

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

 

647

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

 

648

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

 

649

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

 

650

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

 

651

        file (see

506

652

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

507

653

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

508

654

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

514

660

        compromised if they are gone for too long.

515

661

      </para>

516

662

      <para>

517

 

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

518

 

        by the server which would therefore declare the client

519

 

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

520

 

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

521

 

        regard all clients therein as valid, and hence eligible to

522

 

        receive their passwords.  Therefore, be careful when

523

 

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

524

 

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

525

 

        fake Mandos client with the keys from the non-encrypted

526

 

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

527

 

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

528

 

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

529

 

        configuration file to omit any suspect clients, and restart

530

 

        the server program.

531

 

      </para>

532

 

      <para>

533

663

        For more details on client-side security, see

534

664

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

535

665

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

540

670

  <refsect1 id="see_also">

541

671

    <title>SEE ALSO</title>

542

672

    <para>

543

 

      <citerefentry>

544

 

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

545

 

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

546

 

        <refentrytitle>mandos.conf</refentrytitle>

547

 

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

548

 

        <refentrytitle>mandos-client</refentrytitle>

549

 

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

550

 

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

551

 

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

552

683

    </para>

553

684

    <variablelist>

554

685

      <varlistentry>

564

695

      </varlistentry>

565

696

      <varlistentry>

566

697

        <term>

567

 

          <ulink url="http://www.avahi.org/">Avahi</ulink>

 

698

          <ulink url="https://www.avahi.org/">Avahi</ulink>

568

699

        </term>

569

700

      <listitem>

570

701

        <para>

575

706

      </varlistentry>

576

707

      <varlistentry>

577

708

        <term>

578

 

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

579

 

          >GnuTLS</ulink>

 

709

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

580

710

        </term>

581

711

      <listitem>

582

712

        <para>

583

713

          GnuTLS is the library this server uses to implement TLS for

584

714

          communicating securely with the client, and at the same time

585

 

          confidently get the client’s public OpenPGP key.

 

715

          confidently get the client’s public key.

586

716

        </para>

587

717

      </listitem>

588

718

      </varlistentry>

609

739

            <listitem>

610

740

              <para>

611

741

                The clients use IPv6 link-local addresses, which are

612

 

                immediately usable since a link-local addresses is

 

742

                immediately usable since a link-local address is

613

743

                automatically assigned to a network interfaces when it

614

744

                is brought up.

615

745

              </para>

620

750

      </varlistentry>

621

751

      <varlistentry>

622

752

        <term>

623

 

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

624

 

          Protocol Version 1.1</citetitle>

 

753

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

 

754

          Protocol Version 1.2</citetitle>

625

755

        </term>

626

756

      <listitem>

627

757

        <para>

628

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

758

          TLS 1.2 is the protocol implemented by GnuTLS.

629

759

        </para>

630

760

      </listitem>

631

761

      </varlistentry>

641

771

      </varlistentry>

642

772

      <varlistentry>

643

773

        <term>

644

 

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

645

 

          Security</citetitle>

646

 

        </term>

647

 

      <listitem>

648

 

        <para>

649

 

          This is implemented by GnuTLS and used by this server so

650

 

          that OpenPGP keys can be used.

 

774

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

 

775

          Layer Security (TLS) and Datagram Transport Layer Security

 

776

          (DTLS)</citetitle>

 

777

        </term>

 

778

      <listitem>

 

779

        <para>

 

780

          This is implemented by GnuTLS version 3.6.6 and is, if

 

781

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

 

782

          used.

 

783

        </para>

 

784

      </listitem>

 

785

      </varlistentry>

 

786

      <varlistentry>

 

787

        <term>

 

788

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

 

789

          Security (TLS) Authentication</citetitle>

 

790

        </term>

 

791

      <listitem>

 

792

        <para>

 

793

          This is implemented by GnuTLS before version 3.6.0 and is,

 

794

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

 

795

          used.

651

796

        </para>

652

797

      </listitem>

653

798

      </varlistentry>

• Older »

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