/mandos/release : revision 24.1.4

1

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

2

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

3

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

4

<!ENTITY VERSION "1.0">

5

<!ENTITY COMMANDNAME "mandos">

6

]>

7

8

9

10

<title>&COMMANDNAME;</title>

11

12

<productname>&COMMANDNAME;</productname>

13

<productnumber>&VERSION;</productnumber>

14

15

16

<firstname>Björn</firstname>

17

<surname>Påhlsson</surname>

18

19

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

20

</address>

21

</author>

22

23

<firstname>Teddy</firstname>

24

<surname>Hogeborn</surname>

25

26

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

27

</address>

28

</author>

29

</authorgroup>

30

31

32

<holder>Teddy Hogeborn</holder>

33

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

34

</copyright>

35

36

<para>

37

This manual page is free software: you can redistribute it

38

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

39

License as published by the Free Software Foundation,

40

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

41

later version.

42

</para>

43

44

<para>

45

This manual page is distributed in the hope that it will

46

be useful, but WITHOUT ANY WARRANTY; without even the

47

implied warranty of MERCHANTABILITY or FITNESS FOR A

48

PARTICULAR PURPOSE. See the GNU General Public License

49

for more details.

50

</para>

51

52

<para>

53

You should have received a copy of the GNU General Public

54

License along with this program; If not, see

55

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

56

</para>

57

</legalnotice>

58

</refentryinfo>

59

60

61

<refentrytitle>&COMMANDNAME;</refentrytitle>

62

63

</refmeta>

64

65

66

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

67

68

Sends encrypted passwords to authenticated Mandos clients

69

</refpurpose>

70

</refnamediv>

71

72

73

74

<command>&COMMANDNAME;</command>

75

<arg>--interface<arg choice="plain">IF</arg></arg>

76

<arg>--address<arg choice="plain">ADDRESS</arg></arg>

77

78

<arg>--priority<arg choice="plain">PRIORITY</arg></arg>

79

<arg>--servicename<arg choice="plain">NAME</arg></arg>

80

<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>

81

<arg>--debug</arg>

82

</cmdsynopsis>

83

84

<command>&COMMANDNAME;</command>

85

86

<arg>-a<arg choice="plain">ADDRESS</arg></arg>

87

88

<arg>--priority<arg choice="plain">PRIORITY</arg></arg>

89

<arg>--servicename<arg choice="plain">NAME</arg></arg>

90

<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>

91

<arg>--debug</arg>

92

</cmdsynopsis>

93

94

<command>&COMMANDNAME;</command>

95

96

97

98

</group>

99

</cmdsynopsis>

100

101

<command>&COMMANDNAME;</command>

102

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

103

</cmdsynopsis>

104

105

<command>&COMMANDNAME;</command>

106

<arg choice="plain">--check</arg>

107

</cmdsynopsis>

108

</refsynopsisdiv>

109

110

111

<title>DESCRIPTION</title>

112

<para>

113

<command>&COMMANDNAME;</command> is a server daemon which

114

handles incoming request for passwords for a pre-defined list of

115

client host computers. The Mandos server uses Zeroconf to

116

announce itself on the local network, and uses TLS to

117

communicate securely with and to authenticate the clients. The

118

Mandos server uses IPv6 to allow Mandos clients to use IPv6

119

link-local addresses, since the clients will probably not have

120

any other addresses configured (see <xref linkend="overview"/>).

121

Any authenticated client is then given the stored pre-encrypted

122

password for that specific client.

123

</para>

124

125

</refsect1>

126

127

128

<title>PURPOSE</title>

129

130

<para>

131

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

132

rebooting</emphasis> of client host computer with an

133

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

134

linkend="overview"/> for details.

135

</para>

136

137

</refsect1>

138

139

140

<title>OPTIONS</title>

141

142

143

144

145

146

<para>

147

Show a help message and exit

148

</para>

149

</listitem>

150

</varlistentry>

151

152

153

<term><literal>-i</literal>, <literal>--interface <replaceable>

154

IF</replaceable></literal></term>

155

156

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

157

</listitem>

158

</varlistentry>

159

160

161

<term><literal>-a</literal>, <literal>--address <replaceable>

162

ADDRESS</replaceable></literal></term>

163

164

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

165

</listitem>

166

