/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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

• reverse the comparison (237.12.12 to 237.2.208)
• stop comparing with revision 237.2.208

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

 

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>

34

34

      <year>2008</year>

35

35

      <year>2009</year>

36

36

      <year>2010</year>

 

37

      <year>2011</year>

37

38

      <holder>Teddy Hogeborn</holder>

38

39

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

39

40

    </copyright>

87

88

      <sbr/>

88

89

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

89

90

      <sbr/>

 

91

      <arg><option>--debuglevel

 

92

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

 

93

      <sbr/>

90

94

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

91

95

      <sbr/>

92

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>

93

102

    </cmdsynopsis>

94

103

    <cmdsynopsis>

95

104

      <command>&COMMANDNAME;</command>

113

122

    <para>

114

123

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

115

124

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

116

 

      client host computers.  The Mandos server uses Zeroconf to

117

 

      announce itself on the local network, and uses TLS to

118

 

      communicate securely with and to authenticate the clients.  The

119

 

      Mandos server uses IPv6 to allow Mandos clients to use IPv6

120

 

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

121

 

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

122

 

      Any authenticated client is then given the stored pre-encrypted

123

 

      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.

124

135

    </para>

125

136

  </refsect1>

126

137

  

195

206

      </varlistentry>

196

207

      

197

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>

198

227

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

199

228

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

200

229

        <listitem>

251

280

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

252

281

        </listitem>

253

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>

254

298

    </variablelist>

255

299

  </refsect1>

256

300

  

330

374

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

331

375

      longer eligible to receive the encrypted password.  (Manual

332

376

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

333

 

      checker program, and interval between checks can be configured

334

 

      both globally and per client; see <citerefentry>

335

 

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

336

380

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

337

381

      receiving its password will also be treated as a successful

338

382

      checker run.

445

489

        </listitem>

446

490

      </varlistentry>

447

491

      <varlistentry>

 

492

        <term><filename

 

493

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

 

494

        <listitem>

 

495

          <para>

 

496

            Directory where persistent state will be saved.  Change

 

497

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

 

498

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

 

499

          </para>

 

500

        </listitem>

 

501

      </varlistentry>

 

502

      <varlistentry>

448

503

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

449

504

        <listitem>

450

505

          <para>

474

529

      backtrace.  This could be considered a feature.

475

530

    </para>

476

531

    <para>

477

 

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

478

 

      server does not record this fact onto permanent storage.  This

479

 

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

480

 

    </para>

481

 

    <para>

482

532

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

483

533

    </para>

484

534

    <para>

485

535

      Debug mode is conflated with running in the foreground.

486

536

    </para>

487

537

    <para>

488

 

      The console log messages do not show a time stamp.

489

 

    </para>

490

 

    <para>

491

538

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

492

539

      keys.

493

540

    </para>

506

553

    <informalexample>

507

554

      <para>

508

555

        Run the server in debug mode, read configuration files from

509

 

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

510

 

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

511

 

        any other official Mandos server on this host:

 

556

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

 

557

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

 

558

        collide with any other official Mandos server on this host:

512

559

      </para>

513

560

      <para>

514

561

 

563

610

        compromised if they are gone for too long.

564

611

      </para>

565

612

      <para>

566

 

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

567

 

        by the server which would therefore disable the client.  But

568

 

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

569

 

        list from its configuration file and again regard all clients

570

 

        therein as enabled, and hence eligible to receive their

571

 

        passwords.  Therefore, be careful when restarting servers if

572

 

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

573

 

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

574

 

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

575

 

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

576

 

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

577

 

        stop the server program, edit the configuration file to omit

578

 

        any suspect clients, and restart the server program.

579

 

      </para>

580

 

      <para>

581

613

        For more details on client-side security, see

582

614

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

583

615

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

588

620

  <refsect1 id="see_also">

589

621

    <title>SEE ALSO</title>

590

622

    <para>

591

 

      <citerefentry>

592

 

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

593

 

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

594

 

        <refentrytitle>mandos.conf</refentrytitle>

595

 

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

596

 

        <refentrytitle>mandos-client</refentrytitle>

597

 

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

598

 

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

599

 

      </citerefentry>

 

623

      <citerefentry><refentrytitle>intro</refentrytitle>

 

624

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

 

625

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

 

626

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

 

627

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

 

628

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

 

629

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

 

630

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

 

631

      <citerefentry><refentrytitle>sh</refentrytitle>

 

632

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

600

633

    </para>

601

634

    <variablelist>

602

635

      <varlistentry>

• Older »

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