/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (453 to 700)
• stop comparing with revision 700

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-26">

 

5

<!ENTITY TIMESTAMP "2010-09-26">

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@recompile.se</email>

 

22

          <email>belorn@fukt.bsnet.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@recompile.se</email>

 

29

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

30

30

        </address>

31

31

      </author>

32

32

    </authorgroup>

34

34

      <year>2008</year>

35

35

      <year>2009</year>

36

36

      <year>2010</year>

37

 

      <year>2011</year>

38

 

      <year>2012</year>

39

 

      <year>2013</year>

40

37

      <holder>Teddy Hogeborn</holder>

41

38

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

42

39

    </copyright>

96

93

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

97

94

      <sbr/>

98

95

      <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

96

    </cmdsynopsis>

110

97

    <cmdsynopsis>

111

98

      <command>&COMMANDNAME;</command>

129

116

    <para>

130

117

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

131

118

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

132

 

      client host computers. For an introduction, see

133

 

      <citerefentry><refentrytitle>intro</refentrytitle>

134

 

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

135

 

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

136

 

      TLS to communicate securely with and to authenticate the

137

 

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

138

 

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

139

 

      not have any other addresses configured (see <xref

140

 

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

141

 

      the stored pre-encrypted password for that specific client.

 

119

      client host computers.  The Mandos server uses Zeroconf to

 

120

      announce itself on the local network, and uses TLS to

 

121

      communicate securely with and to authenticate the clients.  The

 

122

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

 

123

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

 

124

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

 

125

      Any authenticated client is then given the stored pre-encrypted

 

126

      password for that specific client.

142

127

    </para>

143

128

  </refsect1>

144

129

  

234

219

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

235

220

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

236

221

        <listitem>

237

 

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

238

 

                      xpointer="priority_compat"/>

 

222

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

239

223

        </listitem>

240

224

      </varlistentry>

241

225

      

288

272

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

289

273

        </listitem>

290

274

      </varlistentry>

291

 

      

292

 

      <varlistentry>

293

 

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

294

 

        <listitem>

295

 

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

296

 

          <para>

297

 

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

298

 

          </para>

299

 

        </listitem>

300

 

      </varlistentry>

301

 

      

302

 

      <varlistentry>

303

 

        <term><option>--statedir

304

 

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

305

 

        <listitem>

306

 

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

307

 

        </listitem>

308

 

      </varlistentry>

309

 

      

310

 

      <varlistentry>

311

 

        <term><option>--socket

312

 

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

313

 

        <listitem>

314

 

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

315

 

        </listitem>

316

 

      </varlistentry>

317

 

      

318

 

      <varlistentry>

319

 

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

320

 

        <listitem>

321

 

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

322

 

                      xpointer="foreground"/>

323

 

        </listitem>

324

 

      </varlistentry>

325

 

      

326

275

    </variablelist>

327

276

  </refsect1>

328

277

  

402

351

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

403

352

      longer eligible to receive the encrypted password.  (Manual

404

353

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

405

 

      extended timeout, checker program, and interval between checks

406

 

      can be configured both globally and per client; see

407

 

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

408

 

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

 

354

      checker program, and interval between checks can be configured

 

355

      both globally and per client; see <citerefentry>

 

356

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

 

357

      <manvolnum>5</manvolnum></citerefentry>.  A client successfully

 

358

      receiving its password will also be treated as a successful

 

359

      checker run.

409

360

    </para>

410

361

  </refsect1>

411

362

  

433

384

    <title>LOGGING</title>

434

385

    <para>

435

386

      The server will send log message with various severity levels to

436

 

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

 

387

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

437

388

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

438

389

      and also show them on the console.

439

390

    </para>

440

391

  </refsect1>

441

392

  

442

 

  <refsect1 id="persistent_state">

443

 

    <title>PERSISTENT STATE</title>

444

 

    <para>

445

 

      Client settings, initially read from

446

 

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

447

 

      restarts, and run-time changes will override settings in

448

 

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

449

 

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

450

 

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

451

 

    </para>

452

 

  </refsect1>

453

 

  

454

393

  <refsect1 id="dbus_interface">

455

394

    <title>D-BUS INTERFACE</title>

456

395

    <para>

518

457

        </listitem>

519

458

      </varlistentry>

520

459

      <varlistentry>

521

 

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

 

460

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

522

461

        <listitem>

523

462

          <para>

524

463

            The file containing the process id of the

525

464

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

526

 

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

527

 

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

528

 

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

529

 

            used instead.

530

 

          </para>

531

 

        </listitem>

532

 

      </varlistentry>

533

 

      <varlistentry>

534

 

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

535

 

      </varlistentry>

536

 

      <varlistentry>

537

 

        <term><filename

538

 

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

539

 

        <listitem>

540

 

          <para>

541

 

            Directory where persistent state will be saved.  Change

542

 

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

543

 

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

544

465

          </para>

545

466

        </listitem>

546

467

      </varlistentry>

574

495

      backtrace.  This could be considered a feature.

575

496

    </para>

576

497

    <para>

 

498

      Currently, if a client is disabled due to having timed out, the

 

499

      server does not record this fact onto permanent storage.  This

 

500

      has some security implications, see <xref linkend="clients"/>.

 

501

    </para>

 

502

    <para>

577

503

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

578

504

    </para>

579

505

    <para>

 

506

      Debug mode is conflated with running in the foreground.

 

507

    </para>

 

508

    <para>

 

509

      The console log messages do not show a time stamp.

 

510

    </para>

 

511

    <para>

580

512

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

581

513

      keys.

582

514

    </para>

595

527

    <informalexample>

596

528

      <para>

597

529

        Run the server in debug mode, read configuration files from

598

 

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

599

 

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

600

 

        collide with any other official Mandos server on this host:

 

530

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

 

531

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

 

532

        any other official Mandos server on this host:

601

533

      </para>

602

534

      <para>

603

535

 

652

584

        compromised if they are gone for too long.

653

585

      </para>

654

586

      <para>

 

587

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

 

588

        by the server which would therefore disable the client.  But

 

589

        if the server was ever restarted, it would re-read its client

 

590

        list from its configuration file and again regard all clients

 

591

        therein as enabled, and hence eligible to receive their

 

592

        passwords.  Therefore, be careful when restarting servers if

 

593

        it is suspected that a client has, in fact, been compromised

 

594

        by parties who may now be running a fake Mandos client with

 

595

        the keys from the non-encrypted initial <acronym>RAM</acronym>

 

596

        image of the client host.  What should be done in that case

 

597

        (if restarting the server program really is necessary) is to

 

598

        stop the server program, edit the configuration file to omit

 

599

        any suspect clients, and restart the server program.

 

600

      </para>

 

601

      <para>

655

602

        For more details on client-side security, see

656

603

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

657

604

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

662

609

  <refsect1 id="see_also">

663

610

    <title>SEE ALSO</title>

664

611

    <para>

665

 

      <citerefentry><refentrytitle>intro</refentrytitle>

666

 

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

667

 

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

668

 

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

669

 

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

670

 

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

671

 

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

672

 

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

673

 

      <citerefentry><refentrytitle>sh</refentrytitle>

674

 

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

 

612

      <citerefentry>

 

613

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

 

614

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

 

615

        <refentrytitle>mandos.conf</refentrytitle>

 

616

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

 

617

        <refentrytitle>mandos-client</refentrytitle>

 

618

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

 

619

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

 

620

      </citerefentry>

675

621

    </para>

676

622

    <variablelist>

677

623

      <varlistentry>

• Older »

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