</varlistentry>

167

168

169

170

PORT</replaceable></literal></term>

171

172

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

173

</listitem>

174

</varlistentry>

175

176

177

<term><literal>--check</literal></term>

178

179

<para>

180

Run the server’s self-tests. This includes any unit

181

tests, etc.

182

</para>

183

</listitem>

184

</varlistentry>

185

186

187

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

188

189

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

190

</listitem>

191

</varlistentry>

192

193

194

<term><literal>--priority <replaceable>

195

PRIORITY</replaceable></literal></term>

196

197

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

198

</listitem>

199

</varlistentry>

200

201

202

<term><literal>--servicename <replaceable>NAME</replaceable>

203

</literal></term>

204

205

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

206

xpointer="servicename"/>

207

</listitem>

208

</varlistentry>

209

210

211

<term><literal>--configdir <replaceable>DIR</replaceable>

212

</literal></term>

213

214

<para>

215

Directory to search for configuration files. Default is

216

<quote><literal>/etc/mandos</literal></quote>. See

217

<citerefentry><refentrytitle>mandos.conf</refentrytitle>

218

219

<refentrytitle>mandos-clients.conf</refentrytitle>

220

<manvolnum>5</manvolnum></citerefentry>.

221

</para>

222

</listitem>

223

</varlistentry>

224

225

226

<term><literal>--version</literal></term>

227

228

<para>

229

Prints the program version and exit.

230

</para>

231

</listitem>

232

</varlistentry>

233

</variablelist>

234

</refsect1>

235

236

237

<title>OVERVIEW</title>

238

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

239

<para>

240

This program is the server part. It is a normal server program

241

and will run in a normal system environment, not in an initial

242

RAM disk environment.

243

</para>

244

</refsect1>

245

246

247

<title>NETWORK PROTOCOL</title>

248

<para>

249

The Mandos server announces itself as a Zeroconf service of type

250

<quote><literal>_mandos._tcp</literal></quote>. The Mandos

251

client connects to the announced address and port, and sends a

252

line of text where the first whitespace-separated field is the

253

protocol version, which currently is

254

<quote><literal>1</literal></quote>. The client and server then

255

start a TLS protocol handshake with a slight quirk: the Mandos

256

server program acts as a TLS <quote>client</quote> while the

257

connecting Mandos client acts as a TLS <quote>server</quote>.

258

The Mandos client must supply an OpenPGP certificate, and the

259

fingerprint of this certificate is used by the Mandos server to

260

look up (in a list read from <filename>clients.conf</filename>

261

at start time) which binary blob to give the client. No other

262

authentication or authorization is done by the server.

263

</para>

264

<table>

265

<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>

266

<row>

267

<entry>Mandos Client</entry>

268

<entry>Direction</entry>

269

<entry>Mandos Server</entry>

270

</row>

271

</thead><tbody>

272

<row>

273

<entry>Connect</entry>

274

275

</row>

276

<row>

277

278

279

</row>

280

<row>

281

<entry>TLS handshake <emphasis>as TLS <quote>server</quote>

282

</emphasis></entry>

283

284

<entry>TLS handshake <emphasis>as TLS <quote>client</quote>

285

</emphasis></entry>

286

</row>

287

<row>

288

<entry>OpenPGP public key (part of TLS handshake)</entry>

289

290

</row>

291

<row>

292

293

294

<entry>Binary blob (client will assume OpenPGP data)</entry>

295

</row>

296

<row>

297

298

299

<entry>Close</entry>

300

</row>

301

</tbody></tgroup></table>

302

</refsect1>

303

304

305

<title>CHECKING</title>

306

<para>

307

The server will, by default, continually check that the clients

308

are still up. If a client has not been confirmed as being up

309

for some time, the client is assumed to be compromised and is no

310

longer eligible to receive the encrypted password. The timeout,

311

checker program, and interval between checks can be configured

312

both globally and per client; see <citerefentry>

313

<refentrytitle>mandos.conf</refentrytitle>

314

315

<refentrytitle>mandos-clients.conf</refentrytitle>

316

<manvolnum>5</manvolnum></citerefentry>.

317

</para>

318

</refsect1>

319

320

321

<title>LOGGING</title>

322

<para>

323

The server will send log messaged with various severity levels

324

