/mandos/trunk : revision 173

To get this branch, use:

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

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

Committer: Teddy Hogeborn
Date: 2008-09-06 16:33:54 UTC
Revision ID: teddy@fukt.bsnet.se-20080906163354-x2l238fvbs2xashj

* .bzrignore: Rename "password-request" to "mandos-client".

files added:
.bzrignore

COPYING

README

default-mandos

etc-plugins.d-README

init.d-mandos

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

plugin-runner.xml

plugins.d/mandos-client.xml

plugins.d/password-prompt.xml

plugins.d/usplash

files removed:
ca.pem

cert.pem

client-cert.pem

client-key.pem

crl.pem

key.pem

plugins.d/Makefile

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

server.py => mandos

plugbasedclient.c => plugin-runner.c

plugins.d/mandosclient.c => plugins.d/mandos-client.c

plugins.d/passprompt.c => plugins.d/password-prompt.c

files modified:
Makefile

TODO

Show diffs side-by-side

added added

removed removed

plugins.d/mandos-client.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 "mandos-client">

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

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

Client for <application>Mandos</application>

</refpurpose>

</refnamediv>

<command>&COMMANDNAME;</command>

<group>

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

<replaceable>ADDRESS</replaceable><literal>:</literal

><replaceable>PORT</replaceable></option></arg>

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

<replaceable>ADDRESS</replaceable><literal>:</literal

><replaceable>PORT</replaceable></option></arg>

</group>

<sbr/>

<group>

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

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

</group>

<sbr/>

<group>

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

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

</group>

<sbr/>

<group>

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

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

</group>

<sbr/>

<arg>

<option>--priority <replaceable>STRING</replaceable></option>

</arg>

<sbr/>

<arg>

</arg>

<sbr/>

<arg>

<option>--debug</option>

</arg>

</cmdsynopsis>

<command>&COMMANDNAME;</command>

100

101

102

</group>

103

</cmdsynopsis>

104

105

<command>&COMMANDNAME;</command>

106

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

107

</cmdsynopsis>

108

109

<command>&COMMANDNAME;</command>

110

111

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

112

113

</group>

114

</cmdsynopsis>

115

</refsynopsisdiv>

116

117

118

<title>DESCRIPTION</title>

119

<para>

120

<command>&COMMANDNAME;</command> is a client program that

121

communicates with <citerefentry><refentrytitle

122

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

123

to get a password. It uses IPv6 link-local addresses to get

124

network connectivity, Zeroconf to find servers, and TLS with an

125

OpenPGP key to ensure authenticity and confidentiality. It

126

keeps running, trying all servers on the network, until it

127

receives a satisfactory reply or a TERM signal is received.

128

</para>

129

<para>

130

This program is not meant to be run directly; it is really meant

131

to run as a plugin of the <application>Mandos</application>

132

<citerefentry><refentrytitle>plugin-runner</refentrytitle>

133

<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the

134

initial <acronym>RAM</acronym> disk environment because it is

135

specified as a <quote>keyscript</quote> in the <citerefentry>

136

<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>

137

</citerefentry> file.

138

</para>

139

</refsect1>

140

141

142

<title>PURPOSE</title>

143

<para>

144

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

145

rebooting</emphasis> of client host computer with an

146

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

147

linkend="overview"/> for details.

148

</para>

149

</refsect1>

150

151

152

<title>OPTIONS</title>

153

<para>

154

This program is commonly not invoked from the command line; it

155

is normally started by the <application>Mandos</application>

156

plugin runner, see <citerefentry><refentrytitle

157

>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>

158

</citerefentry>. Any command line options this program accepts

159

are therefore normally provided by the plugin runner, and not

160

directly.

161

</para>

162

163

164

165

<term><option>--connect=<replaceable

166

>ADDRESS</replaceable><literal>:</literal><replaceable

167

>PORT</replaceable></option></term>

168

<term><option>-c

169

<replaceable>ADDRESS</replaceable><literal>:</literal

170

><replaceable>PORT</replaceable></option></term>

171

172

<para>

173

Do not use Zeroconf to locate servers. Connect directly

174

to only one specified <application>Mandos</application>

175

server. Note that an IPv6 address has colon characters in

176

it, so the <emphasis>last</emphasis> colon character is

177

assumed to separate the address from the port number.

178

</para>

179

<para>

180

This option is normally only useful for testing and

181

debugging.

182

</para>

183

</listitem>

184

</varlistentry>

185

186

187

<term><option>--interface=

188

189

<term><option>-i

190

191

192

<para>

193

Network interface that will be brought up and scanned for

194

Mandos servers to connect to. The default it

195

<quote><literal>eth0</literal></quote>.

196

</para>

197

<para>

198

If the <option>--connect</option> option is used, this

199

specifies the interface to use to connect to the address

200

given.

201

</para>

202

</listitem>

203

</varlistentry>

204

205

206

<term><option>--pubkey=<replaceable

207

>FILE</replaceable></option></term>

208

<term><option>-p

209

210

211

<para>

212

OpenPGP public key file name. The default name is

213

<quote><filename>/conf/conf.d/mandos/pubkey.txt</filename

