/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (255 to 299)
• stop comparing with revision 299

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 "2012-01-15">

 

5

<!ENTITY TIMESTAMP "2009-02-24">

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@recompile.se</email>

 

22

          <email>belorn@fukt.bsnet.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@recompile.se</email>

 

29

          <email>teddy@fukt.bsnet.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

36

      <holder>Teddy Hogeborn</holder>

40

37

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

41

38

    </copyright>

89

86

      <sbr/>

90

87

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

91

88

      <sbr/>

92

 

      <arg><option>--debuglevel

93

 

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

94

 

      <sbr/>

95

 

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

96

 

      <sbr/>

97

89

      <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

90

    </cmdsynopsis>

104

91

    <cmdsynopsis>

105

92

      <command>&COMMANDNAME;</command>

123

110

    <para>

124

111

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

125

112

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

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.

 

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.

136

121

    </para>

137

122

  </refsect1>

138

123

  

207

192

      </varlistentry>

208

193

      

209

194

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

228

195

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

229

196

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

230

197

        <listitem>

266

233

      </varlistentry>

267

234

      

268

235

      <varlistentry>

269

 

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

270

 

        <listitem>

271

 

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

272

 

          <para>

273

 

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

274

 

          </para>

275

 

        </listitem>

276

 

      </varlistentry>

277

 

      

278

 

      <varlistentry>

279

236

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

280

237

        <listitem>

281

238

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

282

239

        </listitem>

283

240

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

300

 

        </listitem>

301

 

      </varlistentry>

302

241

    </variablelist>

303

242

  </refsect1>

304

243

  

376

315

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

377

316

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

378

317

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

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>

 

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>

 

321

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

384

322

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

385

323

    </para>

386

324

  </refsect1>

387

325

  

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>

395

 

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

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

 

    

406

 

  </refsect1>

407

 

  

408

326

  <refsect1 id="logging">

409

327

    <title>LOGGING</title>

410

328

    <para>

411

329

      The server will send log message with various severity levels to

412

 

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

 

330

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

413

331

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

414

332

      and also show them on the console.

415

333

    </para>

416

334

  </refsect1>

417

335

  

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

431

 

    <title>D-BUS INTERFACE</title>

432

 

    <para>

433

 

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

434

 

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

435

 

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

436

 

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

437

 

    </para>

438

 

  </refsect1>

439

 

  

440

336

  <refsect1 id="exit_status">

441

337

    <title>EXIT STATUS</title>

442

338

    <para>

497

393

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

498

394

        <listitem>

499

395

          <para>

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.

 

396

            The file containing the process id of

 

397

            <command>&COMMANDNAME;</command>.

516

398

          </para>

517

399

        </listitem>

518

400

      </varlistentry>

546

428

      backtrace.  This could be considered a feature.

547

429

    </para>

548

430

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

549

442

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

550

443

    </para>

551

444

    <para>

552

445

      Debug mode is conflated with running in the foreground.

553

446

    </para>

554

447

    <para>

 

448

      The console log messages do not show a time stamp.

 

449

    </para>

 

450

    <para>

555

451

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

556

452

      keys.

557

453

    </para>

570

466

    <informalexample>

571

467

      <para>

572

468

        Run the server in debug mode, read configuration files from

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:

 

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:

576

472

      </para>

577

473

      <para>

578

474

 

627

523

        compromised if they are gone for too long.

628

524

      </para>

629

525

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

630

542

        For more details on client-side security, see

631

543

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

632

544

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

637

549

  <refsect1 id="see_also">

638

550

    <title>SEE ALSO</title>

639

551

    <para>

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>

 

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>

650

561

    </para>

651

562

    <variablelist>

652

563

      <varlistentry>

• Older »

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