/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (289 to 513)
• stop comparing with revision 513

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 "2009-01-04">

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@recompile.se</email>

 

22

          <email>belorn@fukt.bsnet.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@recompile.se</email>

 

29

          <email>teddy@fukt.bsnet.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>

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

 

      <sbr/>

96

 

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

97

90

    </cmdsynopsis>

98

91

    <cmdsynopsis>

99

92

      <command>&COMMANDNAME;</command>

117

110

    <para>

118

111

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

119

112

      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.

 

113

      client host computers.  The Mandos server uses Zeroconf to

 

114

      announce itself on the local network, and uses TLS to

 

115

      communicate securely with and to authenticate the clients.  The

 

116

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

 

117

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

 

118

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

 

119

      Any authenticated client is then given the stored pre-encrypted

 

120

      password for that specific client.

130

121

    </para>

131

122

  </refsect1>

132

123

  

201

192

      </varlistentry>

202

193

      

203

194

      <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

195

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

223

196

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

224

197

        <listitem>

268

241

          </para>

269

242

        </listitem>

270

243

      </varlistentry>

271

 

      

272

 

      <varlistentry>

273

 

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

274

 

        <listitem>

275

 

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

276

 

        </listitem>

277

 

      </varlistentry>

278

244

    </variablelist>

279

245

  </refsect1>

280

246

  

352

318

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

353

319

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

354

320

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

355

 

      longer eligible to receive the encrypted password.  (Manual

356

 

      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>

360

 

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

361

 

      receiving its password will also be treated as a successful

362

 

      checker run.

363

 

    </para>

364

 

  </refsect1>

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>

 

321

      longer eligible to receive the encrypted password.  The timeout,

 

322

      checker program, and interval between checks can be configured

 

323

      both globally and per client; see <citerefentry>

373

324

      <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

 

    

 

325

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

 

326

    </para>

384

327

  </refsect1>

385

328

  

386

329

  <refsect1 id="logging">

398

341

    <para>

399

342

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

400

343

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

 

344

      Mandos-specific user, if such a user exists.

 

345

      <!-- XXX -->

403

346

    </para>

404

347

  </refsect1>

405

 

  

 

348

 

406

349

  <refsect1 id="exit_status">

407

350

    <title>EXIT STATUS</title>

408

351

    <para>

463

406

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

464

407

        <listitem>

465

408

          <para>

466

 

            The file containing the process id of the

467

 

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

 

409

            The file containing the process id of

 

410

            <command>&COMMANDNAME;</command>.

468

411

          </para>

469

412

        </listitem>

470

413

      </varlistentry>

498

441

      backtrace.  This could be considered a feature.

499

442

    </para>

500

443

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

 

444

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

 

445

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

 

446

      permanent storage.  This has some security implications, see

 

447

      <xref linkend="clients"/>.

 

448

    </para>

 

449

    <para>

 

450

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

 

451

      status of clients, other than analyzing its <systemitem

 

452

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

504

453

    </para>

505

454

    <para>

506

455

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

509

458

      Debug mode is conflated with running in the foreground.

510

459

    </para>

511

460

    <para>

512

 

      The console log messages do not show a time stamp.

 

461

      The console log messages does not show a time stamp.

513

462

    </para>

514

463

    <para>

515

464

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

588

537

      </para>

589

538

      <para>

590

539

        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.

 

540

        by the server which would therefore declare the client

 

541

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

 

542

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

 

543

        regard all clients therein as valid, and hence eligible to

 

544

        receive their passwords.  Therefore, be careful when

 

545

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

 

546

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

 

547

        fake Mandos client with the keys from the non-encrypted

 

548

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

 

549

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

 

550

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

 

551

        configuration file to omit any suspect clients, and restart

 

552

        the server program.

603

553

      </para>

604

554

      <para>

605

555

        For more details on client-side security, see

612

562

  <refsect1 id="see_also">

613

563

    <title>SEE ALSO</title>

614

564

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

 

565

      <citerefentry>

 

566

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

 

567

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

 

568

        <refentrytitle>mandos.conf</refentrytitle>

 

569

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

 

570

        <refentrytitle>mandos-client</refentrytitle>

 

571

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

 

572

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

 

573

      </citerefentry>

625

574

    </para>

626

575

    <variablelist>

627

576

      <varlistentry>

• Older »

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