/mandos/trunk : revision 659

11

# "AvahiService" class, and some lines in "main".

12

#

13

# Everything else is

14

15

14

15

16

#

17

# This program is free software: you can redistribute it and/or modify

18

# it under the terms of the GNU General Public License as published by

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

63

65

import cPickle as pickle

64

66

import multiprocessing

65

67

import types

68

import binascii

69

import tempfile

70

import itertools

71

import collections

66

72

67

73

import dbus

68

74

import dbus.service

82

88

except ImportError:

83

89

SO_BINDTODEVICE = None

84

90

85

86

version = "1.4.1"

91

version = "1.6.4"

92

stored_state_file = "clients.pickle"

87

93

88

94

logger = logging.getLogger()

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

address = str("/dev/log")))

92

syslogger.setFormatter(logging.Formatter

93

('Mandos [%(process)d]: %(levelname)s:'

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

console.setFormatter(logging.Formatter('%(asctime)s %(name)s'

99

' [%(process)d]:'

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

95

syslogger = None

96

97

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

(ctypes.util.find_library("c"))

100

.if_nametoindex)

101

except (OSError, AttributeError):

102

def if_nametoindex(interface):

103

"Get an interface index the hard way, i.e. using fcntl()"

104

SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h

105

with contextlib.closing(socket.socket()) as s:

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

struct.pack(str("16s16x"),

108

interface))

109

interface_index = struct.unpack(str("I"),

110

ifreq[16:20])[0]

111

return interface_index

112

113

114

def initlogger(debug, level=logging.WARNING):

115

"""init logger and add loglevel"""

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

address = str("/dev/log")))

121

syslogger.setFormatter(logging.Formatter

122

('Mandos [%(process)d]: %(levelname)s:'

123

' %(message)s'))

124

logger.addHandler(syslogger)

125

126

if debug:

127

console = logging.StreamHandler()

128

console.setFormatter(logging.Formatter('%(asctime)s %(name)s'

129

' [%(process)d]:'

130

' %(levelname)s:'

131

' %(message)s'))

132

logger.addHandler(console)

133

logger.setLevel(level)

134

135

136

class PGPError(Exception):

137

"""Exception if encryption/decryption fails"""

138

pass

139

140

141

class PGPEngine(object):

142

"""A simple class for OpenPGP symmetric encryption & decryption"""

143

def __init__(self):

144

self.tempdir = tempfile.mkdtemp(prefix="mandos-")

145

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

147

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

151

def __enter__(self):

152

return self

153

154

def __exit__(self, exc_type, exc_value, traceback):

155

self._cleanup()

156

return False

157

158

def __del__(self):

159

self._cleanup()

160

161

def _cleanup(self):

162

if self.tempdir is not None:

163

# Delete contents of tempdir

164

for root, dirs, files in os.walk(self.tempdir,

165

topdown = False):

166

for filename in files:

167

os.remove(os.path.join(root, filename))

168

for dirname in dirs:

169

os.rmdir(os.path.join(root, dirname))

170

# Remove tempdir

171

os.rmdir(self.tempdir)

172

self.tempdir = None

173

174

def password_encode(self, password):

175

# Passphrase can not be empty and can not contain newlines or

176

# NUL bytes. So we prefix it and hex encode it.

177

encoded = b"mandos" + binascii.hexlify(password)

178

if len(encoded) > 2048:

179

# GnuPG can't handle long passwords, so encode differently

180

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

181

.replace(b"\n", b"\\n")

182

.replace(b"\0", b"\\x00"))

183

return encoded

184

185

def encrypt(self, data, password):

186

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

189

passfile.write(passphrase)

190

passfile.flush()

191

