/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (301 to 266)
• stop comparing with revision 266

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

 

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

35

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

 

38

      <year>2012</year>

36

39

      <holder>Teddy Hogeborn</holder>

37

40

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

38

41

    </copyright>

86

89

      <sbr/>

87

90

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

88

91

      <sbr/>

 

92

      <arg><option>--debuglevel

 

93

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

 

94

      <sbr/>

 

95

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

 

96

      <sbr/>

89

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>

90

106

    </cmdsynopsis>

91

107

    <cmdsynopsis>

92

108

      <command>&COMMANDNAME;</command>

110

126

    <para>

111

127

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

112

128

      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.

 

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.

121

139

    </para>

122

140

  </refsect1>

123

141

  

192

210

      </varlistentry>

193

211

      

194

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>

195

231

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

196

232

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

197

233

        <listitem>

233

269

      </varlistentry>

234

270

      

235

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>

236

282

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

237

283

        <listitem>

238

284

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

239

285

        </listitem>

240

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

      

241

314

    </variablelist>

242

315

  </refsect1>

243

316

  

317

390

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

318

391

      longer eligible to receive the encrypted password.  (Manual

319

392

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

320

 

      checker program, and interval between checks can be configured

321

 

      both globally and per client; see <citerefentry>

 

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>

322

407

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

323

 

      <manvolnum>5</manvolnum></citerefentry>.  A client successfully

324

 

      receiving its password will also be treated as a successful

325

 

      checker run.

326

 

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

    

327

418

  </refsect1>

328

419

  

329

420

  <refsect1 id="logging">

330

421

    <title>LOGGING</title>

331

422

    <para>

332

423

      The server will send log message with various severity levels to

333

 

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

 

424

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

334

425

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

335

426

      and also show them on the console.

336

427

    </para>

337

428

  </refsect1>

338

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

  

339

452

  <refsect1 id="exit_status">

340

453

    <title>EXIT STATUS</title>

341

454

    <para>

396

509

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

397

510

        <listitem>

398

511

          <para>

399

 

            The file containing the process id of

400

 

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

401

528

          </para>

402

529

        </listitem>

403

530

      </varlistentry>

431

558

      backtrace.  This could be considered a feature.

432

559

    </para>

433

560

    <para>

434

 

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

435

 

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

436

 

      permanent storage.  This has some security implications, see

437

 

      <xref linkend="clients"/>.

438

 

    </para>

439

 

    <para>

440

 

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

441

 

      status of clients, other than analyzing its <systemitem

442

 

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

443

 

    </para>

444

 

    <para>

445

561

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

446

562

    </para>

447

563

    <para>

448

564

      Debug mode is conflated with running in the foreground.

449

565

    </para>

450

566

    <para>

451

 

      The console log messages do not show a time stamp.

452

 

    </para>

453

 

    <para>

454

567

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

455

568

      keys.

456

569

    </para>

469

582

    <informalexample>

470

583

      <para>

471

584

        Run the server in debug mode, read configuration files from

472

 

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

473

 

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

474

 

        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:

475

588

      </para>

476

589

      <para>

477

590

 

526

639

        compromised if they are gone for too long.

527

640

      </para>

528

641

      <para>

529

 

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

530

 

        by the server which would therefore declare the client

531

 

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

532

 

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

533

 

        regard all clients therein as valid, and hence eligible to

534

 

        receive their passwords.  Therefore, be careful when

535

 

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

536

 

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

537

 

        fake Mandos client with the keys from the non-encrypted

538

 

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

539

 

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

540

 

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

541

 

        configuration file to omit any suspect clients, and restart

542

 

        the server program.

543

 

      </para>

544

 

      <para>

545

642

        For more details on client-side security, see

546

643

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

547

644

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

552

649

  <refsect1 id="see_also">

553

650

    <title>SEE ALSO</title>

554

651

    <para>

555

 

      <citerefentry>

556

 

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

557

 

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

558

 

        <refentrytitle>mandos.conf</refentrytitle>

559

 

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

560

 

        <refentrytitle>mandos-client</refentrytitle>

561

 

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

562

 

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

563

 

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

564

662

    </para>

565

663

    <variablelist>

566

664

      <varlistentry>

• Older »

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