/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (443 to 536)
• stop comparing with revision 536

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 "2011-11-26">

 

5

<!ENTITY TIMESTAMP "2010-09-25">

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

36

      <holder>Teddy Hogeborn</holder>

39

37

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

40

38

    </copyright>

88

86

      <sbr/>

89

87

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

90

88

      <sbr/>

91

 

      <arg><option>--debuglevel

92

 

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

93

 

      <sbr/>

94

89

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

95

90

      <sbr/>

96

91

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

97

 

      <sbr/>

98

 

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

99

 

      <sbr/>

100

 

      <arg><option>--statedir

101

 

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

102

92

    </cmdsynopsis>

103

93

    <cmdsynopsis>

104

94

      <command>&COMMANDNAME;</command>

122

112

    <para>

123

113

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

124

114

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

125

 

      client host computers. For an introduction, see

126

 

      <citerefentry><refentrytitle>intro</refentrytitle>

127

 

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

128

 

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

129

 

      TLS to communicate securely with and to authenticate the

130

 

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

131

 

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

132

 

      not have any other addresses configured (see <xref

133

 

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

134

 

      the stored pre-encrypted password for that specific client.

 

115

      client host computers.  The Mandos server uses Zeroconf to

 

116

      announce itself on the local network, and uses TLS to

 

117

      communicate securely with and to authenticate the clients.  The

 

118

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

 

119

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

 

120

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

 

121

      Any authenticated client is then given the stored pre-encrypted

 

122

      password for that specific client.

135

123

    </para>

136

124

  </refsect1>

137

125

  

206

194

      </varlistentry>

207

195

      

208

196

      <varlistentry>

209

 

        <term><option>--debuglevel

210

 

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

211

 

        <listitem>

212

 

          <para>

213

 

            Set the debugging log level.

214

 

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

215

 

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

216

 

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

217

 

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

218

 

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

219

 

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

220

 

            increasing verbosity.  The default level is

221

 

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

222

 

          </para>

223

 

        </listitem>

224

 

      </varlistentry>

225

 

      

226

 

      <varlistentry>

227

197

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

228

198

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

229

199

        <listitem>

280

250

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

281

251

        </listitem>

282

252

      </varlistentry>

283

 

      

284

 

      <varlistentry>

285

 

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

286

 

        <listitem>

287

 

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

288

 

        </listitem>

289

 

      </varlistentry>

290

 

      

291

 

      <varlistentry>

292

 

        <term><option>--statedir

293

 

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

294

 

        <listitem>

295

 

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

296

 

        </listitem>

297

 

      </varlistentry>

298

253

    </variablelist>

299

254

  </refsect1>

300

255

  

374

329

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

375

330

      longer eligible to receive the encrypted password.  (Manual

376

331

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

377

 

      extended timeout, checker program, and interval between checks

378

 

      can be configured both globally and per client; see

379

 

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

 

332

      checker program, and interval between checks can be configured

 

333

      both globally and per client; see <citerefentry>

 

334

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

380

335

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

381

336

      receiving its password will also be treated as a successful

382

337

      checker run.

407

362

    <title>LOGGING</title>

408

363

    <para>

409

364

      The server will send log message with various severity levels to

410

 

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

 

365

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

411

366

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

412

367

      and also show them on the console.

413

368

    </para>

489

444

        </listitem>

490

445

      </varlistentry>

491

446

      <varlistentry>

492

 

        <term><filename class="devicefile">/dev/log</filename></term>

493

 

      </varlistentry>

494

 

      <varlistentry>

495

 

        <term><filename

496

 

        class="directory">/var/lib/mandos</filename></term>

497

 

        <listitem>

498

 

          <para>

499

 

            Directory where persistent state will be saved.  Change

500

 

            this with the <option>--statedir</option> option.  See

501

 

            also the <option>--no-restore</option> option.

502

 

          </para>

503

 

        </listitem>

504

 

      </varlistentry>

505

 

      <varlistentry>

506

447

        <term><filename>/dev/log</filename></term>

507

448

        <listitem>

508

449

          <para>

532

473

      backtrace.  This could be considered a feature.

533

474

    </para>

534

475

    <para>

 

476

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

 

477

      server does not record this fact onto permanent storage.  This

 

478

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

 

479

    </para>

 

480

    <para>

535

481

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

536

482

    </para>

537

483

    <para>

538

484

      Debug mode is conflated with running in the foreground.

539

485

    </para>

540

486

    <para>

 

487

      The console log messages do not show a time stamp.

 

488

    </para>

 

489

    <para>

541

490

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

542

491

      keys.

543

492

    </para>

556

505

    <informalexample>

557

506

      <para>

558

507

        Run the server in debug mode, read configuration files from

559

 

        the <filename class="directory">~/mandos</filename> directory,

560

 

        and use the Zeroconf service name <quote>Test</quote> to not

561

 

        collide with any other official Mandos server on this host:

 

508

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

 

509

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

 

510

        any other official Mandos server on this host:

562

511

      </para>

563

512

      <para>

564

513

 

613

562

        compromised if they are gone for too long.

614

563

      </para>

615

564

      <para>

 

565

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

 

566

        by the server which would therefore disable the client.  But

 

567

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

 

568

        list from its configuration file and again regard all clients

 

569

        therein as enabled, and hence eligible to receive their

 

570

        passwords.  Therefore, be careful when restarting servers if

 

571

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

 

572

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

 

573

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

 

574

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

 

575

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

 

576

        stop the server program, edit the configuration file to omit

 

577

        any suspect clients, and restart the server program.

 

578

      </para>

 

579

      <para>

616

580

        For more details on client-side security, see

617

581

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

618

582

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

623

587

  <refsect1 id="see_also">

624

588

    <title>SEE ALSO</title>

625

589

    <para>

626

 

      <citerefentry><refentrytitle>intro</refentrytitle>

627

 

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

628

 

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

629

 

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

630

 

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

631

 

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

632

 

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

633

 

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

634

 

      <citerefentry><refentrytitle>sh</refentrytitle>

635

 

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

 

590

      <citerefentry>

 

591

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

 

592

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

 

593

        <refentrytitle>mandos.conf</refentrytitle>

 

594

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

 

595

        <refentrytitle>mandos-client</refentrytitle>

 

596

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

 

597

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

 

598

      </citerefentry>

636

599

    </para>

637

600

    <variablelist>

638

601

      <varlistentry>

• Older »

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