214

></quote>.

215

</para>

216

</listitem>

217

</varlistentry>

218

219

220

<term><option>--seckey=<replaceable

221

>FILE</replaceable></option></term>

222

<term><option>-s

223

224

225

<para>

226

OpenPGP secret key file name. The default name is

227

<quote><filename>/conf/conf.d/mandos/seckey.txt</filename

228

></quote>.

229

</para>

230

</listitem>

231

</varlistentry>

232

233

234

<term><option>--priority=<replaceable

235

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

236

237

<xi:include href="../mandos-options.xml"

238

xpointer="priority"/>

239

</listitem>

240

</varlistentry>

241

242

243

<term><option>--dh-bits=<replaceable

244

>BITS</replaceable></option></term>

245

246

<para>

247

Sets the number of bits to use for the prime number in the

248

TLS Diffie-Hellman key exchange. Default is 1024.

249

</para>

250

</listitem>

251

</varlistentry>

252

253

254

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

255

256

<para>

257

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

258

standard error about what the program is doing. The

259

program will still perform all other functions normally.

260

</para>

261

<para>

262

It will also enable debug mode in the Avahi and GnuTLS

263

libraries, making them print large amounts of debugging

264

output.

265

</para>

266

</listitem>

267

</varlistentry>

268

269

270

271

272

273

<para>

274

Gives a help message about options and their meanings.

275

</para>

276

</listitem>

277

</varlistentry>

278

279

280

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

281

282

<para>

283

Gives a short usage message.

284

</para>

285

</listitem>

286

</varlistentry>

287

288

289

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

290

291

292

<para>

293

Prints the program version.

294

</para>

295

</listitem>

296

</varlistentry>

297

</variablelist>

298

</refsect1>

299

300

301

<title>OVERVIEW</title>

302

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

303

<para>

304

This program is the client part. It is a plugin started by

305

<citerefentry><refentrytitle>plugin-runner</refentrytitle>

306

<manvolnum>8mandos</manvolnum></citerefentry> which will run in

307

an initial <acronym>RAM</acronym> disk environment.

308

</para>

309

<para>

310

This program could, theoretically, be used as a keyscript in

311

<filename>/etc/crypttab</filename>, but it would then be

312

impossible to enter a password for the encrypted root disk at

313

the console, since this program does not read from the console

314

at all. This is why a separate plugin runner (<citerefentry>

315

<refentrytitle>plugin-runner</refentrytitle>

316

<manvolnum>8mandos</manvolnum></citerefentry>) is used to run

317

both this program and others in in parallel,

318

<emphasis>one</emphasis> of which will prompt for passwords on

319

the system console.

320

</para>

321

</refsect1>

322

323

324

<title>EXIT STATUS</title>

325

<para>

326

This program will exit with a successful (zero) exit status if a

327

server could be found and the password received from it could be

328

successfully decrypted and output on standard output. The

329

program will exit with a non-zero exit status only if a critical

330

error occurs. Otherwise, it will forever connect to new

331

<application>Mandos</application> servers as they appear, trying

332

to get a decryptable password and print it.

333

</para>

334

</refsect1>

335

336

337

<title>ENVIRONMENT</title>

338

<para>

339

This program does not use any environment variables, not even

340

the ones provided by <citerefentry><refentrytitle

341

>cryptsetup</refentrytitle><manvolnum>8</manvolnum>

342

</citerefentry>.

343

</para>

344

</refsect1>

345

346

347

<title>FILES</title>

348

349

350

<term><filename>/conf/conf.d/mandos/pubkey.txt</filename

351

></term>

352

<term><filename>/conf/conf.d/mandos/seckey.txt</filename

353

></term>

354

355

<para>

356

OpenPGP public and private key files, in <quote>ASCII

357

Armor</quote> format. These are the default file names,

358

they can be changed with the <option>--pubkey</option> and

359

<option>--seckey</option> options.

360

</para>

361

</listitem>

362

</varlistentry>

363

</variablelist>

364

</refsect1>

365

366

367

368

369

370

371

372

373

<title>EXAMPLE</title>

374

<para>

375

Note that normally, command line options will not be given

376

directly, but via options for the Mandos <citerefentry

377

><refentrytitle>plugin-runner</refentrytitle>

378

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

379

</para>

380

381

<para>

382

Normal invocation needs no options, if the network interface

383

is <quote>eth0</quote>:

384

</para>

385

<para>

386

<userinput>&COMMANDNAME;</userinput>

387

</para>

388

</informalexample>

389

390

<para>

391

Search for Mandos servers (and connect to them) using another

392

interface:

393

</para>

394

<para>

395

396

<userinput>&COMMANDNAME; --interface eth1</userinput>

397

</para>

398

</informalexample>

399

400

<para>

401

Run in debug mode, and use a custom key:

402

</para>

403

<para>

404

405

406

<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>

407

408

</para>

409

</informalexample>

410

411

<para>

412

Run in debug mode, with a custom key, and do not use Zeroconf

413

to locate a server; connect directly to the IPv6 address

414

<quote><systemitem class="ipaddress"

415

>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,

416

port 4711, using interface eth2:

