/mandos/trunk : revision 121

To get this branch, use:

bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugin-runner.xml

Committer: Teddy Hogeborn
Date: 2008-08-30 19:49:24 UTC
Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn

* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

files added:
.bzrignore

COPYING

initramfs-tools-hook

initramfs-tools-hook-conf

initramfs-tools-script

mandos-clients.conf.xml

mandos-keygen

mandos-keygen.xml

mandos-options.xml

mandos.conf.xml

mandos.xml

overview.xml

plugin-runner.xml

plugins.d/password-prompt.xml

plugins.d/password-request.xml

plugins.d/usplash

files removed:
network-protocol.txt

files renamed:
mandos-client.c => plugin-runner.c

files modified:
Makefile

TODO

clients.conf

mandos

mandos.conf

plugins.d/password-prompt.c

plugins.d/password-request.c

Show diffs side-by-side

added added

removed removed

plugin-runner.xml

<?xml version='1.0' encoding='UTF-8'?>

<?xml-stylesheet type="text/xsl"

href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

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

<!ENTITY VERSION "1.0">

<!ENTITY COMMANDNAME "plugin-runner">

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

<title>Mandos Manual</title>

<productname>Mandos</productname>

<productnumber>&VERSION;</productnumber>

<date>&TIMESTAMP;</date>

<firstname>Björn</firstname>

<surname>Påhlsson</surname>

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

</address>

</author>

<firstname>Teddy</firstname>

<surname>Hogeborn</surname>

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

</address>

</author>

</authorgroup>

<holder>Teddy Hogeborn & Björn Påhlsson</holder>

</copyright>

<para>

This manual page is free software: you can redistribute it

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

License as published by the Free Software Foundation,

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

later version.

</para>

<para>

This manual page is distributed in the hope that it will

be useful, but WITHOUT ANY WARRANTY; without even the

implied warranty of MERCHANTABILITY or FITNESS FOR A

PARTICULAR PURPOSE. See the GNU General Public License

for more details.

</para>

<para>

You should have received a copy of the GNU General Public

License along with this program; If not, see

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

</para>

</legalnotice>

</refentryinfo>

<refentrytitle>&COMMANDNAME;</refentrytitle>

<manvolnum>8mandos</manvolnum>

</refmeta>

<refname><command>&COMMANDNAME;</command></refname>

Run Mandos plugins. Pass data from first succesful one.

</refpurpose>

</refnamediv>

<command>&COMMANDNAME;</command>

<arg choice="plain"><option>--global-envs=<replaceable

>VAR</replaceable><literal>=</literal><replaceable

>value</replaceable></option></arg>

<arg choice="plain"><option>-e

<replaceable>VAR</replaceable><literal>=</literal><replaceable

>value</replaceable> </option></arg>

</group>

<sbr/>

<arg choice="plain"><option>--envs-for=<replaceable

>PLUGIN</replaceable><literal>:</literal><replaceable

>ENV</replaceable><literal>=</literal><replaceable

>value</replaceable></option></arg>

PLUGIN</replaceable><literal>:</literal><replaceable

>ENV</replaceable><literal>=</literal><replaceable

>value</replaceable> </option></arg>

</group>

<sbr/>

<arg choice="plain"><option>--global-options=<replaceable

100

>OPTIONS</replaceable></option></arg>

101

102

OPTIONS</replaceable> </option></arg>

103

</group>

104

<sbr/>

105

106

<arg choice="plain"><option>--options-for=<replaceable

107

>PLUGIN</replaceable><literal>:</literal><replaceable

108

>OPTIONS</replaceable></option></arg>

109

110

PLUGIN</replaceable><literal>:</literal><replaceable

111

>OPTIONS</replaceable> </option></arg>

112

</group>

113

<sbr/>

114

115

<arg choice="plain"><option>--disable=<replaceable

116

>PLUGIN</replaceable></option></arg>

117

<arg choice="plain"><option>-d

118

<replaceable>PLUGIN</replaceable> </option></arg>

119

</group>

120

<sbr/>

121

<arg><option>--groupid=<replaceable

122

>ID</replaceable></option></arg>

123

<sbr/>

124

<arg><option>--userid=<replaceable

125

>ID</replaceable></option></arg>

126

<sbr/>

127

<arg><option>--plugin-dir=<replaceable

128

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

129

<sbr/>

130

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

131

</cmdsynopsis>

132

133

<command>&COMMANDNAME;</command>

