/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

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

• reverse the comparison (174 to 130)
• stop comparing with revision 130

Show diffs side-by-side

added

removed

mandos-clients.conf.xml

4

4

<!ENTITY VERSION "1.0">

5

5

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

6

6

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

7

 

<!ENTITY TIMESTAMP "2008-08-31">

 

7

<!ENTITY TIMESTAMP "2008-09-04">

8

8

]>

9

9

 

10

 

<refentry>

 

10

<refentry xmlns:xi="http://www.w3.org/2001/XInclude">

11

11

  <refentryinfo>

12

12

    <title>Mandos Manual</title>

13

13

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

35

35

      <holder>Teddy Hogeborn</holder>

36

36

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

37

37

    </copyright>

38

 

    <legalnotice>

39

 

      <para>

40

 

        This manual page is free software: you can redistribute it

41

 

        and/or modify it under the terms of the GNU General Public

42

 

        License as published by the Free Software Foundation,

43

 

        either version 3 of the License, or (at your option) any

44

 

        later version.

45

 

      </para>

46

 

 

47

 

      <para>

48

 

        This manual page is distributed in the hope that it will

49

 

        be useful, but WITHOUT ANY WARRANTY; without even the

50

 

        implied warranty of MERCHANTABILITY or FITNESS FOR A

51

 

        PARTICULAR PURPOSE.  See the GNU General Public License

52

 

        for more details.

53

 

      </para>

54

 

 

55

 

      <para>

56

 

        You should have received a copy of the GNU General Public

57

 

        License along with this program; If not, see

58

 

        <ulink url="http://www.gnu.org/licenses/"/>.

59

 

      </para>

60

 

    </legalnotice>

 

38

    <xi:include href="legalnotice.xml"/>

61

39

  </refentryinfo>

62

40

 

63

41

  <refmeta>

115

93

      start time expansion, see <xref linkend="expansion"/>.

116

94

    </para>

117

95

    <para>

118

 

      Uknown options are ignored.  The used options are as follows:

 

96

      Unknown options are ignored.  The used options are as follows:

119

97

    </para>

120

98

 

121

99

    <variablelist>

125

103

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

126

104

        <listitem>

127

105

          <para>

 

106

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

 

107

          </para>

 

108

          <para>

128

109

            The timeout is how long the server will wait for a

129

110

            successful checker run until a client is considered

130

111

            invalid - that is, ineligible to get the data this server

151

132

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

152

133

        <listitem>

153

134

          <para>

 

135

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

 

136

          </para>

 

137

          <para>

154

138

            How often to run the checker to confirm that a client is

155

139

            still up.  <emphasis>Note:</emphasis> a new checker will

156

140

            not be started if an old one is still running.  The server

171

155

        >COMMAND</replaceable></option></term>

172

156

        <listitem>

173

157

          <para>

 

158

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

 

159

          </para>

 

160

          <para>

174

161

            This option allows you to override the default shell

175

162

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

176

163

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

196

183

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

197

184

        <listitem>

198

185

          <para>

 

186

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

 

187

          </para>

 

188

          <para>

199

189

            This option sets the OpenPGP fingerprint that identifies

200

190

            the public key that clients authenticate themselves with

201

191

            through TLS.  The string needs to be in hexidecimal form,

209

199

        >BASE64_ENCODED_DATA</replaceable></option></term>

210

200

        <listitem>

211

201

          <para>

 

202

            If this option is not specified, the <option

 

203

            >secfile</option> option is <emphasis>required</emphasis>

 

204

            to be present.

 

205

          </para>

 

206

          <para>

212

207

            If present, this option must be set to a string of

213

208

            base64-encoded binary data.  It will be decoded and sent

214

209

            to the client matching the above

226

221

            lines is that a line beginning with white space adds to

227

222

            the value of the previous line, RFC 822-style.

228

223

          </para>

229

 

          <para>

230

 

            If this option is not specified, the <option

231

 

            >secfile</option> option is used instead, but one of them

232

 

            <emphasis>must</emphasis> be present.

233

 

          </para>

234

224

        </listitem>

235

225

      </varlistentry>

236

226

 

239

229

        >FILENAME</replaceable></option></term>

240

230

        <listitem>

241

231

          <para>

 

232

            This option is only used if <option>secret</option> is not

 

233

            specified, in which case this option is

 

234

            <emphasis>required</emphasis>.

 

235

          </para>

 

236

          <para>

242

237

            Similar to the <option>secret</option>, except the secret

243

238

            data is in an external file.  The contents of the file

244

239

            should <emphasis>not</emphasis> be base64-encoded, but

245

240

            will be sent to clients verbatim.

246

241

          </para>

247

 

          <para>

248

 

            This option is only used, and <emphasis>must</emphasis> be

249

 

            present, if <option>secret</option> is not specified.

250

 

          </para>

251

242

        </listitem>

252

243

      </varlistentry>

253

244

 

256

247

        >STRING</replaceable></option></term>

257

248

        <listitem>

258

249

          <para>

 

250

            This option is <emphasis>optional</emphasis>, but highly

 

251

            <emphasis>recommended</emphasis> unless the

 

252

            <option>checker</option> option is modified to a

 

253

            non-standard value without <quote>%(host)s</quote> in it.

 

254

          </para>

 

255

          <para>

259

256

            Host name for this client.  This is not used by the server

260

257

            directly, but can be, and is by default, used by the

261

258

            checker.  See the <option>checker</option> option.

• Older »

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