/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.51 to 237.2.19)
• stop comparing with revision 237.2.19

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-02-24">

 

5

<!ENTITY TIMESTAMP "2014-06-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

35

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

 

39

      <year>2013</year>

36

40

      <holder>Teddy Hogeborn</holder>

37

41

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

38

42

    </copyright>

86

90

      <sbr/>

87

91

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

88

92

      <sbr/>

 

93

      <arg><option>--debuglevel

 

94

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

 

95

      <sbr/>

 

96

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

 

97

      <sbr/>

89

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>

 

109

      <sbr/>

 

110

      <arg><option>--no-zeroconf</option></arg>

90

111

    </cmdsynopsis>

91

112

    <cmdsynopsis>

92

113

      <command>&COMMANDNAME;</command>

110

131

    <para>

111

132

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

112

133

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

113

 

      client host computers.  The Mandos server uses Zeroconf to

114

 

      announce itself on the local network, and uses TLS to

115

 

      communicate securely with and to authenticate the clients.  The

116

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

117

 

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

118

 

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

119

 

      Any authenticated client is then given the stored pre-encrypted

120

 

      password for that specific client.

 

134

      client host computers. For an introduction, see

 

135

      <citerefentry><refentrytitle>intro</refentrytitle>

 

136

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

 

137

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

 

138

      TLS to communicate securely with and to authenticate the

 

139

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

 

140

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

 

