/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (550 to 444)
• stop comparing with revision 444

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

 

5

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

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>

34

34

      <year>2008</year>

35

35

      <year>2009</year>

36

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

37

39

      <holder>Teddy Hogeborn</holder>

38

40

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

39

41

    </copyright>

87

89

      <sbr/>

88

90

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

89

91

      <sbr/>

 

92

      <arg><option>--debuglevel

 

93

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

 

94

      <sbr/>

90

95

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

91

96

      <sbr/>

92

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>

93

103

    </cmdsynopsis>

94

104

    <cmdsynopsis>

95

105

      <command>&COMMANDNAME;</command>

113

123

    <para>

114

124

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

115

125

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

116

 

      client host computers.  The Mandos server uses Zeroconf to

117

 

      announce itself on the local network, and uses TLS to

118

 

      communicate securely with and to authenticate the clients.  The

119

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

120

 

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

121

 

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

122

 

      Any authenticated client is then given the stored pre-encrypted

123

 

      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.

124

136

    </para>

125

137

  </refsect1>

126

138

  

195

207

      </varlistentry>

196

208

      

197

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>

198

228

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

199

229

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

200

230

        <listitem>

251

281

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

252

282

        </listitem>

253

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>

254

302

    </variablelist>

255

303

  </refsect1>

256

304

  

330

378

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

331

379

      longer eligible to receive the encrypted password.  (Manual

332

380

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

333

 

      checker program, and interval between checks can be configured

334

 

      both globally and per client; see <citerefentry>

335

 

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

 

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>

336

384

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

337

385

      receiving its password will also be treated as a successful

338

386

      checker run.

363

411

    <title>LOGGING</title>

364

412

    <para>

365

413

      The server will send log message with various severity levels to

366

 

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

 

414

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

367

415

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

368

416

      and also show them on the console.

369

417

    </para>

370

418

  </refsect1>

371

419

  

 

420

  <refsect1 id="persistent_state">

 

421

    <title>PERSISTENT STATE</title>

 

422

    <para>

 

423

      Client settings, initially read from

 

424

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

 

425

      restarts, and run-time changes will override settings in

 

426

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

 

427

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

 

428

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

 

429

    </para>

 

430

  </refsect1>

 

431

  

372

432

  <refsect1 id="dbus_interface">

373

433

    <title>D-BUS INTERFACE</title>

374

434

    <para>

445

505

        </listitem>

446

506

      </varlistentry>

447

507

      <varlistentry>

 

508

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

 

509

      </varlistentry>

 

510

      <varlistentry>

 

511

        <term><filename

 

512

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

 

513

        <listitem>

 

514

          <para>

 

515

            Directory where persistent state will be saved.  Change

 

516

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

 

517

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

 

518

          </para>

 

519

        </listitem>

 

520

      </varlistentry>

 

521

      <varlistentry>

448

522

        <term><filename>/dev/log</filename></term>

449

523

        <listitem>

450

524

          <para>

474

548

      backtrace.  This could be considered a feature.

475

549

    </para>

476

550

    <para>

477

 

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

478

 

      server does not record this fact onto permanent storage.  This

479

 

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

480

 

    </para>

481

 

    <para>

482

551

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

483

552

    </para>

484

553

    <para>

485

554

      Debug mode is conflated with running in the foreground.

486

555

    </para>

487

556

    <para>

488

 

      The console log messages do not show a time stamp.

489

 

    </para>

490

 

    <para>

491

557

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

492

558

      keys.

493

559

    </para>

506

572

    <informalexample>

507

573

      <para>

508

574

        Run the server in debug mode, read configuration files from

509

 

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

510

 

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

511

 

        any other official Mandos server on this host:

 

575

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

 

576

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

 

577

        collide with any other official Mandos server on this host:

512

578

      </para>

513

579

      <para>

514

580

 

563

629

        compromised if they are gone for too long.

564

630

      </para>

565

631

      <para>

566

 

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

567

 

        by the server which would therefore disable the client.  But

568

 

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

569

 

        list from its configuration file and again regard all clients

570

 

        therein as enabled, and hence eligible to receive their

571

 

        passwords.  Therefore, be careful when restarting servers if

572

 

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

573

 

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

574

 

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

575

 

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

576

 

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

577

 

        stop the server program, edit the configuration file to omit

578

 

        any suspect clients, and restart the server program.

579

 

      </para>

580

 

      <para>

581

632

        For more details on client-side security, see

582

633

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

583

634

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

588

639

  <refsect1 id="see_also">

589

640

    <title>SEE ALSO</title>

590

641

    <para>

591

 

      <citerefentry>

592

 

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

593

 

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

594

 

        <refentrytitle>mandos.conf</refentrytitle>

595

 

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

596

 

        <refentrytitle>mandos-client</refentrytitle>

597

 

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

598

 

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

599

 

      </citerefentry>

 

642

      <citerefentry><refentrytitle>intro</refentrytitle>

 

643

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

 

644

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

 

645

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

 

646

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

 

647

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

 

648

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

 

649

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

 

650

      <citerefentry><refentrytitle>sh</refentrytitle>

 

651

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

600

652

    </para>

601

653

    <variablelist>

602

654

      <varlistentry>

• Older »

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