/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

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

• reverse the comparison (24.1.180 to 594)
• stop comparing with revision 594

Show diffs side-by-side

added

removed

mandos-clients.conf.xml

3

3

        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

4

4

<!ENTITY CONFNAME "mandos-clients.conf">

5

5

<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">

6

 

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

 

6

<!ENTITY TIMESTAMP "2011-08-08">

7

7

<!ENTITY % common SYSTEM "common.ent">

8

8

%common;

9

9

]>

20

20

        <firstname>Björn</firstname>

21

21

        <surname>Påhlsson</surname>

22

22

        <address>

23

 

          <email>belorn@recompile.se</email>

 

23

          <email>belorn@fukt.bsnet.se</email>

24

24

        </address>

25

25

      </author>

26

26

      <author>

27

27

        <firstname>Teddy</firstname>

28

28

        <surname>Hogeborn</surname>

29

29

        <address>

30

 

          <email>teddy@recompile.se</email>

 

30

          <email>teddy@fukt.bsnet.se</email>

31

31

        </address>

32

32

      </author>

33

33

    </authorgroup>

36

36

      <year>2009</year>

37

37

      <year>2010</year>

38

38

      <year>2011</year>

39

 

      <year>2012</year>

40

39

      <holder>Teddy Hogeborn</holder>

41

40

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

42

41

    </copyright>

66

65

      ><refentrytitle>mandos</refentrytitle>

67

66

      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.

68

67

      The file needs to list all clients that should be able to use

69

 

      the service.  The settings in this file can be overridden by

70

 

      runtime changes to the server, which it saves across restarts.

71

 

      (See the section called <quote>PERSISTENT STATE</quote> in

72

 

      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum

73

 

      >8</manvolnum></citerefentry>.)  However, any <emphasis

74

 

      >changes</emphasis> to this file (including adding and removing

75

 

      clients) will, at startup, override changes done during runtime.

 

68

      the service.  All clients listed will be regarded as enabled,

 

69

      even if a client was disabled in a previous run of the server.

76

70

    </para>

77

71

    <para>

78

72

      The format starts with a <literal>[<replaceable>section

167

161

            This option is <emphasis>optional</emphasis>.

168

162

          </para>

169

163

          <para>

170

 

            This option overrides the default shell command that the

171

 

            server will use to check if the client is still up.  Any

172

 

            output of the command will be ignored, only the exit code

173

 

            is checked:  If the exit code of the command is zero, the

174

 

            client is considered up.  The command will be run using

175

 

            <quote><command><filename>/bin/sh</filename>

 

164

            This option allows you to override the default shell

 

165

            command that the server will use to check if the client is

 

166

            still up.  Any output of the command will be ignored, only

 

167

            the exit code is checked:  If the exit code of the command

 

168

            is zero, the client is considered up.  The command will be

 

169

            run using <quote><command><filename>/bin/sh</filename>

176

170

            <option>-c</option></command></quote>, so

177

171

            <varname>PATH</varname> will be searched.  The default

178

172

            value for the checker command is <quote><literal

188

182

      </varlistentry>

189

183

      

190

184

      <varlistentry>

191

 

        <term><option>extended_timeout<literal> = </literal><replaceable

192

 

        >TIME</replaceable></option></term>

193

 

        <listitem>

194

 

          <para>

195

 

            This option is <emphasis>optional</emphasis>.

196

 

          </para>

197

 

          <para>

198

 

            Extended timeout is an added timeout that is given once

199

 

            after a password has been sent successfully to a client.

200

 

            The timeout is by default longer than the normal timeout,

201

 

            and is used for handling the extra long downtime while a

202

 

            machine is booting up.  Time to take into consideration

203

 

            when changing this value is file system checks and quota

204

 

            checks.  The default value is 15 minutes.

205

 

          </para>

206

 

          <para>

207

 

            The format of <replaceable>TIME</replaceable> is the same

208

 

            as for <varname>timeout</varname> below.

209

 

          </para>

210

 

        </listitem>

211

 

      </varlistentry>

212

 

      

213

 

      <varlistentry>

214

185

        <term><option>fingerprint<literal> = </literal

215

186

        ><replaceable>HEXSTRING</replaceable></option></term>

216

187

        <listitem>

328

299

            This option is <emphasis>optional</emphasis>.

329

300

          </para>

330

301

          <para>

331

 

            The timeout is how long the server will wait, after a

332

 

            successful checker run, until a client is disabled and not

333

 

            allowed to get the data this server holds.  By default

334

 

            Mandos will use 5 minutes.  See also the

335

 

            <option>extended_timeout</option> option.

 

302

            The timeout is how long the server will wait (for either a

 

303

            successful checker run or a client receiving its secret)

 

304

            until a client is disabled and not allowed to get the data

 

305

            this server holds.  By default Mandos will use 5 minutes.

336

306

          </para>

337

307

          <para>

338

308

            The <replaceable>TIME</replaceable> is specified as a

349

319

          </para>

350

320

        </listitem>

351

321

      </varlistentry>

352

 

      

 

322

 

353

323

      <varlistentry>

354

 

        <term><option>enabled<literal> = </literal>{ <literal

355

 

        >1</literal> | <literal>yes</literal> | <literal>true</literal

356

 

        > | <literal >on</literal> | <literal>0</literal> | <literal

357

 

        >no</literal> | <literal>false</literal> | <literal

358

 

        >off</literal> }</option></term>

 

324

        <term><option>extended_timeout<literal> = </literal><replaceable

 

325

        >TIME</replaceable></option></term>

359

326

        <listitem>

360

327

          <para>

361

 

            Whether this client should be enabled by default.  The

362

 

            default is <quote>true</quote>.

 

328

            This option is <emphasis>optional</emphasis>.

 

329

          </para>

 

330

          <para>

 

331

            Extended timeout is an added timeout that is given once

 

332

            after a password has been sent sucessfully to a client.

 

333

            The timeout is by default longer than the normal timeout,

 

334

            and is used for handling the extra long downtime while a

 

335

            matchine is booting up.  Time to take into consideration

 

336

            when changing this value is system file checks and quota

 

337

            checks.  The default value is 15 minutes.

 

338

          </para>

 

339

          <para>

 

340

            The format of <replaceable>TIME</replaceable> is the same

 

341

            as for <varname>timeout</varname> above.

363

342

          </para>

364

343

        </listitem>

365

344

      </varlistentry>

409

388

        <quote><literal>approval_duration</literal></quote>,

410

389

        <quote><literal>created</literal></quote>,

411

390

        <quote><literal>enabled</literal></quote>,

412

 

        <quote><literal>expires</literal></quote>,

413

391

        <quote><literal>fingerprint</literal></quote>,

414

392

        <quote><literal>host</literal></quote>,

415

393

        <quote><literal>interval</literal></quote>,

512

490

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

513

491

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

514

492

      <citerefentry><refentrytitle>mandos</refentrytitle>

515

 

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

516

 

      <citerefentry><refentrytitle>fping</refentrytitle>

517

493

      <manvolnum>8</manvolnum></citerefentry>

518

494

    </para>

519

495

  </refsect1>

• Older »

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