proc = subprocess.Popen(['gpg', '--symmetric',

192

'--passphrase-file',

193

passfile.name]

194

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

ciphertext, err = proc.communicate(input = data)

199

if proc.returncode != 0:

200

raise PGPError(err)

201

return ciphertext

202

203

def decrypt(self, data, password):

204

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

207

passfile.write(passphrase)

208

passfile.flush()

209

proc = subprocess.Popen(['gpg', '--decrypt',

210

'--passphrase-file',

211

passfile.name]

212

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

218

if proc.returncode != 0:

219

raise PGPError(err)

220

return decrypted_plaintext

103

221

104

222

105

223

class AvahiError(Exception):

124

242

Used to optionally bind to the specified interface.

125

243

name: string; Example: 'Mandos'

126

244

type: string; Example: '_mandos._tcp'.

127

See <http://www.dns-sd.org/ServiceTypes.html>

245

See <https://www.iana.org/assignments/service-names-port-numbers>

128

246

port: integer; what port to announce

129

247

TXT: list of strings; TXT record for the service

130

248

domain: string; Domain to publish on, default to .local if empty.

136

254

server: D-Bus Server

137

255

bus: dbus.SystemBus()

138

256

"""

257

139

258

def __init__(self, interface = avahi.IF_UNSPEC, name = None,

140

259

servicetype = None, port = None, TXT = None,

141

260

domain = "", host = "", max_renames = 32768,

154

273

self.server = None

155

274

self.bus = bus

156

275

self.entry_group_state_changed_match = None

276

157

277

def rename(self):

158

278

"""Derived from the Avahi example code"""

159

279

if self.rename_count >= self.max_renames:

169

289

try:

170

290

self.add()

171

291

except dbus.exceptions.DBusException as error:

172

logger.critical("DBusException: %s", error)

292

logger.critical("D-Bus Exception", exc_info=error)

173

293

self.cleanup()

174

294

os._exit(1)

175

295

self.rename_count += 1

296

176

297

def remove(self):

177

298

"""Derived from the Avahi example code"""

178

299

if self.entry_group_state_changed_match is not None:

180

301

self.entry_group_state_changed_match = None

181

302

if self.group is not None:

182

303

self.group.Reset()

304

183

305

def add(self):

184

306

"""Derived from the Avahi example code"""

185

307

self.remove()

202

324

dbus.UInt16(self.port),

203

325

avahi.string_array_to_txt_array(self.TXT))

204

326

self.group.Commit()

327

205

328

def entry_group_state_changed(self, state, error):

206

329

"""Derived from the Avahi example code"""

207

330

logger.debug("Avahi entry group state change: %i", state)

214

337

elif state == avahi.ENTRY_GROUP_FAILURE:

215

338

logger.critical("Avahi: Error in group state changed %s",

216

339

unicode(error))

217

raise AvahiGroupError("State changed: %s"

218

% unicode(error))

340

raise AvahiGroupError("State changed: {0!s}"

341

.format(error))

342

219

343

def cleanup(self):

220

344

"""Derived from the Avahi example code"""

221

345

if self.group is not None:

222

346

try:

223

347

self.group.Free()

224

348

except (dbus.exceptions.UnknownMethodException,

225

dbus.exceptions.DBusException) as e:

349

dbus.exceptions.DBusException):

226

350

pass

227

351

self.group = None

228

352

self.remove()

353

229

354

def server_state_changed(self, state, error=None):

230

355

"""Derived from the Avahi example code"""

231

356

logger.debug("Avahi server state change: %i", state)

250

375

logger.debug("Unknown state: %r", state)

251

376

else:

252

377

logger.debug("Unknown state: %r: %r", state, error)

378

253

379

def activate(self):

254

380

"""Derived from the Avahi example code"""

255

381

if self.server is None:

262

388

self.server_state_changed)

263

389

self.server_state_changed(self.server.GetState())

264

390

391

265

392

class AvahiServiceToSyslog(AvahiService):

266

393

def rename(self):

267

394

"""Add the new name to the syslog messages"""

268

395

ret = AvahiService.rename(self)

269

396

syslogger.setFormatter(logging.Formatter

270

('Mandos (%s) [%%(process)d]:'

271

' %%(levelname)s: %%(message)s'

272

% self.name))

397

('Mandos ({0}) [%(process)d]:'

398

' %(levelname)s: %(message)s'

399

.format(self.name)))

273

400

return ret

274

401

275

def _timedelta_to_milliseconds(td):

402

403

def timedelta_to_milliseconds(td):

276

404

"Convert a datetime.timedelta() to milliseconds"

277

405

return ((td.days * 24 * 60 * 60 * 1000)

278

406

+ (td.seconds * 1000)

279

407

+ (td.microseconds // 1000))

280

408

409

281

410

class Client(object):

282

411

"""A representation of a client host served by this server.

283

412

284

413

Attributes:

285

_approved: bool(); 'None' if not yet approved/disapproved

414

approved: bool(); 'None' if not yet approved/disapproved

286

415

approval_delay: datetime.timedelta(); Time to wait for approval

287

416

approval_duration: datetime.timedelta(); Duration of one approval

288

417

checker: subprocess.Popen(); a running checker process used

295

424

instance %(name)s can be used in the command.

296

425

checker_initiator_tag: a gobject event source tag, or None

297

426

created: datetime.datetime(); (UTC) object creation

427

client_structure: Object describing what attributes a client has

428

and is used for storing the client at exit

298

429

current_checker_command: string; current running checker_command

299

disable_hook: If set, called by disable() as disable_hook(self)

300

430

disable_initiator_tag: a gobject event source tag, or None

301

431

enabled: bool()

302

432

fingerprint: string (40 or 32 hexadecimal digits); used to

305

435

interval: datetime.timedelta(); How often to start a new checker

306

436

last_approval_request: datetime.datetime(); (UTC) or None

307

437

last_checked_ok: datetime.datetime(); (UTC) or None

308

last_enabled: datetime.datetime(); (UTC)

438

last_checker_status: integer between 0 and 255 reflecting exit

439

status of last checker. -1 reflects crashed

440

checker, -2 means no checker completed yet.

441

last_enabled: datetime.datetime(); (UTC) or None

309

442

name: string; from the config file, used in log messages and

310

443

D-Bus identifiers

311

444

secret: bytestring; sent verbatim (over TLS) to client

312

445

timeout: datetime.timedelta(); How long from last_checked_ok

313

446

until this client is disabled

314

extended_timeout: extra long timeout when password has been sent

447

extended_timeout: extra long timeout when secret has been sent

315

448

runtime_expansions: Allowed attributes for runtime expansion.

316

449

expires: datetime.datetime(); time (UTC) when a client will be

317

450

disabled, or None

451

server_settings: The server_settings dict from main()

318

452

"""

319

453

320

454

runtime_expansions = ("approval_delay", "approval_duration",

321

"created", "enabled", "fingerprint",

322

"host", "interval", "last_checked_ok",

455

"created", "enabled", "expires",

456

"fingerprint", "host", "interval",

457

"last_approval_request", "last_checked_ok",

323

458

"last_enabled", "name", "timeout")

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

"checker": "fping -q -- %%(host)s",

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

324

469

325

470

def timeout_milliseconds(self):

326

471

"Return the 'timeout' attribute in milliseconds"

327

return _timedelta_to_milliseconds(self.timeout)

472

return timedelta_to_milliseconds(self.timeout)

328

473

329

474

def extended_timeout_milliseconds(self):

330

475

"Return the 'extended_timeout' attribute in milliseconds"

331

return _timedelta_to_milliseconds(self.extended_timeout)

476

return timedelta_to_milliseconds(self.extended_timeout)

332

477

333

478

def interval_milliseconds(self):

334

479

"Return the 'interval' attribute in milliseconds"

335

return _timedelta_to_milliseconds(self.interval)

480

return timedelta_to_milliseconds(self.interval)

336

481

337

482

def approval_delay_milliseconds(self):

338

return _timedelta_to_milliseconds(self.approval_delay)

339

340

def __init__(self, name = None, disable_hook=None, config=None):

341

"""Note: the 'checker' key in 'config' sets the

342

'checker_command' attribute and *not* the 'checker'

343

attribute."""

483

return timedelta_to_milliseconds(self.approval_delay)

484

485

@staticmethod

486

def config_parser(config):

487

"""Construct a new dict of client settings of this form:

488

{ client_name: {setting_name: value, ...}, ...}

489

with exceptions for any special settings as defined above.

490

NOTE: Must be a pure function. Must return the same result

491

value given the same arguments.

492

"""

493

settings = {}

494

for client_name in config.sections():

495

section = dict(config.items(client_name))

496

client = settings[client_name] = {}

497

498

client["host"] = section["host"]

499

# Reformat values from string types to Python types

500

client["approved_by_default"] = config.getboolean(

501

client_name, "approved_by_default")

502

client["enabled"] = config.getboolean(client_name,

503

"enabled")

504

505

client["fingerprint"] = (section["fingerprint"].upper()

506

.replace(" ", ""))

507

if "secret" in section:

508

client["secret"] = section["secret"].decode("base64")

509

elif "secfile" in section:

510

with open(os.path.expanduser(os.path.expandvars

511

(section["secfile"])),

512

"rb") as secfile:

513

client["secret"] = secfile.read()

514

else:

515

raise TypeError("No secret or secfile for section {0}"

516

.format(section))

517

client["timeout"] = string_to_delta(section["timeout"])

518

client["extended_timeout"] = string_to_delta(

519

section["extended_timeout"])

520

client["interval"] = string_to_delta(section["interval"])

521

client["approval_delay"] = string_to_delta(

522

section["approval_delay"])

523

client["approval_duration"] = string_to_delta(

524

section["approval_duration"])

525

client["checker_command"] = section["checker"]

526

client["last_approval_request"] = None

527

client["last_checked_ok"] = None

528

client["last_checker_status"] = -2

529

530

return settings

531

532

def __init__(self, settings, name = None, server_settings=None):

344

533

self.name = name

345

if config is None:

346

config = {}

534

if server_settings is None:

535

server_settings = {}

536

self.server_settings = server_settings

537

# adding all client settings

538

for setting, value in settings.iteritems():

539

setattr(self, setting, value)

540

541

if self.enabled:

542

if not hasattr(self, "last_enabled"):

543

self.last_enabled = datetime.datetime.utcnow()

544

if not hasattr(self, "expires"):

545

self.expires = (datetime.datetime.utcnow()

546

+ self.timeout)

547

else:

548

self.last_enabled = None

549

self.expires = None

550

347

551

logger.debug("Creating client %r", self.name)

348

552

# Uppercase and remove spaces from fingerprint for later

349

553

# comparison purposes with return value from the fingerprint()

350

554

# function

351

self.fingerprint = (config["fingerprint"].upper()

352

.replace(" ", ""))

353

555

logger.debug(" Fingerprint: %s", self.fingerprint)

354

if "secret" in config:

355

self.secret = config["secret"].decode("base64")

356

elif "secfile" in config:

357

with open(os.path.expanduser(os.path.expandvars

358

(config["secfile"])),

359

"rb") as secfile:

360

self.secret = secfile.read()

361

else:

362

raise TypeError("No secret or secfile for client %s"

363

% self.name)

364

self.host = config.get("host", "")

365

self.created = datetime.datetime.utcnow()

366

self.enabled = False

367

self.last_approval_request = None

368

self.last_enabled = None

369

self.last_checked_ok = None

370

self.timeout = string_to_delta(config["timeout"])

371

self.extended_timeout = string_to_delta(config

372

["extended_timeout"])

373

self.interval = string_to_delta(config["interval"])

374

self.disable_hook = disable_hook

556

self.created = settings.get("created",

557

datetime.datetime.utcnow())

558

559

# attributes specific for this server instance

375

560

self.checker = None

376

561

self.checker_initiator_tag = None

377

562

self.disable_initiator_tag = None

378

self.expires = None

379

563

self.checker_callback_tag = None

380

self.checker_command = config["checker"]

381

564

self.current_checker_command = None

382

self.last_connect = None

383

self._approved = None

384

self.approved_by_default = config.get("approved_by_default",

385

True)

565

self.approved = None

386

566

self.approvals_pending = 0

387

self.approval_delay = string_to_delta(

388

config["approval_delay"])

389

self.approval_duration = string_to_delta(

390

config["approval_duration"])

391

567

self.changedstate = (multiprocessing_manager

392

568

.Condition(multiprocessing_manager

393

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

572

if not attr.startswith("_")]

573

self.client_structure.append("client_structure")

574

575

for name, t in inspect.getmembers(type(self),

576

lambda obj:

577

isinstance(obj,

578

property)):

579

if not name.startswith("_"):

580

self.client_structure.append(name)

394

581

582

# Send notice to process children that client state has changed

395

583

def send_changedstate(self):

396

self.changedstate.acquire()

397

self.changedstate.notify_all()

398

self.changedstate.release()

584

with self.changedstate:

585

self.changedstate.notify_all()

399

586

400

587

def enable(self):

401

588

"""Start this client's checker and timeout hooks"""

402

589

if getattr(self, "enabled", False):

403

590

# Already enabled

404

591

return

592

self.expires = datetime.datetime.utcnow() + self.timeout

593

self.enabled = True

594

self.last_enabled = datetime.datetime.utcnow()

595

self.init_checker()

405

596

self.send_changedstate()

597

598

def disable(self, quiet=True):

599

"""Disable this client."""

600

if not getattr(self, "enabled", False):

601

return False

602

if not quiet:

603

logger.info("Disabling client %s", self.name)

604

if getattr(self, "disable_initiator_tag", None) is not None:

605

gobject.source_remove(self.disable_initiator_tag)

606

self.disable_initiator_tag = None

607

self.expires = None

608

if getattr(self, "checker_initiator_tag", None) is not None:

609

gobject.source_remove(self.checker_initiator_tag)

610

self.checker_initiator_tag = None

611

self.stop_checker()

612

self.enabled = False

613

if not quiet:

614

self.send_changedstate()

615

# Do not run this again if called by a gobject.timeout_add

616

return False

617

618

def __del__(self):

619

self.disable()

620

621

def init_checker(self):

406

622

# Schedule a new checker to be started an 'interval' from now,

407

623

# and every interval from then on.

624

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

408

626

self.checker_initiator_tag = (gobject.timeout_add

409

627

(self.interval_milliseconds(),

410

628

self.start_checker))

411

629

# Schedule a disable() when 'timeout' has passed

412

self.expires = datetime.datetime.utcnow() + self.timeout

630

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

413

632

self.disable_initiator_tag = (gobject.timeout_add

414

633

(self.timeout_milliseconds(),

415

634

self.disable))

416

self.enabled = True

417

self.last_enabled = datetime.datetime.utcnow()

418

635

# Also start a new checker *right now*.

419

636

self.start_checker()

420

637

421

def disable(self, quiet=True):

422

"""Disable this client."""

423

if not getattr(self, "enabled", False):

424

return False

425

if not quiet:

426

self.send_changedstate()

427

if not quiet:

428

logger.info("Disabling client %s", self.name)

429

if getattr(self, "disable_initiator_tag", False):

430

gobject.source_remove(self.disable_initiator_tag)

431

self.disable_initiator_tag = None

432

self.expires = None

433

if getattr(self, "checker_initiator_tag", False):

434

gobject.source_remove(self.checker_initiator_tag)

435

self.checker_initiator_tag = None

436

self.stop_checker()

437

if self.disable_hook:

438

self.disable_hook(self)

439

self.enabled = False

440

# Do not run this again if called by a gobject.timeout_add

441

return False

442

443

def __del__(self):

444

self.disable_hook = None

445

self.disable()

446

447

638

def checker_callback(self, pid, condition, command):

448

639

"""The checker has completed, so take appropriate actions."""

449

640

self.checker_callback_tag = None

450

641

self.checker = None

451

642

if os.WIFEXITED(condition):

452

exitstatus = os.WEXITSTATUS(condition)

453

if exitstatus == 0:

643

self.last_checker_status = os.WEXITSTATUS(condition)

644

if self.last_checker_status == 0:

454

645

logger.info("Checker for %(name)s succeeded",

455

646

vars(self))

456

647

self.checked_ok()

458

649

logger.info("Checker for %(name)s failed",

459

650

vars(self))

460

651

else:

652

self.last_checker_status = -1

461

653

logger.warning("Checker for %(name)s crashed?",

462

654

vars(self))

463

655

464

def checked_ok(self, timeout=None):

465

"""Bump up the timeout for this client.

466

467

This should only be called when the client has been seen,

468

alive and well.

469

"""

656

def checked_ok(self):

657

"""Assert that the client has been seen, alive and well."""

658

self.last_checked_ok = datetime.datetime.utcnow()

659

self.last_checker_status = 0

660

self.bump_timeout()

661

662

def bump_timeout(self, timeout=None):

663

"""Bump up the timeout for this client."""

470

664

if timeout is None:

471

665

timeout = self.timeout

472

self.last_checked_ok = datetime.datetime.utcnow()

473

666

if self.disable_initiator_tag is not None:

474

667

gobject.source_remove(self.disable_initiator_tag)

668

self.disable_initiator_tag = None

475

669

if getattr(self, "enabled", False):

476

670

self.disable_initiator_tag = (gobject.timeout_add

477

(_timedelta_to_milliseconds

671

(timedelta_to_milliseconds

478

672

(timeout), self.disable))

479

673

self.expires = datetime.datetime.utcnow() + timeout

480

674

487

681

If a checker already exists, leave it running and do

488

682

nothing."""

489

683

# The reason for not killing a running checker is that if we

490

# did that, then if a checker (for some reason) started

491

# running slowly and taking more than 'interval' time, the

492

# client would inevitably timeout, since no checker would get

493

# a chance to run to completion. If we instead leave running

684

# did that, and if a checker (for some reason) started running

685

# slowly and taking more than 'interval' time, then the client

686

# would inevitably timeout, since no checker would get a

687

# chance to run to completion. If we instead leave running

494

688

# checkers alone, the checker would have to take more time

495

689

# than 'timeout' for the client to be disabled, which is as it

496

690

# should be.

498

692

# If a checker exists, make sure it is not a zombie

499

693

try:

500

694

pid, status = os.waitpid(self.checker.pid, os.WNOHANG)

501

except (AttributeError, OSError) as error:

502

if (isinstance(error, OSError)

503

and error.errno != errno.ECHILD):

504

raise error

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

505

700

else:

506

701

if pid:

507

702

logger.warning("Checker was a zombie")

510

705

self.current_checker_command)

511

706

# Start a new checker if needed

512

707

if self.checker is None:

708

# Escape attributes for the shell

709

escaped_attrs = dict(

710

(attr, re.escape(unicode(getattr(self, attr))))

711

for attr in

712

self.runtime_expansions)

513

713

try:

514

# In case checker_command has exactly one % operator

515

command = self.checker_command % self.host

516

except TypeError:

517

# Escape attributes for the shell

518

escaped_attrs = dict(

519

(attr,

520

re.escape(unicode(str(getattr(self, attr, "")),

521

errors=

522

'replace')))

523

for attr in

524

self.runtime_expansions)

525

526

try:

527

command = self.checker_command % escaped_attrs

528

except TypeError as error:

529

logger.error('Could not format string "%s":'

530

' %s', self.checker_command, error)

531

return True # Try again later

714

command = self.checker_command % escaped_attrs

715

except TypeError as error:

716

logger.error('Could not format string "%s"',

717

self.checker_command, exc_info=error)

718

return True # Try again later

532

719

self.current_checker_command = command

533

720

try:

534

721

logger.info("Starting checker %r for %s",

537

724

# in normal mode, that is already done by daemon(),

538

725

# and in debug mode we don't want to. (Stdin is

539

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

540

735

self.checker = subprocess.Popen(command,

541

736

close_fds=True,

542

shell=True, cwd="/")

543

self.checker_callback_tag = (gobject.child_watch_add

544

(self.checker.pid,

545

self.checker_callback,

546

data=command))

547

# The checker may have completed before the gobject

548

# watch was added. Check for this.

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

549

750

pid, status = os.waitpid(self.checker.pid, os.WNOHANG)

550

if pid:

551

gobject.source_remove(self.checker_callback_tag)

552

self.checker_callback(pid, status, command)

553

751

except OSError as error:

554

logger.error("Failed to start subprocess: %s",

555

error)

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

556

761

# Re-run this periodically if run by gobject.timeout_add

557

762

return True

558

763

565

770

return

566

771

logger.debug("Stopping checker for %(name)s", vars(self))

567

772

try:

568

os.kill(self.checker.pid, signal.SIGTERM)

773

self.checker.terminate()

569

774

#time.sleep(0.5)

570

775

#if self.checker.poll() is None:

571

# os.kill(self.checker.pid, signal.SIGKILL)

776

# self.checker.kill()

572

777

except OSError as error:

573

778

if error.errno != errno.ESRCH: # No such process

574

779

raise

591

796

# "Set" method, so we fail early here:

592

797

if byte_arrays and signature != "ay":

593

798

raise ValueError("Byte arrays not supported for non-'ay'"

594

" signature %r" % signature)

799

" signature {0!r}".format(signature))

595

800

def decorator(func):

596

801

func._dbus_is_property = True

597

802

func._dbus_interface = dbus_interface

605

810

return decorator

606

811

607

812

813

def dbus_interface_annotations(dbus_interface):

814

"""Decorator for marking functions returning interface annotations

815

816

Usage:

817

818

@dbus_interface_annotations("org.example.Interface")

819

def _foo(self): # Function name does not matter

820

return {"org.freedesktop.DBus.Deprecated": "true",

821

"org.freedesktop.DBus.Property.EmitsChangedSignal":

822

"false"}

823

"""

824

def decorator(func):

825

func._dbus_is_interface = True

826

func._dbus_interface = dbus_interface

827

func._dbus_name = dbus_interface

828

return func

829

return decorator

830

831

832

def dbus_annotations(annotations):

833

"""Decorator to annotate D-Bus methods, signals or properties

834

Usage:

835

836

@dbus_service_property("org.example.Interface", signature="b",

837

access="r")

838

@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

def Property_dbus_property(self):

842

return dbus.Boolean(False)

843

"""

844

def decorator(func):

845

func._dbus_annotations = annotations

846

return func

847

return decorator

848

849

608

850

class DBusPropertyException(dbus.exceptions.DBusException):

609

851

"""A base class for D-Bus property-related exceptions

610

852

"""

633

875

"""

634

876

635

877

@staticmethod

636

def _is_dbus_property(obj):

637

return getattr(obj, "_dbus_is_property", False)

878

def _is_dbus_thing(thing):

879

"""Returns a function testing if an attribute is a D-Bus thing

880

881

If called like _is_dbus_thing("method") it returns a function

882

suitable for use as predicate to inspect.getmembers().

883

"""

884

return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),

885

False)

638

886

639

def _get_all_dbus_properties(self):

887

def _get_all_dbus_things(self, thing):

640

888

"""Returns a generator of (name, attribute) pairs

641

889

"""

642

return ((prop.__get__(self)._dbus_name, prop.__get__(self))

890

return ((getattr(athing.__get__(self), "_dbus_name",

891

name),

892

athing.__get__(self))

643

893

for cls in self.__class__.__mro__

644

for name, prop in

645

inspect.getmembers(cls, self._is_dbus_property))

894

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

646

897

647

898

def _get_dbus_property(self, interface_name, property_name):

648

899

"""Returns a bound method if one exists which is a D-Bus

650

901

"""

651

902

for cls in self.__class__.__mro__:

652

903

for name, value in (inspect.getmembers

653

(cls, self._is_dbus_property)):

904

(cls,

905

self._is_dbus_thing("property"))):

654

906

if (value._dbus_name == property_name

655

907

and value._dbus_interface == interface_name):

656

908

return value.__get__(self)

684

936

# The byte_arrays option is not supported yet on

685

937

# signatures other than "ay".

686

938

if prop._dbus_signature != "ay":

687

raise ValueError

688

value = dbus.ByteArray(''.join(unichr(byte)

689

for byte in value))

939

raise ValueError("Byte arrays not supported for non-"

940

"'ay' signature {0!r}"

941

.format(prop._dbus_signature))

942

value = dbus.ByteArray(b''.join(chr(byte)

943

for byte in value))

690

944

prop(value)

691

945

692

946

@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",

697

951

698

952

Note: Will not include properties with access="write".

699

953

"""

700

all = {}

701

for name, prop in self._get_all_dbus_properties():

954

properties = {}

955

for name, prop in self._get_all_dbus_things("property"):

702

956

if (interface_name

703

957

and interface_name != prop._dbus_interface):

704

958

# Interface non-empty but did not match

708

962

continue

709

963

value = prop()

710

964

if not hasattr(value, "variant_level"):

711

all[name] = value

965

properties[name] = value

712

966

continue

713

all[name] = type(value)(value, variant_level=

714

value.variant_level+1)

715

return dbus.Dictionary(all, signature="sv")

967

properties[name] = type(value)(value, variant_level=

968

value.variant_level+1)

969

return dbus.Dictionary(properties, signature="sv")

716

970

717

971

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

718

972

out_signature="s",

719

973

path_keyword='object_path',

720

974

connection_keyword='connection')

721

975

def Introspect(self, object_path, connection):

722

"""Standard D-Bus method, overloaded to insert property tags.

976

"""Overloading of standard D-Bus method.

977

978

Inserts property tags and interface annotation tags.

723

979

"""

724

980

xmlstring = dbus.service.Object.Introspect(self, object_path,

725

981

connection)

732

988

e.setAttribute("access", prop._dbus_access)

733

989

return e

734

990

for if_tag in document.getElementsByTagName("interface"):

991

# Add property tags

735

992

for tag in (make_tag(document, name, prop)

736

993

for name, prop

737

in self._get_all_dbus_properties()

994

in self._get_all_dbus_things("property")

738

995

if prop._dbus_interface

739

996

== if_tag.getAttribute("name")):

740

997

if_tag.appendChild(tag)

998

# Add annotation tags

999

for typ in ("method", "signal", "property"):

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

if (name == tag.getAttribute("name")

1005

and prop._dbus_interface

1006

== if_tag.getAttribute("name")):

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

if name == if_tag.getAttribute("name")

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

741

1029

# Add the names to the return values for the

742

1030

# "org.freedesktop.DBus.Properties" methods

743

1031

if (if_tag.getAttribute("name")

758

1046

except (AttributeError, xml.dom.DOMException,

759

1047

xml.parsers.expat.ExpatError) as error:

760

1048

logger.error("Failed to override Introspection method",

761

error)

1049

exc_info=error)

762

1050

return xmlstring

763

1051

764

1052

765

def datetime_to_dbus (dt, variant_level=0):

1053

def datetime_to_dbus(dt, variant_level=0):

766

1054

"""Convert a UTC datetime.datetime() to a D-Bus type."""

767

1055

if dt is None:

768

1056

return dbus.String("", variant_level = variant_level)

769

1057

return dbus.String(dt.isoformat(),

770

1058

variant_level=variant_level)

771

1059

772

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

773

.__metaclass__):

