/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.30 to 243)
• stop comparing with revision 243

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-12-28">

 

5

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

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>

85

89

      <sbr/>

86

90

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

87

91

      <sbr/>

 

92

      <arg><option>--debuglevel

 

93

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

 

94

      <sbr/>

88

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>

89

103

    </cmdsynopsis>

90

104

    <cmdsynopsis>

91

105

      <command>&COMMANDNAME;</command>

109

123

    <para>

110

124

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

111

125

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

112

 

      client host computers.  The Mandos server uses Zeroconf to

113

 

      announce itself on the local network, and uses TLS to

114

 

      communicate securely with and to authenticate the clients.  The

115

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

116

 

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

117

 

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

118

 

      Any authenticated client is then given the stored pre-encrypted

119

 

      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.

120

136

    </para>

121

137

  </refsect1>

122

138

  

191

207

      </varlistentry>

192

208

      

193

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>

194

228

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

195

229

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

196

230

        <listitem>

236

270

        <listitem>

237

271

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

238

272

          <para>

239

 

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

 

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

240

300

        </listitem>

241

301

      </varlistentry>

242

302

    </variablelist>

316

376

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

317

377

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

318

378

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

319

 

      longer eligible to receive the encrypted password.  The timeout,

320

 

      checker program, and interval between checks can be configured

321

 

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

 

385

    </para>

 

386

  </refsect1>

 

387

  

 

388

  <refsect1 id="approval">

 

389

    <title>APPROVAL</title>

 

390

    <para>

 

391

      The server can be configured to require manual approval for a

 

392

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

 

393

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

 

394

      configured both globally and per client; see <citerefentry>

322

395

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

323

 

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

324

 

    </para>

 

396

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

 

397

      will be approved immediately without delay.

 

398

    </para>

 

399

    <para>

 

400

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

 

401

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

 

402

      the server delay before giving a client its secret, allowing

 

403

      optional manual denying of this specific client.

 

404

    </para>

 

405

    

325

406

  </refsect1>

326

407

  

327

408

  <refsect1 id="logging">

328

409

    <title>LOGGING</title>

329

410

    <para>

330

411

      The server will send log message with various severity levels to

331

 

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

 

412

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

332

413

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

333

414

      and also show them on the console.

334

415

    </para>

335

416

  </refsect1>

336

417

  

337

 

  <refsect1 id="dbus">

 

418

  <refsect1 id="persistent_state">

 

419

    <title>PERSISTENT STATE</title>

 

420

    <para>

 

421

      Client settings, initially read from

 

422

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

 

423

      restarts, and run-time changes will override settings in

 

424

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

 

425

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

 

426

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

 

427

    </para>

 

428

  </refsect1>

 

429

  

 

430

  <refsect1 id="dbus_interface">

338

431

    <title>D-BUS INTERFACE</title>

339

432

    <para>

340

433

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

341

434

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

342

 

      Mandos-specific user, if such a user exists.

343

 

      <!-- XXX -->

 

435

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

 

436

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

344

437

    </para>

345

438

  </refsect1>

346

 

 

 

439

  

347

440

  <refsect1 id="exit_status">

348

441

    <title>EXIT STATUS</title>

349

442

    <para>

404

497

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

405

498

        <listitem>

406

499

          <para>

407

 

            The file containing the process id of

408

 

            <command>&COMMANDNAME;</command>.

 

500

            The file containing the process id of the

 

501

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

 

502

          </para>

 

503

        </listitem>

 

504

      </varlistentry>

 

505

      <varlistentry>

 

506

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

 

507

      </varlistentry>

 

508

      <varlistentry>

 

509

        <term><filename

 

510

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

 

511

        <listitem>

 

512

          <para>

 

513

            Directory where persistent state will be saved.  Change

 

514

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

 

515

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

409

516

          </para>

410

517

        </listitem>

411

518

      </varlistentry>

439

546

      backtrace.  This could be considered a feature.

440

547

    </para>

441

548

    <para>

442

 

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

443

 

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

444

 

      permanent storage.  This has some security implications, see

445

 

      <xref linkend="clients"/>.

446

 

    </para>

447

 

    <para>

448

 

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

449

 

      status of clients, other than analyzing its <systemitem

450

 

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

451

 

    </para>

452

 

    <para>

453

549

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

454

550

    </para>

455

551

    <para>

456

552

      Debug mode is conflated with running in the foreground.

457

553

    </para>

458

554

    <para>

459

 

      The console log messages does not show a time stamp.

460

 

    </para>

461

 

    <para>

462

555

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

463

556

      keys.

464

557

    </para>

477

570

    <informalexample>

478

571

      <para>

479

572

        Run the server in debug mode, read configuration files from

480

 

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

481

 

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

482

 

        any other official Mandos server on this host:

 

573

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

 

574

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

 

575

        collide with any other official Mandos server on this host:

483

576

      </para>

484

577

      <para>

485

578

 

534

627

        compromised if they are gone for too long.

535

628

      </para>

536

629

      <para>

537

 

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

538

 

        by the server which would therefore declare the client

539

 

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

540

 

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

541

 

        regard all clients therein as valid, and hence eligible to

542

 

        receive their passwords.  Therefore, be careful when

543

 

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

544

 

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

545

 

        fake Mandos client with the keys from the non-encrypted

546

 

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

547

 

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

548

 

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

549

 

        configuration file to omit any suspect clients, and restart

550

 

        the server program.

551

 

      </para>

552

 

      <para>

553

630

        For more details on client-side security, see

554

631

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

555

632

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

560

637

  <refsect1 id="see_also">

561

638

    <title>SEE ALSO</title>

562

639

    <para>

563

 

      <citerefentry>

564

 

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

565

 

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

566

 

        <refentrytitle>mandos.conf</refentrytitle>

567

 

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

568

 

        <refentrytitle>mandos-client</refentrytitle>

569

 

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

570

 

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

571

 

      </citerefentry>

 

640

      <citerefentry><refentrytitle>intro</refentrytitle>

 

641

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

 

642

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

 

643

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

 

644

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

 

645

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

 

646

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

 

647

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

 

648

      <citerefentry><refentrytitle>sh</refentrytitle>

 

649

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

572

650

    </para>

573

651

    <variablelist>

574

652

      <varlistentry>

• Older »

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