/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (1186 to 634)
• stop comparing with revision 634

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 "2013-10-23">

 

5

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

6

6

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

7

7

%common;

8

8

]>

37

37

      <year>2011</year>

38

38

      <year>2012</year>

39

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>

40

46

      <holder>Teddy Hogeborn</holder>

41

47

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

42

48

    </copyright>

106

112

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

107

113

      <sbr/>

108

114

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

 

115

      <sbr/>

 

116

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

109

117

    </cmdsynopsis>

110

118

    <cmdsynopsis>

111

119

      <command>&COMMANDNAME;</command>

234

242

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

235

243

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

236

244

        <listitem>

237

 

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

238

 

                      xpointer="priority_compat"/>

 

245

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

239

246

        </listitem>

240

247

      </varlistentry>

241

248

      

323

330

        </listitem>

324

331

      </varlistentry>

325

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

      

326

340

    </variablelist>

327

341

  </refsect1>

328

342

  

348

362

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

349

363

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

350

364

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

351

 

      The Mandos client must supply an OpenPGP certificate, and the

352

 

      fingerprint of this certificate is used by the Mandos server to

353

 

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

354

 

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

355

 

      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.

356

370

    </para>

357

371

    <table>

358

372

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

378

392

        </emphasis></entry>

379

393

      </row>

380

394

      <row>

381

 

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

 

395

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

382

396

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

383

397

      </row>

384

398

      <row>

523

537

          <para>

524

538

            The file containing the process id of the

525

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.

526

544

          </para>

527

545

        </listitem>

528

546

      </varlistentry>

529

547

      <varlistentry>

530

 

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

531

 

      </varlistentry>

532

 

      <varlistentry>

533

548

        <term><filename

534

549

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

535

550

        <listitem>

541

556

        </listitem>

542

557

      </varlistentry>

543

558

      <varlistentry>

544

 

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

 

559

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

545

560

        <listitem>

546

561

          <para>

547

562

            The Unix domain socket to where local syslog messages are

572

587

    <para>

573

588

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

574

589

    </para>

575

 

    <para>

576

 

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

577

 

      keys.

578

 

    </para>

 

590

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

579

591

  </refsect1>

580

592

  

581

593

  <refsect1 id="example">

631

643

      <title>CLIENTS</title>

632

644

      <para>

633

645

        The server only gives out its stored data to clients which

634

 

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

635

 

        guaranteed by the fact that the client sends its OpenPGP

636

 

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

637

 

        genuine.  The server computes the fingerprint of the key

638

 

        itself and looks up the fingerprint in its list of

639

 

        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

640

652

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

641

653

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

642

654

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

683

695

      </varlistentry>

684

696

      <varlistentry>

685

697

        <term>

686

 

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

 

698

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

687

699

        </term>

688

700

      <listitem>

689

701

        <para>

694

706

      </varlistentry>

695

707

      <varlistentry>

696

708

        <term>

697

 

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

698

 

          >GnuTLS</ulink>

 

709

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

699

710

        </term>

700

711

      <listitem>

701

712

        <para>

702

713

          GnuTLS is the library this server uses to implement TLS for

703

714

          communicating securely with the client, and at the same time

704

 

          confidently get the client’s public OpenPGP key.

 

715

          confidently get the client’s public key.

705

716

        </para>

706

717

      </listitem>

707

718

      </varlistentry>

739

750

      </varlistentry>

740

751

      <varlistentry>

741

752

        <term>

742

 

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

743

 

          Protocol Version 1.1</citetitle>

 

753

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

 

754

          Protocol Version 1.2</citetitle>

744

755

        </term>

745

756

      <listitem>

746

757

        <para>

747

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

758

          TLS 1.2 is the protocol implemented by GnuTLS.

748

759

        </para>

749

760

      </listitem>

750

761

      </varlistentry>

760

771

      </varlistentry>

761

772

      <varlistentry>

762

773

        <term>

763

 

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

764

 

          Security</citetitle>

765

 

        </term>

766

 

      <listitem>

767

 

        <para>

768

 

          This is implemented by GnuTLS and used by this server so

769

 

          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.

770

796

        </para>

771

797

      </listitem>

772

798

      </varlistentry>

• Older »

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