/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (1206 to 623)
• stop comparing with revision 623

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-06-17">

 

5

<!ENTITY TIMESTAMP "2019-07-24">

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>

 

45

      <year>2019</year>

39

46

      <holder>Teddy Hogeborn</holder>

40

47

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

41

48

    </copyright>

105

112

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

106

113

      <sbr/>

107

114

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

 

115

      <sbr/>

 

116

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

108

117

    </cmdsynopsis>

109

118

    <cmdsynopsis>

110

119

      <command>&COMMANDNAME;</command>

321

330

        </listitem>

322

331

      </varlistentry>

323

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

      

324

340

    </variablelist>

325

341

  </refsect1>

326

342

  

346

362

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

347

363

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

348

364

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

349

 

      The Mandos client must supply an OpenPGP certificate, and the

350

 

      fingerprint of this certificate is used by the Mandos server to

351

 

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

352

 

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

353

 

      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.

354

370

    </para>

355

371

    <table>

356

372

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

376

392

        </emphasis></entry>

377

393

      </row>

378

394

      <row>

379

 

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

 

395

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

380

396

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

381

397

      </row>

382

398

      <row>

516

532

        </listitem>

517

533

      </varlistentry>

518

534

      <varlistentry>

519

 

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

 

535

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

520

536

        <listitem>

521

537

          <para>

522

538

            The file containing the process id of the

523

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.

524

544

          </para>

525

545

        </listitem>

526

546

      </varlistentry>

527

547

      <varlistentry>

528

 

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

529

 

      </varlistentry>

530

 

      <varlistentry>

531

548

        <term><filename

532

549

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

533

550

        <listitem>

539

556

        </listitem>

540

557

      </varlistentry>

541

558

      <varlistentry>

542

 

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

 

559

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

543

560

        <listitem>

544

561

          <para>

545

562

            The Unix domain socket to where local syslog messages are

570

587

    <para>

571

588

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

572

589

    </para>

573

 

    <para>

574

 

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

575

 

      keys.

576

 

    </para>

 

590

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

577

591

  </refsect1>

578

592

  

579

593

  <refsect1 id="example">

629

643

      <title>CLIENTS</title>

630

644

      <para>

631

645

        The server only gives out its stored data to clients which

632

 

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

633

 

        guaranteed by the fact that the client sends its OpenPGP

634

 

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

635

 

        genuine.  The server computes the fingerprint of the key

636

 

        itself and looks up the fingerprint in its list of

637

 

        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

638

652

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

639

653

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

640

654

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

681

695

      </varlistentry>

682

696

      <varlistentry>

683

697

        <term>

684

 

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

 

698

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

685

699

        </term>

686

700

      <listitem>

687

701

        <para>

692

706

      </varlistentry>

693

707

      <varlistentry>

694

708

        <term>

695

 

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

696

 

          >GnuTLS</ulink>

 

709

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

697

710

        </term>

698

711

      <listitem>

699

712

        <para>

700

713

          GnuTLS is the library this server uses to implement TLS for

701

714

          communicating securely with the client, and at the same time

702

 

          confidently get the client’s public OpenPGP key.

 

715

          confidently get the client’s public key.

703

716

        </para>

704

717

      </listitem>

705

718

      </varlistentry>

737

750

      </varlistentry>

738

751

      <varlistentry>

739

752

        <term>

740

 

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

741

 

          Protocol Version 1.1</citetitle>

 

753

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

 

754

          Protocol Version 1.2</citetitle>

742

755

        </term>

743

756

      <listitem>

744

757

        <para>

745

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

758

          TLS 1.2 is the protocol implemented by GnuTLS.

746

759

        </para>

747

760

      </listitem>

748

761

      </varlistentry>

758

771

      </varlistentry>

759

772

      <varlistentry>

760

773

        <term>

761

 

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

762

 

          Security</citetitle>

763

 

        </term>

764

 

      <listitem>

765

 

        <para>

766

 

          This is implemented by GnuTLS and used by this server so

767

 

          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.

768

796

        </para>

769

797

      </listitem>

770

798

      </varlistentry>

• Older »

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