/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.7.238 to 237.2.6)
• stop comparing with revision 237.2.6

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

85

90

      <sbr/>

86

91

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

87

92

      <sbr/>

 

93

      <arg><option>--debuglevel

 

94

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

 

95

      <sbr/>

88

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>

89

109

    </cmdsynopsis>

90

110

    <cmdsynopsis>

91

111

      <command>&COMMANDNAME;</command>

109

129

    <para>

110

130

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

111

131

      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.

 

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.

120

142

    </para>

121

143

  </refsect1>

122

144

  

191

213

      </varlistentry>

192

214

      

193

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>

194

234

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

195

235

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

196

236

        <listitem>

197

 

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

 

237

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

 

238

                      xpointer="priority_compat"/>

198

239

        </listitem>

199

240

      </varlistentry>

200

241

      

236

277

        <listitem>

237

278

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

238

279

          <para>

239

 

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

240

 

        </listitem>

241

 

      </varlistentry>

 

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

      

242

326

    </variablelist>

243

327

  </refsect1>

244

328

  

316

400

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

317

401

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

318

402

      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>

 

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>

322

419

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

323

 

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

324

 

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

    

325

430

  </refsect1>

326

431

  

327

432

  <refsect1 id="logging">

328

433

    <title>LOGGING</title>

329

434

    <para>

330

435

      The server will send log message with various severity levels to

331

 

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

 

436

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

332

437

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

333

438

      and also show them on the console.

334

439

    </para>

335

440

  </refsect1>

336

441

  

337

 

  <refsect1 id="dbus">

 

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

338

455

    <title>D-BUS INTERFACE</title>

339

456

    <para>

340

457

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

341

458

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

342

 

      Mandos-specific user, if such a user exists.

343

 

      <!-- XXX -->

 

459

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

 

460

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

344

461

    </para>

345

462

  </refsect1>

346

 

 

 

463

  

347

464

  <refsect1 id="exit_status">

348

465

    <title>EXIT STATUS</title>

349

466

    <para>

401

518

        </listitem>

402

519

      </varlistentry>

403

520

      <varlistentry>

404

 

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

405

 

        <listitem>

406

 

          <para>

407

 

            The file containing the process id of

408

 

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

409

544

          </para>

410

545

        </listitem>

411

546

      </varlistentry>

439

574

      backtrace.  This could be considered a feature.

440

575

    </para>

441

576

    <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

577

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

454

578

    </para>

455

579

    <para>

456

 

      Debug mode is conflated with running in the foreground.

457

 

    </para>

458

 

    <para>

459

 

      The console log messages does not show a time stamp.

460

 

    </para>

461

 

    <para>

462

580

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

463

581

      keys.

464

582

    </para>

477

595

    <informalexample>

478

596

      <para>

479

597

        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:

 

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:

483

601

      </para>

484

602

      <para>

485

603

 

534

652

        compromised if they are gone for too long.

535

653

      </para>

536

654

      <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

655

        For more details on client-side security, see

554

656

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

555

657

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

560

662

  <refsect1 id="see_also">

561

663

    <title>SEE ALSO</title>

562

664

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

 

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>

572

675

    </para>

573

676

    <variablelist>

574

677

      <varlistentry>

• Older »

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