/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.26 to 189)
• stop comparing with revision 189

Show diffs side-by-side

added

removed

mandos.xml

1

1

<?xml version="1.0" encoding="UTF-8"?>

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

 

<!ENTITY VERSION "1.0">

5

4

<!ENTITY COMMANDNAME "mandos">

6

 

<!ENTITY TIMESTAMP "2008-09-12">

 

5

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

 

6

<!ENTITY % common SYSTEM "common.ent">

 

7

%common;

7

8

]>

8

9

 

9

10

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">

10

 

  <refentryinfo>

 

11

   <refentryinfo>

11

12

    <title>Mandos Manual</title>

12

13

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

13

14

    <productname>Mandos</productname>

14

 

    <productnumber>&VERSION;</productnumber>

 

15

    <productnumber>&version;</productnumber>

15

16

    <date>&TIMESTAMP;</date>

16

17

    <authorgroup>

17

18

      <author>

18

19

        <firstname>Björn</firstname>

19

20

        <surname>Påhlsson</surname>

20

21

        <address>

21

 

          <email>belorn@fukt.bsnet.se</email>

 

22

          <email>belorn@recompile.se</email>

22

23

        </address>

23

24

      </author>

24

25

      <author>

25

26

        <firstname>Teddy</firstname>

26

27

        <surname>Hogeborn</surname>

27

28

        <address>

28

 

          <email>teddy@fukt.bsnet.se</email>

 

29

          <email>teddy@recompile.se</email>

29

30

        </address>

30

31

      </author>

31

32

    </authorgroup>

32

33

    <copyright>

33

34

      <year>2008</year>

 

35

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

34

39

      <holder>Teddy Hogeborn</holder>

35

40

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

36

41

    </copyright>

83

88

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

84

89

      <sbr/>

85

90

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

 

91

      <sbr/>

 

92

      <arg><option>--debuglevel

 

93

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

 

94

      <sbr/>

 

95

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

 

96

      <sbr/>

 

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>

86

103

    </cmdsynopsis>

87

104

    <cmdsynopsis>

88

105

      <command>&COMMANDNAME;</command>

106

123

    <para>

107

124

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

108

125

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

109

 

      client host computers.  The Mandos server uses Zeroconf to

110

 

      announce itself on the local network, and uses TLS to

111

 

      communicate securely with and to authenticate the clients.  The

112

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

113

 

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

114

 

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

115

 

      Any authenticated client is then given the stored pre-encrypted

116

 

      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.

117

136

    </para>

118

137

  </refsect1>

119

138

  

188

207

      </varlistentry>

189

208

      

190

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>

191

228

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

192

229

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

193

230

        <listitem>

227

264

          </para>

228

265

        </listitem>

229

266

      </varlistentry>

 

267

      

 

268

      <varlistentry>

 

269

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

 

270

        <listitem>

 

271

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

 

272

          <para>

 

273

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

 

274

          </para>

 

275

        </listitem>

 

276

      </varlistentry>

 

277

      

 

278

      <varlistentry>

 

279

        <term><option>--no-ipv6</option></term>

 

280

        <listitem>

 

281

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

 

282

        </listitem>

 

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>

230

302

    </variablelist>

231

303

  </refsect1>

232

304

  

304

376

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

305

377

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

306

378

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

307

 

      longer eligible to receive the encrypted password.  The timeout,

308

 

      checker program, and interval between checks can be configured

309

 

      both globally and per client; see <citerefentry>

 

