/mandos/trunk : revision 24.1.80

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: Björn Påhlsson
Date: 2008-09-02 10:40:22 UTC
mfrom: (139 mandos)
mto: (24.1.154 mandos) (237.4.3 mandos-release)
mto: This revision was merged to the branch mainline in revision 149.
Revision ID: belorn@braxen-20080902104022-5x39n4gmle0j15ws

merge

files added:
.bzrignore

COPYING

initramfs-tools-hook

initramfs-tools-hook-conf

initramfs-tools-script

legalnotice.xml

mandos-clients.conf.xml

mandos-keygen

mandos-keygen.xml

mandos-options.xml

mandos.conf

mandos.conf.xml

mandos.xml

overview.xml

plugin-runner.c

plugin-runner.xml

plugins.d

plugins.d/password-prompt.c

plugins.d/password-prompt.xml

plugins.d/password-request.c

plugins.d/password-request.xml

plugins.d/usplash

files removed:
ca.pem

cert.pem

client-cert.pem

client-key.pem

client.cpp

crl.pem

key.pem

files renamed:
mandos-clients.conf => clients.conf

server.py => mandos

files modified:
Makefile

TODO

Show diffs side-by-side

added added

removed removed

plugin-runner.xml

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

<!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-09-02">

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

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

</copyright>

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

</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-env=<replaceable

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

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

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

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

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

</group>

<sbr/>

<arg choice="plain"><option>--env-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

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

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

</group>

<sbr/>

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

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

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

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

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

</group>

<sbr/>

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

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

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

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

</group>

<sbr/>

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

100

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

101

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

102

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

103

</group>

104

<sbr/>

105

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

106

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

107

<sbr/>

108

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

109

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

110

<sbr/>

111

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

112

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

113

<sbr/>

114

<arg><option>--config-file=<replaceable

115

>FILE</replaceable></option></arg>

116

<sbr/>

117

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

118

</cmdsynopsis>

119

120

<command>&COMMANDNAME;</command>

121

122

123

124

</group>

125

</cmdsynopsis>

126

127

<command>&COMMANDNAME;</command>

128

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

129

</cmdsynopsis>

130

131

<command>&COMMANDNAME;</command>

132

133

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

134

135

</group>

136

</cmdsynopsis>

137

</refsynopsisdiv>

138

139

140

<title>DESCRIPTION</title>

141

<para>

142

<command>&COMMANDNAME;</command> is a program which is meant to

143

be specified as <quote>keyscript</quote> in <citerefentry>

144

<refentrytitle>crypttab</refentrytitle>

145

<manvolnum>5</manvolnum></citerefentry> for the root disk. The

146

aim of this program is therefore to output a password, which

147

then <citerefentry><refentrytitle>cryptsetup</refentrytitle>

148

<manvolnum>8</manvolnum></citerefentry> will use to try and

149

unlock the root disk.

150

</para>

151

<para>

152

This program is not meant to be invoked directly, but can be in

153

order to test it. Note that any password obtained will simply

154

be output on standard output.

155

</para>

156

</refsect1>

157

158

159

<title>PURPOSE</title>

160

<para>

161

The purpose of this is to enable <emphasis>remote and unattended

162

rebooting</emphasis> of client host computer with an

163

<emphasis>encrypted root file system</emphasis>. See <xref

164

linkend="overview"/> for details.

165

</para>

166

</refsect1>

167

168

169

<title>OPTIONS</title>

170

171

172

<term><option>--global-env

173

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

174

>value</replaceable></option></term>

175

<term><option>-e

176

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

177

>value</replaceable></option></term>

178

179

<para>

180

This option will add an environment variable setting to

181

all plugins. This will override any inherited environment

182

variable.

183

</para>

184

</listitem>

185

</varlistentry>

186

187

188

<term><option>--env-for

189

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

190

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

191

><replaceable>value</replaceable></option></term>

192

<term><option>-f

193

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

194

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

195

><replaceable>value</replaceable></option></term>

196

197

<para>

198

This option will add an environment variable setting to

199

the <replaceable>PLUGIN</replaceable> plugin. This will

200

override any inherited environment variables or

201

environment variables specified using

202

<option>--global-env</option>.