417

</para>

418

<para>

419

420

421

<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>

422

423

</para>

424

</informalexample>

425

</refsect1>

426

427

428

<title>SECURITY</title>

429

<para>

430

This program is set-uid to root, but will switch back to the

431

original (and presumably non-privileged) user and group after

432

bringing up the network interface.

433

</para>

434

<para>

435

To use this program for its intended purpose (see <xref

436

linkend="purpose"/>), the password for the root file system will

437

have to be given out to be stored in a server computer, after

438

having been encrypted using an OpenPGP key. This encrypted data

439

which will be stored in a server can only be decrypted by the

440

OpenPGP key, and the data will only be given out to those

441

clients who can prove they actually have that key. This key,

442

however, is stored unencrypted on the client side in its initial

443

<acronym>RAM</acronym> disk image file system. This is normally

444

readable by all, but this is normally fixed during installation

445

of this program; file permissions are set so that no-one is able

446

to read that file.

447

</para>

448

<para>

449

The only remaining weak point is that someone with physical

450

access to the client hard drive might turn off the client

451

computer, read the OpenPGP keys directly from the hard drive,

452

and communicate with the server. The defense against this is

453

that the server is supposed to notice the client disappearing

454

and will stop giving out the encrypted data. Therefore, it is

455

important to set the timeout and checker interval values tightly

456

on the server. See <citerefentry><refentrytitle

457

>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.

458

</para>

459

<para>

460

It will also help if the checker program on the server is

461

configured to request something from the client which can not be

462

spoofed by someone else on the network, unlike unencrypted

463

<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.

464

</para>

465

<para>

466

<emphasis>Note</emphasis>: This makes it completely insecure to

467

have <application >Mandos</application> clients which dual-boot

468

to another operating system which is <emphasis>not</emphasis>

469

trusted to keep the initial <acronym>RAM</acronym> disk image

470

confidential.

471

</para>

472

</refsect1>

473

474

475

476

<para>

477

<citerefentry><refentrytitle>cryptsetup</refentrytitle>

478

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

479

<citerefentry><refentrytitle>crypttab</refentrytitle>

480

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

481

<citerefentry><refentrytitle>mandos</refentrytitle>

482

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

483

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

484

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

485

<citerefentry><refentrytitle>plugin-runner</refentrytitle>

486

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

487

</para>

488

489

490

<term>

491

<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>

492

</term>

493

494

<para>

495

Zeroconf is the network protocol standard used for finding

496

Mandos servers on the local network.

497

</para>

498

</listitem>

499

</varlistentry>

500

501

<term>

502

<ulink url="http://www.avahi.org/">Avahi</ulink>

503

</term>

504

505

<para>

506

Avahi is the library this program calls to find Zeroconf

507

services.

508

</para>

509

</listitem>

510

</varlistentry>

511

512

<term>

513

<ulink url="http://www.gnu.org/software/gnutls/"

514

>GnuTLS</ulink>

515

</term>

516

517

<para>

518

GnuTLS is the library this client uses to implement TLS for

519

communicating securely with the server, and at the same time

520

send the public OpenPGP key to the server.

521

</para>

522

</listitem>

523

</varlistentry>

524

525

<term>

526

<ulink url="http://www.gnupg.org/related_software/gpgme/"

527

>GPGME</ulink>

528

</term>

529

530

<para>

531

GPGME is the library used to decrypt the OpenPGP data sent

532

by the server.

533

</para>

534

</listitem>

535

</varlistentry>

536

537

<term>

538

RFC 4291: <citetitle>IP Version 6 Addressing

539

Architecture</citetitle>

540

</term>

541

542

543

544

<term>Section 2.2: <citetitle>Text Representation of

545

Addresses</citetitle></term>

546

547

</varlistentry>

548

549

<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6

550

Address</citetitle></term>

551

552

</varlistentry>

553

554

<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast

555

Addresses</citetitle></term>

556

557

<para>

558

This client uses IPv6 link-local addresses, which are

559

immediately usable since a link-local addresses is

560

automatically assigned to a network interfaces when it

561

is brought up.

562

</para>

563

</listitem>

564

</varlistentry>

565

</variablelist>

566

</listitem>

567

</varlistentry>

568

569

<term>

570

RFC 4346: <citetitle>The Transport Layer Security (TLS)

571

Protocol Version 1.1</citetitle>

572

</term>

573

574

<para>

575

TLS 1.1 is the protocol implemented by GnuTLS.

576

</para>

577

</listitem>

578

</varlistentry>

579

580

<term>

581

RFC 4880: <citetitle>OpenPGP Message Format</citetitle>

582

</term>

583

584

<para>

585

The data received from the server is binary encrypted

586

OpenPGP data.

587

</para>

588

</listitem>

589

</varlistentry>

590

591

<term>

592

RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer

593

Security</citetitle>

594

</term>

595

596

<para>

597

This is implemented by GnuTLS and used by this program so

598

that OpenPGP keys can be used.

599

</para>

600

</listitem>

601

</varlistentry>

602

</variablelist>

603

</refsect1>

604

605

</refentry>

606

607

608

609

610

Older »