379

      longer eligible to receive the encrypted password.  (Manual

 

380

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

 

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>.  A client successfully

 

385

      receiving its password will also be treated as a successful

 

386

      checker run.

 

387

    </para>

 

388

  </refsect1>

 

389

  

 

390

  <refsect1 id="approval">

 

391

    <title>APPROVAL</title>

 

392

    <para>

 

393

      The server can be configured to require manual approval for a

 

394

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

 

395

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

 

396

      configured both globally and per client; see <citerefentry>

310

397

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

311

 

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

312

 

    </para>

 

398

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

 

399

      will be approved immediately without delay.

 

400

    </para>

 

401

    <para>

 

402

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

 

403

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

 

404

      the server delay before giving a client its secret, allowing

 

405

      optional manual denying of this specific client.

 

406

    </para>

 

407

    

313

408

  </refsect1>

314

409

  

315

410

  <refsect1 id="logging">

316

411

    <title>LOGGING</title>

317

412

    <para>

318

413

      The server will send log message with various severity levels to

319

 

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

 

414

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

320

415

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

321

416

      and also show them on the console.

322

417

    </para>

323

418

  </refsect1>

324

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

  

 

432

  <refsect1 id="dbus_interface">

 

433

    <title>D-BUS INTERFACE</title>

 

434

    <para>

 

435

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

 

436

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

 

437

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

 

438

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

 

439

    </para>

 

440

  </refsect1>

 

441

  

325

442

  <refsect1 id="exit_status">

326

443

    <title>EXIT STATUS</title>

327

444

    <para>

350

467

    </variablelist>

351

468

  </refsect1>

352

469

  

353

 

  <refsect1 id="file">

 

470

  <refsect1 id="files">

354

471

    <title>FILES</title>

355

472

    <para>

356

473

      Use the <option>--configdir</option> option to change where

382

499

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

383

500

        <listitem>

384

501

          <para>

385

 

            The file containing the process id of

386

 

            <command>&COMMANDNAME;</command>.

 

502

            The file containing the process id of the

 

503

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

 

504

          </para>

 

505

        </listitem>

 

506

      </varlistentry>

 

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.

387

518

          </para>

388

519

        </listitem>

389

520

      </varlistentry>

417

548

      backtrace.  This could be considered a feature.

418

549

    </para>

419

550

    <para>

420

 

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

421

 

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

422

 

      permanent storage.  This has some security implications, see

423

 

      <xref linkend="CLIENTS"/>.

424

 

    </para>

425

 

    <para>

426

 

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

427

 

      status of clients, other than analyzing its <systemitem

428

 

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

429

 

    </para>

430

 

    <para>

431

551

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

432

552

    </para>

433

553

    <para>

434

554

      Debug mode is conflated with running in the foreground.

435

555

    </para>

436

556

    <para>

437

 

      The console log messages does not show a time stamp.

438

 

    </para>

439

 

    <para>

440

557

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

441

558

      keys.

442

559

    </para>

455

572

    <informalexample>

456

573

      <para>

457

574

        Run the server in debug mode, read configuration files from

458

 

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

459

 

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

460

 

        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:

461

578

      </para>

462

579

      <para>

463

580

 

482

599

  

483

600

  <refsect1 id="security">

484

601

    <title>SECURITY</title>

485

 

    <refsect2 id="SERVER">

 

602

    <refsect2 id="server">

486

603

      <title>SERVER</title>

487

604

      <para>

488

605

        Running this <command>&COMMANDNAME;</command> server program

491

608

        soon after startup.

492

609

      </para>

493

610

    </refsect2>

494

 

    <refsect2 id="CLIENTS">

 

611

    <refsect2 id="clients">

495

612

      <title>CLIENTS</title>

496

613

      <para>

497

614

        The server only gives out its stored data to clients which

504

621

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

505

622

        <manvolnum>5</manvolnum></citerefentry>)

506

623

        <emphasis>must</emphasis> be made non-readable by anyone

507

 

        except the user running the server.

 

624

        except the user starting the server (usually root).

508

625

      </para>

509

626

      <para>

510

627

        As detailed in <xref linkend="checking"/>, the status of all

512

629

        compromised if they are gone for too long.

513

630

      </para>

514

631

      <para>

515

 

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

516

 

        by the server which would therefore declare the client

517

 

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

518

 

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

519

 

        regard all clients therein as valid, and hence eligible to

520

 

        receive their passwords.  Therefore, be careful when

521

 

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

522

 

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

523

 

        fake Mandos client with the keys from the non-encrypted

524

 

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

525

 

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

526

 

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

527

 

        configuration file to omit any suspect clients, and restart

528

 

        the server program.

529

 

      </para>

530

 

      <para>

531

632

        For more details on client-side security, see

532

633

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

533

634

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

538

639

  <refsect1 id="see_also">

539

640

    <title>SEE ALSO</title>

540

641

    <para>

541

 

      <citerefentry>

542

 

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

543

 

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

544

 

        <refentrytitle>mandos.conf</refentrytitle>

545

 

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

546

 

        <refentrytitle>mandos-client</refentrytitle>

547

 

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

548

 

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

549

 

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

550

652

    </para>

551

653

    <variablelist>

552

654

      <varlistentry>

• Older »

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