134

135

136

137

</group>

138

</cmdsynopsis>

139

140

<command>&COMMANDNAME;</command>

141

<arg choice='plain'><option>--usage</option></arg>

142

</cmdsynopsis>

143

144

<command>&COMMANDNAME;</command>

145

146

<arg choice='plain'><option>--version</option></arg>

147

148

</group>

149

</cmdsynopsis>

150

</refsynopsisdiv>

151

152

153

<title>DESCRIPTION</title>

154

<para>

155

<command>&COMMANDNAME;</command> is a plugin runner that waits

156

for any of its plugins to return sucessfull with a password, and

157

passes it to cryptsetup as stdout message. This command is not

158

meant to be invoked directly, but is instead meant to be run by

159

cryptsetup by being specified in /etc/crypttab as a keyscript

160

and subsequlently started in the initrd environment. See

161

<citerefentry><refentrytitle>crypttab</refentrytitle>

162

<manvolnum>5</manvolnum></citerefentry> for more information on

163

keyscripts.

164

</para>

165

166

<para>

167

plugins is looked for in the plugins directory which by default will be

168

/conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.

169

</para>

170

</refsect1>

171

172

<title>OPTIONS</title>

173

174

175

<term><literal>-g</literal>,<literal>--global-options

176

<replaceable>OPTIONS</replaceable></literal></term>

177

178

<para>

179

Global options given to all plugins as additional start

180

arguments. Options are specified with a -o flag followed

181

by a comma separated string of options.

182

</para>

183

</listitem>

184

</varlistentry>

185

186

187

<term><literal>-o</literal>,<literal> --options-for

188

<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>

189

</literal></term>

190

191

<para>

192

Plugin specific options given to the plugin as additional

193

start arguments. Options are specified with a -o flag

194

followed by a comma separated string of options.

195

</para>

196

</listitem>

197

</varlistentry>

198

199

200

<term><literal>-d</literal>,<literal> --disable

201

<replaceable>PLUGIN</replaceable>

202

</literal></term>

203

204

<para>

205

Disable a specific plugin

206

</para>

207

</listitem>

208

</varlistentry>

209

210

211

<term><literal>--groupid <replaceable>ID</replaceable>

212

</literal></term>

213

214

<para>

215

Group ID the plugins will run as

216

</para>

217

</listitem>

218

</varlistentry>

219

220

221

<term><literal>--userid <replaceable>ID</replaceable>

222

</literal></term>

223

224

<para>

225

User ID the plugins will run as

226

</para>

227

</listitem>

228

</varlistentry>

229

230

231

<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>

232

</literal></term>

233

234

<para>

235

Specify a different plugin directory

236

</para>

237

</listitem>

238

</varlistentry>

239

240

241

<term><literal>--debug</literal></term>

242

243

<para>

244

Debug mode

245

</para>

246

</listitem>

247

</varlistentry>

248

249

250

251

252

<para>

253

Gives a help message

254

</para>

255

</listitem>

256

</varlistentry>

257

258

259

<term><literal>--usage</literal></term>

260

261

<para>

262

Gives a short usage message

263

</para>

264

</listitem>

265

</varlistentry>

266

267

268

<term><literal>-V</literal>, <literal>--version</literal></term>

269

270

<para>

271

Prints the program version

272

</para>

273

</listitem>

274

</varlistentry>

275

</variablelist>

276

</refsect1>

277

278

279

<title>EXIT STATUS</title>

280

<para>

281

</para>

282

</refsect1>

283

284

285

<title>FILES</title>

286

<para>

287

</para>

288

</refsect1>

289

290

291

<title>NOTES</title>

292

<para>

293

</para>

294

</refsect1>

295

296

297

298

<para>

299

</para>

300

</refsect1>

301

302

303

<title>EXAMPLE</title>

304

<para>

305

</para>

306

</refsect1>

307

308

309

<title>SECURITY</title>

310

<para>

311

</para>

312

</refsect1>

313

314

315

316

<para>

317

<citerefentry><refentrytitle>cryptsetup</refentrytitle>

318

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

319

<citerefentry><refentrytitle>mandos</refentrytitle>

320

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

321

<citerefentry><refentrytitle>password-prompt</refentrytitle>

322

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

323

<citerefentry><refentrytitle>password-request</refentrytitle>

324

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

325

</para>

326

</refsect1>

327

328

</refentry>

329

330

331

332

333

Older »