/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.37 to 518.1.1)
• stop comparing with revision 518.1.1

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-10-03">

 

5

<!ENTITY TIMESTAMP "2013-10-23">

6

6

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

7

7

%common;

8

8

]>

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>

96

98

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

97

99

      <sbr/>

98

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>

99

109

    </cmdsynopsis>

100

110

    <cmdsynopsis>

101

111

      <command>&COMMANDNAME;</command>

224

234

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

225

235

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

226

236

        <listitem>

227

 

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

 

237

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

 

238

                      xpointer="priority_compat"/>

228

239

        </listitem>

229

240

      </varlistentry>

230

241

      

282

293

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

283

294

        <listitem>

284

295

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

285

 

        </listitem>

286

 

      </varlistentry>

 

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

      

287

326

    </variablelist>

288

327

  </refsect1>

289

328

  

366

405

      extended timeout, checker program, and interval between checks

367

406

      can be configured both globally and per client; see

368

407

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

369

 

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

370

 

      receiving its password will also be treated as a successful

371

 

      checker run.

 

408

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

372

409

    </para>

373

410

  </refsect1>

374

411

  

396

433

    <title>LOGGING</title>

397

434

    <para>

398

435

      The server will send log message with various severity levels to

399

 

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

 

436

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

400

437

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

401

438

      and also show them on the console.

402

439

    </para>

403

440

  </refsect1>

404

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

  

405

454

  <refsect1 id="dbus_interface">

406

455

    <title>D-BUS INTERFACE</title>

407

456

    <para>

469

518

        </listitem>

470

519

      </varlistentry>

471

520

      <varlistentry>

472

 

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

 

521

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

473

522

        <listitem>

474

523

          <para>

475

524

            The file containing the process id of the

478

527

        </listitem>

479

528

      </varlistentry>

480

529

      <varlistentry>

 

530

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

 

531

      </varlistentry>

 

532

      <varlistentry>

 

533

        <term><filename

 

534

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

 

535

        <listitem>

 

536

          <para>

 

537

            Directory where persistent state will be saved.  Change

 

538

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

 

539

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

 

540

          </para>

 

541

        </listitem>

 

542

      </varlistentry>

 

543

      <varlistentry>

481

544

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

482

545

        <listitem>

483

546

          <para>

507

570

      backtrace.  This could be considered a feature.

508

571

    </para>

509

572

    <para>

510

 

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

511

 

      server does not record this fact onto permanent storage.  This

512

 

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

513

 

    </para>

514

 

    <para>

515

573

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

516

574

    </para>

517

575

    <para>

518

 

      Debug mode is conflated with running in the foreground.

519

 

    </para>

520

 

    <para>

521

 

      The console log messages do not show a time stamp.

522

 

    </para>

523

 

    <para>

524

576

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

525

577

      keys.

526

578

    </para>

539

591

    <informalexample>

540

592

      <para>

541

593

        Run the server in debug mode, read configuration files from

542

 

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

543

 

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

544

 

        any other official Mandos server on this host:

 

594

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

 

595

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

 

596

        collide with any other official Mandos server on this host:

545

597

      </para>

546

598

      <para>

547

599

 

596

648

        compromised if they are gone for too long.

597

649

      </para>

598

650

      <para>

599

 

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

600

 

        by the server which would therefore disable the client.  But

601

 

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

602

 

        list from its configuration file and again regard all clients

603

 

        therein as enabled, and hence eligible to receive their

604

 

        passwords.  Therefore, be careful when restarting servers if

605

 

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

606

 

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

607

 

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

608

 

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

609

 

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

610

 

        stop the server program, edit the configuration file to omit

611

 

        any suspect clients, and restart the server program.

612

 

      </para>

613

 

      <para>

614

651

        For more details on client-side security, see

615

652

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

616

653

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

• Older »

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