203

</para>

204

</listitem>

205

</varlistentry>

206

207

208

<term><option>--global-options

209

<replaceable>OPTIONS</replaceable></option></term>

210

<term><option>-g

211

<replaceable>OPTIONS</replaceable></option></term>

212

213

<para>

214

Pass some options to <emphasis>all</emphasis> plugins.

215

<replaceable>OPTIONS</replaceable> is a comma separated

216

list of options. This is not a very useful option, except

217

for specifying the <quote><option>--debug</option></quote>

218

for all plugins.

219

</para>

220

</listitem>

221

</varlistentry>

222

223

224

<term><option>--options-for

225

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

226

><replaceable>OPTION</replaceable></option></term>

227

<term><option>-o

228

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

229

><replaceable>OPTION</replaceable></option></term>

230

231

<para>

232

Pass some options to a specific plugin. <replaceable

233

>PLUGIN</replaceable> is the name (file basename) of a

234

plugin, and <replaceable>OPTIONS</replaceable> is a comma

235

separated list of options.

236

</para>

237

<para>

238

Note that since options are not split on whitespace, the

239

way to pass, to the plugin

240

<quote><filename>foo</filename></quote>, the option

241

<option>--bar</option> with the option argument

242

<quote>baz</quote> is either

243

<userinput>--options-for=foo:--bar=baz</userinput> or

244

<userinput>--options-for=foo:--bar,baz</userinput>, but

245

246

<userinput>--options-for="foo:--bar baz"</userinput>.

247

</para>

248

</listitem>

249

</varlistentry>

250

251

252

<term><option>--disable

253

<replaceable>PLUGIN</replaceable></option></term>

254

<term><option>-d

255

<replaceable>PLUGIN</replaceable></option></term>

256

257

<para>

258

Disable the plugin named

259

<replaceable>PLUGIN</replaceable>. The plugin will not be

260

started.

261

</para>

262

</listitem>

263

</varlistentry>

264

265

266

<term><option>--enable

267

<replaceable>PLUGIN</replaceable></option></term>

268

<term><option>-e

269

<replaceable>PLUGIN</replaceable></option></term>

270

271

<para>

272

Re-enable the plugin named

273

<replaceable>PLUGIN</replaceable>. This is only useful to

274

undo a previous <option>--disable</option> option, maybe

275

from the config file.

276

</para>

277

</listitem>

278

</varlistentry>

279

280

281

<term><option>--groupid

282

283

284

<para>

285

Change to group ID <replaceable>ID</replaceable> on

286

startup. The default is 65534. All plugins will be

287

started using this group ID. <emphasis>Note:</emphasis>

288

This must be a number, not a name.

289

</para>

290

</listitem>

291

</varlistentry>

292

293

294

<term><option>--userid

295

296

297

<para>

298

Change to user ID <replaceable>ID</replaceable> on

299

startup. The default is 65534. All plugins will be

300

started using this user ID. <emphasis>Note:</emphasis>

301

This must be a number, not a name.

302

</para>

303

</listitem>

304

</varlistentry>

305

306

307

<term><option>--plugin-dir

308

<replaceable>DIRECTORY</replaceable></option></term>

309

310

<para>

311

Specify a different plugin directory. The default is

312

<filename>/lib/mandos/plugins.d</filename>, which will

313

exist in the initial <acronym>RAM</acronym> disk

314

environment.

315

</para>

316

</listitem>

317

</varlistentry>

318

319

320

<term><option>--config-file

321

322

323

<para>

324

Specify a different file to read additional options from.

325

See <xref linkend="files"/>. Other command line options

326

will override options specified in the file.

327

</para>

328

</listitem>

329

</varlistentry>

330

331

332

<term><option>--debug</option></term>

333

334

<para>

335

Enable debug mode. This will enable a lot of output to

336

standard error about what the program is doing. The

337

program will still perform all other functions normally.

338

The default is to <emphasis>not</emphasis> run in debug

339

mode.

340

</para>

341

<para>

342

The plugins will <emphasis>not</emphasis> be affected by

343

this option. Use

344

<userinput><option>--global-options=--debug</option></userinput>

345

if complete debugging eruption is desired.

