/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (457 to 237.2.19)
• stop comparing with revision 237.2.19

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 "2009-02-24">

 

5

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

6

6

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

7

7

%common;

8

8

]>

33

33

    <copyright>

34

34

      <year>2008</year>

35

35

      <year>2009</year>

 

36

      <year>2010</year>

36

37

      <holder>Teddy Hogeborn</holder>

37

38

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

38

39

    </copyright>

86

87

      <sbr/>

87

88

      <arg><option>--debug</option></arg>

88

89

      <sbr/>

 

90

      <arg><option>--debuglevel

 

91

      <replaceable>LEVEL</replaceable></option></arg>

 

92

      <sbr/>

 

93

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

 

94

      <sbr/>

89

95

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

90

96

    </cmdsynopsis>

91

97

    <cmdsynopsis>

192

198

      </varlistentry>

193

199

      

194

200

      <varlistentry>

 

201

        <term><option>--debuglevel

 

202

        <replaceable>LEVEL</replaceable></option></term>

 

203

        <listitem>

 

204

          <para>

 

205

            Set the debugging log level.

 

206

            <replaceable>LEVEL</replaceable> is a string, one of

 

207

            <quote><literal>CRITICAL</literal></quote>,

 

208

            <quote><literal>ERROR</literal></quote>,

 

209

            <quote><literal>WARNING</literal></quote>,

 

210

            <quote><literal>INFO</literal></quote>, or

 

211

            <quote><literal>DEBUG</literal></quote>, in order of

 

212

            increasing verbosity.  The default level is

 

213

            <quote><literal>WARNING</literal></quote>.

 

214

          </para>

 

215

        </listitem>

 

216

      </varlistentry>

 

217

      

 

218

      <varlistentry>

195

219

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

196

220

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

197

221

        <listitem>

233

257

      </varlistentry>

234

258

      

235

259

      <varlistentry>

 

260

        <term><option>--no-dbus</option></term>

 

261

        <listitem>

 

262

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

 

263

          <para>

 

264

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

 

265

          </para>

 

266

        </listitem>

 

267

      </varlistentry>

 

268

      

 

269

      <varlistentry>

236

270

        <term><option>--no-ipv6</option></term>

237

271

        <listitem>

238

272

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

315

349

      The server will, by default, continually check that the clients

316

350

      are still up.  If a client has not been confirmed as being up

317

351

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

318

 

      longer eligible to receive the encrypted password.  The timeout,

 

352

      longer eligible to receive the encrypted password.  (Manual

 

353

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

319

354

      checker program, and interval between checks can be configured

320

355

      both globally and per client; see <citerefentry>

321

356

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

322

 

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

323

 

    </para>

 

357

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

 

358

      receiving its password will also be treated as a successful

 

359

      checker run.

 

360

    </para>

 

361

  </refsect1>

 

362

  

 

363

  <refsect1 id="approval">

 

364

    <title>APPROVAL</title>

 

365

    <para>

 

366

      The server can be configured to require manual approval for a

 

367

      client before it is sent its secret.  The delay to wait for such

 

368

      approval and the default action (approve or deny) can be

 

369

      configured both globally and per client; see <citerefentry>

 

370

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

 

371

      <manvolnum>5</manvolnum></citerefentry>.  By default all clients

 

372

      will be approved immediately without delay.

 

373

    </para>

 

374

    <para>

 

375

      This can be used to deny a client its secret if not manually

 

376

      approved within a specified time.  It can also be used to make

 

377

      the server delay before giving a client its secret, allowing

 

378

      optional manual denying of this specific client.

 

379

    </para>

 

380

    

324

381

  </refsect1>

325

382

  

326

383

  <refsect1 id="logging">

333

390

    </para>

334

391

  </refsect1>

335

392

  

 

393

  <refsect1 id="dbus_interface">

 

394

    <title>D-BUS INTERFACE</title>

 

395

    <para>

 

396

      The server will by default provide a D-Bus system bus interface.

 

397

      This interface will only be accessible by the root user or a

 

398

      Mandos-specific user, if such a user exists.  For documentation

 

399

      of the D-Bus API, see the file <filename>DBUS-API</filename>.

 

400

    </para>

 

401

  </refsect1>

 

402

  

336

403

  <refsect1 id="exit_status">

337

404

    <title>EXIT STATUS</title>

338

405

    <para>

393

460

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

394

461

        <listitem>

395

462

          <para>

396

 

            The file containing the process id of

397

 

            <command>&COMMANDNAME;</command>.

 

463

            The file containing the process id of the

 

464

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

398

465

          </para>

399

466

        </listitem>

400

467

      </varlistentry>

428

495

      backtrace.  This could be considered a feature.

429

496

    </para>

430

497

    <para>

431

 

      Currently, if a client is declared <quote>invalid</quote> due to

432

 

      having timed out, the server does not record this fact onto

433

 

      permanent storage.  This has some security implications, see

434

 

      <xref linkend="clients"/>.

435

 

    </para>

436

 

    <para>

437

 

      There is currently no way of querying the server of the current

438

 

      status of clients, other than analyzing its <systemitem

439

 

      class="service">syslog</systemitem> output.

 

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

440

501

    </para>

441

502

    <para>

442

503

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

524

585

      </para>

525

586

      <para>

526

587

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

527

 

        by the server which would therefore declare the client

528

 

        invalid.  But if the server was ever restarted, it would

529

 

        re-read its client list from its configuration file and again

530

 

        regard all clients therein as valid, and hence eligible to

531

 

        receive their passwords.  Therefore, be careful when

532

 

        restarting servers if it is suspected that a client has, in

533

 

        fact, been compromised by parties who may now be running a

534

 

        fake Mandos client with the keys from the non-encrypted

535

 

        initial <acronym>RAM</acronym> image of the client host.  What

536

 

        should be done in that case (if restarting the server program

537

 

        really is necessary) is to stop the server program, edit the

538

 

        configuration file to omit any suspect clients, and restart

539

 

        the server program.

 

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.

540

600

      </para>

541

601

      <para>

542

602

        For more details on client-side security, see

• Older »

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