774

"""Applied to an empty subclass of a D-Bus object, this metaclass

775

will add additional D-Bus attributes matching a certain pattern.

1060

1061

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1062

"""A class decorator; applied to a subclass of

1063

dbus.service.Object, it will add alternate D-Bus attributes with

1064

interface names according to the "alt_interface_names" mapping.

1065

Usage:

1066

1067

@alternate_dbus_interfaces({"org.example.Interface":

1068

"net.example.AlternateInterface"})

1069

class SampleDBusObject(dbus.service.Object):

1070

@dbus.service.method("org.example.Interface")

1071

def SampleDBusMethod():

1072

pass

1073

1074

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

reachable via two interfaces: "org.example.Interface" and

1076

"net.example.AlternateInterface", the latter of which will have

1077

its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to

1078

"true", unless "deprecate" is passed with a False value.

1079

1080

This works for methods and signals, and also for D-Bus properties

1081

(from DBusObjectWithProperties) and interfaces (from the

1082

dbus_interface_annotations decorator).

776

1083

"""

777

def __new__(mcs, name, bases, attr):

778

# Go through all the base classes which could have D-Bus

779

# methods, signals, or properties in them

780

for base in (b for b in bases

781

if issubclass(b, dbus.service.Object)):

782

# Go though all attributes of the base class

783

for attrname, attribute in inspect.getmembers(base):

1084

def wrapper(cls):

1085

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1087

attr = {}

1088

interface_names = set()

1089

# Go though all attributes of the class

1090

for attrname, attribute in inspect.getmembers(cls):

784

1091

# Ignore non-D-Bus attributes, and D-Bus attributes

785

1092

# with the wrong interface name

786

1093

if (not hasattr(attribute, "_dbus_interface")

787

1094

or not attribute._dbus_interface

788

.startswith("se.recompile.Mandos")):

1095

.startswith(orig_interface_name)):

789

1096

continue

790

1097

# Create an alternate D-Bus interface name based on

791

1098

# the current name

792

1099

alt_interface = (attribute._dbus_interface

793

.replace("se.recompile.Mandos",

794

"se.bsnet.fukt.Mandos"))

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1102

interface_names.add(alt_interface)

795

1103

# Is this a D-Bus signal?

796

1104

if getattr(attribute, "_dbus_is_signal", False):

797

# Extract the original non-method function by

798

# black magic

1105

# Extract the original non-method undecorated

1106

# function by black magic

799

1107

nonmethod_func = (dict(

800

1108

zip(attribute.func_code.co_freevars,

801

1109

attribute.__closure__))["func"]

812

1120

nonmethod_func.func_name,

813

1121

nonmethod_func.func_defaults,

814

1122

nonmethod_func.func_closure)))

1123

# Copy annotations, if any

1124

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1127

except AttributeError:

1128

pass

815

1129

# Define a creator of a function to call both the

816

# old and new functions, so both the old and new

817

# signals gets sent when the function is called

1130

# original and alternate functions, so both the

1131

# original and alternate signals gets sent when

1132

# the function is called

818

1133

def fixscope(func1, func2):

819

1134

"""This function is a scope container to pass

