/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (518.2.10 to 382)
• stop comparing with revision 382

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-09-17">

 

5

<!ENTITY TIMESTAMP "2011-11-26">

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>

36

38

      <holder>Teddy Hogeborn</holder>

37

39

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

38

40

    </copyright>

86

88

      <sbr/>

87

89

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

88

90

      <sbr/>

 

91

      <arg><option>--debuglevel

 

92

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

 

93

      <sbr/>

89

94

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

90

95

      <sbr/>

91

96

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

 

97

      <sbr/>

 

98

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

 

99

      <sbr/>

 

100

      <arg><option>--statedir

 

101

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

92

102

    </cmdsynopsis>

93

103

    <cmdsynopsis>

94

104

      <command>&COMMANDNAME;</command>

112

122

    <para>

113

123

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

114

124

      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.

 

125

      client host computers. For an introduction, see

 

126

      <citerefentry><refentrytitle>intro</refentrytitle>

 

127

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

 

128

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

 

129

      TLS to communicate securely with and to authenticate the

 

130

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

 

131

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

 

132

      not have any other addresses configured (see <xref

 

133

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

 

134

      the stored pre-encrypted password for that specific client.

123

135

    </para>

124

136

  </refsect1>

125

137

  

194

206

      </varlistentry>

195

207

      

196

208

      <varlistentry>

 

209

        <term><option>--debuglevel

 

210

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

 

211

        <listitem>

 

212

          <para>

 

213

            Set the debugging log level.

 

214

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

 

215

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

 

216

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

 

217

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

 

218

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

 

219

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

 

220

            increasing verbosity.  The default level is

 

221

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

 

222

          </para>

 

223

        </listitem>

 

224

      </varlistentry>

 

225

      

 

226

      <varlistentry>

197

227

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

198

228

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

199

229

        <listitem>

250

280

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

251

281

        </listitem>

252

282

      </varlistentry>

 

283

      

 

284

      <varlistentry>

 

285

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

 

286

        <listitem>

 

287

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

 

288

        </listitem>

 

289

      </varlistentry>

 

290

      

 

291

      <varlistentry>

 

292

        <term><option>--statedir

 

293

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

 

294

        <listitem>

 

295

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

 

296

        </listitem>

 

297

      </varlistentry>

253

298

    </variablelist>

254

299

  </refsect1>

255

300

  

329

374

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

330

375

      longer eligible to receive the encrypted password.  (Manual

331

376

      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>

334

 

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

 

377

      extended timeout, checker program, and interval between checks

 

378

      can be configured both globally and per client; see

 

379

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

335

380

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

336

381

      receiving its password will also be treated as a successful

337

382

      checker run.

338

383

    </para>

339

384

  </refsect1>

340

385

  

 

386

  <refsect1 id="approval">

 

387

    <title>APPROVAL</title>

 

388

    <para>

 

389

      The server can be configured to require manual approval for a

 

390

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

 

391

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

 

392

      configured both globally and per client; see <citerefentry>

 

393

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

 

394

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

 

395

      will be approved immediately without delay.

 

396

    </para>

 

397

    <para>

 

398

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

 

399

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

 

400

      the server delay before giving a client its secret, allowing

 

401

      optional manual denying of this specific client.

 

402

    </para>

 

403

    

 

404

  </refsect1>

 

405

  

341

406

  <refsect1 id="logging">

342

407

    <title>LOGGING</title>

343

408

    <para>

353

418

    <para>

354

419

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

355

420

      This interface will only be accessible by the root user or a

356

 

      Mandos-specific user, if such a user exists.

357

 

      <!-- XXX -->

 

421

      Mandos-specific user, if such a user exists.  For documentation

 

422

      of the D-Bus API, see the file <filename>DBUS-API</filename>.

358

423

    </para>

359

424

  </refsect1>

360

425

  

418

483

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

419

484

        <listitem>

420

485

          <para>

421

 

            The file containing the process id of

422

 

            <command>&COMMANDNAME;</command>.

 

486

            The file containing the process id of the

 

487

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

 

488

          </para>

 

489

        </listitem>

 

490

      </varlistentry>

 

491

      <varlistentry>

 

492

        <term><filename

 

493

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

 

494

        <listitem>

 

495

          <para>

 

496

            Directory where persistent state will be saved.  Change

 

497

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

 

498

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

423

499

          </para>

424

500

        </listitem>

425

501

      </varlistentry>

453

529

      backtrace.  This could be considered a feature.

454

530

    </para>

455

531

    <para>

456

 

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

457

 

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

458

 

      permanent storage.  This has some security implications, see

459

 

      <xref linkend="clients"/>.

460

 

    </para>

461

 

    <para>

462

 

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

463

 

      status of clients, other than analyzing its <systemitem

464

 

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

465

 

    </para>

466

 

    <para>

467

532

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

468

533

    </para>

469

534

    <para>

470

535

      Debug mode is conflated with running in the foreground.

471

536

    </para>

472

537

    <para>

473

 

      The console log messages do not show a time stamp.

474

 

    </para>

475

 

    <para>

476

538

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

477

539

      keys.

478

540

    </para>

491

553

    <informalexample>

492

554

      <para>

493

555

        Run the server in debug mode, read configuration files from

494

 

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

495

 

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

496

 

        any other official Mandos server on this host:

 

556

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

 

557

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

 

558

        collide with any other official Mandos server on this host:

497

559

      </para>

498

560

      <para>

499

561

 

548

610

        compromised if they are gone for too long.

549

611

      </para>

550

612

      <para>

551

 

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

552

 

        by the server which would therefore declare the client

553

 

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

554

 

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

555

 

        regard all clients therein as valid, and hence eligible to

556

 

        receive their passwords.  Therefore, be careful when

557

 

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

558

 

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

559

 

        fake Mandos client with the keys from the non-encrypted

560

 

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

561

 

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

562

 

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

563

 

        configuration file to omit any suspect clients, and restart

564

 

        the server program.

565

 

      </para>

566

 

      <para>

567

613

        For more details on client-side security, see

568

614

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

569

615

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

574

620

  <refsect1 id="see_also">

575

621

    <title>SEE ALSO</title>

576

622

    <para>

577

 

      <citerefentry>

578

 

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

579

 

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

580

 

        <refentrytitle>mandos.conf</refentrytitle>

581

 

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

582

 

        <refentrytitle>mandos-client</refentrytitle>

583

 

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

584

 

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

585

 

      </citerefentry>

 

623

      <citerefentry><refentrytitle>intro</refentrytitle>

 

624

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

 

625

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

 

626

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

 

627

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

 

628

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

 

629

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

 

630

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

 

631

      <citerefentry><refentrytitle>sh</refentrytitle>

 

632

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

586

633

    </para>

587

634

    <variablelist>

588

635

      <varlistentry>

• Older »

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