/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (537 to 441)
• stop comparing with revision 441

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 "2010-09-25">

 

5

<!ENTITY TIMESTAMP "2011-11-26">

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>

90

95

      <sbr/>

91

96

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

92

102

    </cmdsynopsis>

93

103

    <cmdsynopsis>

94

104

      <command>&COMMANDNAME;</command>

112

122

    <para>

113

123

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

114

124

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

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.

 

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.

123

135

    </para>

124

136

  </refsect1>

125

137

  

194

206

      </varlistentry>

195

207

      

196

208

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

197

227

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

198

228

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

199

229

        <listitem>

250

280

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

251

281

        </listitem>

252

282

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

253

298

    </variablelist>

254

299

  </refsect1>

255

300

  

329

374

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

330

375

      longer eligible to receive the encrypted password.  (Manual

331

376

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

332

 

      checker program, and interval between checks can be configured

333

 

      both globally and per client; see <citerefentry>

334

 

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

 

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>

335

380

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

336

381

      receiving its password will also be treated as a successful

337

382

      checker run.

362

407

    <title>LOGGING</title>

363

408

    <para>

364

409

      The server will send log message with various severity levels to

365

 

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

 

410

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

366

411

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

367

412

      and also show them on the console.

368

413

    </para>

444

489

        </listitem>

445

490

      </varlistentry>

446

491

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

447

506

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

448

507

        <listitem>

449

508

          <para>

473

532

      backtrace.  This could be considered a feature.

474

533

    </para>

475

534

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

481

535

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

482

536

    </para>

483

537

    <para>

484

538

      Debug mode is conflated with running in the foreground.

485

539

    </para>

486

540

    <para>

487

 

      The console log messages do not show a time stamp.

488

 

    </para>

489

 

    <para>

490

541

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

491

542

      keys.

492

543

    </para>

505

556

    <informalexample>

506

557

      <para>

507

558

        Run the server in debug mode, read configuration files from

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:

 

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:

511

562

      </para>

512

563

      <para>

513

564

 

562

613

        compromised if they are gone for too long.

563

614

      </para>

564

615

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

580

616

        For more details on client-side security, see

581

617

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

582

618

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

587

623

  <refsect1 id="see_also">

588

624

    <title>SEE ALSO</title>

589

625

    <para>

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>

 

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>

599

636

    </para>

600

637

    <variablelist>

601

638

      <varlistentry>

• Older »

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