/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (375 to 501)
• stop comparing with revision 501

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 "2009-09-17">

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>

37

 

      <year>2011</year>

38

36

      <holder>Teddy Hogeborn</holder>

39

37

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

40

38

    </copyright>

88

86

      <sbr/>

89

87

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

90

88

      <sbr/>

91

 

      <arg><option>--debuglevel

92

 

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

93

 

      <sbr/>

94

89

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

95

90

      <sbr/>

96

91

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

117

112

    <para>

118

113

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

119

114

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

120

 

      client host computers. For an introduction, see

121

 

      <citerefentry><refentrytitle>intro</refentrytitle>

122

 

      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server

123

 

      uses Zeroconf to announce itself on the local network, and uses

124

 

      TLS to communicate securely with and to authenticate the

125

 

      clients.  The Mandos server uses IPv6 to allow Mandos clients to

126

 

      use IPv6 link-local addresses, since the clients will probably

127

 

      not have any other addresses configured (see <xref

128

 

      linkend="overview"/>).  Any authenticated client is then given

129

 

      the stored pre-encrypted password for that specific client.

 

115

      client host computers.  The Mandos server uses Zeroconf to

 

116

      announce itself on the local network, and uses TLS to

 

117

      communicate securely with and to authenticate the clients.  The

 

118

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

 

119

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

 

120

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

 

121

      Any authenticated client is then given the stored pre-encrypted

 

122

      password for that specific client.

130

123

    </para>

131

124

  </refsect1>

132

125

  

201

194

      </varlistentry>

202

195

      

203

196

      <varlistentry>

204

 

        <term><option>--debuglevel

205

 

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

206

 

        <listitem>

207

 

          <para>

208

 

            Set the debugging log level.

209

 

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

210

 

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

211

 

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

212

 

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

213

 

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

214

 

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

215

 

            increasing verbosity.  The default level is

216

 

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

217

 

          </para>

218

 

        </listitem>

219

 

      </varlistentry>

220

 

      

221

 

      <varlistentry>

222

197

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

223

198

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

224

199

        <listitem>

354

329

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

355

330

      longer eligible to receive the encrypted password.  (Manual

356

331

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

357

 

      extended timeout, checker program, and interval between checks

358

 

      can be configured both globally and per client; see

359

 

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

 

332

      checker program, and interval between checks can be configured

 

333

      both globally and per client; see <citerefentry>

 

334

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

360

335

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

361

336

      receiving its password will also be treated as a successful

362

337

      checker run.

363

338

    </para>

364

339

  </refsect1>

365

340

  

366

 

  <refsect1 id="approval">

367

 

    <title>APPROVAL</title>

368

 

    <para>

369

 

      The server can be configured to require manual approval for a

370

 

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

371

 

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

372

 

      configured both globally and per client; see <citerefentry>

373

 

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

374

 

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

375

 

      will be approved immediately without delay.

376

 

    </para>

377

 

    <para>

378

 

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

379

 

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

380

 

      the server delay before giving a client its secret, allowing

381

 

      optional manual denying of this specific client.

382

 

    </para>

383

 

    

384

 

  </refsect1>

385

 

  

386

341

  <refsect1 id="logging">

387

342

    <title>LOGGING</title>

388

343

    <para>

398

353

    <para>

399

354

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

400

355

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

401

 

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

402

 

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

 

356

      Mandos-specific user, if such a user exists.

 

357

      <!-- XXX -->

403

358

    </para>

404

359

  </refsect1>

405

360

  

463

418

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

464

419

        <listitem>

465

420

          <para>

466

 

            The file containing the process id of the

467

 

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

 

421

            The file containing the process id of

 

422

            <command>&COMMANDNAME;</command>.

468

423

          </para>

469

424

        </listitem>

470

425

      </varlistentry>

498

453

      backtrace.  This could be considered a feature.

499

454

    </para>

500

455

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

 

456

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

 

457

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

 

458

      permanent storage.  This has some security implications, see

 

459

      <xref linkend="clients"/>.

 

460

    </para>

 

461

    <para>

 

462

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

 

463

      status of clients, other than analyzing its <systemitem

 

464

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

504

465

    </para>

505

466

    <para>

506

467

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

588

549

      </para>

589

550

      <para>

590

551

        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.

 

552

        by the server which would therefore declare the client

 

553

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

 

554

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

 

555

        regard all clients therein as valid, and hence eligible to

 

556

        receive their passwords.  Therefore, be careful when

 

557

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

 

558

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

 

559

        fake Mandos client with the keys from the non-encrypted

 

560

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

 

561

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

 

562

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

 

563

        configuration file to omit any suspect clients, and restart

 

564

        the server program.

603

565

      </para>

604

566

      <para>

605

567

        For more details on client-side security, see

612

574

  <refsect1 id="see_also">

613

575

    <title>SEE ALSO</title>

614

576

    <para>

615

 

      <citerefentry><refentrytitle>intro</refentrytitle>

616

 

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

617

 

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

618

 

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

619

 

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

620

 

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

621

 

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

622

 

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

623

 

      <citerefentry><refentrytitle>sh</refentrytitle>

624

 

      <manvolnum>1</manvolnum></citerefentry>

 

577

      <citerefentry>

 

578

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

 

579

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

 

580

        <refentrytitle>mandos.conf</refentrytitle>

 

581

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

 

582

        <refentrytitle>mandos-client</refentrytitle>

 

583

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

 

584

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

 

585

      </citerefentry>

625

586

    </para>

626

587

    <variablelist>

627

588

      <varlistentry>

• Older »

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