/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (734 to 505.3.12)
• stop comparing with revision 505.3.12

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 "2014-06-15">

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>

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>

 

109

      <sbr/>

 

110

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

97

111

    </cmdsynopsis>

98

112

    <cmdsynopsis>

99

113

      <command>&COMMANDNAME;</command>

222

236

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

223

237

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

224

238

        <listitem>

225

 

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

 

239

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

 

240

                      xpointer="priority_compat"/>

226

241

        </listitem>

227

242

      </varlistentry>

228

243

      

275

290

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

276

291

        </listitem>

277

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

      

278

335

    </variablelist>

279

336

  </refsect1>

280

337

  

357

414

      extended timeout, checker program, and interval between checks

358

415

      can be configured both globally and per client; see

359

416

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

360

 

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

361

 

      receiving its password will also be treated as a successful

362

 

      checker run.

 

417

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

363

418

    </para>

364

419

  </refsect1>

365

420

  

387

442

    <title>LOGGING</title>

388

443

    <para>

389

444

      The server will send log message with various severity levels to

390

 

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

 

445

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

391

446

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

392

447

      and also show them on the console.

393

448

    </para>

394

449

  </refsect1>

395

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

  

396

463

  <refsect1 id="dbus_interface">

397

464

    <title>D-BUS INTERFACE</title>

398

465

    <para>

460

527

        </listitem>

461

528

      </varlistentry>

462

529

      <varlistentry>

463

 

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

 

530

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

464

531

        <listitem>

465

532

          <para>

466

533

            The file containing the process id of the

467

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.

468

553

          </para>

469

554

        </listitem>

470

555

      </varlistentry>

498

583

      backtrace.  This could be considered a feature.

499

584

    </para>

500

585

    <para>

501

 

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

502

 

      server does not record this fact onto permanent storage.  This

503

 

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

504

 

    </para>

505

 

    <para>

506

586

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

507

587

    </para>

508

588

    <para>

509

 

      Debug mode is conflated with running in the foreground.

510

 

    </para>

511

 

    <para>

512

 

      The console log messages do not show a time stamp.

513

 

    </para>

514

 

    <para>

515

589

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

516

590

      keys.

517

591

    </para>

530

604

    <informalexample>

531

605

      <para>

532

606

        Run the server in debug mode, read configuration files from

533

 

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

534

 

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

535

 

        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:

536

610

      </para>

537

611

      <para>

538

612

 

587

661

        compromised if they are gone for too long.

588

662

      </para>

589

663

      <para>

590

 

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

591

 

        by the server which would therefore disable the client.  But

592

 

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

593

 

        list from its configuration file and again regard all clients

594

 

        therein as enabled, and hence eligible to receive their

595

 

        passwords.  Therefore, be careful when restarting servers if

596

 

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

597

 

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

598

 

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

599

 

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

600

 

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

601

 

        stop the server program, edit the configuration file to omit

602

 

        any suspect clients, and restart the server program.

603

 

      </para>

604

 

      <para>

605

664

        For more details on client-side security, see

606

665

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

607

666

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

• Older »

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