/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 237.2.29)
• stop comparing with revision 237.2.29

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

 

94

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

 

95

      <sbr/>

89

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>

233

262

      </varlistentry>

234

263

      

235

264

      <varlistentry>

 

265

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

 

266

        <listitem>

 

267

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

 

268

          <para>

 

269

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

 

270

          </para>

 

271

        </listitem>

 

272

      </varlistentry>

 

273

      

 

274

      <varlistentry>

236

275

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

237

276

        <listitem>

238

277

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

239

278

        </listitem>

240

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>

241

287

    </variablelist>

242

288

  </refsect1>

243

289

  

317

363

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

318

364

      longer eligible to receive the encrypted password.  (Manual

319

365

      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>

322

 

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

 

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>

323

369

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

324

370

      receiving its password will also be treated as a successful

325

371

      checker run.

326

372

    </para>

327

373

  </refsect1>

328

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>

 

382

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

 

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

    

 

393

  </refsect1>

 

394

  

329

395

  <refsect1 id="logging">

330

396

    <title>LOGGING</title>

331

397

    <para>

336

402

    </para>

337

403

  </refsect1>

338

404

  

 

405

  <refsect1 id="dbus_interface">

 

406

    <title>D-BUS INTERFACE</title>

 

407

    <para>

 

408

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

 

409

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

 

410

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

 

411

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

 

412

    </para>

 

413

  </refsect1>

 

414

  

339

415

  <refsect1 id="exit_status">

340

416

    <title>EXIT STATUS</title>

341

417

    <para>

396

472

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

397

473

        <listitem>

398

474

          <para>

399

 

            The file containing the process id of

400

 

            <command>&COMMANDNAME;</command>.

 

475

            The file containing the process id of the

 

476

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

401

477

          </para>

402

478

        </listitem>

403

479

      </varlistentry>

431

507

      backtrace.  This could be considered a feature.

432

508

    </para>

433

509

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

 

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

443

513

    </para>

444

514

    <para>

445

515

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

448

518

      Debug mode is conflated with running in the foreground.

449

519

    </para>

450

520

    <para>

451

 

      The console log messages do not show a time stamp.

452

 

    </para>

453

 

    <para>

454

521

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

455

522

      keys.

456

523

    </para>

527

594

      </para>

528

595

      <para>

529

596

        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.

 

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.

543

609

      </para>

544

610

      <para>

545

611

        For more details on client-side security, see

552

618

  <refsect1 id="see_also">

553

619

    <title>SEE ALSO</title>

554

620

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

 

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>

564

631

    </para>

565

632

    <variablelist>

566

633

      <varlistentry>

• Older »

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