/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (509 to 391)
• stop comparing with revision 391

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

 

5

<!ENTITY TIMESTAMP "2011-10-03">

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>

33

33

    <copyright>

34

34

      <year>2008</year>

35

35

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

36

38

      <holder>Teddy Hogeborn</holder>

37

39

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

38

40

    </copyright>

86

88

      <sbr/>

87

89

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

88

90

      <sbr/>

 

91

      <arg><option>--debuglevel

 

92

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

 

93

      <sbr/>

89

94

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

90

95

      <sbr/>

91

96

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

112

117

    <para>

113

118

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

114

119

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

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.

 

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.

123

130

    </para>

124

131

  </refsect1>

125

132

  

194

201

      </varlistentry>

195

202

      

196

203

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

197

222

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

198

223

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

199

224

        <listitem>

329

354

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

330

355

      longer eligible to receive the encrypted password.  (Manual

331

356

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

332

 

      checker program, and interval between checks can be configured

333

 

      both globally and per client; see <citerefentry>

334

 

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

 

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>

335

360

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

336

361

      receiving its password will also be treated as a successful

337

362

      checker run.

338

363

    </para>

339

364

  </refsect1>

340

365

  

 

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

  

341

386

  <refsect1 id="logging">

342

387

    <title>LOGGING</title>

343

388

    <para>

353

398

    <para>

354

399

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

355

400

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

356

 

      Mandos-specific user, if such a user exists.

357

 

      <!-- XXX -->

 

401

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

 

402

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

358

403

    </para>

359

404

  </refsect1>

360

405

  

418

463

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

419

464

        <listitem>

420

465

          <para>

421

 

            The file containing the process id of

422

 

            <command>&COMMANDNAME;</command>.

 

466

            The file containing the process id of the

 

467

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

423

468

          </para>

424

469

        </listitem>

425

470

      </varlistentry>

453

498

      backtrace.  This could be considered a feature.

454

499

    </para>

455

500

    <para>

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.

 

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

465

504

    </para>

466

505

    <para>

467

506

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

549

588

      </para>

550

589

      <para>

551

590

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

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.

 

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.

565

603

      </para>

566

604

      <para>

567

605

        For more details on client-side security, see

574

612

  <refsect1 id="see_also">

575

613

    <title>SEE ALSO</title>

576

614

    <para>

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>

 

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>

586

625

    </para>

587

626

    <variablelist>

588

627

      <varlistentry>

• Older »

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