/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (443 to 605)
• stop comparing with revision 605

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

 

5

<!ENTITY TIMESTAMP "2010-09-25">

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

 

      <year>2012</year>

39

36

      <holder>Teddy Hogeborn</holder>

40

37

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

41

38

    </copyright>

89

86

      <sbr/>

90

87

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

91

88

      <sbr/>

92

 

      <arg><option>--debuglevel

93

 

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

94

 

      <sbr/>

95

89

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

96

90

      <sbr/>

97

91

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

103

 

      <sbr/>

104

 

      <arg><option>--socket

105

 

      <replaceable>FD</replaceable></option></arg>

106

92

    </cmdsynopsis>

107

93

    <cmdsynopsis>

108

94

      <command>&COMMANDNAME;</command>

126

112

    <para>

127

113

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

128

114

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

129

 

      client host computers. For an introduction, see

130

 

      <citerefentry><refentrytitle>intro</refentrytitle>

131

 

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

132

 

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

133

 

      TLS to communicate securely with and to authenticate the

134

 

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

135

 

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

136

 

      not have any other addresses configured (see <xref

137

 

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

138

 

      the stored pre-encrypted password for that specific client.

 

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.

139

123

    </para>

140

124

  </refsect1>

141

125

  

210

194

      </varlistentry>

211

195

      

212

196

      <varlistentry>

213

 

        <term><option>--debuglevel

214

 

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

215

 

        <listitem>

216

 

          <para>

217

 

            Set the debugging log level.

218

 

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

219

 

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

220

 

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

221

 

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

222

 

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

223

 

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

224

 

            increasing verbosity.  The default level is

225

 

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

226

 

          </para>

227

 

        </listitem>

228

 

      </varlistentry>

229

 

      

230

 

      <varlistentry>

231

197

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

232

198

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

233

199

        <listitem>

284

250

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

285

251

        </listitem>

286

252

      </varlistentry>

287

 

      

288

 

      <varlistentry>

289

 

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

290

 

        <listitem>

291

 

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

292

 

          <para>

293

 

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

294

 

          </para>

295

 

        </listitem>

296

 

      </varlistentry>

297

 

      

298

 

      <varlistentry>

299

 

        <term><option>--statedir

300

 

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

301

 

        <listitem>

302

 

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

303

 

        </listitem>

304

 

      </varlistentry>

305

 

      

306

 

      <varlistentry>

307

 

        <term><option>--socket

308

 

        <replaceable>FD</replaceable></option></term>

309

 

        <listitem>

310

 

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

311

 

        </listitem>

312

 

      </varlistentry>

313

 

      

314

253

    </variablelist>

315

254

  </refsect1>

316

255

  

390

329

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

391

330

      longer eligible to receive the encrypted password.  (Manual

392

331

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

393

 

      extended timeout, checker program, and interval between checks

394

 

      can be configured both globally and per client; see

395

 

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

396

 

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

 

332

      checker program, and interval between checks can be configured

 

333

      both globally and per client; see <citerefentry>

 

334

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

397

338

    </para>

398

339

  </refsect1>

399

340

  

421

362

    <title>LOGGING</title>

422

363

    <para>

423

364

      The server will send log message with various severity levels to

424

 

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

 

365

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

425

366

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

426

367

      and also show them on the console.

427

368

    </para>

428

369

  </refsect1>

429

370

  

430

 

  <refsect1 id="persistent_state">

431

 

    <title>PERSISTENT STATE</title>

432

 

    <para>

433

 

      Client settings, initially read from

434

 

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

435

 

      restarts, and run-time changes will override settings in

436

 

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

437

 

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

438

 

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

439

 

    </para>

440

 

  </refsect1>

441

 

  

442

371

  <refsect1 id="dbus_interface">

443

372

    <title>D-BUS INTERFACE</title>

444

373

    <para>

515

444

        </listitem>

516

445

      </varlistentry>

517

446

      <varlistentry>

518

 

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

519

 

      </varlistentry>

520

 

      <varlistentry>

521

 

        <term><filename

522

 

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

523

 

        <listitem>

524

 

          <para>

525

 

            Directory where persistent state will be saved.  Change

526

 

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

527

 

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

528

 

          </para>

529

 

        </listitem>

530

 

      </varlistentry>

531

 

      <varlistentry>

532

447

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

533

448

        <listitem>

534

449

          <para>

558

473

      backtrace.  This could be considered a feature.

559

474

    </para>

560

475

    <para>

 

476

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

 

477

      server does not record this fact onto permanent storage.  This

 

478

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

 

479

    </para>

 

480

    <para>

561

481

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

562

482

    </para>

563

483

    <para>

564

484

      Debug mode is conflated with running in the foreground.

565

485

    </para>

566

486

    <para>

 

487

      The console log messages do not show a time stamp.

 

488

    </para>

 

489

    <para>

567

490

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

568

491

      keys.

569

492

    </para>

582

505

    <informalexample>

583

506

      <para>

584

507

        Run the server in debug mode, read configuration files from

585

 

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

586

 

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

587

 

        collide with any other official Mandos server on this host:

 

508

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

 

509

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

 

510

        any other official Mandos server on this host:

588

511

      </para>

589

512

      <para>

590

513

 

639

562

        compromised if they are gone for too long.

640

563

      </para>

641

564

      <para>

 

565

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

 

566

        by the server which would therefore disable the client.  But

 

567

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

 

568

        list from its configuration file and again regard all clients

 

569

        therein as enabled, and hence eligible to receive their

 

570

        passwords.  Therefore, be careful when restarting servers if

 

571

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

 

572

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

 

573

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

 

574

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

 

575

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

 

576

        stop the server program, edit the configuration file to omit

 

577

        any suspect clients, and restart the server program.

 

578

      </para>

 

579

      <para>

642

580

        For more details on client-side security, see

643

581

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

644

582

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

649

587

  <refsect1 id="see_also">

650

588

    <title>SEE ALSO</title>

651

589

    <para>

652

 

      <citerefentry><refentrytitle>intro</refentrytitle>

653

 

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

654

 

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

655

 

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

656

 

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

657

 

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

658

 

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

659

 

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

660

 

      <citerefentry><refentrytitle>sh</refentrytitle>

661

 

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

 

590

      <citerefentry>

 

591

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

 

592

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

 

593

        <refentrytitle>mandos.conf</refentrytitle>

 

594

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

 

595

        <refentrytitle>mandos-client</refentrytitle>

 

596

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

 

597

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

 

598

      </citerefentry>

662

599

    </para>

663

600

    <variablelist>

664

601

      <varlistentry>

• Older »

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