/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (289 to 212)
• stop comparing with revision 212

Show diffs side-by-side

added

removed

mandos.xml

1

1

<?xml version="1.0" encoding="UTF-8"?>

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

 

<!ENTITY VERSION "1.0">

5

4

<!ENTITY COMMANDNAME "mandos">

6

 

<!ENTITY TIMESTAMP "2008-09-21">

 

5

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

 

6

<!ENTITY % common SYSTEM "common.ent">

 

7

%common;

7

8

]>

8

9

 

9

10

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">

10

 

  <refentryinfo>

 

11

   <refentryinfo>

11

12

    <title>Mandos Manual</title>

12

13

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

13

14

    <productname>Mandos</productname>

14

 

    <productnumber>&VERSION;</productnumber>

 

15

    <productnumber>&version;</productnumber>

15

16

    <date>&TIMESTAMP;</date>

16

17

    <authorgroup>

17

18

      <author>

18

19

        <firstname>Björn</firstname>

19

20

        <surname>Påhlsson</surname>

20

21

        <address>

21

 

          <email>belorn@fukt.bsnet.se</email>

 

22

          <email>belorn@recompile.se</email>

22

23

        </address>

23

24

      </author>

24

25

      <author>

25

26

        <firstname>Teddy</firstname>

26

27

        <surname>Hogeborn</surname>

27

28

        <address>

28

 

          <email>teddy@fukt.bsnet.se</email>

 

29

          <email>teddy@recompile.se</email>

29

30

        </address>

30

31

      </author>

31

32

    </authorgroup>

32

33

    <copyright>

33

34

      <year>2008</year>

 

35

      <year>2009</year>

 

36

      <year>2010</year>

 

37

      <year>2011</year>

34

38

      <holder>Teddy Hogeborn</holder>

35

39

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

36

40

    </copyright>

83

87

      <replaceable>DIRECTORY</replaceable></option></arg>

84

88

      <sbr/>

85

89

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

 

90

      <sbr/>

 

91

      <arg><option>--debuglevel

 

92

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

 

93

      <sbr/>

 

94

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

 

95

      <sbr/>

 

96

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

86

97

    </cmdsynopsis>

87

98

    <cmdsynopsis>

88

99

      <command>&COMMANDNAME;</command>

106

117

    <para>

107

118

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

108

119

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

109

 

      client host computers.  The Mandos server uses Zeroconf to

110

 

      announce itself on the local network, and uses TLS to

111

 

      communicate securely with and to authenticate the clients.  The

112

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

113

 

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

114

 

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

115

 

      Any authenticated client is then given the stored pre-encrypted

116

 

      password for that specific client.

 

120

      client host computers. For an introduction, see

 

121

      <citerefentry><refentrytitle>intro</refentrytitle>

 

122

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

 

123

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

 

124

      TLS to communicate securely with and to authenticate the

 

125

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

 

126

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

 