346

</para>

347

</listitem>

348

</varlistentry>

349

350

351

352

353

354

<para>

355

Gives a help message about options and their meanings.

356

</para>

357

</listitem>

358

</varlistentry>

359

360

361

<term><option>--usage</option></term>

362

363

<para>

364

Gives a short usage message.

365

</para>

366

</listitem>

367

</varlistentry>

368

369

370

<term><option>--version</option></term>

371

372

373

<para>

374

Prints the program version.

375

</para>

376

</listitem>

377

</varlistentry>

378

</variablelist>

379

</refsect1>

380

381

382

<title>OVERVIEW</title>

383

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

384

<para>

385

This program will run on the client side in the initial

386

<acronym>RAM</acronym> disk environment, and is responsible for

387

getting a password. It does this by running plugins, one of

388

which will normally be the actual client program communicating

389

with the server.

390

</para>

391

</refsect1>

392

393

<title>PLUGINS</title>

394

<para>

395

This program will get a password by running a number of

396

<firstterm>plugins</firstterm>, which are simply executable

397

programs in a directory in the initial <acronym>RAM</acronym>

398

disk environment. The default directory is

399

<filename>/lib/mandos/plugins.d</filename>, but this can be

400

changed with the <option>--plugin-dir</option> option. The

401

plugins are started in parallel, and the first plugin to output

402

a password <emphasis>and</emphasis> exit with a successful exit

403

code will make this plugin-runner output the password from that

404

plugin, stop any other plugins, and exit.

405

</para>

406

</refsect1>

407

408

409

<title>FALLBACK</title>

410

<para>

411

If no plugins succeed, this program will, as a fallback, ask for

412

a password on the console using <citerefentry><refentrytitle

413

>getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

414

and output it. This is not meant to be the normal mode of

415

operation, as there is a separate plugin for getting a password

416

from the console.

417

</para>

418

</refsect1>

419

420

421

<title>EXIT STATUS</title>

422

<para>

423

Exit status of this program is zero if no errors were

424

encountered, and otherwise not. The fallback (see <xref

425

linkend="fallback"/>) may or may not have succeeded in either

426

case.

427

</para>

428

</refsect1>

429

430

431

<title>ENVIRONMENT</title>

432

<para>

433

This program does not use any environment variables itself, it

434

only passes on its environment to all the plugins. The

435

environment passed to plugins can be modified using the

436

<option>--global-env</option> and <option>--env-for</option>

437

optins.

438

</para>

439

</refsect1>

440

441

442

<title>FILES</title>

443

<para>

444

445

446

<term><filename

447

>/conf/conf.d/mandos/plugin-runner.conf</filename></term>

448

449

<para>

450

Since this program will be run as a keyscript, there is

451

little to no opportunity to pass command line arguments

452

to it. Therefore, it will <emphasis>also</emphasis>

453

read this file and use its contents as

454

whitespace-separated command line options. Also,

455

everything from a <quote>#</quote> character to the end

456

of a line is ignored.

457

</para>

458

<para>

459

This program is meant to run in the initial RAM disk

460

environment, so that is where this file is assumed to

461

exist. The file does not need to exist in the normal

462

file system.

463

</para>

464

<para>

465

This file will be processed <emphasis>before</emphasis>

466

the normal command line options, so the latter can

467

override the former, if need be.

468

</para>

469

<para>

470

This file name is the default; the file to read for

471

arguments can be changed using the

472

<option>--config-file</option> option.

473

</para>

474

</listitem>

475

</varlistentry>

476

</variablelist>

477

</para>

478

</refsect1>

479

480

481

482

<para>

483

</para>

484

</refsect1>

485

486

487

<title>EXAMPLE</title>

488

<para>

489

</para>

490

</refsect1>

491

492

493

<title>SECURITY</title>

494

<para>

495

</para>

496

</refsect1>

497

498

499

500

<para>

501

<citerefentry><refentrytitle>cryptsetup</refentrytitle>

502

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

503

<citerefentry><refentrytitle>mandos</refentrytitle>

504

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

505

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

506

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

507

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

508

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

509

</para>

510

</refsect1>

511

512

</refentry>

513

514

515

516

517

Older »