/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 505)
• stop comparing with revision 505

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

 

5

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

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>

222

234

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

223

235

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

224

236

        <listitem>

225

 

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

 

237

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

 

238

                      xpointer="priority_compat"/>

226

239

        </listitem>

227

240

      </varlistentry>

228

241

      

275

288

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

276

289

        </listitem>

277

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

      

278

326

    </variablelist>

279

327

  </refsect1>

280

328

  

357

405

      extended timeout, checker program, and interval between checks

358

406

      can be configured both globally and per client; see

359

407

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

 

408

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

363

409

    </para>

364

410

  </refsect1>

365

411

  

387

433

    <title>LOGGING</title>

388

434

    <para>

389

435

      The server will send log message with various severity levels to

390

 

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

 

436

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

391

437

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

392

438

      and also show them on the console.

393

439

    </para>

394

440

  </refsect1>

395

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

  

396

454

  <refsect1 id="dbus_interface">

397

455

    <title>D-BUS INTERFACE</title>

398

456

    <para>

460

518

        </listitem>

461

519

      </varlistentry>

462

520

      <varlistentry>

463

 

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

 

521

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

464

522

        <listitem>

465

523

          <para>

466

524

            The file containing the process id of the

469

527

        </listitem>

470

528

      </varlistentry>

471

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>

472

544

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

473

545

        <listitem>

474

546

          <para>

498

570

      backtrace.  This could be considered a feature.

499

571

    </para>

500

572

    <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

573

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

507

574

    </para>

508

575

    <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

576

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

516

577

      keys.

517

578

    </para>

530

591

    <informalexample>

531

592

      <para>

532

593

        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:

 

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:

536

597

      </para>

537

598

      <para>

538

599

 

587

648

        compromised if they are gone for too long.

588

649

      </para>

589

650

      <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

651

        For more details on client-side security, see

606

652

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

607

653

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

• Older »

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