/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.38 to 472)
• stop comparing with revision 472

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 "2011-02-27">

 

5

<!ENTITY TIMESTAMP "2013-10-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@fukt.bsnet.se</email>

 

22

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

 

29

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

30

30

        </address>

31

31

      </author>

32

32

    </authorgroup>

35

35

      <year>2009</year>

36

36

      <year>2010</year>

37

37

      <year>2011</year>

 

38

      <year>2012</year>

 

39

      <year>2013</year>

38

40

      <holder>Teddy Hogeborn</holder>

39

41

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

40

42

    </copyright>

94

96

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

95

97

      <sbr/>

96

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>

97

109

    </cmdsynopsis>

98

110

    <cmdsynopsis>

99

111

      <command>&COMMANDNAME;</command>

117

129

    <para>

118

130

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

119

131

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

120

 

      client host computers.  The Mandos server uses Zeroconf to

121

 

      announce itself on the local network, and uses TLS to

122

 

      communicate securely with and to authenticate the clients.  The

123

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

124

 

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

125

 

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

126

 

      Any authenticated client is then given the stored pre-encrypted

127

 

      password for that specific client.

 

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.

128

142

    </para>

129

143

  </refsect1>

130

144

  

220

234

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

221

235

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

222

236

        <listitem>

223

 

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

 

237

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

 

238

                      xpointer="priority_compat"/>

224

239

        </listitem>

225

240

      </varlistentry>

226

241

      

273

288

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

274

289

        </listitem>

275

290

      </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

      

276

326

    </variablelist>

277

327

  </refsect1>

278

328

  

352

402

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

353

403

      longer eligible to receive the encrypted password.  (Manual

354

404

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

355

 

      checker program, and interval between checks can be configured

356

 

      both globally and per client; see <citerefentry>

357

 

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

358

 

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

359

 

      receiving its password will also be treated as a successful

360

 

      checker run.

 

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>.

361

409

    </para>

362

410

  </refsect1>

363

411

  

385

433

    <title>LOGGING</title>

386

434

    <para>

387

435

      The server will send log message with various severity levels to

388

 

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

 

436

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

389

437

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

390

438

      and also show them on the console.

391

439

    </para>

392

440

  </refsect1>

393

441

  

 

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

  

394

454

  <refsect1 id="dbus_interface">

395

455

    <title>D-BUS INTERFACE</title>

396

456

    <para>

458

518

        </listitem>

459

519

      </varlistentry>

460

520

      <varlistentry>

461

 

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

 

521

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

462

522

        <listitem>

463

523

          <para>

464

524

            The file containing the process id of the

465

525

            <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.

466

544

          </para>

467

545

        </listitem>

468

546

      </varlistentry>

496

574

      backtrace.  This could be considered a feature.

497

575

    </para>

498

576

    <para>

499

 

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

500

 

      server does not record this fact onto permanent storage.  This

501

 

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

502

 

    </para>

503

 

    <para>

504

577

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

505

578

    </para>

506

579

    <para>

507

 

      Debug mode is conflated with running in the foreground.

508

 

    </para>

509

 

    <para>

510

 

      The console log messages do not show a time stamp.

511

 

    </para>

512

 

    <para>

513

580

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

514

581

      keys.

515

582

    </para>

528

595

    <informalexample>

529

596

      <para>

530

597

        Run the server in debug mode, read configuration files from

531

 

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

532

 

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

533

 

        any other official Mandos server on this host:

 

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:

534

601

      </para>

535

602

      <para>

536

603

 

585

652

        compromised if they are gone for too long.

586

653

      </para>

587

654

      <para>

588

 

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

589

 

        by the server which would therefore disable the client.  But

590

 

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

591

 

        list from its configuration file and again regard all clients

592

 

        therein as enabled, and hence eligible to receive their

593

 

        passwords.  Therefore, be careful when restarting servers if

594

 

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

595

 

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

596

 

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

597

 

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

598

 

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

599

 

        stop the server program, edit the configuration file to omit

600

 

        any suspect clients, and restart the server program.

601

 

      </para>

602

 

      <para>

603

655

        For more details on client-side security, see

604

656

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

605

657

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

610

662

  <refsect1 id="see_also">

611

663

    <title>SEE ALSO</title>

612

664

    <para>

613

 

      <citerefentry>

614

 

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

615

 

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

616

 

        <refentrytitle>mandos.conf</refentrytitle>

617

 

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

618

 

        <refentrytitle>mandos-client</refentrytitle>

619

 

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

620

 

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

621

 

      </citerefentry>

 

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>

622

675

    </para>

623

676

    <variablelist>

624

677

      <varlistentry>

• Older »

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