/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (963 to 585)
• stop comparing with revision 585

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 "2012-01-15">

 

5

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

6

6

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

7

7

%common;

8

8

]>

36

36

      <year>2010</year>

37

37

      <year>2011</year>

38

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>

39

45

      <holder>Teddy Hogeborn</holder>

40

46

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

41

47

    </copyright>

100

106

      <sbr/>

101

107

      <arg><option>--statedir

102

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>

103

116

    </cmdsynopsis>

104

117

    <cmdsynopsis>

105

118

      <command>&COMMANDNAME;</command>

299

312

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

300

313

        </listitem>

301

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

      

302

339

    </variablelist>

303

340

  </refsect1>

304

341

  

324

361

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

325

362

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

326

363

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

327

 

      The Mandos client must supply an OpenPGP certificate, and the

328

 

      fingerprint of this certificate is used by the Mandos server to

329

 

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

330

 

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

331

 

      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.

332

369

    </para>

333

370

    <table>

334

371

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

354

391

        </emphasis></entry>

355

392

      </row>

356

393

      <row>

357

 

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

 

394

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

358

395

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

359

396

      </row>

360

397

      <row>

494

531

        </listitem>

495

532

      </varlistentry>

496

533

      <varlistentry>

497

 

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

 

534

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

498

535

        <listitem>

499

536

          <para>

500

537

            The file containing the process id of the

501

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.

502

543

          </para>

503

544

        </listitem>

504

545

      </varlistentry>

505

546

      <varlistentry>

506

 

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

507

 

      </varlistentry>

508

 

      <varlistentry>

509

547

        <term><filename

510

548

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

511

549

        <listitem>

517

555

        </listitem>

518

556

      </varlistentry>

519

557

      <varlistentry>

520

 

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

 

558

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

521

559

        <listitem>

522

560

          <para>

523

561

            The Unix domain socket to where local syslog messages are

548

586

    <para>

549

587

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

550

588

    </para>

551

 

    <para>

552

 

      Debug mode is conflated with running in the foreground.

553

 

    </para>

554

 

    <para>

555

 

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

556

 

      keys.

557

 

    </para>

 

589

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

558

590

  </refsect1>

559

591

  

560

592

  <refsect1 id="example">

610

642

      <title>CLIENTS</title>

611

643

      <para>

612

644

        The server only gives out its stored data to clients which

613

 

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

614

 

        guaranteed by the fact that the client sends its OpenPGP

615

 

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

616

 

        genuine.  The server computes the fingerprint of the key

617

 

        itself and looks up the fingerprint in its list of

618

 

        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

619

651

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

620

652

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

621

653

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

673

705

      </varlistentry>

674

706

      <varlistentry>

675

707

        <term>

676

 

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

677

 

          >GnuTLS</ulink>

 

708

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

678

709

        </term>

679

710

      <listitem>

680

711

        <para>

681

712

          GnuTLS is the library this server uses to implement TLS for

682

713

          communicating securely with the client, and at the same time

683

 

          confidently get the client’s public OpenPGP key.

 

714

          confidently get the client’s public key.

684

715

        </para>

685

716

      </listitem>

686

717

      </varlistentry>

718

749

      </varlistentry>

719

750

      <varlistentry>

720

751

        <term>

721

 

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

722

 

          Protocol Version 1.1</citetitle>

 

752

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

 

753

          Protocol Version 1.2</citetitle>

723

754

        </term>

724

755

      <listitem>

725

756

        <para>

726

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

757

          TLS 1.2 is the protocol implemented by GnuTLS.

727

758

        </para>

728

759

      </listitem>

729

760

      </varlistentry>

739

770

      </varlistentry>

740

771

      <varlistentry>

741

772

        <term>

742

 

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

743

 

          Security</citetitle>

744

 

        </term>

745

 

      <listitem>

746

 

        <para>

747

 

          This is implemented by GnuTLS and used by this server so

748

 

          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.

749

795

        </para>

750

796

      </listitem>

751

797

      </varlistentry>

• Older »

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