/mandos/trunk : revision 24.1.81

3

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

4

<!ENTITY VERSION "1.0">

5

<!ENTITY COMMANDNAME "plugin-runner">

6

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

6

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

7

]>

8

9

9

10

11

<title>Mandos Manual</title>

12

34

<holder>Teddy Hogeborn</holder>

35

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

36

</copyright>

37

38

<para>

39

This manual page is free software: you can redistribute it

40

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

41

License as published by the Free Software Foundation,

42

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

43

later version.

44

</para>

45

46

<para>

47

This manual page is distributed in the hope that it will

48

be useful, but WITHOUT ANY WARRANTY; without even the

49

implied warranty of MERCHANTABILITY or FITNESS FOR A

50

PARTICULAR PURPOSE. See the GNU General Public License

51

for more details.

52

</para>

53

54

<para>

55

You should have received a copy of the GNU General Public

56

License along with this program; If not, see

57

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

58

</para>

59

</legalnotice>

37

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

60

38

</refentryinfo>

61

39

62

40

75

53

76

54

<command>&COMMANDNAME;</command>

77

55

78

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

56

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

79

57

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

80

58

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

81

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

59

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

82

60

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

83

61

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

84

62

</group>

85

63

<sbr/>

86

64

87

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

65

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

88

66

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

89

67

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

90

68

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

91

69

92

70

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

93

71

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

94

72

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

105

83

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

106

84

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

107

85

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

108

86

109

87

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

110

88

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

111

89

</group>

117

95

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

118

96

</group>

119

97

<sbr/>

98

99

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

120

105

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

121

106

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

122

107

<sbr/>

126

111

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

127

112

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

128

113

<sbr/>

114

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

115

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

116

<sbr/>

129

117

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

130

118

</cmdsynopsis>

131

119

147

135

</group>

148

136

</cmdsynopsis>

149

137

</refsynopsisdiv>

150

138

151

139

152

140

<title>DESCRIPTION</title>

153

141

<para>

154

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

155

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

156

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

157

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

158

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

159

and subsequlently started in the initrd environment. See

160

<citerefentry><refentrytitle>crypttab</refentrytitle>

161

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

162

keyscripts.

163

</para>

164

165

<para>

166

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

167

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

168

</para>

169

</refsect1>

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

170

168

171

169

<title>OPTIONS</title>

172

170

173

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

174

208

<term><option>--global-options

175

209

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

176

210

<term><option>-g

177

211

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

178

212

179

213

<para>

180

Global options given to all plugins as additional start

181

arguments. Options are specified with a -o flag followed

182

by a comma separated string of options.

183

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

184

220

</listitem>

185

221

</varlistentry>

186

222

187

223

188

224

<term><option>--options-for

189

225

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

193

229

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

194

230

195

231

<para>

196

Plugin specific options given to the plugin as additional

197

start arguments. Options are specified with a -o flag

198

followed by a comma separated string of options.

199

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

200

248

</listitem>

201

249

</varlistentry>

202

250

203

251

204

<term><option> --disable

252

<term><option>--disable

205

253

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

206

254

<term><option>-d

207

255

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

208

256

209

257

<para>

210

Disable a specific plugin

258

Disable the plugin named

259

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

260

started.

211

261

</para>

212

262

</listitem>

213

263

</varlistentry>

214

264

215

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

216

281

<term><option>--groupid

217

282

218

283

219

284

<para>

220

Group ID the plugins will run as

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.

221

289

</para>

222

290

</listitem>

223

291

</varlistentry>

227

295

228

296

229

297

<para>

230

User ID the plugins will run as

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.

231

302

</para>

232

303

</listitem>

233

304

</varlistentry>

237

308

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

238

309

239

310

<para>

240

Specify a different plugin directory

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.

241

327

</para>

242

328

</listitem>

243

329

</varlistentry>

246

332

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

247

333

248

334

<para>

249

Debug mode

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.

250

346

</para>

251

347

</listitem>

252

348

</varlistentry>

256

352

257

353

258

354

<para>

259

Gives a help message

355

Gives a help message about options and their meanings.

260

356

</para>

261

357

</listitem>

262

358

</varlistentry>

265

361

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

266

362

267

363

<para>

268

Gives a short usage message

364

Gives a short usage message.

269

365

</para>

270

366

</listitem>

271

367

</varlistentry>

275

371

276

372

277

373

<para>

278

Prints the program version

374

Prints the program version.

279

375

</para>

280

376

</listitem>

281

377

</varlistentry>

282

378

</variablelist>

283

379

</refsect1>

284

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

285

420

286

421

<title>EXIT STATUS</title>

287

422

<para>

288

</para>

289

</refsect1>

290

291

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

292

442

<title>FILES</title>

293

443

<para>

294

</para>

295

</refsect1>

296

297

298

<title>NOTES</title>

299

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

300

477

</para>

301

478

</refsect1>

302

479

305

482

<para>

306

483

</para>

307

484

</refsect1>

308

485

309

486

310

487

<title>EXAMPLE</title>

311

488

<para>

312

489

</para>

313

490

</refsect1>

314

491

315

492

316

493

<title>SECURITY</title>

317

494

<para>

318

495

</para>

319

496

</refsect1>

320

497

321

498

322

499

323

500

<para>

331

508

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

332

509

</para>

333

510

</refsect1>

334

511

335

512

</refentry>

336

513

337

514