/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (24.1.186 to 237.2.2)
• stop comparing with revision 237.2.2

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

 

5

<!ENTITY TIMESTAMP "2011-08-08">

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>

36

38

      <holder>Teddy Hogeborn</holder>

37

39

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

38

40

    </copyright>

85

87

      <replaceable>DIRECTORY</replaceable></option></arg>

86

88

      <sbr/>

87

89

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

 

90

      <sbr/>

 

91

      <arg><option>--debuglevel

 

92

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

 

93

      <sbr/>

 

94

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

 

95

      <sbr/>

 

96

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

88

97

    </cmdsynopsis>

89

98

    <cmdsynopsis>

90

99

      <command>&COMMANDNAME;</command>

108

117

    <para>

109

118

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

110

119

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

111

 

      client host computers.  The Mandos server uses Zeroconf to

112

 

      announce itself on the local network, and uses TLS to

113

 

      communicate securely with and to authenticate the clients.  The

114

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

115

 

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

116

 

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

117

 

      Any authenticated client is then given the stored pre-encrypted

118

 

      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.

119

130

    </para>

120

131

  </refsect1>

121

132

  

190

201

      </varlistentry>

191

202

      

192

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>

193

222

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

194

223

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

195

224

        <listitem>

229

258

          </para>

230

259

        </listitem>

231

260

      </varlistentry>

 

261

      

 

262

      <varlistentry>

 

263

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

 

264

        <listitem>

 

265

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

 

266

          <para>

 

267

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

 

268

          </para>

 

269

        </listitem>

 

270

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

232

278

    </variablelist>

233

279

  </refsect1>

234

280

  

306

352

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

307

353

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

308

354

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

309

 

      longer eligible to receive the encrypted password.  The timeout,

310

 

      checker program, and interval between checks can be configured

311

 

      both globally and per client; see <citerefentry>

 

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>

312

373

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

313

 

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

314

 

    </para>

 

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

    

315

384

  </refsect1>

316

385

  

317

386

  <refsect1 id="logging">

324

393

    </para>

325

394

  </refsect1>

326

395

  

 

396

  <refsect1 id="dbus_interface">

 

397

    <title>D-BUS INTERFACE</title>

 

398

    <para>

 

399

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

 

400

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

 

403

    </para>

 

404

  </refsect1>

 

405

  

327

406

  <refsect1 id="exit_status">

328

407

    <title>EXIT STATUS</title>

329

408

    <para>

384

463

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

385

464

        <listitem>

386

465

          <para>

387

 

            The file containing the process id of

388

 

            <command>&COMMANDNAME;</command>.

 

466

            The file containing the process id of the

 

467

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

389

468

          </para>

390

469

        </listitem>

391

470

      </varlistentry>

419

498

      backtrace.  This could be considered a feature.

420

499

    </para>

421

500

    <para>

422

 

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

423

 

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

424

 

      permanent storage.  This has some security implications, see

425

 

      <xref linkend="clients"/>.

426

 

    </para>

427

 

    <para>

428

 

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

429

 

      status of clients, other than analyzing its <systemitem

430

 

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

431

504

    </para>

432

505

    <para>

433

506

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

436

509

      Debug mode is conflated with running in the foreground.

437

510

    </para>

438

511

    <para>

439

 

      The console log messages does not show a time stamp.

 

512

      The console log messages do not show a time stamp.

440

513

    </para>

441

514

    <para>

442

515

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

515

588

      </para>

516

589

      <para>

517

590

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

518

 

        by the server which would therefore declare the client

519

 

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

520

 

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

521

 

        regard all clients therein as valid, and hence eligible to

522

 

        receive their passwords.  Therefore, be careful when

523

 

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

524

 

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

525

 

        fake Mandos client with the keys from the non-encrypted

526

 

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

527

 

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

528

 

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

529

 

        configuration file to omit any suspect clients, and restart

530

 

        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.

531

603

      </para>

532

604

      <para>

533

605

        For more details on client-side security, see

540

612

  <refsect1 id="see_also">

541

613

    <title>SEE ALSO</title>

542

614

    <para>

543

 

      <citerefentry>

544

 

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

545

 

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

546

 

        <refentrytitle>mandos.conf</refentrytitle>

547

 

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

548

 

        <refentrytitle>mandos-client</refentrytitle>

549

 

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

550

 

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

551

 

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

552

625

    </para>

553

626

    <variablelist>

554

627

      <varlistentry>

• Older »

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