/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.32 to 218)
• stop comparing with revision 218

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 "2008-09-30">

 

5

<!ENTITY TIMESTAMP "2012-05-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

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

35

39

      <holder>Teddy Hogeborn</holder>

36

40

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

37

41

    </copyright>

84

88

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

85

89

      <sbr/>

86

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>

 

103

      <sbr/>

 

104

      <arg><option>--socket

 

105

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

87

106

    </cmdsynopsis>

88

107

    <cmdsynopsis>

89

108

      <command>&COMMANDNAME;</command>

107

126

    <para>

108

127

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

109

128

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

110

 

      client host computers.  The Mandos server uses Zeroconf to

111

 

      announce itself on the local network, and uses TLS to

112

 

      communicate securely with and to authenticate the clients.  The

113

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

114

 

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

115

 

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

116

 

      Any authenticated client is then given the stored pre-encrypted

117

 

      password for that specific client.

 

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.

118

139

    </para>

119

140

  </refsect1>

120

141

  

189

210

      </varlistentry>

190

211

      

191

212

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

192

231

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

193

232

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

194

233

        <listitem>

228

267

          </para>

229

268

        </listitem>

230

269

      </varlistentry>

 

270

      

 

271

      <varlistentry>

 

272

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

 

273

        <listitem>

 

274

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

 

275

          <para>

 

276

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

 

277

          </para>

 

278

        </listitem>

 

279

      </varlistentry>

 

280

      

 

281

      <varlistentry>

 

282

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

 

283

        <listitem>

 

284

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

 

285

        </listitem>

 

286

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

      

231

314

    </variablelist>

232

315

  </refsect1>

233

316

  

305

388

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

306

389

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

307

390

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

308

 

      longer eligible to receive the encrypted password.  The timeout,

309

 

      checker program, and interval between checks can be configured

310

 

      both globally and per client; see <citerefentry>

 

391

      longer eligible to receive the encrypted password.  (Manual

 

392

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

 

397

    </para>

 

398

  </refsect1>

 

399

  

 

400

  <refsect1 id="approval">

 

401

    <title>APPROVAL</title>

 

402

    <para>

 

403

      The server can be configured to require manual approval for a

 

404

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

 

405

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

 

406

      configured both globally and per client; see <citerefentry>

311

407

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

312

 

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

313

 

    </para>

 

408

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

 

409

      will be approved immediately without delay.

 

410

    </para>

 

411

    <para>

 

412

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

 

413

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

 

414

      the server delay before giving a client its secret, allowing

 

415

      optional manual denying of this specific client.

 

416

    </para>

 

417

    

314

418

  </refsect1>

315

419

  

316

420

  <refsect1 id="logging">

317

421

    <title>LOGGING</title>

318

422

    <para>

319

423

      The server will send log message with various severity levels to

320

 

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

 

424

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

321

425

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

322

426

      and also show them on the console.

323

427

    </para>

324

428

  </refsect1>

325

429

  

 

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

  <refsect1 id="dbus_interface">

 

443

    <title>D-BUS INTERFACE</title>

 

444

    <para>

 

445

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

 

446

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

 

447

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

 

448

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

 

449

    </para>

 

450

  </refsect1>

 

451

  

326

452

  <refsect1 id="exit_status">

327

453

    <title>EXIT STATUS</title>

328

454

    <para>

351

477

    </variablelist>

352

478

  </refsect1>

353

479

  

354

 

  <refsect1 id="file">

 

480

  <refsect1 id="files">

355

481

    <title>FILES</title>

356

482

    <para>

357

483

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

383

509

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

384

510

        <listitem>

385

511

          <para>

386

 

            The file containing the process id of

387

 

            <command>&COMMANDNAME;</command>.

 

512

            The file containing the process id of the

 

513

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

 

514

          </para>

 

515

        </listitem>

 

516

      </varlistentry>

 

517

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

388

528

          </para>

389

529

        </listitem>

390

530

      </varlistentry>

418

558

      backtrace.  This could be considered a feature.

419

559

    </para>

420

560

    <para>

421

 

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

422

 

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

423

 

      permanent storage.  This has some security implications, see

424

 

      <xref linkend="CLIENTS"/>.

425

 

    </para>

426

 

    <para>

427

 

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

428

 

      status of clients, other than analyzing its <systemitem

429

 

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

430

 

    </para>

431

 

    <para>

432

561

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

433

562

    </para>

434

563

    <para>

435

564

      Debug mode is conflated with running in the foreground.

436

565

    </para>

437

566

    <para>

438

 

      The console log messages does not show a time stamp.

439

 

    </para>

440

 

    <para>

441

567

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

442

568

      keys.

443

569

    </para>

456

582

    <informalexample>

457

583

      <para>

458

584

        Run the server in debug mode, read configuration files from

459

 

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

460

 

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

461

 

        any other official Mandos server on this host:

 

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:

462

588

      </para>

463

589

      <para>

464

590

 

483

609

  

484

610

  <refsect1 id="security">

485

611

    <title>SECURITY</title>

486

 

    <refsect2 id="SERVER">

 

612

    <refsect2 id="server">

487

613

      <title>SERVER</title>

488

614

      <para>

489

615

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

492

618

        soon after startup.

493

619

      </para>

494

620

    </refsect2>

495

 

    <refsect2 id="CLIENTS">

 

621

    <refsect2 id="clients">

496

622

      <title>CLIENTS</title>

497

623

      <para>

498

624

        The server only gives out its stored data to clients which

513

639

        compromised if they are gone for too long.

514

640

      </para>

515

641

      <para>

516

 

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

517

 

        by the server which would therefore declare the client

518

 

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

519

 

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

520

 

        regard all clients therein as valid, and hence eligible to

521

 

        receive their passwords.  Therefore, be careful when

522

 

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

523

 

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

524

 

        fake Mandos client with the keys from the non-encrypted

525

 

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

526

 

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

527

 

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

528

 

        configuration file to omit any suspect clients, and restart

529

 

        the server program.

530

 

      </para>

531

 

      <para>

532

642

        For more details on client-side security, see

533

643

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

534

644

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

539

649

  <refsect1 id="see_also">

540

650

    <title>SEE ALSO</title>

541

651

    <para>

542

 

      <citerefentry>

543

 

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

544

 

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

545

 

        <refentrytitle>mandos.conf</refentrytitle>

546

 

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

547

 

        <refentrytitle>mandos-client</refentrytitle>

548

 

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

549

 

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

550

 

      </citerefentry>

 

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>

551

662

    </para>

552

663

    <variablelist>

553

664

      <varlistentry>

• Older »

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