/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (756 to 211)
• stop comparing with revision 211

Show diffs side-by-side

added

removed

mandos.xml

1

1

<?xml version="1.0" encoding="UTF-8"?>

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

 

<!ENTITY VERSION "1.0">

5

4

<!ENTITY COMMANDNAME "mandos">

6

 

<!ENTITY TIMESTAMP "2008-09-21">

 

5

<!ENTITY TIMESTAMP "2015-01-25">

 

6

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

 

7

%common;

7

8

]>

8

9

 

9

10

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">

10

 

  <refentryinfo>

 

11

   <refentryinfo>

11

12

    <title>Mandos Manual</title>

12

13

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

13

14

    <productname>Mandos</productname>

14

 

    <productnumber>&VERSION;</productnumber>

 

15

    <productnumber>&version;</productnumber>

15

16

    <date>&TIMESTAMP;</date>

16

17

    <authorgroup>

17

18

      <author>

18

19

        <firstname>Björn</firstname>

19

20

        <surname>Påhlsson</surname>

20

21

        <address>

21

 

          <email>belorn@fukt.bsnet.se</email>

 

22

          <email>belorn@recompile.se</email>

22

23

        </address>

23

24

      </author>

24

25

      <author>

25

26

        <firstname>Teddy</firstname>

26

27

        <surname>Hogeborn</surname>

27

28

        <address>

28

 

          <email>teddy@fukt.bsnet.se</email>

 

29

          <email>teddy@recompile.se</email>

29

30

        </address>

30

31

      </author>

31

32

    </authorgroup>

32

33

    <copyright>

33

34

      <year>2008</year>

 

35

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

 

39

      <year>2013</year>

34

40

      <holder>Teddy Hogeborn</holder>

35

41

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

36

42

    </copyright>

83

89

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

84

90

      <sbr/>

85

91

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

 

92

      <sbr/>

 

93

      <arg><option>--debuglevel

 

94

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

 

95

      <sbr/>

 

96

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

 

97

      <sbr/>

 

98

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

 

99

      <sbr/>

 

100

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

 

101

      <sbr/>

 

102

      <arg><option>--statedir

 

103

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

 

104

      <sbr/>

 

105

      <arg><option>--socket

 

106

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

 

107

      <sbr/>

 

108

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

 

109

      <sbr/>

 

110

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

86

111

    </cmdsynopsis>

87

112

    <cmdsynopsis>

88

113

      <command>&COMMANDNAME;</command>

106

131

    <para>

107

132

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

108

133

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

109

 

      client host computers.  The Mandos server uses Zeroconf to

110

 

      announce itself on the local network, and uses TLS to

111

 

      communicate securely with and to authenticate the clients.  The

112

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

113

 

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

114

 

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

115

 

      Any authenticated client is then given the stored pre-encrypted

116

 

      password for that specific client.

 

134

      client host computers. For an introduction, see

 

135

      <citerefentry><refentrytitle>intro</refentrytitle>

 

136

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

 

137

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

 

138

      TLS to communicate securely with and to authenticate the

 

139

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

 

140

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

 