820

1135

func1 and func2 to the "call_both" function

827

1142

return call_both

828

1143

# Create the "call_both" function and add it to

829

1144

# the class

830

attr[attrname] = fixscope(attribute,

831

new_function)

1145

attr[attrname] = fixscope(attribute, new_function)

832

1146

# Is this a D-Bus method?

833

1147

elif getattr(attribute, "_dbus_is_method", False):

834

1148

# Create a new, but exactly alike, function

845

1159

attribute.func_name,

846

1160

attribute.func_defaults,

847

1161

attribute.func_closure)))

1162

# Copy annotations, if any

1163

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1166

except AttributeError:

1167

pass

848

1168

# Is this a D-Bus property?

849

1169

elif getattr(attribute, "_dbus_is_property", False):

850

1170

# Create a new, but exactly alike, function

864

1184

attribute.func_name,

865

1185

attribute.func_defaults,

866

1186

attribute.func_closure)))

867

return type.__new__(mcs, name, bases, attr)

868

1187

# Copy annotations, if any

1188

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1191

except AttributeError:

1192

pass

1193

# Is this a D-Bus interface?

1194

elif getattr(attribute, "_dbus_is_interface", False):

1195

# Create a new, but exactly alike, function

1196

# object. Decorate it to be a new D-Bus interface

1197

# with the alternate D-Bus interface name. Add it

1198

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1207

if deprecate:

1208

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1210

for interface_name in interface_names:

1211

@dbus_interface_annotations(interface_name)

1212

def func(self):

1213

return { "org.freedesktop.DBus.Deprecated":

1214

"true" }

1215

# Find an unused name

1216

for aname in (iname.format(i)

1217

for i in itertools.count()):

1218

if aname not in attr:

1219

attr[aname] = func

1220

break

1221

if interface_names:

1222

# Replace the class with a new subclass of it with

1223

# methods, signals, etc. as created above.

1224

cls = type(b"{0}Alternate".format(cls.__name__),

1225

(cls,), attr)

1226

return cls

1227

return wrapper

1228

1229

1230

@alternate_dbus_interfaces({"se.recompile.Mandos":

1231

"se.bsnet.fukt.Mandos"})

869

1232

class ClientDBus(Client, DBusObjectWithProperties):

870

1233

"""A Client class using D-Bus

871

1234

880

1243

# dbus.service.Object doesn't use super(), so we can't either.

881

1244

882

1245

def __init__(self, bus = None, *args, **kwargs):

883

self._approvals_pending = 0

884

1246

self.bus = bus

885

1247

Client.__init__(self, *args, **kwargs)

886

1248

# Only now, when this client is initialized, can it show up on

892

1254

("/clients/" + client_object_name))

893

1255

DBusObjectWithProperties.__init__(self, self.bus,

894

1256

self.dbus_object_path)

895

1257

896

1258

def notifychangeproperty(transform_func,

897

1259

dbus_name, type_func=lambda x: x,

898

1260

variant_level=1):

899

1261

""" Modify a variable so that it's a property which announces

900

1262

its changes to DBus.

901

1263

902

1264

transform_fun: Function that takes a value and a variant_level

903

1265

and transforms it to a D-Bus type.

904

1266

dbus_name: D-Bus name of the variable

921

1283

922

1284

return property(lambda self: getattr(self, attrname), setter)

923

1285

924

925

1286

expires = notifychangeproperty(datetime_to_dbus, "Expires")

926

1287

approvals_pending = notifychangeproperty(dbus.Boolean,

927

1288

"ApprovalPending",

934

1295

checker is not None)

935

1296

last_checked_ok = notifychangeproperty(datetime_to_dbus,

936

1297

"LastCheckedOK")

1298

last_checker_status = notifychangeproperty(dbus.Int16,

1299

"LastCheckerStatus")

937

1300

last_approval_request = notifychangeproperty(

938

1301

datetime_to_dbus, "LastApprovalRequest")

939

1302

approved_by_default = notifychangeproperty(dbus.Boolean,

940

1303

"ApprovedByDefault")

941

approval_delay = notifychangeproperty(dbus.UInt16,

1304

approval_delay = notifychangeproperty(dbus.UInt64,

942

1305

"ApprovalDelay",

943

1306

type_func =

944

_timedelta_to_milliseconds)

1307

timedelta_to_milliseconds)

945

1308

approval_duration = notifychangeproperty(

946

dbus.UInt16, "ApprovalDuration",

947

type_func = _timedelta_to_milliseconds)

1309

dbus.UInt64, "ApprovalDuration",

1310

type_func = timedelta_to_milliseconds)

948

1311

host = notifychangeproperty(dbus.String, "Host")

949

timeout = notifychangeproperty(dbus.UInt16, "Timeout",

1312

timeout = notifychangeproperty(dbus.UInt64, "Timeout",

950

1313

type_func =

951

_timedelta_to_milliseconds)

1314

timedelta_to_milliseconds)

952

1315

extended_timeout = notifychangeproperty(

953

dbus.UInt16, "ExtendedTimeout",

954

type_func = _timedelta_to_milliseconds)

955

interval = notifychangeproperty(dbus.UInt16,

1316

dbus.UInt64, "ExtendedTimeout",

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

956

1319

"Interval",

957

1320

type_func =

958

_timedelta_to_milliseconds)

1321

timedelta_to_milliseconds)

959

1322

checker_command = notifychangeproperty(dbus.String, "Checker")

960

1323

961

1324

del notifychangeproperty

989

1352

*args, **kwargs)

990

1353

991

1354

def start_checker(self, *args, **kwargs):

992

old_checker = self.checker

993

if self.checker is not None:

994

old_checker_pid = self.checker.pid

995

else:

996

old_checker_pid = None

1355

old_checker_pid = getattr(self.checker, "pid", None)

997

1356

r = Client.start_checker(self, *args, **kwargs)

998

1357

# Only if new checker process was started

999

1358

