/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.43 to 221)
• stop comparing with revision 221

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 "2013-10-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>

 

39

      <year>2013</year>

35

40

      <holder>Teddy Hogeborn</holder>

36

41

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

37

42

    </copyright>

84

89

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

85

90

      <sbr/>

86

91

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

 

92

      <sbr/>

 

93

      <arg><option>--debuglevel

 

94

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

 

95

      <sbr/>

 

96

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

 

97

      <sbr/>

 

98

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

 

99

      <sbr/>

 

100

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

 

101

      <sbr/>

 

102

      <arg><option>--statedir

 

103

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

 

104

      <sbr/>

 

105

      <arg><option>--socket

 

106

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

 

107

      <sbr/>

 

108

      <arg><option>--foreground</option></arg>

87

109

    </cmdsynopsis>

88

110

    <cmdsynopsis>

89

111

      <command>&COMMANDNAME;</command>

107

129

    <para>

108

130

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

109

131

      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.

 

132

      client host computers. For an introduction, see

 

133

      <citerefentry><refentrytitle>intro</refentrytitle>

 

134

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

 

135

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

 

136

      TLS to communicate securely with and to authenticate the

 

137

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

 

138

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

 

139

      not have any other addresses configured (see <xref

 

140

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

 

141

      the stored pre-encrypted password for that specific client.

118

142

    </para>

119

143

  </refsect1>

120

144

  

189

213

      </varlistentry>

190

214

      

191

215

      <varlistentry>

 

216

        <term><option>--debuglevel

 

217

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

 

218

        <listitem>

 

219

          <para>

 

220

            Set the debugging log level.

 

221

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

 

222

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

 

223

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

 

224

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

 

225

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

 

226

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

 

227

            increasing verbosity.  The default level is

 

228

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

 

229

          </para>

 

230

        </listitem>

 

231

      </varlistentry>

 

232

      

 

233

      <varlistentry>

192

234

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

193

235

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

194

236

        <listitem>

195

 

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

 

237

          <xi:include href="mandos-options.xml"

 

238

                      xpointer="priority_compat"/>

196

239

        </listitem>

197

240

      </varlistentry>

198

241

      

228

271

          </para>

229

272

        </listitem>

230

273

      </varlistentry>

 

274

      

 

275

      <varlistentry>

 

276

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

 

277

        <listitem>

 

278

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

 

279

          <para>

 

280

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

 

281

          </para>

 

282

        </listitem>

 

283

      </varlistentry>

 

284

      

 

285

      <varlistentry>

 

286

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

 

287

        <listitem>

 

288

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

 

289

        </listitem>

 

290

      </varlistentry>

 

291

      

 

292

      <varlistentry>

 

293

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

 

294

        <listitem>

 

295

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

 

296

          <para>

 

297

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

 

298

          </para>

 

299

        </listitem>

 

300

      </varlistentry>

 

301

      

 

302

      <varlistentry>

 

303

        <term><option>--statedir

 

304

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

 

305

        <listitem>

 

306

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

 

307

        </listitem>

 

308

      </varlistentry>

 

309

      

 

310

      <varlistentry>

 

311

        <term><option>--socket

 

312

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

 

313

        <listitem>

 

314

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

 

315

        </listitem>

 

316

      </varlistentry>

 

317

      

 

318

      <varlistentry>

 

319

        <term><option>--foreground</option></term>

 

320

        <listitem>

 

321

          <xi:include href="mandos-options.xml"

 

322

                      xpointer="foreground"/>

 

323

        </listitem>

 

324

      </varlistentry>

 

325

      

231

326

    </variablelist>

232

327

  </refsect1>

233

328

  

305

400

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

306

401

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

307

402

      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>

 

403

      longer eligible to receive the encrypted password.  (Manual

 

404

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

 

405

      extended timeout, checker program, and interval between checks

 

406

      can be configured both globally and per client; see

 

407

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

 

408

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

 

409

    </para>

 

410

  </refsect1>

 

411

  

 

412

  <refsect1 id="approval">

 

413

    <title>APPROVAL</title>

 

414

    <para>

 

415

      The server can be configured to require manual approval for a

 

416

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

 

417

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

 

418

      configured both globally and per client; see <citerefentry>

311

419

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

312

 

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

313

 

    </para>

 

420

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

 

421

      will be approved immediately without delay.

 

422

    </para>

 

423

    <para>

 

424

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

 

425

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

 

426

      the server delay before giving a client its secret, allowing

 

427

      optional manual denying of this specific client.

 

428

    </para>

 

429

    

314

430

  </refsect1>

315

431

  

316

432

  <refsect1 id="logging">

317

433

    <title>LOGGING</title>

318

434

    <para>

319

435

      The server will send log message with various severity levels to

320

 

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

 

436

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

321

437

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

322

438

      and also show them on the console.

323

439

    </para>

324

440

  </refsect1>

325

441

  

 

442

  <refsect1 id="persistent_state">

 

443

    <title>PERSISTENT STATE</title>

 

444

    <para>

 

445

      Client settings, initially read from

 

446

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

 

447

      restarts, and run-time changes will override settings in

 

448

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

 

449

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

 

450

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

 

451

    </para>

 

452

  </refsect1>

 

453

  

 

454

  <refsect1 id="dbus_interface">

 

455

    <title>D-BUS INTERFACE</title>

 

456

    <para>

 

457

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

 

458

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

 

459

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

 

460

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

 

461

    </para>

 

462

  </refsect1>

 

463

  

326

464

  <refsect1 id="exit_status">

327

465

    <title>EXIT STATUS</title>

328

466

    <para>

351

489

    </variablelist>

352

490

  </refsect1>

353

491

  

354

 

  <refsect1 id="file">

 

492

  <refsect1 id="files">

355

493

    <title>FILES</title>

356

494

    <para>

357

495

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

380

518

        </listitem>

381

519

      </varlistentry>

382

520

      <varlistentry>

383

 

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

384

 

        <listitem>

385

 

          <para>

386

 

            The file containing the process id of

387

 

            <command>&COMMANDNAME;</command>.

 

521

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

 

522

        <listitem>

 

523

          <para>

 

524

            The file containing the process id of the

 

525

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

 

526

            <emphasis >Note:</emphasis> If the <filename

 

527

            class="directory">/run</filename> directory does not

 

528

            exist, <filename>/var/run/mandos.pid</filename> will be

 

529

            used instead.

 

530

          </para>

 

531

        </listitem>

 

532

      </varlistentry>

 

533

      <varlistentry>

 

534

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

 

535

      </varlistentry>

 

536

      <varlistentry>

 

537

        <term><filename

 

538

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

 

539

        <listitem>

 

540

          <para>

 

541

            Directory where persistent state will be saved.  Change

 

542

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

 

543

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

388

544

          </para>

389

545

        </listitem>

390

546

      </varlistentry>

418

574

      backtrace.  This could be considered a feature.

419

575

    </para>

420

576

    <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

577

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

433

578

    </para>

434

579

    <para>

435

 

      Debug mode is conflated with running in the foreground.

436

 

    </para>

437

 

    <para>

438

 

      The console log messages does not show a time stamp.

439

 

    </para>

440

 

    <para>

441

580

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

442

581

      keys.

443

582

    </para>

456

595

    <informalexample>

457

596

      <para>

458

597

        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:

 

598

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

 

599

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

 

600

        collide with any other official Mandos server on this host:

462

601

      </para>

463

602

      <para>

464

603

 

483

622

  

484

623

  <refsect1 id="security">

485

624

    <title>SECURITY</title>

486

 

    <refsect2 id="SERVER">

 

625

    <refsect2 id="server">

487

626

      <title>SERVER</title>

488

627

      <para>

489

628

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

492

631

        soon after startup.

493

632

      </para>

494

633

    </refsect2>

495

 

    <refsect2 id="CLIENTS">

 

634

    <refsect2 id="clients">

496

635

      <title>CLIENTS</title>

497

636

      <para>

498

637

        The server only gives out its stored data to clients which

513

652

        compromised if they are gone for too long.

514

653

      </para>

515

654

      <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

655

        For more details on client-side security, see

533

656

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

534

657

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

539

662

  <refsect1 id="see_also">

540

663

    <title>SEE ALSO</title>

541

664

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

 

665

      <citerefentry><refentrytitle>intro</refentrytitle>

 

666

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

 

667

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

 

668

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

 

669

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

 

670

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

 

671

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

 

672

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

 

673

      <citerefentry><refentrytitle>sh</refentrytitle>

 

674

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

551

675

    </para>

552

676

    <variablelist>

553

677

      <varlistentry>

• Older »

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