/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.7.1 to 431)
• stop comparing with revision 431

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 "2010-09-11">

 

5

<!ENTITY TIMESTAMP "2012-01-15">

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>

 

38

      <year>2012</year>

36

39

      <holder>Teddy Hogeborn</holder>

37

40

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

38

41

    </copyright>

86

89

      <sbr/>

87

90

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

88

91

      <sbr/>

 

92

      <arg><option>--debuglevel

 

93

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

 

94

      <sbr/>

89

95

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

90

96

      <sbr/>

91

97

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

 

98

      <sbr/>

 

99

      <arg><option>--no-restore</option></arg>

 

100

      <sbr/>

 

101

      <arg><option>--statedir

 

102

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

92

103

    </cmdsynopsis>

93

104

    <cmdsynopsis>

94

105

      <command>&COMMANDNAME;</command>

112

123

    <para>

113

124

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

114

125

      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.

 

126

      client host computers. For an introduction, see

 

127

      <citerefentry><refentrytitle>intro</refentrytitle>

 

128

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

 

129

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

 

130

      TLS to communicate securely with and to authenticate the

 

131

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

 

132

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

 

133

      not have any other addresses configured (see <xref

 

134

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

 

135

      the stored pre-encrypted password for that specific client.

123

136

    </para>

124

137

  </refsect1>

125

138

  

194

207

      </varlistentry>

195

208

      

196

209

      <varlistentry>

 

210

        <term><option>--debuglevel

 

211

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

 

212

        <listitem>

 

213

          <para>

 

214

            Set the debugging log level.

 

215

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

 

216

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

 

217

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

 

218

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

 

219

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

 

220

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

 

221

            increasing verbosity.  The default level is

 

222

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

 

223

          </para>

 

224

        </listitem>

 

225

      </varlistentry>

 

226

      

 

227

      <varlistentry>

197

228

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

198

229

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

199

230

        <listitem>

250

281

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

251

282

        </listitem>

252

283

      </varlistentry>

 

284

      

 

285

      <varlistentry>

 

286

        <term><option>--no-restore</option></term>

 

287

        <listitem>

 

288

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

 

289

          <para>

 

290

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

 

291

          </para>

 

292

        </listitem>

 

293

      </varlistentry>

 

294

      

 

295

      <varlistentry>

 

296

        <term><option>--statedir

 

297

        <replaceable>DIRECTORY</replaceable></option></term>

 

298

        <listitem>

 

299

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

 

300

        </listitem>

 

301

      </varlistentry>

253

302

    </variablelist>

254

303

  </refsect1>

255

304

  

329

378

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

330

379

      longer eligible to receive the encrypted password.  (Manual

331

380

      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>

 

381

      extended timeout, checker program, and interval between checks

 

382

      can be configured both globally and per client; see

 

383

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

 

384

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

 

385

    </para>

 

386

  </refsect1>

 

387

  

 

388

  <refsect1 id="approval">

 

389

    <title>APPROVAL</title>

 

390

    <para>

 

391

      The server can be configured to require manual approval for a

 

392

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

 

393

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

 

394

      configured both globally and per client; see <citerefentry>

334

395

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

335

 

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

336

 

      receiving its password will also be treated as a successful

337

 

      checker run.

338

 

    </para>

 

396

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

 

397

      will be approved immediately without delay.

 

398

    </para>

 

399

    <para>

 

400

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

 

401

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

 

402

      the server delay before giving a client its secret, allowing

 

403

      optional manual denying of this specific client.

 

404

    </para>

 

405

    

339

406

  </refsect1>

340

407

  

341

408

  <refsect1 id="logging">

342

409

    <title>LOGGING</title>

343

410

    <para>

344

411

      The server will send log message with various severity levels to

345

 

      <filename>/dev/log</filename>.  With the

 

412

      <filename class="devicefile">/dev/log</filename>.  With the

346

413

      <option>--debug</option> option, it will log even more messages,

347

414

      and also show them on the console.

348

415

    </para>

349

416

  </refsect1>

350

417

  

 

418

  <refsect1 id="persistent_state">

 

419

    <title>PERSISTENT STATE</title>

 

420

    <para>

 

421

      Client settings, initially read from

 

422

      <filename>clients.conf</filename>, are persistent across

 

423

      restarts, and run-time changes will override settings in

 

424

      <filename>clients.conf</filename>.  However, if a setting is

 

425

      <emphasis>changed</emphasis> (or a client added, or removed) in

 

426

      <filename>clients.conf</filename>, this will take precedence.

 

427

    </para>

 

428

  </refsect1>

 

429

  

351

430

  <refsect1 id="dbus_interface">

352

431

    <title>D-BUS INTERFACE</title>

353

432

    <para>

418

497

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

419

498

        <listitem>

420

499

          <para>

421

 

            The file containing the process id of

422

 

            <command>&COMMANDNAME;</command>.

 

500

            The file containing the process id of the

 

501

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

 

502

          </para>

 

503

        </listitem>

 

504

      </varlistentry>

 

505

      <varlistentry>

 

506

        <term><filename class="devicefile">/dev/log</filename></term>

 

507

      </varlistentry>

 

508

      <varlistentry>

 

509

        <term><filename

 

510

        class="directory">/var/lib/mandos</filename></term>

 

511

        <listitem>

 

512

          <para>

 

513

            Directory where persistent state will be saved.  Change

 

514

            this with the <option>--statedir</option> option.  See

 

515

            also the <option>--no-restore</option> option.

423

516

          </para>

424

517

        </listitem>

425

518

      </varlistentry>

453

546

      backtrace.  This could be considered a feature.

454

547

    </para>

455

548

    <para>

456

 

      Currently, if a client is disabled due to having timed out, the

457

 

      server does not record this fact onto permanent storage.  This

458

 

      has some security implications, see <xref linkend="clients"/>.

459

 

    </para>

460

 

    <para>

461

549

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

462

550

    </para>

463

551

    <para>

464

552

      Debug mode is conflated with running in the foreground.

465

553

    </para>

466

554

    <para>

467

 

      The console log messages do not show a time stamp.

468

 

    </para>

469

 

    <para>

470

555

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

471

556

      keys.

472

557

    </para>

485

570

    <informalexample>

486

571

      <para>

487

572

        Run the server in debug mode, read configuration files from

488

 

        the <filename>~/mandos</filename> directory, and use the

489

 

        Zeroconf service name <quote>Test</quote> to not collide with

490

 

        any other official Mandos server on this host:

 

573

        the <filename class="directory">~/mandos</filename> directory,

 

574

        and use the Zeroconf service name <quote>Test</quote> to not

 

575

        collide with any other official Mandos server on this host:

491

576

      </para>

492

577

      <para>

493

578

 

542

627

        compromised if they are gone for too long.

543

628

      </para>

544

629

      <para>

545

 

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

546

 

        by the server which would therefore disable the client.  But

547

 

        if the server was ever restarted, it would re-read its client

548

 

        list from its configuration file and again regard all clients

549

 

        therein as enabled, and hence eligible to receive their

550

 

        passwords.  Therefore, be careful when restarting servers if

551

 

        it is suspected that a client has, in fact, been compromised

552

 

        by parties who may now be running a fake Mandos client with

553

 

        the keys from the non-encrypted initial <acronym>RAM</acronym>

554

 

        image of the client host.  What should be done in that case

555

 

        (if restarting the server program really is necessary) is to

556

 

        stop the server program, edit the configuration file to omit

557

 

        any suspect clients, and restart the server program.

558

 

      </para>

559

 

      <para>

560

630

        For more details on client-side security, see

561

631

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

562

632

        <manvolnum>8mandos</manvolnum></citerefentry>.

567

637

  <refsect1 id="see_also">

568

638

    <title>SEE ALSO</title>

569

639

    <para>

570

 

      <citerefentry>

571

 

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

572

 

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

573

 

        <refentrytitle>mandos.conf</refentrytitle>

574

 

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

575

 

        <refentrytitle>mandos-client</refentrytitle>

576

 

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

577

 

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

578

 

      </citerefentry>

 

640

      <citerefentry><refentrytitle>intro</refentrytitle>

 

641

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

 

642

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

 

643

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

 

644

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

 

645

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

 

646

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

 

647

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

 

648

      <citerefentry><refentrytitle>sh</refentrytitle>

 

649

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

579

650

    </para>

580

651

    <variablelist>

581

652

      <varlistentry>

• Older »

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