141

      not have any other addresses configured (see <xref

 

142

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

 

143

      the stored pre-encrypted password for that specific client.

117

144

    </para>

118

145

  </refsect1>

119

146

  

188

215

      </varlistentry>

189

216

      

190

217

      <varlistentry>

 

218

        <term><option>--debuglevel

 

219

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

 

220

        <listitem>

 

221

          <para>

 

222

            Set the debugging log level.

 

223

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

 

224

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

 

225

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

 

226

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

 

227

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

 

228

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

 

229

            increasing verbosity.  The default level is

 

230

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

 

231

          </para>

 

232

        </listitem>

 

233

      </varlistentry>

 

234

      

 

235

      <varlistentry>

191

236

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

192

237

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

193

238

        <listitem>

194

 

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

 

239

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

 

240

                      xpointer="priority_compat"/>

195

241

        </listitem>

196

242

      </varlistentry>

197

243

      

227

273

          </para>

228

274

        </listitem>

229

275

      </varlistentry>

 

276

      

 

277

      <varlistentry>

 

278

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

 

279

        <listitem>

 

280

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

 

281

          <para>

 

282

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

 

283

          </para>

 

284

        </listitem>

 

285

      </varlistentry>

 

286

      

 

287

      <varlistentry>

 

288

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

 

289

        <listitem>

 

290

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

 

291

        </listitem>

 

292

      </varlistentry>

 

293

      

 

294

      <varlistentry>

 

295

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

 

296

        <listitem>

 

297

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

 

298

          <para>

 

299

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

 

300

          </para>

 

301

        </listitem>

 

302

      </varlistentry>

 

303

      

 

304

      <varlistentry>

 

305

        <term><option>--statedir

 

306

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

 

307

        <listitem>

 

308

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

 

309

        </listitem>

 

310

      </varlistentry>

 

311

      

 

312

      <varlistentry>

 

313

        <term><option>--socket

 

314

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

 

315

        <listitem>

 

316

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

 

317

        </listitem>

 

318

      </varlistentry>

 

319

      

 

320

      <varlistentry>

 

321

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

 

322

        <listitem>

 

323

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

 

324

                      xpointer="foreground"/>

 

325

        </listitem>

 

326

      </varlistentry>

 

327

      

 

328

      <varlistentry>

 

329

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

 

330

        <listitem>

 

331

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

 

332

        </listitem>

 

333

      </varlistentry>

 

334

      

230

335

    </variablelist>

231

336

  </refsect1>

232

337

  

304

409

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

305

410

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

306

411

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

307

 

      longer eligible to receive the encrypted password.  The timeout,

308

 

      checker program, and interval between checks can be configured

309

 

      both globally and per client; see <citerefentry>

 

412

      longer eligible to receive the encrypted password.  (Manual

 

413

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

 

414

      extended timeout, checker program, and interval between checks

 

415

      can be configured both globally and per client; see

 

416

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

 

417

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

 

418

    </para>

 

419

  </refsect1>

 

420

  

 

421

  <refsect1 id="approval">

 

422

    <title>APPROVAL</title>

 

423

    <para>

 

424

      The server can be configured to require manual approval for a

 

425

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

 

426

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

 

427

      configured both globally and per client; see <citerefentry>

310

428

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

311

 

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

312

 

    </para>

 

429

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

 

430

      will be approved immediately without delay.

 

431

    </para>

 

432

    <para>

 

433

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

 

434

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

 

435

      the server delay before giving a client its secret, allowing

 

436

      optional manual denying of this specific client.

 

437

    </para>

 

438

    

313

439

  </refsect1>

314

440

  

315

441

  <refsect1 id="logging">

316

442

    <title>LOGGING</title>

317

443

    <para>

318

444

      The server will send log message with various severity levels to

319

 

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

 

445

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

320

446

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

321

447

      and also show them on the console.

322

448

    </para>

323

449

  </refsect1>

324

450

  

 

451

  <refsect1 id="persistent_state">

 

452

    <title>PERSISTENT STATE</title>

 

453

    <para>

 

454

      Client settings, initially read from

 

455

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

 

456

      restarts, and run-time changes will override settings in

 

457

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

 

458

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

 

459

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

 

460

    </para>

 

461

  </refsect1>

 

462

  

 

463

  <refsect1 id="dbus_interface">

 

464

    <title>D-BUS INTERFACE</title>

 

465

    <para>

 

466

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

 

467

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

 

468

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

 

469

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

 

470

    </para>

 

471

  </refsect1>

 

472

  

325

473

  <refsect1 id="exit_status">

326

474

    <title>EXIT STATUS</title>

327

475

    <para>

350

498

    </variablelist>

351

499

  </refsect1>

352

500

  

353

 

  <refsect1 id="file">

 

501

  <refsect1 id="files">

354

502

    <title>FILES</title>

355

503

    <para>

356

504

      Use the <option>--configdir</option> option to change where

379

527

        </listitem>

380

528

      </varlistentry>

381

529

      <varlistentry>

382

 

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

383

 

        <listitem>

384

 

          <para>

385

 

            The file containing the process id of

386

 

            <command>&COMMANDNAME;</command>.

 

530

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

 

531

        <listitem>

 

532

          <para>

 

533

            The file containing the process id of the

 

534

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

 

535

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

 

536

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

 

537

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

 

538

            used instead.

 

539

          </para>

 

540

        </listitem>

 

541

      </varlistentry>

 

542

      <varlistentry>

 

543

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

 

544

      </varlistentry>

 

545

      <varlistentry>

 

546

        <term><filename

 

547

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

 

548

        <listitem>

 

549

          <para>

 

550

            Directory where persistent state will be saved.  Change

 

551

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

 

552

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

387

553

          </para>

388

554

        </listitem>

389

555

      </varlistentry>

417

583

      backtrace.  This could be considered a feature.

418

584

    </para>

419

585

    <para>

420

 

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

421

 

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

422

 

      permanent storage.  This has some security implications, see

423

 

      <xref linkend="CLIENTS"/>.

424

 

    </para>

425

 

    <para>

426

 

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

427

 

      status of clients, other than analyzing its <systemitem

428

 

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

429

 

    </para>

430

 

    <para>

431

586

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

432

587

    </para>

433

588

    <para>

434

 

      Debug mode is conflated with running in the foreground.

435

 

    </para>

436

 

    <para>

437

 

      The console log messages does not show a time stamp.

438

 

    </para>

439

 

    <para>

440

589

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

441

590

      keys.

442

591

    </para>

455

604

    <informalexample>

456

605

      <para>

457

606

        Run the server in debug mode, read configuration files from

458

 

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

459

 

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

460

 

        any other official Mandos server on this host:

 

607

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

 

608

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

 

609

        collide with any other official Mandos server on this host:

461

610

      </para>

462

611

      <para>

463

612

 

482

631

  

483

632

  <refsect1 id="security">

484

633

    <title>SECURITY</title>

485

 

    <refsect2 id="SERVER">

 

634

    <refsect2 id="server">

486

635

      <title>SERVER</title>

487

636

      <para>

488

637

        Running this <command>&COMMANDNAME;</command> server program

491

640

        soon after startup.

492

641

      </para>

493

642

    </refsect2>

494

 

    <refsect2 id="CLIENTS">

 

643

    <refsect2 id="clients">

495

644

      <title>CLIENTS</title>

496

645

      <para>

497

646

        The server only gives out its stored data to clients which

512

661

        compromised if they are gone for too long.

513

662

      </para>

514

663

      <para>

515

 

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

516

 

        by the server which would therefore declare the client

517

 

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

518

 

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

519

 

        regard all clients therein as valid, and hence eligible to

520

 

        receive their passwords.  Therefore, be careful when

521

 

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

522

 

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

523

 

        fake Mandos client with the keys from the non-encrypted

524

 

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

525

 

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

526

 

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

527

 

        configuration file to omit any suspect clients, and restart

528

 

        the server program.

529

 

      </para>

530

 

      <para>

531

664

        For more details on client-side security, see

532

665

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

533

666

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

538

671

  <refsect1 id="see_also">

539

672

    <title>SEE ALSO</title>

540

673

    <para>

541

 

      <citerefentry>

542

 

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

543

 

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

544

 

        <refentrytitle>mandos.conf</refentrytitle>

545

 

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

546

 

        <refentrytitle>mandos-client</refentrytitle>

547

 

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

548

 

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

549

 

      </citerefentry>

 

674

      <citerefentry><refentrytitle>intro</refentrytitle>

 

675

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

 

676

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

 

677

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

 

678

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

 

679

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

 

680

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

 

681

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

 

682

      <citerefentry><refentrytitle>sh</refentrytitle>

 

683

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

550

684

    </para>

551

685

    <variablelist>

552

686

      <varlistentry>

573

707

      </varlistentry>

574

708

      <varlistentry>

575

709

        <term>

576

 

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

577

 

          >GnuTLS</ulink>

 

710

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

578

711

        </term>

579

712

      <listitem>

580

713

        <para>

618

751

      </varlistentry>

619

752

      <varlistentry>

620

753

        <term>

621

 

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

622

 

          Protocol Version 1.1</citetitle>

 

754

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

 

755

          Protocol Version 1.2</citetitle>

623

756

        </term>

624

757

      <listitem>

625

758

        <para>

626

 

          TLS 1.1 is the protocol implemented by GnuTLS.

 

759

          TLS 1.2 is the protocol implemented by GnuTLS.

627

760

        </para>

628

761

      </listitem>

629

762

      </varlistentry>

639

772

      </varlistentry>

640

773

      <varlistentry>

641

774

        <term>

642

 

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

643

 

          Security</citetitle>

 

775

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

 

776

          Security (TLS) Authentication</citetitle>

644

777

        </term>

645

778

      <listitem>

646

779

        <para>

• Older »

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