/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.4.32 to 166)
• stop comparing with revision 166

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

 

5

<!ENTITY TIMESTAMP "2012-05-26">

 

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>

 

38

      <year>2012</year>

34

39

      <holder>Teddy Hogeborn</holder>

35

40

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

36

41

    </copyright>

37

42

    <xi:include href="legalnotice.xml"/>

38

43

  </refentryinfo>

39

 

 

 

44

  

40

45

  <refmeta>

41

46

    <refentrytitle>&COMMANDNAME;</refentrytitle>

42

47

    <manvolnum>8</manvolnum>

48

53

      Gives encrypted passwords to authenticated Mandos clients

49

54

    </refpurpose>

50

55

  </refnamediv>

51

 

 

 

56

  

52

57

  <refsynopsisdiv>

53

58

    <cmdsynopsis>

54

59

      <command>&COMMANDNAME;</command>

83

88

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

84

89

      <sbr/>

85

90

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

 

91

      <sbr/>

 

92

      <arg><option>--debuglevel

 

93

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

 

94

      <sbr/>

 

95

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

 

96

      <sbr/>

 

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>

86

106

    </cmdsynopsis>

87

107

    <cmdsynopsis>

88

108

      <command>&COMMANDNAME;</command>

100

120

      <arg choice="plain"><option>--check</option></arg>

101

121

    </cmdsynopsis>

102

122

  </refsynopsisdiv>

103

 

 

 

123

  

104

124

  <refsect1 id="description">

105

125

    <title>DESCRIPTION</title>

106

126

    <para>

107

127

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

108

128

      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.

 

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.

117

139

    </para>

118

140

  </refsect1>

119

141

  

186

208

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

187

209

        </listitem>

188

210

      </varlistentry>

189

 

 

 

211

      

 

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

      

190

230

      <varlistentry>

191

231

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

192

232

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

194

234

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

195

235

        </listitem>

196

236

      </varlistentry>

197

 

 

 

237

      

198

238

      <varlistentry>

199

239

        <term><option>--servicename

200

240

        <replaceable>NAME</replaceable></option></term>

203

243

                      xpointer="servicename"/>

204

244

        </listitem>

205

245

      </varlistentry>

206

 

 

 

246

      

207

247

      <varlistentry>

208

248

        <term><option>--configdir

209

249

        <replaceable>DIRECTORY</replaceable></option></term>

218

258

          </para>

219

259

        </listitem>

220

260

      </varlistentry>

221

 

 

 

261

      

222

262

      <varlistentry>

223

263

        <term><option>--version</option></term>

224

264

        <listitem>

227

267

          </para>

228

268

        </listitem>

229

269

      </varlistentry>

 

270

      

 

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>

 

282

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

 

283

        <listitem>

 

284

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

 

285

        </listitem>

 

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

      

230

314

    </variablelist>

231

315

  </refsect1>

232

 

 

 

316

  

233

317

  <refsect1 id="overview">

234

318

    <title>OVERVIEW</title>

235

319

    <xi:include href="overview.xml"/>

239

323

      <acronym>RAM</acronym> disk environment.

240

324

    </para>

241

325

  </refsect1>

242

 

 

 

326

  

243

327

  <refsect1 id="protocol">

244

328

    <title>NETWORK PROTOCOL</title>

245

329

    <para>

297

381

      </row>

298

382

    </tbody></tgroup></table>

299

383

  </refsect1>

300

 

 

 

384

  

301

385

  <refsect1 id="checking">

302

386

    <title>CHECKING</title>

303

387

    <para>

304

388

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

305

389

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

306

390

      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>

 

391

      longer eligible to receive the encrypted password.  (Manual

 

392

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

 

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>

310

407

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

311

 

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

312

 

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

    

313

418

  </refsect1>

314

 

 

 

419

  

315

420

  <refsect1 id="logging">

316

421

    <title>LOGGING</title>

317

422

    <para>

318

423

      The server will send log message with various severity levels to

319

 

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

 

424

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

320

425

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

321

426

      and also show them on the console.

322

427

    </para>

323

428

  </refsect1>

324

 

 

 

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

  

325

452

  <refsect1 id="exit_status">

326

453

    <title>EXIT STATUS</title>

327

454

    <para>

329

456

      critical error is encountered.

330

457

    </para>

331

458

  </refsect1>

332

 

 

 

459

  

333

460

  <refsect1 id="environment">

334

461

    <title>ENVIRONMENT</title>

335

462

    <variablelist>

349

476

      </varlistentry>

350

477

    </variablelist>

351

478

  </refsect1>

352

 

 

353

 

  <refsect1 id="file">

 

479

  

 

480

  <refsect1 id="files">

354

481

    <title>FILES</title>

355

482

    <para>

356

483

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

382

509

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

383

510

        <listitem>

384

511

          <para>

385

 

            The file containing the process id of

386

 

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

387

528

          </para>

388

529

        </listitem>

389

530

      </varlistentry>

417

558

      backtrace.  This could be considered a feature.

418

559

    </para>

419

560

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

429

 

    </para>

430

 

    <para>

431

561

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

432

562

    </para>

433

563

    <para>

434

564

      Debug mode is conflated with running in the foreground.

435

565

    </para>

436

566

    <para>

437

 

      The console log messages does not show a time stamp.

438

 

    </para>

439

 

    <para>

440

567

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

441

568

      keys.

442

569

    </para>

455

582

    <informalexample>

456

583

      <para>

457

584

        Run the server in debug mode, read configuration files from

458

 

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

459

 

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

460

 

        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:

461

588

      </para>

462

589

      <para>

463

590

 

479

606

      </para>

480

607

    </informalexample>

481

608

  </refsect1>

482

 

 

 

609

  

483

610

  <refsect1 id="security">

484

611

    <title>SECURITY</title>

485

 

    <refsect2 id="SERVER">

 

612

    <refsect2 id="server">

486

613

      <title>SERVER</title>

487

614

      <para>

488

615

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

491

618

        soon after startup.

492

619

      </para>

493

620

    </refsect2>

494

 

    <refsect2 id="CLIENTS">

 

621

    <refsect2 id="clients">

495

622

      <title>CLIENTS</title>

496

623

      <para>

497

624

        The server only gives out its stored data to clients which

504

631

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

505

632

        <manvolnum>5</manvolnum></citerefentry>)

506

633

        <emphasis>must</emphasis> be made non-readable by anyone

507

 

        except the user running the server.

 

634

        except the user starting the server (usually root).

508

635

      </para>

509

636

      <para>

510

637

        As detailed in <xref linkend="checking"/>, the status of all

512

639

        compromised if they are gone for too long.

513

640

      </para>

514

641

      <para>

515

 

        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.

529

 

      </para>

530

 

      <para>

531

642

        For more details on client-side security, see

532

 

        <citerefentry><refentrytitle>password-request</refentrytitle>

 

643

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

533

644

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

534

645

      </para>

535

646

    </refsect2>

536

647

  </refsect1>

537

 

 

 

648

  

538

649

  <refsect1 id="see_also">

539

650

    <title>SEE ALSO</title>

540

651

    <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>password-request</refentrytitle>

547

 

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

548

 

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

549

 

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

550

662

    </para>

551

663

    <variablelist>

552

664

      <varlistentry>

• Older »

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