/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (518.1.6 to 24.1.130)
• stop comparing with revision 24.1.130

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

 

5

<!ENTITY TIMESTAMP "2011-10-22">

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>

36

38

      <holder>Teddy Hogeborn</holder>

37

39

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

38

40

    </copyright>

86

88

      <sbr/>

87

89

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

88

90

      <sbr/>

 

91

      <arg><option>--debuglevel

 

92

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

 

93

      <sbr/>

89

94

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

 

95

      <sbr/>

 

96

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

 

97

      <sbr/>

 

98

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

90

99

    </cmdsynopsis>

91

100

    <cmdsynopsis>

92

101

      <command>&COMMANDNAME;</command>

110

119

    <para>

111

120

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

112

121

      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.

 

122

      client host computers. For an introduction, see

 

123

      <citerefentry><refentrytitle>intro</refentrytitle>

 

124

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

 

125

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

 

126

      TLS to communicate securely with and to authenticate the

 

127

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

 

128

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

 

129

      not have any other addresses configured (see <xref

 

130

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

 

131

      the stored pre-encrypted password for that specific client.

121

132

    </para>

122

133

  </refsect1>

123

134

  

192

203

      </varlistentry>

193

204

      

194

205

      <varlistentry>

 

206

        <term><option>--debuglevel

 

207

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

 

208

        <listitem>

 

209

          <para>

 

210

            Set the debugging log level.

 

211

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

 

212

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

 

213

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

 

214

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

 

215

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

 

216

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

 

217

            increasing verbosity.  The default level is

 

218

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

 

219

          </para>

 

220

        </listitem>

 

221

      </varlistentry>

 

222

      

 

223

      <varlistentry>

195

224

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

196

225

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

197

226

        <listitem>

241

270

          </para>

242

271

        </listitem>

243

272

      </varlistentry>

 

273

      

 

274

      <varlistentry>

 

275

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

 

276

        <listitem>

 

277

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

 

278

        </listitem>

 

279

      </varlistentry>

 

280

      

 

281

      <varlistentry>

 

282

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

 

283

        <listitem>

 

284

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

 

285

        </listitem>

 

286

      </varlistentry>

244

287

    </variablelist>

245

288

  </refsect1>

246

289

  

318

361

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

319

362

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

320

363

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

321

 

      longer eligible to receive the encrypted password.  The timeout,

322

 

      checker program, and interval between checks can be configured

323

 

      both globally and per client; see <citerefentry>

 

364

      longer eligible to receive the encrypted password.  (Manual

 

365

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

 

366

      extended timeout, checker program, and interval between checks

 

367

      can be configured both globally and per client; see

 

368

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

 

369

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

 

370

      receiving its password will also be treated as a successful

 

371

      checker run.

 

372

    </para>

 

373

  </refsect1>

 

374

  

 

375

  <refsect1 id="approval">

 

376

    <title>APPROVAL</title>

 

377

    <para>

 

378

      The server can be configured to require manual approval for a

 

379

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

 

380

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

 

381

      configured both globally and per client; see <citerefentry>

324

382

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

325

 

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

326

 

    </para>

 

383

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

 

384

      will be approved immediately without delay.

 

385

    </para>

 

386

    <para>

 

387

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

 

388

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

 

389

      the server delay before giving a client its secret, allowing

 

390

      optional manual denying of this specific client.

 

391

    </para>

 

392

    

327

393

  </refsect1>

328

394

  

329

395

  <refsect1 id="logging">

341

407

    <para>

342

408

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

343

409

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

344

 

      Mandos-specific user, if such a user exists.

345

 

      <!-- XXX -->

 

410

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

 

411

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

346

412

    </para>

347

413

  </refsect1>

348

 

 

 

414

  

349

415

  <refsect1 id="exit_status">

350

416

    <title>EXIT STATUS</title>

351

417

    <para>

406

472

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

407

473

        <listitem>

408

474

          <para>

409

 

            The file containing the process id of

410

 

            <command>&COMMANDNAME;</command>.

 

475

            The file containing the process id of the

 

476

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

411

477

          </para>

412

478

        </listitem>

413

479

      </varlistentry>

441

507

      backtrace.  This could be considered a feature.

442

508

    </para>

443

509

    <para>

444

 

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

445

 

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

446

 

      permanent storage.  This has some security implications, see

447

 

      <xref linkend="clients"/>.

448

 

    </para>

449

 

    <para>

450

 

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

451

 

      status of clients, other than analyzing its <systemitem

452

 

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

 

510

      Currently, if a client is disabled due to having timed out, the

 

511

      server does not record this fact onto permanent storage.  This

 

512

      has some security implications, see <xref linkend="clients"/>.

453

513

    </para>

454

514

    <para>

455

515

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

458

518

      Debug mode is conflated with running in the foreground.

459

519

    </para>

460

520

    <para>

461

 

      The console log messages does not show a time stamp.

462

 

    </para>

463

 

    <para>

464

521

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

465

522

      keys.

466

523

    </para>

537

594

      </para>

538

595

      <para>

539

596

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

540

 

        by the server which would therefore declare the client

541

 

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

542

 

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

543

 

        regard all clients therein as valid, and hence eligible to

544

 

        receive their passwords.  Therefore, be careful when

545

 

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

546

 

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

547

 

        fake Mandos client with the keys from the non-encrypted

548

 

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

549

 

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

550

 

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

551

 

        configuration file to omit any suspect clients, and restart

552

 

        the server program.

 

597

        by the server which would therefore disable the client.  But

 

598

        if the server was ever restarted, it would re-read its client

 

599

        list from its configuration file and again regard all clients

 

600

        therein as enabled, and hence eligible to receive their

 

601

        passwords.  Therefore, be careful when restarting servers if

 

602

        it is suspected that a client has, in fact, been compromised

 

603

        by parties who may now be running a fake Mandos client with

 

604

        the keys from the non-encrypted initial <acronym>RAM</acronym>

 

605

        image of the client host.  What should be done in that case

 

606

        (if restarting the server program really is necessary) is to

 

607

        stop the server program, edit the configuration file to omit

 

608

        any suspect clients, and restart the server program.

553

609

      </para>

554

610

      <para>

555

611

        For more details on client-side security, see

562

618

  <refsect1 id="see_also">

563

619

    <title>SEE ALSO</title>

564

620

    <para>

565

 

      <citerefentry>

566

 

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

567

 

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

568

 

        <refentrytitle>mandos.conf</refentrytitle>

569

 

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

570

 

        <refentrytitle>mandos-client</refentrytitle>

571

 

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

572

 

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

573

 

      </citerefentry>

 

621

      <citerefentry><refentrytitle>intro</refentrytitle>

 

622

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

 

623

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

 

624

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

 

625

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

 

626

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

 

627

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

 

628

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

 

629

      <citerefentry><refentrytitle>sh</refentrytitle>

 

630

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

574

631

    </para>

575

632

    <variablelist>

576

633

      <varlistentry>

• Older »

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