141

      not have any other addresses configured (see <xref

 

142

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

 

143

      the stored pre-encrypted password for that specific client.

121

144

    </para>

122

145

  </refsect1>

123

146

  

192

215

      </varlistentry>

193

216

      

194

217

      <varlistentry>

 

218

        <term><option>--debuglevel

 

219

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

 

220

        <listitem>

 

221

          <para>

 

222

            Set the debugging log level.

 

223

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

 

224

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

 

225

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

 

226

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

 

227

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

 

228

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

 

229

            increasing verbosity.  The default level is

 

230

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

 

231

          </para>

 

232

        </listitem>

 

233

      </varlistentry>

 

234

      

 

235

      <varlistentry>

195

236

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

196

237

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

197

238

        <listitem>

198

 

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

 

239

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

 

240

                      xpointer="priority_compat"/>

199

241

        </listitem>

200

242

      </varlistentry>

201

243

      

233

275

      </varlistentry>

234

276

      

235

277

      <varlistentry>

 

278

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

 

279

        <listitem>

 

280

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

 

281

          <para>

 

282

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

 

283

          </para>

 

284

        </listitem>

 

285

      </varlistentry>

 

286

      

 

287

      <varlistentry>

236

288

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

237

289

        <listitem>

238

290

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

239

291

        </listitem>

240

292

      </varlistentry>

 

293

      

 

294

      <varlistentry>

 

295

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

 

296

        <listitem>

 

297

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

 

298

          <para>

 

299

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

 

300

          </para>

 

301

        </listitem>

 

302

      </varlistentry>

 

303

      

 

304

      <varlistentry>

 

305

        <term><option>--statedir

 

306

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

 

307

        <listitem>

 

308

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

 

309

        </listitem>

 

310

      </varlistentry>

 

311

      

 

312

      <varlistentry>

 

313

        <term><option>--socket

 

314

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

 

315

        <listitem>

 

316

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

 

317

        </listitem>

 

318

      </varlistentry>

 

319

      

 

320

      <varlistentry>

 

321

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

 

322

        <listitem>

 

323

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

 

324

                      xpointer="foreground"/>

 

325

        </listitem>

 

326

      </varlistentry>

 

327

      

 

328

      <varlistentry>

 

329

        <term><option>--no-zeroconf</option></term>

 

330

        <listitem>

 

331

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

 

332

        </listitem>

 

333

      </varlistentry>

 

334

      

241

335

    </variablelist>

242

336

  </refsect1>

243

337

  

315

409

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

316

410

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

317

411

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

318

 

      longer eligible to receive the encrypted password.  The timeout,

319

 

      checker program, and interval between checks can be configured

320

 

      both globally and per client; see <citerefentry>

 

412

      longer eligible to receive the encrypted password.  (Manual

 

413

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

 

414

      extended timeout, checker program, and interval between checks

 

415

      can be configured both globally and per client; see

 

416

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

 

417

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

 

418

    </para>

 

419

  </refsect1>

 

420

  

 

421

  <refsect1 id="approval">

 

422

    <title>APPROVAL</title>

 

423

    <para>

 

424

      The server can be configured to require manual approval for a

 

425

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

 

426

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

 

427

      configured both globally and per client; see <citerefentry>

321

428

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

322

 

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

323

 

    </para>

 

429

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

 

430

      will be approved immediately without delay.

 

431

    </para>

 

432

    <para>

 

433

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

 

434

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

 

435

      the server delay before giving a client its secret, allowing

 

436

      optional manual denying of this specific client.

 

437

    </para>

 

438

    

324

439

  </refsect1>

325

440

  

326

441

  <refsect1 id="logging">

327

442

    <title>LOGGING</title>

328

443

    <para>

329

444

      The server will send log message with various severity levels to

330

 

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

 

445

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

331

446

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

332

447

      and also show them on the console.

333

448

    </para>

334

449

  </refsect1>

335

450

  

 

451

  <refsect1 id="persistent_state">

 

452

    <title>PERSISTENT STATE</title>

 

453

    <para>

 

454

      Client settings, initially read from

 

455

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

 

456

      restarts, and run-time changes will override settings in

 

457

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

 

458

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

 

459

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

 

460

    </para>

 

461

  </refsect1>

 

462

  

 

463

  <refsect1 id="dbus_interface">

 

464

    <title>D-BUS INTERFACE</title>

 

465

    <para>

 

466

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

 

467

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

 

468

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

 

469

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

 

470

    </para>

 

471

  </refsect1>

 

472

  

336

473

  <refsect1 id="exit_status">

337

474

    <title>EXIT STATUS</title>

338

475

    <para>

390

527

        </listitem>

391

528

      </varlistentry>

392

529

      <varlistentry>

393

 

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

394

 

        <listitem>

395

 

          <para>

396

 

            The file containing the process id of

397

 

            <command>&COMMANDNAME;</command>.

 

530

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

 

531

        <listitem>

 

532

          <para>

 

533

            The file containing the process id of the

 

534

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

 

535

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

 

536

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

 

537

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

 

538

            used instead.

 

539

          </para>

 

540

        </listitem>

 

541

      </varlistentry>

 

542

      <varlistentry>

 

543

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

 

544

      </varlistentry>

 

545

      <varlistentry>

 

546

        <term><filename

 

547

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

 

548

        <listitem>

 

549

          <para>

 

550

            Directory where persistent state will be saved.  Change

 

551

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

 

552

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

398

553

          </para>

399

554

        </listitem>

400

555

      </varlistentry>

428

583

      backtrace.  This could be considered a feature.

429

584

    </para>

430

585

    <para>

431

 

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

432

 

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

433

 

      permanent storage.  This has some security implications, see

434

 

      <xref linkend="clients"/>.

435

 

    </para>

436

 

    <para>

437

 

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

438

 

      status of clients, other than analyzing its <systemitem

439

 

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

440

 

    </para>

441

 

    <para>

442

586

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

443

587

    </para>

444

588

    <para>

445

 

      Debug mode is conflated with running in the foreground.

446

 

    </para>

447

 

    <para>

448

 

      The console log messages do not show a time stamp.

449

 

    </para>

450

 

    <para>

451

589

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

452

590

      keys.

453

591

    </para>

466

604

    <informalexample>

467

605

      <para>

468

606

        Run the server in debug mode, read configuration files from

469

 

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

470

 

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

471

 

        any other official Mandos server on this host:

 

607

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

 

608

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

 

609

        collide with any other official Mandos server on this host:

472

610

      </para>

473

611

      <para>

474

612

 

523

661

        compromised if they are gone for too long.

524

662

      </para>

525

663

      <para>

526

 

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

527

 

        by the server which would therefore declare the client

528

 

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

529

 

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

530

 

        regard all clients therein as valid, and hence eligible to

531

 

        receive their passwords.  Therefore, be careful when

532

 

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

533

 

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

534

 

        fake Mandos client with the keys from the non-encrypted

535

 

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

536

 

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

537

 

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

538

 

        configuration file to omit any suspect clients, and restart

539

 

        the server program.

540

 

      </para>

541

 

      <para>

542

664

        For more details on client-side security, see

543

665

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

544

666

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

549

671

  <refsect1 id="see_also">

550

672

    <title>SEE ALSO</title>

551

673

    <para>

552

 

      <citerefentry>

553

 

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

554

 

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

555

 

        <refentrytitle>mandos.conf</refentrytitle>

556

 

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

557

 

        <refentrytitle>mandos-client</refentrytitle>

558

 

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

559

 

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

560

 

      </citerefentry>

 

674

      <citerefentry><refentrytitle>intro</refentrytitle>

 

675

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

 

676

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

 

677

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

 

678

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

 

679

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

 

680

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

 

681

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

 

682

      <citerefentry><refentrytitle>sh</refentrytitle>

 

683

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

561

684

    </para>

562

685

    <variablelist>

563

686

      <varlistentry>

• Older »

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