to <filename>/dev/log</filename>. With the

325

<option>--debug</option> option, it will log even more messages,

326

and also show them on the console.

327

</para>

328

</refsect1>

329

330

331

<title>EXIT STATUS</title>

332

<para>

333

The server will exit with a non-zero exit status only when a

334

critical error is encountered.

335

</para>

336

</refsect1>

337

338

339

<title>ENVIRONMENT</title>

340

341

342

343

344

<para>

345

To start the configured checker (see <xref

346

linkend="checking"/>), the server uses

347

<filename>/bin/sh</filename>, which in turn uses

348

<varname>PATH</varname> to search for matching commands if

349

an absolute path is not given. See <citerefentry>

350

351

</citerefentry>

352

</para>

353

</listitem>

354

</varlistentry>

355

</variablelist>

356

</refsect1>

357

358

359

<title>FILES</title>

360

<para>

361

Use the <option>--configdir</option> option to change where

362

<command>&COMMANDNAME;</command> looks for its configurations

363

files. The default file names are listed here.

364

</para>

365

366

367

<term><filename>/etc/mandos/mandos.conf</filename></term>

368

369

<para>

370

Server-global settings. See

371

<citerefentry><refentrytitle>mandos.conf</refentrytitle>

372

<manvolnum>5</manvolnum></citerefentry> for details.

373

</para>

374

</listitem>

375

</varlistentry>

376

377

<term><filename>/etc/mandos/clients.conf</filename></term>

378

379

<para>

380

List of clients and client-specific settings. See

381

<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>

382

<manvolnum>5</manvolnum></citerefentry> for details.

383

</para>

384

</listitem>

385

</varlistentry>

386

387

<term><filename>/var/run/mandos/mandos.pid</filename></term>

388

389

<para>

390

The file containing the process id of

391

<command>&COMMANDNAME;</command>.

392

</para>

393

</listitem>

394

</varlistentry>

395

396

397

398

<para>

399

The Unix domain socket to where local syslog messages are

400

sent.

401

</para>

402

</listitem>

403

</varlistentry>

404

405

406

407

<para>

408

This is used to start the configured checker command for

409

each client. See <citerefentry>

410

<refentrytitle>mandos-clients.conf</refentrytitle>

411

<manvolnum>5</manvolnum></citerefentry> for details.

412

</para>

413

</listitem>

414

</varlistentry>

415

</variablelist>

416

</refsect1>

417

418

419

420

<para>

421

This server might, on especially fatal errors, emit a Python

422

backtrace. This could be considered a feature.

423

</para>

424

<para>

425

Currently, if a client is declared <quote>invalid</quote> due to

426

having timed out, the server does not record this fact onto

427

permanent storage. This has some security implications, see

428

<xref linkend="CLIENTS"/>.

429

</para>

430

<para>

431

There is currently no way of querying the server of the current

432

status of clients, other than analyzing its <systemitem

433

class="service">syslog</systemitem> output.

434

</para>

435

<para>

436

There is no fine-grained control over logging and debug output.

437

</para>

438

<para>

439

Debug mode is conflated with running in the foreground.

440

</para>

441

<para>

442

The console log messages does not show a timestamp.

443

</para>

444

</refsect1>

445

446

447

<title>EXAMPLE</title>

448

449

<para>

450

Normal invocation needs no options:

451

</para>

452

<para>

453

<userinput>mandos</userinput>

454

</para>

455

</informalexample>

456

457

<para>

458

Run the server in debug mode, read configuration files from

459

the <filename>~/mandos</filename> directory, and use the

460

Zeroconf service name <quote>Test</quote> to not collide with

461

any other official Mandos server on this host:

462

</para>

463

<para>

464

465

466

<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>

467

468

</para>

469

</informalexample>

470

471

<para>

472

Run the server normally, but only listen to one interface and

473

only on the link-local address on that interface:

474

</para>

475

<para>

476

477

478

<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>

479

480

</para>

481

</informalexample>

482

</refsect1>

483

484

485

<title>SECURITY</title>

486

487

<title>SERVER</title>

488

<para>

489

Running this <command>&COMMANDNAME;</command> server program

490

should not in itself present any security risk to the host

491

computer running it. The program does not need any special

492

privileges to run, and is designed to run as a non-root user.