127

      not have any other addresses configured (see <xref

 

128

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

 

129

      the stored pre-encrypted password for that specific client.

117

130

    </para>

118

131

  </refsect1>

119

132

  

188

201

      </varlistentry>

189

202

      

190

203

      <varlistentry>

 

204

        <term><option>--debuglevel

 

205

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

 

206

        <listitem>

 

207

          <para>

 

208

            Set the debugging log level.

 

209

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

 

210

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

 

211

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

 

212

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

 

213

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

 

214

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

 

215

            increasing verbosity.  The default level is

 

216

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

 

217

          </para>

 

218

        </listitem>

 

219

      </varlistentry>

 

220

      

 

221

      <varlistentry>

191

222

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

192

223

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

193

224

        <listitem>

227

258

          </para>

228

259

        </listitem>

229

260

      </varlistentry>

 

261

      

 

262

      <varlistentry>

 

263

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

 

264

        <listitem>

 

265

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

 

266

          <para>

 

267

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

 

268

          </para>

 

269

        </listitem>

 

270

      </varlistentry>

 

271

      

 

272

      <varlistentry>

 

273

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

 

274

        <listitem>

 

275

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

 

276

        </listitem>

 

277

      </varlistentry>

230

278

    </variablelist>

231

279

  </refsect1>

232

280

  

304

352

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

305

353

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

306

354

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

307

 

      longer eligible to receive the encrypted password.  The timeout,

308

 

      checker program, and interval between checks can be configured

309

 

      both globally and per client; see <citerefentry>

 

355

      longer eligible to receive the encrypted password.  (Manual

 

356

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

 

357

      extended timeout, checker program, and interval between checks

 

358

      can be configured both globally and per client; see

 

359

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

 

360

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

 

361

      receiving its password will also be treated as a successful

 

362

      checker run.

 

363

    </para>

 

364

  </refsect1>

 

365

  

 

366

  <refsect1 id="approval">

 

367

    <title>APPROVAL</title>

 

368

    <para>

 

369

      The server can be configured to require manual approval for a

 

370

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

 

371

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

 

372

      configured both globally and per client; see <citerefentry>

310

373

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

311

 

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

312

 

    </para>

 

374

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

 

375

      will be approved immediately without delay.

 

376

    </para>

 

377

    <para>

 

378

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

 

379

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

 

380

      the server delay before giving a client its secret, allowing

 

381

      optional manual denying of this specific client.

 

382

    </para>

 

383

    

313

384

  </refsect1>

314

385

  

315

386

  <refsect1 id="logging">

322

393

    </para>

323

394

  </refsect1>

324

395

  

 

396

  <refsect1 id="dbus_interface">

 

397

    <title>D-BUS INTERFACE</title>

 

398

    <para>

 

399

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

 

400

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

 

401

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

 

402

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

 

403

    </para>

 

404

  </refsect1>

 

405

  

325

406

  <refsect1 id="exit_status">

326

407

    <title>EXIT STATUS</title>

327

408

    <para>

350

431

    </variablelist>

351

432

  </refsect1>

352

433

  

353

 

  <refsect1 id="file">

 

434

  <refsect1 id="files">

354

435

    <title>FILES</title>

355

436

    <para>

356

437

      Use the <option>--configdir</option> option to change where

382

463

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

383

464

        <listitem>

384

465

          <para>

385

 

            The file containing the process id of

386

 

            <command>&COMMANDNAME;</command>.

 

466

            The file containing the process id of the

 

467

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

387

468

          </para>

388

469

        </listitem>

389

470

      </varlistentry>

417

498

      backtrace.  This could be considered a feature.

418

499

    </para>

419

500

    <para>

420

 

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

421

 

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

422

 

      permanent storage.  This has some security implications, see

423

 

      <xref linkend="CLIENTS"/>.

424

 

    </para>

425

 

    <para>

426

 

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

427

 

      status of clients, other than analyzing its <systemitem

428

 

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

 

501

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

 

502

      server does not record this fact onto permanent storage.  This

 

503

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

429

504

    </para>

430

505

    <para>

431

506

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

434

509

      Debug mode is conflated with running in the foreground.

435

510

    </para>

436

511

    <para>

437

 

      The console log messages does not show a time stamp.

 

512

      The console log messages do not show a time stamp.

438

513

    </para>

439

514

    <para>

440

515

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

482

557

  

483

558

  <refsect1 id="security">

484

559

    <title>SECURITY</title>

485

 

    <refsect2 id="SERVER">

 

560

    <refsect2 id="server">

486

561

      <title>SERVER</title>

487

562

      <para>

488

563

        Running this <command>&COMMANDNAME;</command> server program

491

566

        soon after startup.

492

567

      </para>

493

568

    </refsect2>

494

 

    <refsect2 id="CLIENTS">

 

569

    <refsect2 id="clients">

495

570

      <title>CLIENTS</title>

496

571

      <para>

497

572

        The server only gives out its stored data to clients which

513

588

      </para>

514

589

      <para>

515

590

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

516

 

        by the server which would therefore declare the client

517

 

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

518

 

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

519

 

        regard all clients therein as valid, and hence eligible to

520

 

        receive their passwords.  Therefore, be careful when

521

 

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

522

 

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

523

 

        fake Mandos client with the keys from the non-encrypted

524

 

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

525

 

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

526

 

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

527

 

        configuration file to omit any suspect clients, and restart

528

 

        the server program.

 

591

        by the server which would therefore disable the client.  But

 

592

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

 

593

        list from its configuration file and again regard all clients

 

594

        therein as enabled, and hence eligible to receive their

 

595

        passwords.  Therefore, be careful when restarting servers if

 

596

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

 

597

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

 

598

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

 

599

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

 

600

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

 

601

        stop the server program, edit the configuration file to omit

 

602

        any suspect clients, and restart the server program.

529

603

      </para>

530

604

      <para>

531

605

        For more details on client-side security, see

538

612

  <refsect1 id="see_also">

539

613

    <title>SEE ALSO</title>

540

614

    <para>

541

 

      <citerefentry>

542

 

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

543

 

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

544

 

        <refentrytitle>mandos.conf</refentrytitle>

545

 

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

546

 

        <refentrytitle>mandos-client</refentrytitle>

547

 

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

548

 

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

549

 

      </citerefentry>

 

615

      <citerefentry><refentrytitle>intro</refentrytitle>

 

616

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

 

617

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

 

618

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

 

619

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

 

620

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

 

621

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

 

622

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

 

623

      <citerefentry><refentrytitle>sh</refentrytitle>

 

624

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

550

625

    </para>

551

626

    <variablelist>

552

627

      <varlistentry>

• Older »

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