if (self.checker is not None

1003

1362

return r

1004

1363

1005

1364

def _reset_approved(self):

1006

self._approved = None

1365

self.approved = None

1007

1366

return False

1008

1367

1009

1368

def approve(self, value=True):

1010

self.send_changedstate()

1011

self._approved = value

1012

gobject.timeout_add(_timedelta_to_milliseconds

1369

self.approved = value

1370

gobject.timeout_add(timedelta_to_milliseconds

1013

1371

(self.approval_duration),

1014

1372

self._reset_approved)

1015

1373

self.send_changedstate()

1016

1374

1017

1375

## D-Bus methods, signals & properties

1018

1376

_interface = "se.recompile.Mandos.Client"

1019

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

return { "org.freedesktop.DBus.Property.EmitsChangedSignal":

1383

"false"}

1384

1020

1385

## Signals

1021

1386

1022

1387

# CheckerCompleted - signal

1121

1486

access="readwrite")

1122

1487

def ApprovalDuration_dbus_property(self, value=None):

1123

1488

if value is None: # get

1124

return dbus.UInt64(_timedelta_to_milliseconds(

1489

return dbus.UInt64(timedelta_to_milliseconds(

1125

1490

self.approval_duration))

1126

1491

self.approval_duration = datetime.timedelta(0, 0, 0, value)

1127

1492

1141

1506

def Host_dbus_property(self, value=None):

1142

1507

if value is None: # get

1143

1508

return dbus.String(self.host)

1144

self.host = value

1509

self.host = unicode(value)

1145

1510

1146

1511

# Created - property

1147

1512

@dbus_service_property(_interface, signature="s", access="read")

1148

1513

def Created_dbus_property(self):

1149

return dbus.String(datetime_to_dbus(self.created))

1514

return datetime_to_dbus(self.created)

1150

1515

1151

1516

# LastEnabled - property

1152

1517

@dbus_service_property(_interface, signature="s", access="read")

1173

1538

return

1174

1539

return datetime_to_dbus(self.last_checked_ok)

1175

1540

1541

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

1544

def LastCheckerStatus_dbus_property(self):

1545

return dbus.Int16(self.last_checker_status)

1546

1176

1547

# Expires - property

1177

1548

@dbus_service_property(_interface, signature="s", access="read")

1178

1549

def Expires_dbus_property(self):

1189

1560

def Timeout_dbus_property(self, value=None):

1190

1561

if value is None: # get

1191

1562

return dbus.UInt64(self.timeout_milliseconds())

1563

old_timeout = self.timeout

1192

1564

self.timeout = datetime.timedelta(0, 0, 0, value)

1193

if getattr(self, "disable_initiator_tag", None) is None:

1194

return

1195

# Reschedule timeout

1196

gobject.source_remove(self.disable_initiator_tag)

1197

self.disable_initiator_tag = None

1198

self.expires = None

1199

time_to_die = _timedelta_to_milliseconds((self

1200

.last_checked_ok

1201

+ self.timeout)

1202

- datetime.datetime

1203

.utcnow())

1204

if time_to_die <= 0:

1205

# The timeout has passed

1206

self.disable()

1207

else:

1208

self.expires = (datetime.datetime.utcnow()

1209

+ datetime.timedelta(milliseconds =

1210

time_to_die))

1211

self.disable_initiator_tag = (gobject.timeout_add

1212

(time_to_die, self.disable))

1565

# Reschedule disabling

1566

if self.enabled:

1567

now = datetime.datetime.utcnow()

1568

self.expires += self.timeout - old_timeout

1569

if self.expires <= now:

1570

# The timeout has passed

1571

self.disable()

1572

else:

1573

if (getattr(self, "disable_initiator_tag", None)

1574

is None):

1575

return

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1213

1581

1214

1582

# ExtendedTimeout - property

1215

1583

@dbus_service_property(_interface, signature="t",

1228

1596

self.interval = datetime.timedelta(0, 0, 0, value)

1229

1597

if getattr(self, "checker_initiator_tag", None) is None:

1230

1598

return

1231

# Reschedule checker run

1232

gobject.source_remove(self.checker_initiator_tag)

1233

self.checker_initiator_tag = (gobject.timeout_add

1234

(value, self.start_checker))

1235

self.start_checker() # Start one now, too

1599

if self.enabled:

1600

# Reschedule checker run

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1236

1605

1237

1606

# Checker - property

1238

1607

@dbus_service_property(_interface, signature="s",

1240

1609

def Checker_dbus_property(self, value=None):

1241

1610

if value is None: # get

1242

1611

return dbus.String(self.checker_command)

1243

self.checker_command = value

1612

self.checker_command = unicode(value)

1244

1613

1245

1614

# CheckerRunning - property

1246

1615

@dbus_service_property(_interface, signature="b",

1275

1644

raise KeyError()

1276

1645

1277

1646

def __getattribute__(self, name):

1278

if(name == '_pipe'):

1647

if name == '_pipe':

1279

1648

return super(ProxyClient, self).__getattribute__(name)

1280

1649

self._pipe.send(('getattr', name))

1281

1650

data = self._pipe.recv()

1288

1657

return func

1289

1658

1290

1659

def __setattr__(self, name, value):

1291

if(name == '_pipe'):

1660

if name == '_pipe':

1292

1661

return super(ProxyClient, self).__setattr__(name, value)

1293

1662

self._pipe.send(('setattr', name, value))

1294

1663

1295

class ClientDBusTransitional(ClientDBus):

1296

__metaclass__ = AlternateDBusNamesMetaclass

1297

1664

1298

1665

class ClientHandler(socketserver.BaseRequestHandler, object):

1299

1666

"""A class to handle client connections.

1336

1703

logger.debug("Protocol version: %r", line)

1337

1704

try:

1338

1705

if int(line.strip().split()[0]) > 1:

1339

raise RuntimeError

1706

raise RuntimeError(line)

1340

1707

except (ValueError, IndexError, RuntimeError) as error:

1341

1708

logger.error("Unknown protocol version: %s", error)

1342

1709

return

1382

1749

client.Rejected("Disabled")

1383

1750

return

1384

1751

1385

if client._approved or not client.approval_delay:

1752

if client.approved or not client.approval_delay:

1386

1753

#We are approved or approval is disabled

1387

1754

break

1388

elif client._approved is None:

1755

elif client.approved is None:

1389

1756

logger.info("Client %s needs approval",

1390

1757

client.name)

1391

1758

if self.server.use_dbus:

1404

1771

#wait until timeout or approved

1405

1772

time = datetime.datetime.now()

1406

1773

client.changedstate.acquire()

1407

(client.changedstate.wait

1408

(float(client._timedelta_to_milliseconds(delay)

1409

/ 1000)))

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

1410

1777

client.changedstate.release()

1411

1778

time2 = datetime.datetime.now()

1412

1779

if (time2 - time) >= delay:

1428

1795

try:

1429

1796

sent = session.send(client.secret[sent_size:])

1430

1797

except gnutls.errors.GNUTLSError as error:

1431

logger.warning("gnutls send failed")

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1432

1800

return

1433

1801

logger.debug("Sent: %d, remaining: %d",

1434

1802

sent, len(client.secret)

1437

1805

1438

1806

logger.info("Sending secret to %s", client.name)

1439

1807

# bump the timeout using extended_timeout

1440

client.checked_ok(client.extended_timeout)

1808

client.bump_timeout(client.extended_timeout)

1441

1809

if self.server.use_dbus:

1442

1810

# Emit D-Bus signal

1443

1811

client.GotSecret()

1448

1816

try:

1449

1817

session.bye()

1450

1818

except gnutls.errors.GNUTLSError as error:

1451

logger.warning("GnuTLS bye failed")

1819

logger.warning("GnuTLS bye failed",

1820

exc_info=error)

1452

1821

1453

1822

@staticmethod

1454

1823

def peer_certificate(session):

1510

1879

# Convert the buffer to a Python bytestring

1511

1880

fpr = ctypes.string_at(buf, buf_len.value)

1512

1881

# Convert the bytestring to hexadecimal notation

1513

hex_fpr = ''.join("%02X" % ord(char) for char in fpr)

1882

hex_fpr = binascii.hexlify(fpr).upper()

1514

1883

return hex_fpr

1515

1884

1516

1885

1519

1888

def sub_process_main(self, request, address):

1520

1889

try:

1521

1890

self.finish_request(request, address)

1522

except:

1891

except Exception:

1523

1892

self.handle_error(request, address)

1524

1893

self.close_request(request)

1525

1894

1526

1895

def process_request(self, request, address):

1527

1896

"""Start a new process to process the request."""

1528

1897

proc = multiprocessing.Process(target = self.sub_process_main,

1529

args = (request,

1530

address))

1898

args = (request, address))

1531

1899

proc.start()

1532

1900

return proc

1533

1901

1548

1916

1549

1917

def add_pipe(self, parent_pipe, proc):

1550

1918

"""Dummy function; override as necessary"""

1551

raise NotImplementedError

1919

raise NotImplementedError()

1552

1920

1553

1921

1554

1922

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1561

1929

use_ipv6: Boolean; to use IPv6 or not

1562

1930

"""

1563

1931

def __init__(self, server_address, RequestHandlerClass,

1564

interface=None, use_ipv6=True):

1932

interface=None, use_ipv6=True, socketfd=None):

1933

"""If socketfd is set, use that file descriptor instead of

1934

creating a new one with socket.socket().

1935

"""

1565

1936

self.interface = interface

1566

1937

if use_ipv6:

1567

1938

self.address_family = socket.AF_INET6

1939

if socketfd is not None:

1940

# Save the file descriptor

1941

self.socketfd = socketfd

1942

# Save the original socket.socket() function

1943

self.socket_socket = socket.socket

1944

# To implement --socket, we monkey patch socket.socket.

1945

#

1946

# (When socketserver.TCPServer is a new-style class, we

1947

# could make self.socket into a property instead of monkey

1948

# patching socket.socket.)

1949

#

1950

# Create a one-time-only replacement for socket.socket()

1951

@functools.wraps(socket.socket)

1952

def socket_wrapper(*args, **kwargs):

1953

# Restore original function so subsequent calls are

1954

# not affected.

1955

socket.socket = self.socket_socket

1956

del self.socket_socket

1957

# This time only, return a new socket object from the

1958

# saved file descriptor.

1959

return socket.fromfd(self.socketfd, *args, **kwargs)

1960

# Replace socket.socket() function with wrapper

1961

socket.socket = socket_wrapper

1962

# The socketserver.TCPServer.__init__ will call

1963

# socket.socket(), which might be our replacement,

1964

# socket_wrapper(), if socketfd was set.

1568

1965

socketserver.TCPServer.__init__(self, server_address,

1569

1966

RequestHandlerClass)

1967

1570

1968

def server_bind(self):

1571

1969

"""This overrides the normal server_bind() function

1572

1970

to bind to an interface if one was specified, and also NOT to

1580

1978

try:

1581

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1582

1980

SO_BINDTODEVICE,

1583

str(self.interface

1584

+ '\0'))

1981

str(self.interface + '\0'))

1585

1982

except socket.error as error:

1586

if error[0] == errno.EPERM:

1587

logger.error("No permission to"

1588

" bind to interface %s",

1589

self.interface)

1590

elif error[0] == errno.ENOPROTOOPT:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1591

1987

logger.error("SO_BINDTODEVICE not available;"

1592

1988

" cannot bind to interface %s",

1593

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

logger.error("Interface %s does not exist,"

1992

" cannot bind", self.interface)

1594

1993

else:

1595

1994

raise

1596

1995

# Only bind(2) the socket if we really need to.

1599

1998

if self.address_family == socket.AF_INET6:

1600

1999

any_address = "::" # in6addr_any

1601

2000

else:

1602

any_address = socket.INADDR_ANY

2001

any_address = "0.0.0.0" # INADDR_ANY

1603

2002

self.server_address = (any_address,

1604

2003

self.server_address[1])

1605

2004

elif not self.server_address[1]:

1626

2025

"""

1627

2026

def __init__(self, server_address, RequestHandlerClass,

1628

2027

interface=None, use_ipv6=True, clients=None,

1629

gnutls_priority=None, use_dbus=True):

2028

gnutls_priority=None, use_dbus=True, socketfd=None):

1630

2029

self.enabled = False

1631

2030

self.clients = clients

1632

2031

if self.clients is None:

1633

self.clients = set()

2032

self.clients = {}

1634

2033

self.use_dbus = use_dbus

1635

2034

self.gnutls_priority = gnutls_priority

1636

2035

IPv6_TCPServer.__init__(self, server_address,

1637

2036

RequestHandlerClass,

1638

2037

interface = interface,

1639

use_ipv6 = use_ipv6)

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

1640

2040

def server_activate(self):

1641

2041

if self.enabled:

1642

2042

return socketserver.TCPServer.server_activate(self)

1655

2055

1656

2056

def handle_ipc(self, source, condition, parent_pipe=None,

1657

2057

proc = None, client_object=None):

1658

condition_names = {

1659

gobject.IO_IN: "IN", # There is data to read.

1660

gobject.IO_OUT: "OUT", # Data can be written (without

1661

# blocking).

1662

gobject.IO_PRI: "PRI", # There is urgent data to read.

1663

gobject.IO_ERR: "ERR", # Error condition.

1664

gobject.IO_HUP: "HUP" # Hung up (the connection has been

1665

# broken, usually for pipes and

1666

# sockets).

1667

}

1668

conditions_string = ' | '.join(name

1669

for cond, name in

1670

condition_names.iteritems()

1671

if cond & condition)

1672

2058

# error, or the other end of multiprocessing.Pipe has closed

1673

if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):

2059

if condition & (gobject.IO_ERR | gobject.IO_HUP):

1674

2060

# Wait for other process to exit

1675

2061

proc.join()

1676

2062

return False

1683

2069

fpr = request[1]

1684

2070

address = request[2]

1685

2071

1686

for c in self.clients:

2072

for c in self.clients.itervalues():

1687

2073

if c.fingerprint == fpr:

1688

2074

client = c

1689

2075

break

1734

2120

return True

1735

2121

1736

2122

2123

def rfc3339_duration_to_delta(duration):

2124

"""Parse an RFC 3339 "duration" and return a datetime.timedelta

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2140

"""

2141

2142

# Parsing an RFC 3339 duration with regular expressions is not

2143

# possible - there would have to be multiple places for the same

2144

# values, like seconds. The current code, while more esoteric, is

2145

# cleaner without depending on a parsing library. If Python had a

2146

# built-in library for parsing we would use it, but we'd like to

2147

# avoid excessive use of external libraries.

2148

2149

# New type for defining tokens, syntax, and semantics all-in-one

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2159

# RFC 3339 "duration" tokens, syntax, and semantics; taken from

2160

# the "duration" ABNF definition in RFC 3339, Appendix A.

2161

token_end = Token(re.compile(r"$"), None, frozenset())

2162

token_second = Token(re.compile(r"(\d+)S"),

2163

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2165

token_minute = Token(re.compile(r"(\d+)M"),

2166

datetime.timedelta(minutes=1),

2167

frozenset((token_second, token_end)))

2168

token_hour = Token(re.compile(r"(\d+)H"),

2169

datetime.timedelta(hours=1),

2170

frozenset((token_minute, token_end)))

2171

token_time = Token(re.compile(r"T"),

2172

None,

2173

frozenset((token_hour, token_minute,

2174

token_second)))

2175

token_day = Token(re.compile(r"(\d+)D"),

2176

datetime.timedelta(days=1),

2177

frozenset((token_time, token_end)))

2178

token_month = Token(re.compile(r"(\d+)M"),

2179

datetime.timedelta(weeks=4),

2180

frozenset((token_day, token_end)))

2181

token_year = Token(re.compile(r"(\d+)Y"),

2182

datetime.timedelta(weeks=52),

2183

frozenset((token_month, token_end)))

2184

token_week = Token(re.compile(r"(\d+)W"),

2185

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2187

token_duration = Token(re.compile(r"P"), None,

2188

frozenset((token_year, token_month,

2189

token_day, token_time,

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2193

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2196

# Loop until end token is found

2197

while found_token is not token_end:

2198

# Search for any currently valid tokens

2199

for token in followers:

2200

match = token.regexp.match(s)

2201

if match is not None:

2202

# Token found

2203

if token.value is not None:

2204

# Value found, parse digits

2205

factor = int(match.group(1), 10)

2206

# Add to value so far

2207

value += factor * token.value

2208

# Strip token from string

2209

s = token.regexp.sub("", s, 1)

2210

# Go to found token

2211

found_token = token

2212

# Set valid next tokens

2213

followers = found_token.followers

2214

break

2215

else:

2216

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2218

# End token found

2219

return value

2220

2221

1737

2222

def string_to_delta(interval):

1738

2223

"""Parse a string and return a datetime.timedelta

1739

2224

1750

2235

>>> string_to_delta('5m 30s')

1751

2236

datetime.timedelta(0, 330)

1752

2237

"""

2238

2239

try:

2240

return rfc3339_duration_to_delta(interval)

2241

except ValueError:

2242

pass

2243

1753

2244

timevalue = datetime.timedelta(0)

1754

2245

for s in interval.split():

1755

2246

try:

1766

2257

elif suffix == "w":

1767

2258

delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)

1768

2259

else:

1769

raise ValueError("Unknown suffix %r" % suffix)

1770

except (ValueError, IndexError) as e:

2260

raise ValueError("Unknown suffix {0!r}"

2261

.format(suffix))

2262

except IndexError as e:

1771

2263

raise ValueError(*(e.args))

1772

2264

timevalue += delta

1773

2265

return timevalue

1774

2266

1775

2267

1776

def if_nametoindex(interface):

1777

"""Call the C function if_nametoindex(), or equivalent

1778

1779

Note: This function cannot accept a unicode string."""

1780

global if_nametoindex

1781

try:

1782

if_nametoindex = (ctypes.cdll.LoadLibrary

1783

(ctypes.util.find_library("c"))

1784

.if_nametoindex)

1785

except (OSError, AttributeError):

1786

logger.warning("Doing if_nametoindex the hard way")

1787

def if_nametoindex(interface):

1788

"Get an interface index the hard way, i.e. using fcntl()"

1789

SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h

1790

with contextlib.closing(socket.socket()) as s:

1791

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1792

struct.pack(str("16s16x"),

1793

interface))

1794

interface_index = struct.unpack(str("I"),

1795

ifreq[16:20])[0]

1796

return interface_index

1797

return if_nametoindex(interface)

1798

1799

1800

2268

def daemon(nochdir = False, noclose = False):

1801

2269

"""See daemon(3). Standard BSD Unix function.

1802

2270

1810

2278

sys.exit()

1811

2279

if not noclose:

1812

2280

# Close all standard open file descriptors

1813

null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)

2281

null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)

1814

2282

if not stat.S_ISCHR(os.fstat(null).st_mode):

1815

2283

raise OSError(errno.ENODEV,

1816

"%s not a character device"

1817

% os.path.devnull)

2284

"{0} not a character device"

2285

.format(os.devnull))

1818

2286

os.dup2(null, sys.stdin.fileno())

1819

2287

os.dup2(null, sys.stdout.fileno())

1820

2288

os.dup2(null, sys.stderr.fileno())

1829

2297

1830

2298

parser = argparse.ArgumentParser()

1831

2299

parser.add_argument("-v", "--version", action="version",

1832

version = "%%(prog)s %s" % version,

2300

version = "%(prog)s {0}".format(version),

1833

2301

help="show version number and exit")

1834

2302

parser.add_argument("-i", "--interface", metavar="IF",

1835

2303

help="Bind to interface IF")

1841

2309

help="Run self-test")

1842

2310

parser.add_argument("--debug", action="store_true",

1843

2311

help="Debug mode; run in foreground and log"

1844

" to terminal")

2312

" to terminal", default=None)

1845

2313

parser.add_argument("--debuglevel", metavar="LEVEL",

1846

2314

help="Debug level for stdout output")

1847

2315

parser.add_argument("--priority", help="GnuTLS"

1854

2322

" files")

1855

2323

parser.add_argument("--no-dbus", action="store_false",

1856

2324

dest="use_dbus", help="Do not provide D-Bus"

1857

" system bus interface")

2325

" system bus interface", default=None)

1858

2326

parser.add_argument("--no-ipv6", action="store_false",

1859

dest="use_ipv6", help="Do not use IPv6")

2327

dest="use_ipv6", help="Do not use IPv6",

2328

default=None)

2329

parser.add_argument("--no-restore", action="store_false",

2330

dest="restore", help="Do not restore stored"

2331

" state", default=None)

2332

parser.add_argument("--socket", type=int,

2333

help="Specify a file descriptor to a network"

2334

" socket to use instead of creating one")

2335

parser.add_argument("--statedir", metavar="DIR",

2336

help="Directory to save/restore state in")

2337

parser.add_argument("--foreground", action="store_true",

2338

help="Run in foreground", default=None)

2339

1860

2340

options = parser.parse_args()

1861

2341

1862

2342

if options.check:

1863

2343

import doctest

1864

doctest.testmod()

1865

sys.exit()

2344

fail_count, test_count = doctest.testmod()

2345

sys.exit(os.EX_OK if fail_count == 0 else 1)

1866

2346

1867

2347

# Default values for config file for server-global settings

1868

2348

server_defaults = { "interface": "",

1870

2350

"port": "",

1871

2351

"debug": "False",

1872

2352

"priority":

1873

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",

2353

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

1874

2354

"servicename": "Mandos",

1875

2355

"use_dbus": "True",

1876

2356

"use_ipv6": "True",

1877

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

"statedir": "/var/lib/mandos",

2361

"foreground": "False",

1878

2362

}

1879

2363

1880

2364

# Parse config file for server-global settings

1885

2369

# Convert the SafeConfigParser object to a dict

1886

2370

server_settings = server_config.defaults()

1887

2371

# Use the appropriate methods on the non-string config options

1888

for option in ("debug", "use_dbus", "use_ipv6"):

2372

for option in ("debug", "use_dbus", "use_ipv6", "foreground"):

1889

2373

server_settings[option] = server_config.getboolean("DEFAULT",

1890

2374

option)

1891

2375

if server_settings["port"]:

1892

2376

server_settings["port"] = server_config.getint("DEFAULT",

1893

2377

"port")

2378

if server_settings["socket"]:

2379

server_settings["socket"] = server_config.getint("DEFAULT",

2380

"socket")

2381

# Later, stdin will, and stdout and stderr might, be dup'ed

2382

# over with an opened os.devnull. But we don't want this to

2383

# happen with a supplied network socket.

2384

if 0 <= server_settings["socket"] <= 2:

2385

server_settings["socket"] = os.dup(server_settings

2386

["socket"])

1894

2387

del server_config

1895

2388

1896

2389

# Override the settings from the config file with command line

1897

2390

# options, if set.

1898

2391

for option in ("interface", "address", "port", "debug",

1899

2392

"priority", "servicename", "configdir",

1900

"use_dbus", "use_ipv6", "debuglevel"):

2393

"use_dbus", "use_ipv6", "debuglevel", "restore",

2394

"statedir", "socket", "foreground"):

1901

2395

value = getattr(options, option)

1902

2396

if value is not None:

1903

2397

server_settings[option] = value

1906

2400

for option in server_settings.keys():

1907

2401

if type(server_settings[option]) is str:

1908

2402

server_settings[option] = unicode(server_settings[option])

2403

# Force all boolean options to be boolean

2404

for option in ("debug", "use_dbus", "use_ipv6", "restore",

2405

"foreground"):

2406

server_settings[option] = bool(server_settings[option])

2407

# Debug implies foreground

2408

if server_settings["debug"]:

2409

server_settings["foreground"] = True

1909

2410

# Now we have our good server settings in "server_settings"

1910

2411

1911

2412

##################################################################

1915

2416

debuglevel = server_settings["debuglevel"]

1916

2417

use_dbus = server_settings["use_dbus"]

1917

2418

use_ipv6 = server_settings["use_ipv6"]

2419

stored_state_path = os.path.join(server_settings["statedir"],

2420

stored_state_file)

2421

foreground = server_settings["foreground"]

2422

2423

if debug:

2424

initlogger(debug, logging.DEBUG)

2425

else:

2426

if not debuglevel:

2427

initlogger(debug)

2428

else:

2429

level = getattr(logging, debuglevel.upper())

2430

initlogger(debug, level)

1918

2431

1919

2432

if server_settings["servicename"] != "Mandos":

1920

2433

syslogger.setFormatter(logging.Formatter

1921

('Mandos (%s) [%%(process)d]:'

1922

' %%(levelname)s: %%(message)s'

1923

% server_settings["servicename"]))

2434

('Mandos ({0}) [%(process)d]:'

2435

' %(levelname)s: %(message)s'

2436

.format(server_settings

2437

["servicename"])))

1924

2438

1925

2439

# Parse config file with clients

1926

client_defaults = { "timeout": "5m",

1927

"extended_timeout": "15m",

1928

"interval": "2m",

1929

"checker": "fping -q -- %%(host)s",

1930

"host": "",

1931

"approval_delay": "0s",

1932

"approval_duration": "1s",

1933

}

1934

client_config = configparser.SafeConfigParser(client_defaults)

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

1935

2442

client_config.read(os.path.join(server_settings["configdir"],

1936

2443

"clients.conf"))

1937

2444

1946

2453

use_ipv6=use_ipv6,

1947

2454

gnutls_priority=

1948

2455

server_settings["priority"],

1949

use_dbus=use_dbus)

1950

if not debug:

1951

pidfilename = "/var/run/mandos.pid"

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

2459

if not foreground:

2460

pidfilename = "/run/mandos.pid"

2461

if not os.path.isdir("/run/."):

2462

pidfilename = "/var/run/mandos.pid"

2463

pidfile = None

1952

2464

try:

1953

2465

pidfile = open(pidfilename, "w")

1954

except IOError:

1955

logger.error("Could not open file %r", pidfilename)

2466

except IOError as e:

2467

logger.error("Could not open file %r", pidfilename,

2468

exc_info=e)

1956

2469

1957

try:

1958

uid = pwd.getpwnam("_mandos").pw_uid

1959

gid = pwd.getpwnam("_mandos").pw_gid

1960

except KeyError:

2470

for name in ("_mandos", "mandos", "nobody"):

1961

2471

try:

1962

uid = pwd.getpwnam("mandos").pw_uid

1963

gid = pwd.getpwnam("mandos").pw_gid

2472

uid = pwd.getpwnam(name).pw_uid

2473

gid = pwd.getpwnam(name).pw_gid

2474

break

1964

2475

except KeyError:

1965

try:

1966

uid = pwd.getpwnam("nobody").pw_uid

1967

gid = pwd.getpwnam("nobody").pw_gid

1968

except KeyError:

1969

uid = 65534

1970

gid = 65534

2476

continue

2477

else:

2478

uid = 65534

2479

gid = 65534

1971

2480

try:

1972

2481

os.setgid(gid)

1973

2482

os.setuid(uid)

1974

2483

except OSError as error:

1975

if error[0] != errno.EPERM:

1976

raise error

1977

1978

if not debug and not debuglevel:

1979

logger.setLevel(logging.WARNING)

1980

if debuglevel:

1981

level = getattr(logging, debuglevel.upper())

1982

logger.setLevel(level)

2484

if error.errno != errno.EPERM:

2485

raise

1983

2486

1984

2487

if debug:

1985

logger.setLevel(logging.DEBUG)

1986

2488

# Enable all possible GnuTLS debugging

1987

2489

1988

2490

# "Use a log level over 10 to enable all debugging options."

1997

2499

.gnutls_global_set_log_function(debug_gnutls))

1998

2500

1999

2501

# Redirect stdin so all checkers get /dev/null

2000

null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)

2502

null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)

2001

2503

os.dup2(null, sys.stdin.fileno())

2002

2504

if null > 2:

2003

2505

os.close(null)

2004

else:

2005

# No console logging

2006

logger.removeHandler(console)

2007

2506

2008

2507

# Need to fork before connecting to D-Bus

2009

if not debug:

2508

if not foreground:

2010

2509

# Close all input and output, do double fork, etc.

2011

2510

daemon()

2012

2511

2512

# multiprocessing will use threads, so before we use gobject we

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

2013

2516

global main_loop

2014

2517

# From the Avahi example code

2015

DBusGMainLoop(set_as_default=True )

2518

DBusGMainLoop(set_as_default=True)

2016

2519

main_loop = gobject.MainLoop()

2017

2520

bus = dbus.SystemBus()

2018

2521

# End of Avahi example code

2024

2527

("se.bsnet.fukt.Mandos", bus,

2025

2528

do_not_queue=True))

2026

2529

except dbus.exceptions.NameExistsException as e:

2027

logger.error(unicode(e) + ", disabling D-Bus")

2530

logger.error("Disabling D-Bus:", exc_info=e)

2028

2531

use_dbus = False

2029

2532

server_settings["use_dbus"] = False

2030

2533

tcp_server.use_dbus = False

2042

2545

2043

2546

client_class = Client

2044

2547

if use_dbus:

2045

client_class = functools.partial(ClientDBusTransitional,

2046

bus = bus)

2047

def client_config_items(config, section):

2048

special_settings = {

2049

"approved_by_default":

2050

lambda: config.getboolean(section,

2051

"approved_by_default"),

2052

}

2053

for name, value in config.items(section):

2548

client_class = functools.partial(ClientDBus, bus = bus)

2549

2550

client_settings = Client.config_parser(client_config)

2551

old_client_settings = {}

2552

clients_data = {}

2553

2554

# This is used to redirect stdout and stderr for checker processes

2555

global wnull

2556

wnull = open(os.devnull, "w") # A writable /dev/null

2557

# Only used if server is running in foreground but not in debug

2558

# mode

2559

if debug or not foreground:

2560

wnull.close()

2561

2562

# Get client data and settings from last running state.

2563

if server_settings["restore"]:

2564

try:

2565

with open(stored_state_path, "rb") as stored_state:

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

2568

os.remove(stored_state_path)

2569

except IOError as e:

2570

if e.errno == errno.ENOENT:

2571

logger.warning("Could not load persistent state: {0}"

2572

.format(os.strerror(e.errno)))

2573

else:

2574

logger.critical("Could not load persistent state:",

2575

exc_info=e)

2576

raise

2577

except EOFError as e:

2578

logger.warning("Could not load persistent state: "

2579

"EOFError:", exc_info=e)

2580

2581

with PGPEngine() as pgp:

2582

for client_name, client in clients_data.iteritems():

2583

# Skip removed clients

2584

if client_name not in client_settings:

2585

continue

2586

2587

# Decide which value to use after restoring saved state.

2588

# We have three different values: Old config file,

2589

# new config file, and saved state.

2590

# New config value takes precedence if it differs from old

2591

# config value, otherwise use saved state.

2592

for name, value in client_settings[client_name].items():

2593

try:

2594

# For each value in new config, check if it

2595

# differs from the old config value (Except for

2596

# the "secret" attribute)

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

2600

client[name] = value

2601

except KeyError:

2602

pass

2603

2604

# Clients who has passed its expire date can still be

2605

# enabled if its last checker was successful. Clients

2606

# whose checker succeeded before we stored its state is

2607

# assumed to have successfully run all checkers during

2608

# downtime.

2609

if client["enabled"]:

2610

if datetime.datetime.utcnow() >= client["expires"]:

2611

if not client["last_checked_ok"]:

2612

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

2616

client["enabled"] = False

2617

elif client["last_checker_status"] != 0:

2618

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

2623

client["enabled"] = False

2624

else:

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

2628

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

2054

2631

try:

2055

yield (name, special_settings[name]())

2056

except KeyError:

2057

yield (name, value)

2058

2059

tcp_server.clients.update(set(

2060

client_class(name = section,

2061

config= dict(client_config_items(

2062

client_config, section)))

2063

for section in client_config.sections()))

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

2636

except PGPError:

2637

# If decryption fails, we use secret from new settings

2638

logger.debug("Failed to decrypt {0} old secret"

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

2643

# Add/remove clients based on new changes made to config

2644

for client_name in (set(old_client_settings)

2645

- set(client_settings)):

2646

del clients_data[client_name]

2647

for client_name in (set(client_settings)

2648

- set(old_client_settings)):

2649

clients_data[client_name] = client_settings[client_name]

2650

2651

# Create all client objects

2652

for client_name, client in clients_data.iteritems():

2653

tcp_server.clients[client_name] = client_class(

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

2064

2657

if not tcp_server.clients:

2065

2658

logger.warning("No clients defined")

2066

2067

if not debug:

2068

try:

2069

with pidfile:

2070

pid = os.getpid()

2071

pidfile.write(str(pid) + "\n".encode("utf-8"))

2072

del pidfile

2073

except IOError:

2074

logger.error("Could not write to file %r with PID %d",

2075

pidfilename, pid)

2076

except NameError:

2077

# "pidfile" was never created

2078

pass

2659

2660

if not foreground:

2661

if pidfile is not None:

2662

try:

2663

with pidfile:

2664

pid = os.getpid()

2665

pidfile.write(str(pid) + "\n".encode("utf-8"))

2666

except IOError:

2667

logger.error("Could not write to file %r with PID %d",

2668

pidfilename, pid)

2669

del pidfile

2079

2670

del pidfilename

2080

2081

signal.signal(signal.SIGINT, signal.SIG_IGN)

2082

2671

2083

2672

signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())

2084

2673

signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())

2085

2674

2086

2675

if use_dbus:

2087

class MandosDBusService(dbus.service.Object):

2676

@alternate_dbus_interfaces({"se.recompile.Mandos":

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

2088

2679

"""A D-Bus proxy object"""

2089

2680

def __init__(self):

2090

2681

dbus.service.Object.__init__(self, bus, "/")

2091

2682

_interface = "se.recompile.Mandos"

2092

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

2093

2690

@dbus.service.signal(_interface, signature="o")

2094

2691

def ClientAdded(self, objpath):

2095

2692

"D-Bus signal"

2109

2706

def GetAllClients(self):

2110

2707

"D-Bus method"

2111

2708

return dbus.Array(c.dbus_object_path

2112

for c in tcp_server.clients)

2709

for c in

2710

tcp_server.clients.itervalues())

2113

2711

2114

2712

@dbus.service.method(_interface,

2115

2713

out_signature="a{oa{sv}}")

2117

2715

"D-Bus method"

2118

2716

return dbus.Dictionary(

2119

2717

((c.dbus_object_path, c.GetAll(""))

2120

for c in tcp_server.clients),

2718

for c in tcp_server.clients.itervalues()),

2121

2719

signature="oa{sv}")

2122

2720

2123

2721

@dbus.service.method(_interface, in_signature="o")

2124

2722

def RemoveClient(self, object_path):

2125

2723

"D-Bus method"

2126

for c in tcp_server.clients:

2724

for c in tcp_server.clients.itervalues():

2127

2725

if c.dbus_object_path == object_path:

2128

tcp_server.clients.remove(c)

2726

del tcp_server.clients[c.name]

2129

2727

c.remove_from_connection()

2130

2728

# Don't signal anything except ClientRemoved

2131

2729

c.disable(quiet=True)

2136

2734

2137

2735

del _interface

2138

2736

2139

class MandosDBusServiceTransitional(MandosDBusService):

2140

__metaclass__ = AlternateDBusNamesMetaclass

2141

mandos_dbus_service = MandosDBusServiceTransitional()

2737

mandos_dbus_service = MandosDBusService()

2142

2738

2143

2739

def cleanup():

2144

2740

"Cleanup function; run on exit"

2145

2741

service.cleanup()

2146

2742

2147

2743

multiprocessing.active_children()

2744

wnull.close()

2745

if not (tcp_server.clients or client_settings):

2746

return

2747

2748

# Store client before exiting. Secrets are encrypted with key

2749

# based on what config file has. If config file is

2750

# removed/edited, old secret will thus be unrecovable.

2751

clients = {}

2752

with PGPEngine() as pgp:

2753

for client in tcp_server.clients.itervalues():

2754

key = client_settings[client.name]["secret"]

2755

client.encrypted_secret = pgp.encrypt(client.secret,

2756

key)

2757

client_dict = {}

2758

2759

# A list of attributes that can not be pickled

2760

# + secret.

2761

exclude = set(("bus", "changedstate", "secret",

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

2765

exclude.add(name)

2766

2767

client_dict["encrypted_secret"] = (client

2768

.encrypted_secret)

2769

for attr in client.client_structure:

2770

if attr not in exclude:

2771

client_dict[attr] = getattr(client, attr)

2772

2773

clients[client.name] = client_dict

2774

del client_settings[client.name]["secret"]

2775

2776

try:

2777

with (tempfile.NamedTemporaryFile

2778

(mode='wb', suffix=".pickle", prefix='clients-',

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

pickle.dump((clients, client_settings), stored_state)

2782

tempname=stored_state.name

2783

os.rename(tempname, stored_state_path)

2784

except (IOError, OSError) as e:

2785

if not debug:

2786

try:

2787

os.remove(tempname)

2788

except NameError:

2789

pass

2790

if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):

2791

logger.warning("Could not save persistent state: {0}"

2792

.format(os.strerror(e.errno)))

2793

else:

2794

logger.warning("Could not save persistent state:",

2795

exc_info=e)

2796

raise

2797

2798

# Delete all clients, and settings from config

2148

2799

while tcp_server.clients:

2149

client = tcp_server.clients.pop()

2800

name, client = tcp_server.clients.popitem()

2150

2801

if use_dbus:

2151

2802

client.remove_from_connection()

2152

client.disable_hook = None

2153

2803

# Don't signal anything except ClientRemoved

2154

2804

client.disable(quiet=True)

2155

2805

if use_dbus:

2157

2807

mandos_dbus_service.ClientRemoved(client

2158

2808

.dbus_object_path,

2159

2809

client.name)

2810

client_settings.clear()

2160

2811

2161

2812

atexit.register(cleanup)

2162

2813

2163

for client in tcp_server.clients:

2814

for client in tcp_server.clients.itervalues():

2164

2815

if use_dbus:

2165

2816

# Emit D-Bus signal

2166

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2167

client.enable()

2818

# Need to initiate checking of clients

2819

if client.enabled:

2820

client.init_checker()

2168

2821

2169

2822

tcp_server.enable()

2170

2823

tcp_server.server_activate()

2173

2826

service.port = tcp_server.socket.getsockname()[1]

2174

2827

if use_ipv6:

2175

2828

logger.info("Now listening on address %r, port %d,"

2176

" flowinfo %d, scope_id %d"

2177

% tcp_server.socket.getsockname())

2829

" flowinfo %d, scope_id %d",

2830

*tcp_server.socket.getsockname())

2178

2831

else: # IPv4

2179

logger.info("Now listening on address %r, port %d"

2180

% tcp_server.socket.getsockname())

2832

logger.info("Now listening on address %r, port %d",

2833

*tcp_server.socket.getsockname())

2181

2834

2182

2835

#service.interface = tcp_server.socket.getsockname()[3]

2183

2836

2186

2839

try:

2187

2840

service.activate()

2188

2841

except dbus.exceptions.DBusException as error:

2189

logger.critical("DBusException: %s", error)

2842

logger.critical("D-Bus Exception", exc_info=error)

2190

2843

cleanup()

2191

2844

sys.exit(1)

2192

2845

# End of Avahi example code

2199

2852

logger.debug("Starting main loop")

2200

2853

main_loop.run()

2201

2854

except AvahiError as error:

2202

logger.critical("AvahiError: %s", error)

2855

logger.critical("Avahi Error", exc_info=error)

2203

2856

cleanup()

2204

2857

sys.exit(1)

2205

2858

except KeyboardInterrupt:

2210

2863

# Must run before the D-Bus bus name gets deregistered

2211

2864

cleanup()

2212

2865

2213

2214

2866

if __name__ == '__main__':

2215

2867

main()