493

</para>

494

</refsect2>

495

496

<title>CLIENTS</title>

497

<para>

498

The server only gives out its stored data to clients which

499

does have the OpenPGP key of the stored fingerprint. This is

500

guaranteed by the fact that the client sends its OpenPGP

501

public key in the TLS handshake; this ensures it to be

502

genuine. The server computes the fingerprint of the key

503

itself and looks up the fingerprint in its list of

504

clients. The <filename>clients.conf</filename> file (see

505

<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>

506

<manvolnum>5</manvolnum></citerefentry>)

507

<emphasis>must</emphasis> be made non-readable by anyone

508

except the user running the server.

509

</para>

510

<para>

511

As detailed in <xref linkend="checking"/>, the status of all

512

client computers will continually be checked and be assumed

513

compromised if they are gone for too long.

514

</para>

515

<para>

516

If a client is compromised, its downtime should be duly noted

517

by the server which would therefore declare the client

518

invalid. But if the server was ever restarted, it would

519

re-read its client list from its configuration file and again

520

regard all clients therein as valid, and hence eligible to

521

receive their passwords. Therefore, be careful when

522

restarting servers if it is suspected that a client has, in

523

fact, been compromised by parties who may now be running a

524

fake Mandos client with the keys from the non-encrypted

525

initial RAM image of the client host. What should be done in

526

that case (if restarting the server program really is

527

necessary) is to stop the server program, edit the

528

configuration file to omit any suspect clients, and restart

529

the server program.

530

</para>

531

<para>

532

For more details on client-side security, see

533

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

534

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

535

</para>

536

</refsect2>

537

</refsect1>

538

539

540

541

542

543

<term>

544

545

<refentrytitle>password-request</refentrytitle>

546

<manvolnum>8mandos</manvolnum>

547

</citerefentry>

548

</term>

549

550

<para>

551

This is the actual program which talks to this server.

552

Note that it is normally not invoked directly, and is only

553

run in the initial RAM disk environment, and not on a

554

fully started system.

555

</para>

556

</listitem>

557

</varlistentry>

558

559

<term>

560

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

561

</term>

562

563

<para>

564

Zeroconf is the network protocol standard used by clients

565

for finding this Mandos server on the local network.

566

</para>

567

</listitem>

568

</varlistentry>

569

570

<term>

571

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

572

</term>

573

574

<para>

575

Avahi is the library this server calls to implement

576

Zeroconf service announcements.

577

</para>

578

</listitem>

579

</varlistentry>

580

581

<term>

582

<ulink

583

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

584

</term>

585

586

<para>

587

GnuTLS is the library this server uses to implement TLS for

588

communicating securely with the client, and at the same time

589

confidently get the client’s public OpenPGP key.

590

</para>

591

</listitem>

592

</varlistentry>

593

594

<term>

595

<citation>RFC 4291: <citetitle>IP Version 6 Addressing

596

Architecture</citetitle>, section 2.5.6, Link-Local IPv6

597

Unicast Addresses</citation>

598

</term>

599

600

<para>

601

The clients use IPv6 link-local addresses, which are

602

immediately usable since a link-local addresses is

603

automatically assigned to a network interfaces when it is

604

brought up.

605

</para>

606

</listitem>

607

</varlistentry>

608

609

<term>

610

<citation>RFC 4346: <citetitle>The Transport Layer Security

611

(TLS) Protocol Version 1.1</citetitle></citation>

612

</term>

613

614

<para>

615

TLS 1.1 is the protocol implemented by GnuTLS.

616

</para>

617

</listitem>

618

</varlistentry>

619

620

<term>

621

<citation>RFC 4880: <citetitle>OpenPGP Message

622

Format</citetitle></citation>

623

</term>

624

625

<para>

626

The data sent to clients is binary encrypted OpenPGP data.

627

</para>

628

</listitem>

629

</varlistentry>

630

631

<term>

632

<citation>RFC 5081: <citetitle>Using OpenPGP Keys for

633

Transport Layer Security</citetitle></citation>

634

</term>

635

636

<para>

637

This is implemented by GnuTLS and used by this server so

638

that OpenPGP keys can be used.

639

</para>

640

</listitem>

641

</varlistentry>

642

</variablelist>

643

</refsect1>

644

</refentry>