/mandos/release : revision 237.7.335

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

# -*- mode: python; coding: utf-8 -*-

3

#

4

# Mandos server - give out binary blobs to connecting clients.

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

import SocketServer as socketserver

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

38

43

import socket

39

44

import argparse

40

45

import datetime

45

50

import gnutls.library.functions

46

51

import gnutls.library.constants

47

52

import gnutls.library.types

48

import ConfigParser as configparser

53

try:

54

import ConfigParser as configparser

55

except ImportError:

56

import configparser

49

57

import sys

50

58

import re

51

59

import os

60

68

import struct

61

69

import fcntl

62

70

import functools

63

import cPickle as pickle

71

try:

72

import cPickle as pickle

73

except ImportError:

74

import pickle

64

75

import multiprocessing

65

76

import types

66

77

import binascii

67

78

import tempfile

79

import itertools

80

import collections

81

import codecs

68

82

69

83

import dbus

70

84

import dbus.service

71

import gobject

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

72

89

import avahi

73

90

from dbus.mainloop.glib import DBusGMainLoop

74

91

import ctypes

75

92

import ctypes.util

76

93

import xml.dom.minidom

77

94

import inspect

78

import GnuPGInterface

79

95

80

96

try:

81

97

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

101

except ImportError:

86

102

SO_BINDTODEVICE = None

87

103

104

if sys.version_info.major == 2:

105

str = unicode

88

106

89

version = "1.4.1"

107

version = "1.6.9"

90

108

stored_state_file = "clients.pickle"

91

109

92

110

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

111

syslogger = None

96

112

97

113

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

114

if_nametoindex = ctypes.cdll.LoadLibrary(

115

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

101

116

except (OSError, AttributeError):

117

102

118

def if_nametoindex(interface):

103

119

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

104

120

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

105

121

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

106

122

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

123

struct.pack(b"16s16x", interface))

124

interface_index = struct.unpack("I", ifreq[16:20])[0]

111

125

return interface_index

112

126

113

127

114

def initlogger(level=logging.WARNING):

128

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

115

129

"""init logger and add loglevel"""

116

130

131

global syslogger

132

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

117

135

syslogger.setFormatter(logging.Formatter

118

136

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

119

137

' %(message)s'))

120

138

logger.addHandler(syslogger)

121

139

122

console = logging.StreamHandler()

123

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

124

' [%(process)d]:'

125

' %(levelname)s:'

126

' %(message)s'))

127

logger.addHandler(console)

140

if debug:

141

console = logging.StreamHandler()

142

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

143

' [%(process)d]:'

144

' %(levelname)s:'

145

' %(message)s'))

146

logger.addHandler(console)

128

147

logger.setLevel(level)

129

148

130

149

131

class CryptoError(Exception):

150

class PGPError(Exception):

151

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

132

152

pass

133

153

134

154

135

class Crypto(object):

155

class PGPEngine(object):

136

156

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

157

137

158

def __init__(self):

138

self.gnupg = GnuPGInterface.GnuPG()

139

159

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

140

self.gnupg = GnuPGInterface.GnuPG()

141

self.gnupg.options.meta_interactive = False

142

self.gnupg.options.homedir = self.tempdir

143

self.gnupg.options.extra_args.extend(['--force-mdc',

144

'--quiet'])

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

145

165

146

166

def __enter__(self):

147

167

return self

148

168

149

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

169

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

150

170

self._cleanup()

151

171

return False

152

172

169

189

def password_encode(self, password):

170

190

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

171

191

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

172

return b"mandos" + binascii.hexlify(password)

192

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

193

if len(encoded) > 2048:

194

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

195

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

196

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

197

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

198

return encoded

173

199

174

200

def encrypt(self, data, password):

175

self.gnupg.passphrase = self.password_encode(password)

176

with open(os.devnull) as devnull:

177

try:

178

proc = self.gnupg.run(['--symmetric'],

179

create_fhs=['stdin', 'stdout'],

180

attach_fhs={'stderr': devnull})

181

with contextlib.closing(proc.handles['stdin']) as f:

182

f.write(data)

183

with contextlib.closing(proc.handles['stdout']) as f:

184

ciphertext = f.read()

185

proc.wait()

186

except IOError as e:

187

raise CryptoError(e)

188

self.gnupg.passphrase = None

201

passphrase = self.password_encode(password)

202

with tempfile.NamedTemporaryFile(

203

dir=self.tempdir) as passfile:

204

passfile.write(passphrase)

205

passfile.flush()

206

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

207

'--passphrase-file',

208

passfile.name]

209

+ self.gnupgargs,

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

214

if proc.returncode != 0:

215

raise PGPError(err)

189

216

return ciphertext

190

217

191

218

def decrypt(self, data, password):

192

self.gnupg.passphrase = self.password_encode(password)

193

with open(os.devnull) as devnull:

194

try:

195

proc = self.gnupg.run(['--decrypt'],

196

create_fhs=['stdin', 'stdout'],

197

attach_fhs={'stderr': devnull})

198

with contextlib.closing(proc.handles['stdin'] ) as f:

199

f.write(data)

200

with contextlib.closing(proc.handles['stdout']) as f:

201

decrypted_plaintext = f.read()

202

proc.wait()

203

except IOError as e:

204

raise CryptoError(e)

205

self.gnupg.passphrase = None

219

passphrase = self.password_encode(password)

220

with tempfile.NamedTemporaryFile(

221

dir = self.tempdir) as passfile:

222

passfile.write(passphrase)

223

passfile.flush()

224

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

225

'--passphrase-file',

226

passfile.name]

227

+ self.gnupgargs,

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

232

if proc.returncode != 0:

233

raise PGPError(err)

206

234

return decrypted_plaintext

207

235

208

236

209

210

237

class AvahiError(Exception):

211

238

def __init__(self, value, *args, **kwargs):

212

239

self.value = value

213

super(AvahiError, self).__init__(value, *args, **kwargs)

214

def __unicode__(self):

215

return unicode(repr(self.value))

240

return super(AvahiError, self).__init__(value, *args,

241

**kwargs)

242

216

243

217

244

class AvahiServiceError(AvahiError):

218

245

pass

219

246

247

220

248

class AvahiGroupError(AvahiError):

221

249

pass

222

250

229

257

Used to optionally bind to the specified interface.

230

258

name: string; Example: 'Mandos'

231

259

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

232

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

260

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

233

261

port: integer; what port to announce

234

262

TXT: list of strings; TXT record for the service

235

263

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

241

269

server: D-Bus Server

242

270

bus: dbus.SystemBus()

243

271

"""

244

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

245

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

246

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

247

protocol = avahi.PROTO_UNSPEC, bus = None):

272

273

def __init__(self,

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

248

284

self.interface = interface

249

285

self.name = name

250

286

self.type = servicetype

259

295

self.server = None

260

296

self.bus = bus

261

297

self.entry_group_state_changed_match = None

262

def rename(self):

298

299

def rename(self, remove=True):

263

300

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

264

301

if self.rename_count >= self.max_renames:

265

302

logger.critical("No suitable Zeroconf service name found"

266

303

" after %i retries, exiting.",

267

304

self.rename_count)

268

305

raise AvahiServiceError("Too many renames")

269

self.name = unicode(self.server

270

.GetAlternativeServiceName(self.name))

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

271

309

logger.info("Changing Zeroconf service name to %r ...",

272

310

self.name)

273

self.remove()

311

if remove:

312

self.remove()

274

313

try:

275

314

self.add()

276

315

except dbus.exceptions.DBusException as error:

277

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

278

self.cleanup()

279

os._exit(1)

280

self.rename_count += 1

316

if (error.get_dbus_name()

317

== "org.freedesktop.Avahi.CollisionError"):

318

logger.info("Local Zeroconf service name collision.")

319

return self.rename(remove=False)

320

else:

321

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

322

self.cleanup()

323

os._exit(1)

324

281

325

def remove(self):

282

326

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

283

327

if self.entry_group_state_changed_match is not None:

285

329

self.entry_group_state_changed_match = None

286

330

if self.group is not None:

287

331

self.group.Reset()

332

288

333

def add(self):

289

334

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

290

335

self.remove()

307

352

dbus.UInt16(self.port),

308

353

avahi.string_array_to_txt_array(self.TXT))

309

354

self.group.Commit()

355

310

356

def entry_group_state_changed(self, state, error):

311

357

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

312

358

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

318

364

self.rename()

319

365

elif state == avahi.ENTRY_GROUP_FAILURE:

320

366

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

321

unicode(error))

322

raise AvahiGroupError("State changed: %s"

323

% unicode(error))

367

str(error))

368

raise AvahiGroupError("State changed: {!s}".format(error))

369

324

370

def cleanup(self):

325

371

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

326

372

if self.group is not None:

331

377

pass

332

378

self.group = None

333

379

self.remove()

380

334

381

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

335

382

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

336

383

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

337

bad_states = { avahi.SERVER_INVALID:

338

"Zeroconf server invalid",

339

avahi.SERVER_REGISTERING: None,

340

avahi.SERVER_COLLISION:

341

"Zeroconf server name collision",

342

avahi.SERVER_FAILURE:

343

"Zeroconf server failure" }

384

bad_states = {

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

386

avahi.SERVER_REGISTERING: None,

387

avahi.SERVER_COLLISION: "Zeroconf server name collision",

388

avahi.SERVER_FAILURE: "Zeroconf server failure",

389

}

344

390

if state in bad_states:

345

391

if bad_states[state] is not None:

346

392

if error is None:

349

395

logger.error(bad_states[state] + ": %r", error)

350

396

self.cleanup()

351

397

elif state == avahi.SERVER_RUNNING:

352

self.add()

398

try:

399

self.add()

400

except dbus.exceptions.DBusException as error:

401

if (error.get_dbus_name()

402

== "org.freedesktop.Avahi.CollisionError"):

403

logger.info("Local Zeroconf service name"

404

" collision.")

405

return self.rename(remove=False)

406

else:

407

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

408

self.cleanup()

409

os._exit(1)

353

410

else:

354

411

if error is None:

355

412

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

356

413

else:

357

414

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

415

358

416

def activate(self):

359

417

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

360

418

if self.server is None:

364

422

follow_name_owner_changes=True),

365

423

avahi.DBUS_INTERFACE_SERVER)

366

424

self.server.connect_to_signal("StateChanged",

367

self.server_state_changed)

425

self.server_state_changed)

368

426

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

369

427

428

370

429

class AvahiServiceToSyslog(AvahiService):

371

def rename(self):

430

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

372

431

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

373

ret = AvahiService.rename(self)

374

syslogger.setFormatter(logging.Formatter

375

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

376

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

377

% self.name))

432

ret = AvahiService.rename(self, *args, **kwargs)

433

syslogger.setFormatter(logging.Formatter(

434

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

435

.format(self.name)))

378

436

return ret

379

437

380

def _timedelta_to_milliseconds(td):

381

"Convert a datetime.timedelta() to milliseconds"

382

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

383

+ (td.seconds * 1000)

384

+ (td.microseconds // 1000))

385

438

def call_pipe(connection, # : multiprocessing.Connection

439

func, *args, **kwargs):

440

"""This function is meant to be called by multiprocessing.Process

441

442

This function runs func(*args, **kwargs), and writes the resulting

443

return value on the provided multiprocessing.Connection.

444

"""

445

connection.send(func(*args, **kwargs))

446

connection.close()

447

386

448

class Client(object):

387

449

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

388

450

389

451

Attributes:

390

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

452

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

391

453

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

392

454

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

393

455

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

411

473

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

412

474

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

413

475

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

414

415

476

last_checker_status: integer between 0 and 255 reflecting exit

416

477

status of last checker. -1 reflects crashed

417

checker, or None.

478

checker, -2 means no checker completed yet.

479

last_checker_signal: The signal which killed the last checker, if

480

last_checker_status is -1

418

481

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

419

482

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

420

483

D-Bus identifiers

421

484

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

422

485

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

423

486

until this client is disabled

424

extended_timeout: extra long timeout when password has been sent

487

extended_timeout: extra long timeout when secret has been sent

425

488

runtime_expansions: Allowed attributes for runtime expansion.

426

489

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

427

490

disabled, or None

491

server_settings: The server_settings dict from main()

428

492

"""

429

493

430

494

runtime_expansions = ("approval_delay", "approval_duration",

431

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

432

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

495

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

496

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

497

"last_approval_request", "last_checked_ok",

433

498

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

434

435

def timeout_milliseconds(self):

436

"Return the 'timeout' attribute in milliseconds"

437

return _timedelta_to_milliseconds(self.timeout)

438

439

def extended_timeout_milliseconds(self):

440

"Return the 'extended_timeout' attribute in milliseconds"

441

return _timedelta_to_milliseconds(self.extended_timeout)

442

443

def interval_milliseconds(self):

444

"Return the 'interval' attribute in milliseconds"

445

return _timedelta_to_milliseconds(self.interval)

446

447

def approval_delay_milliseconds(self):

448

return _timedelta_to_milliseconds(self.approval_delay)

449

450

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

451

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

452

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

453

attribute."""

499

client_defaults = {

500

"timeout": "PT5M",

501

"extended_timeout": "PT15M",

502

"interval": "PT2M",

503

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

504

"host": "",

505

"approval_delay": "PT0S",

506

"approval_duration": "PT1S",

507

"approved_by_default": "True",

508

"enabled": "True",

509

}

510

511

@staticmethod

512

def config_parser(config):

513

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

514

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

515

with exceptions for any special settings as defined above.

516

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

517

value given the same arguments.

518

"""

519

settings = {}

520

for client_name in config.sections():

521

section = dict(config.items(client_name))

522

client = settings[client_name] = {}

523

524

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

525

# Reformat values from string types to Python types

526

client["approved_by_default"] = config.getboolean(

527

client_name, "approved_by_default")

528

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

529

"enabled")

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

534

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

535

.replace(" ", ""))

536

if "secret" in section:

537

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

538

elif "secfile" in section:

539

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

540

(section["secfile"])),

541

"rb") as secfile:

542

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

543

else:

544

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

545

.format(section))

546

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

547

client["extended_timeout"] = string_to_delta(

548

section["extended_timeout"])

549

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

550

client["approval_delay"] = string_to_delta(

551

section["approval_delay"])

552

client["approval_duration"] = string_to_delta(

553

section["approval_duration"])

554

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

555

client["last_approval_request"] = None

556

client["last_checked_ok"] = None

557

client["last_checker_status"] = -2

558

559

return settings

560

561

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

454

562

self.name = name

455

if config is None:

456

config = {}

563

if server_settings is None:

564

server_settings = {}

565

self.server_settings = server_settings

566

# adding all client settings

567

for setting, value in settings.items():

568

setattr(self, setting, value)

569

570

if self.enabled:

571

if not hasattr(self, "last_enabled"):

572

self.last_enabled = datetime.datetime.utcnow()

573

if not hasattr(self, "expires"):

574

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

575

+ self.timeout)

576

else:

577

self.last_enabled = None

578

self.expires = None

579

457

580

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

458

# Uppercase and remove spaces from fingerprint for later

459

# comparison purposes with return value from the fingerprint()

460

# function

461

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

462

.replace(" ", ""))

463

581

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

464

if "secret" in config:

465

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

466

elif "secfile" in config:

467

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

468

(config["secfile"])),

469

"rb") as secfile:

470

self.secret = secfile.read()

471

else:

472

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

473

% self.name)

474

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

475

self.created = datetime.datetime.utcnow()

476

self.enabled = config.get("enabled", True)

477

self.last_approval_request = None

478

if self.enabled:

479

self.last_enabled = datetime.datetime.utcnow()

480

else:

481

self.last_enabled = None

482

self.last_checked_ok = None

483

self.last_checker_status = None

484

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

485

self.extended_timeout = string_to_delta(config

486

["extended_timeout"])

487

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

582

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

583

datetime.datetime.utcnow())

584

585

# attributes specific for this server instance

488

586

self.checker = None

489

587

self.checker_initiator_tag = None

490

588

self.disable_initiator_tag = None

491

if self.enabled:

492

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

493

else:

494

self.expires = None

495

589

self.checker_callback_tag = None

496

self.checker_command = config["checker"]

497

590

self.current_checker_command = None

498

self._approved = None

499

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

500

True)

591

self.approved = None

501

592

self.approvals_pending = 0

502

self.approval_delay = string_to_delta(

503

config["approval_delay"])

504

self.approval_duration = string_to_delta(

505

config["approval_duration"])

506

self.changedstate = (multiprocessing_manager

507

.Condition(multiprocessing_manager

508

.Lock()))

509

self.client_structure = [attr for attr in

510

self.__dict__.iterkeys()

593

self.changedstate = multiprocessing_manager.Condition(

594

multiprocessing_manager.Lock())

595

self.client_structure = [attr

596

for attr in self.__dict__.iterkeys()

511

597

if not attr.startswith("_")]

512

598

self.client_structure.append("client_structure")

513

599

514

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

515

lambda obj:

516

isinstance(obj,

517

property)):

600

for name, t in inspect.getmembers(

601

type(self), lambda obj: isinstance(obj, property)):

518

602

if not name.startswith("_"):

519

603

self.client_structure.append(name)

520

604

528

612

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

529

613

# Already enabled

530

614

return

531

self.send_changedstate()

532

615

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

533

616

self.enabled = True

534

617

self.last_enabled = datetime.datetime.utcnow()

535

618

self.init_checker()

619

self.send_changedstate()

536

620

537

621

def disable(self, quiet=True):

538

622

"""Disable this client."""

539

623

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

540

624

return False

541

625

if not quiet:

542

self.send_changedstate()

543

if not quiet:

544

626

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

545

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

627

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

546

628

gobject.source_remove(self.disable_initiator_tag)

547

629

self.disable_initiator_tag = None

548

630

self.expires = None

549

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

631

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

550

632

gobject.source_remove(self.checker_initiator_tag)

551

633

self.checker_initiator_tag = None

552

634

self.stop_checker()

553

635

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

554

638

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

555

639

return False

556

640

560

644

def init_checker(self):

561

645

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

562

646

# and every interval from then on.

563

self.checker_initiator_tag = (gobject.timeout_add

564

(self.interval_milliseconds(),

565

self.start_checker))

647

if self.checker_initiator_tag is not None:

648

gobject.source_remove(self.checker_initiator_tag)

649

self.checker_initiator_tag = gobject.timeout_add(

650

int(self.interval.total_seconds() * 1000),

651

self.start_checker)

566

652

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

567

self.disable_initiator_tag = (gobject.timeout_add

568

(self.timeout_milliseconds(),

569

self.disable))

653

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = gobject.timeout_add(

656

int(self.timeout.total_seconds() * 1000), self.disable)

570

657

# Also start a new checker *right now*.

571

658

self.start_checker()

572

659

573

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

660

def checker_callback(self, source, condition, connection,

661

command):

574

662

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

575

663

self.checker_callback_tag = None

576

664

self.checker = None

577

if os.WIFEXITED(condition):

578

self.last_checker_status = os.WEXITSTATUS(condition)

665

# Read return code from connection (see call_pipe)

666

returncode = connection.recv()

667

connection.close()

668

669

if returncode >= 0:

670

self.last_checker_status = returncode

671

self.last_checker_signal = None

579

672

if self.last_checker_status == 0:

580

673

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

581

674

vars(self))

582

675

self.checked_ok()

583

676

else:

584

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

585

vars(self))

677

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

586

678

else:

587

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

588

681

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

589

682

vars(self))

590

591

def checked_ok(self, timeout=None):

592

"""Bump up the timeout for this client.

593

594

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

595

alive and well.

596

"""

683

return False

684

685

def checked_ok(self):

686

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

687

self.last_checked_ok = datetime.datetime.utcnow()

688

self.last_checker_status = 0

689

self.last_checker_signal = None

690

self.bump_timeout()

691

692

def bump_timeout(self, timeout=None):

693

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

597

694

if timeout is None:

598

695

timeout = self.timeout

599

self.last_checked_ok = datetime.datetime.utcnow()

600

696

if self.disable_initiator_tag is not None:

601

697

gobject.source_remove(self.disable_initiator_tag)

698

self.disable_initiator_tag = None

602

699

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

603

self.disable_initiator_tag = (gobject.timeout_add

604

(_timedelta_to_milliseconds

605

(timeout), self.disable))

700

self.disable_initiator_tag = gobject.timeout_add(

701

int(timeout.total_seconds() * 1000), self.disable)

606

702

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

607

703

608

704

def need_approval(self):

614

710

If a checker already exists, leave it running and do

615

711

nothing."""

616

712

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

617

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

618

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

619

# client would inevitably timeout, since no checker would get

620

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

713

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

714

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

715

# would inevitably timeout, since no checker would get a

716

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

621

717

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

622

718

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

623

719

# should be.

624

720

625

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

626

try:

627

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

628

except (AttributeError, OSError) as error:

629

if (isinstance(error, OSError)

630

and error.errno != errno.ECHILD):

631

raise error

632

else:

633

if pid:

634

logger.warning("Checker was a zombie")

635

gobject.source_remove(self.checker_callback_tag)

636

self.checker_callback(pid, status,

637

self.current_checker_command)

721

if self.checker is not None and not self.checker.is_alive():

722

logger.warning("Checker was not alive; joining")

723

self.checker.join()

724

self.checker = None

638

725

# Start a new checker if needed

639

726

if self.checker is None:

727

# Escape attributes for the shell

728

escaped_attrs = {

729

attr: re.escape(str(getattr(self, attr)))

730

for attr in self.runtime_expansions }

640

731

try:

641

# In case checker_command has exactly one % operator

642

command = self.checker_command % self.host

643

except TypeError:

644

# Escape attributes for the shell

645

escaped_attrs = dict(

646

(attr,

647

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

648

errors=

649

'replace')))

650

for attr in

651

self.runtime_expansions)

652

653

try:

654

command = self.checker_command % escaped_attrs

655

except TypeError as error:

656

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

657

' %s', self.checker_command, error)

658

return True # Try again later

732

command = self.checker_command % escaped_attrs

733

except TypeError as error:

734

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

735

self.checker_command,

736

exc_info=error)

737

return True # Try again later

659

738

self.current_checker_command = command

660

try:

661

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

662

command, self.name)

663

# We don't need to redirect stdout and stderr, since

664

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

665

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

666

# always replaced by /dev/null.)

667

self.checker = subprocess.Popen(command,

668

close_fds=True,

669

shell=True, cwd="/")

670

self.checker_callback_tag = (gobject.child_watch_add

671

(self.checker.pid,

672

self.checker_callback,

673

data=command))

674

# The checker may have completed before the gobject

675

# watch was added. Check for this.

676

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

677

if pid:

678

gobject.source_remove(self.checker_callback_tag)

679

self.checker_callback(pid, status, command)

680

except OSError as error:

681

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

682

error)

739

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

740

self.name)

741

# We don't need to redirect stdout and stderr, since

742

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

743

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

744

# always replaced by /dev/null.)

745

# The exception is when not debugging but nevertheless

746

# running in the foreground; use the previously

747

# created wnull.

748

popen_args = { "close_fds": True,

749

"shell": True,

750

"cwd": "/" }

751

if (not self.server_settings["debug"]

752

and self.server_settings["foreground"]):

753

popen_args.update({"stdout": wnull,

754

"stderr": wnull })

755

pipe = multiprocessing.Pipe(duplex = False)

756

self.checker = multiprocessing.Process(

757

target = call_pipe,

758

args = (pipe[1], subprocess.call, command),

759

kwargs = popen_args)

760

self.checker.start()

761

self.checker_callback_tag = gobject.io_add_watch(

762

pipe[0].fileno(), gobject.IO_IN,

763

self.checker_callback, pipe[0], command)

683

764

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

684

765

return True

685

766

691

772

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

692

773

return

693

774

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

694

try:

695

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

696

#time.sleep(0.5)

697

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

698

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

699

except OSError as error:

700

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

701

raise

775

self.checker.terminate()

702

776

self.checker = None

703

777

704

778

705

def dbus_service_property(dbus_interface, signature="v",

706

access="readwrite", byte_arrays=False):

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

707

783

"""Decorators for marking methods of a DBusObjectWithProperties to

708

784

become properties on the D-Bus.

709

785

718

794

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

719

795

if byte_arrays and signature != "ay":

720

796

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

721

" signature %r" % signature)

797

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

798

722

799

def decorator(func):

723

800

func._dbus_is_property = True

724

801

func._dbus_interface = dbus_interface

729

806

func._dbus_name = func._dbus_name[:-14]

730

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

731

808

return func

809

810

return decorator

811

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

825

def decorator(func):

826

func._dbus_is_interface = True

827

func._dbus_interface = dbus_interface

828

func._dbus_name = dbus_interface

829

return func

830

831

return decorator

832

833

834

def dbus_annotations(annotations):

835

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

836

Usage:

837

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

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

842

access="r")

843

def Property_dbus_property(self):

844

return dbus.Boolean(False)

845

846

See also the DBusObjectWithAnnotations class.

847

"""

848

849

def decorator(func):

850

func._dbus_annotations = annotations

851

return func

852

732

853

return decorator

733

854

734

855

735

856

class DBusPropertyException(dbus.exceptions.DBusException):

736

857

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

737

858

"""

738

def __unicode__(self):

739

return unicode(str(self))

859

pass

740

860

741

861

742

862

class DBusPropertyAccessException(DBusPropertyException):

751

871

pass

752

872

753

873

754

class DBusObjectWithProperties(dbus.service.Object):

874

class DBusObjectWithAnnotations(dbus.service.Object):

875

"""A D-Bus object with annotations.

876

877

Classes inheriting from this can use the dbus_annotations

878

decorator to add annotations to methods or signals.

879

"""

880

881

@staticmethod

882

def _is_dbus_thing(thing):

883

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

884

885

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

886

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

887

"""

888

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

889

False)

890

891

def _get_all_dbus_things(self, thing):

892

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

893

"""

894

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

895

athing.__get__(self))

896

for cls in self.__class__.__mro__

897

for name, athing in

898

inspect.getmembers(cls, self._is_dbus_thing(thing)))

899

900

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

901

out_signature = "s",

902

path_keyword = 'object_path',

903

connection_keyword = 'connection')

904

def Introspect(self, object_path, connection):

905

"""Overloading of standard D-Bus method.

906

907

Inserts annotation tags on methods and signals.

908

"""

909

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

910

connection)

911

try:

912

document = xml.dom.minidom.parseString(xmlstring)

913

914

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

915

# Add annotation tags

916

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

917

for tag in if_tag.getElementsByTagName(typ):

918

annots = dict()

919

for name, prop in (self.

920

_get_all_dbus_things(typ)):

921

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

922

and prop._dbus_interface

923

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

924

annots.update(getattr(

925

prop, "_dbus_annotations", {}))

926

for name, value in annots.items():

927

ann_tag = document.createElement(

928

"annotation")

929

ann_tag.setAttribute("name", name)

930

ann_tag.setAttribute("value", value)

931

tag.appendChild(ann_tag)

932

# Add interface annotation tags

933

for annotation, value in dict(

934

itertools.chain.from_iterable(

935

annotations().items()

936

for name, annotations

937

in self._get_all_dbus_things("interface")

938

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

939

)).items():

940

ann_tag = document.createElement("annotation")

941

ann_tag.setAttribute("name", annotation)

942

ann_tag.setAttribute("value", value)

943

if_tag.appendChild(ann_tag)

944

# Fix argument name for the Introspect method itself

945

if (if_tag.getAttribute("name")

946

== dbus.INTROSPECTABLE_IFACE):

947

for cn in if_tag.getElementsByTagName("method"):

948

if cn.getAttribute("name") == "Introspect":

949

for arg in cn.getElementsByTagName("arg"):

950

if (arg.getAttribute("direction")

951

== "out"):

952

arg.setAttribute("name",

953

"xml_data")

954

xmlstring = document.toxml("utf-8")

955

document.unlink()

956

except (AttributeError, xml.dom.DOMException,

957

xml.parsers.expat.ExpatError) as error:

958

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

959

exc_info=error)

960

return xmlstring

961

962

963

class DBusObjectWithProperties(DBusObjectWithAnnotations):

755

964

"""A D-Bus object with properties.

756

965

757

966

Classes inheriting from this can use the dbus_service_property

759

968

standard Get(), Set(), and GetAll() methods on the D-Bus.

760

969

"""

761

970

762

@staticmethod

763

def _is_dbus_property(obj):

764

return getattr(obj, "_dbus_is_property", False)

765

766

def _get_all_dbus_properties(self):

767

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

768

"""

769

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

770

for cls in self.__class__.__mro__

771

for name, prop in

772

inspect.getmembers(cls, self._is_dbus_property))

773

774

971

def _get_dbus_property(self, interface_name, property_name):

775

972

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

776

973

property with the specified name and interface.

777

974

"""

778

for cls in self.__class__.__mro__:

779

for name, value in (inspect.getmembers

780

(cls, self._is_dbus_property)):

975

for cls in self.__class__.__mro__:

976

for name, value in inspect.getmembers(

977

cls, self._is_dbus_thing("property")):

781

978

if (value._dbus_name == property_name

782

979

and value._dbus_interface == interface_name):

783

980

return value.__get__(self)

784

981

785

982

# No such property

786

raise DBusPropertyNotFound(self.dbus_object_path + ":"

787

+ interface_name + "."

788

+ property_name)

789

790

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

983

raise DBusPropertyNotFound("{}:{}.{}".format(

984

self.dbus_object_path, interface_name, property_name))

985

986

@classmethod

987

def _get_all_interface_names(cls):

988

"""Get a sequence of all interfaces supported by an object"""

989

return (name for name in set(getattr(getattr(x, attr),

990

"_dbus_interface", None)

991

for x in (inspect.getmro(cls))

992

for attr in dir(x))

993

if name is not None)

994

995

@dbus.service.method(dbus.PROPERTIES_IFACE,

996

in_signature="ss",

791

997

out_signature="v")

792

998

def Get(self, interface_name, property_name):

793

999

"""Standard D-Bus property Get() method, see D-Bus standard.

811

1017

# The byte_arrays option is not supported yet on

812

1018

# signatures other than "ay".

813

1019

if prop._dbus_signature != "ay":

814

raise ValueError

815

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

816

for byte in value))

1020

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

1021

"'ay' signature {!r}"

1022

.format(prop._dbus_signature))

1023

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

1024

for byte in value))

817

1025

prop(value)

818

1026

819

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

1027

@dbus.service.method(dbus.PROPERTIES_IFACE,

1028

in_signature="s",

820

1029

out_signature="a{sv}")

821

1030

def GetAll(self, interface_name):

822

1031

"""Standard D-Bus property GetAll() method, see D-Bus

825

1034

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

826

1035

"""

827

1036

properties = {}

828

for name, prop in self._get_all_dbus_properties():

1037

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

829

1038

if (interface_name

830

1039

and interface_name != prop._dbus_interface):

831

1040

# Interface non-empty but did not match

837

1046

if not hasattr(value, "variant_level"):

838

1047

properties[name] = value

839

1048

continue

840

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

841

value.variant_level+1)

1049

properties[name] = type(value)(

1050

value, variant_level = value.variant_level + 1)

842

1051

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

843

1052

1053

@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")

1054

def PropertiesChanged(self, interface_name, changed_properties,

1055

invalidated_properties):

1056

"""Standard D-Bus PropertiesChanged() signal, see D-Bus

1057

standard.

1058

"""

1059

pass

1060

844

1061

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

845

1062

out_signature="s",

846

1063

path_keyword='object_path',

847

1064

connection_keyword='connection')

848

1065

def Introspect(self, object_path, connection):

849

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

1066

"""Overloading of standard D-Bus method.

1067

1068

Inserts property tags and interface annotation tags.

850

1069

"""

851

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

852

connection)

1070

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1071

object_path,

1072

connection)

853

1073

try:

854

1074

document = xml.dom.minidom.parseString(xmlstring)

1075

855

1076

def make_tag(document, name, prop):

856

1077

e = document.createElement("property")

857

1078

e.setAttribute("name", name)

858

1079

e.setAttribute("type", prop._dbus_signature)

859

1080

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

860

1081

return e

1082

861

1083

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

1084

# Add property tags

862

1085

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

863

1086

for name, prop

864

in self._get_all_dbus_properties()

1087

in self._get_all_dbus_things("property")

865

1088

if prop._dbus_interface

866

1089

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

867

1090

if_tag.appendChild(tag)

1091

# Add annotation tags for properties

1092

for tag in if_tag.getElementsByTagName("property"):

1093

annots = dict()

1094

for name, prop in self._get_all_dbus_things(

1095

"property"):

1096

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

1097

and prop._dbus_interface

1098

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

1099

annots.update(getattr(

1100

prop, "_dbus_annotations", {}))

1101

for name, value in annots.items():

1102

ann_tag = document.createElement(

1103

"annotation")

1104

ann_tag.setAttribute("name", name)

1105

ann_tag.setAttribute("value", value)

1106

tag.appendChild(ann_tag)

868

1107

# Add the names to the return values for the

869

1108

# "org.freedesktop.DBus.Properties" methods

870

1109

if (if_tag.getAttribute("name")

885

1124

except (AttributeError, xml.dom.DOMException,

886

1125

xml.parsers.expat.ExpatError) as error:

887

1126

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

888

error)

889

return xmlstring

890

891

892

def datetime_to_dbus (dt, variant_level=0):

1127

exc_info=error)

1128

return xmlstring

1129

1130

try:

1131

dbus.OBJECT_MANAGER_IFACE

1132

except AttributeError:

1133

dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"

1134

1135

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1136

"""A D-Bus object with an ObjectManager.

1137

1138

Classes inheriting from this exposes the standard

1139

GetManagedObjects call and the InterfacesAdded and

1140

InterfacesRemoved signals on the standard

1141

"org.freedesktop.DBus.ObjectManager" interface.

1142

1143

Note: No signals are sent automatically; they must be sent

1144

manually.

1145

"""

1146

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1147

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

1148

def GetManagedObjects(self):

1149

"""This function must be overridden"""

1150

raise NotImplementedError()

1151

1152

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1153

signature = "oa{sa{sv}}")

1154

def InterfacesAdded(self, object_path, interfaces_and_properties):

1155

pass

1156

1157

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")

1158

def InterfacesRemoved(self, object_path, interfaces):

1159

pass

1160

1161

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1162

out_signature = "s",

1163

path_keyword = 'object_path',

1164

connection_keyword = 'connection')

1165

def Introspect(self, object_path, connection):

1166

"""Overloading of standard D-Bus method.

1167

1168

Override return argument name of GetManagedObjects to be

1169

"objpath_interfaces_and_properties"

1170

"""

1171

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1172

object_path,

1173

connection)

1174

try:

1175

document = xml.dom.minidom.parseString(xmlstring)

1176

1177

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

1178

# Fix argument name for the GetManagedObjects method

1179

if (if_tag.getAttribute("name")

1180

== dbus.OBJECT_MANAGER_IFACE):

1181

for cn in if_tag.getElementsByTagName("method"):

1182

if (cn.getAttribute("name")

1183

== "GetManagedObjects"):

1184

for arg in cn.getElementsByTagName("arg"):

1185

if (arg.getAttribute("direction")

1186

== "out"):

1187

arg.setAttribute(

1188

"name",

1189

"objpath_interfaces"

1190

"_and_properties")

1191

xmlstring = document.toxml("utf-8")

1192

document.unlink()

1193

except (AttributeError, xml.dom.DOMException,

1194

xml.parsers.expat.ExpatError) as error:

1195

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

1196

exc_info = error)

1197

return xmlstring

1198

1199

def datetime_to_dbus(dt, variant_level=0):

893

1200

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

894

1201

if dt is None:

895

1202

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

896

return dbus.String(dt.isoformat(),

897

variant_level=variant_level)

898

899

900

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

901

.__metaclass__):

902

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

903

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

1203

return dbus.String(dt.isoformat(), variant_level=variant_level)

1204

1205

1206

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1207

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

1208

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

1209

interface names according to the "alt_interface_names" mapping.

1210

Usage:

1211

1212

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

1213

"net.example.AlternateInterface"})

1214

class SampleDBusObject(dbus.service.Object):

1215

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

1216

def SampleDBusMethod():

1217

pass

1218

1219

The above "SampleDBusMethod" on "SampleDBusObject" will be

1220

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

1221

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

1222

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

1223

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

1224

1225

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

1226

(from DBusObjectWithProperties) and interfaces (from the

1227

dbus_interface_annotations decorator).

904

1228

"""

905

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

906

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

907

# methods, signals, or properties in them

908

for base in (b for b in bases

909

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

910

# Go though all attributes of the base class

911

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

1229

1230

def wrapper(cls):

1231

for orig_interface_name, alt_interface_name in (

1232

alt_interface_names.items()):

1233

attr = {}

1234

interface_names = set()

1235

# Go though all attributes of the class

1236

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

912

1237

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

913

1238

# with the wrong interface name

914

1239

if (not hasattr(attribute, "_dbus_interface")

915

or not attribute._dbus_interface

916

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

1240

or not attribute._dbus_interface.startswith(

1241

orig_interface_name)):

917

1242

continue

918

1243

# Create an alternate D-Bus interface name based on

919

1244

# the current name

920

alt_interface = (attribute._dbus_interface

921

.replace("se.recompile.Mandos",

922

"se.bsnet.fukt.Mandos"))

1245

alt_interface = attribute._dbus_interface.replace(

1246

orig_interface_name, alt_interface_name)

1247

interface_names.add(alt_interface)

923

1248

# Is this a D-Bus signal?

924

1249

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

925

# Extract the original non-method function by

926

# black magic

927

nonmethod_func = (dict(

1250

if sys.version_info.major == 2:

1251

# Extract the original non-method undecorated

1252

# function by black magic

1253

nonmethod_func = (dict(

928

1254

zip(attribute.func_code.co_freevars,

929

attribute.__closure__))["func"]

930

.cell_contents)

1255

attribute.__closure__))

1256

["func"].cell_contents)

1257

else:

1258

nonmethod_func = attribute

931

1259

# Create a new, but exactly alike, function

932

1260

# object, and decorate it to be a new D-Bus signal

933

1261

# with the alternate D-Bus interface name

934

new_function = (dbus.service.signal

935

(alt_interface,

936

attribute._dbus_signature)

937

(types.FunctionType(

938

nonmethod_func.func_code,

939

nonmethod_func.func_globals,

940

nonmethod_func.func_name,

941

nonmethod_func.func_defaults,

942

nonmethod_func.func_closure)))

1262

if sys.version_info.major == 2:

1263

new_function = types.FunctionType(

1264

nonmethod_func.func_code,

1265

nonmethod_func.func_globals,

1266

nonmethod_func.func_name,

1267

nonmethod_func.func_defaults,

1268

nonmethod_func.func_closure)

1269

else:

1270

new_function = types.FunctionType(

1271

nonmethod_func.__code__,

1272

nonmethod_func.__globals__,

1273

nonmethod_func.__name__,

1274

nonmethod_func.__defaults__,

1275

nonmethod_func.__closure__)

1276

new_function = (dbus.service.signal(

1277

alt_interface,

1278

attribute._dbus_signature)(new_function))

1279

# Copy annotations, if any

1280

try:

1281

new_function._dbus_annotations = dict(

1282

attribute._dbus_annotations)

1283

except AttributeError:

1284

pass

943

1285

# Define a creator of a function to call both the

944

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

945

# signals gets sent when the function is called

1286

# original and alternate functions, so both the

1287

# original and alternate signals gets sent when

1288

# the function is called

946

1289

def fixscope(func1, func2):

947

1290

"""This function is a scope container to pass

948

1291

func1 and func2 to the "call_both" function

949

1292

outside of its arguments"""

1293

1294

@functools.wraps(func2)

950

1295

def call_both(*args, **kwargs):

951

1296

"""This function will emit two D-Bus

952

1297

signals by calling func1 and func2"""

953

1298

func1(*args, **kwargs)

954

1299

func2(*args, **kwargs)

1300

# Make wrapper function look like a D-Bus signal

1301

for name, attr in inspect.getmembers(func2):

1302

if name.startswith("_dbus_"):

1303

setattr(call_both, name, attr)

1304

955

1305

return call_both

956

1306

# Create the "call_both" function and add it to

957

1307

# the class

958

attr[attrname] = fixscope(attribute,

959

new_function)

1308

attr[attrname] = fixscope(attribute, new_function)

960

1309

# Is this a D-Bus method?

961

1310

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

962

1311

# Create a new, but exactly alike, function

963

1312

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

964

1313

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

965

1314

# to the class.

966

attr[attrname] = (dbus.service.method

967

(alt_interface,

968

attribute._dbus_in_signature,

969

attribute._dbus_out_signature)

970

(types.FunctionType

971

(attribute.func_code,

972

attribute.func_globals,

973

attribute.func_name,

974

attribute.func_defaults,

975

attribute.func_closure)))

1315

attr[attrname] = (

1316

dbus.service.method(

1317

alt_interface,

1318

attribute._dbus_in_signature,

1319

attribute._dbus_out_signature)

1320

(types.FunctionType(attribute.func_code,

1321

attribute.func_globals,

1322

attribute.func_name,

1323

attribute.func_defaults,

1324

attribute.func_closure)))

1325

# Copy annotations, if any

1326

try:

1327

attr[attrname]._dbus_annotations = dict(

1328

attribute._dbus_annotations)

1329

except AttributeError:

1330

pass

976

1331

# Is this a D-Bus property?

977

1332

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

978

1333

# Create a new, but exactly alike, function

979

1334

# object, and decorate it to be a new D-Bus

980

1335

# property with the alternate D-Bus interface

981

1336

# name. Add it to the class.

982

attr[attrname] = (dbus_service_property

983

(alt_interface,

984

attribute._dbus_signature,

985

attribute._dbus_access,

986

attribute

987

._dbus_get_args_options

988

["byte_arrays"])

989

(types.FunctionType

990

(attribute.func_code,

991

attribute.func_globals,

992

attribute.func_name,

993

attribute.func_defaults,

994

attribute.func_closure)))

995

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

996

997

1337

attr[attrname] = (dbus_service_property(

1338

alt_interface, attribute._dbus_signature,

1339

attribute._dbus_access,

1340

attribute._dbus_get_args_options

1341

["byte_arrays"])

1342

(types.FunctionType(

1343

attribute.func_code,

1344

attribute.func_globals,

1345

attribute.func_name,

1346

attribute.func_defaults,

1347

attribute.func_closure)))

1348

# Copy annotations, if any

1349

try:

1350

attr[attrname]._dbus_annotations = dict(

1351

attribute._dbus_annotations)

1352

except AttributeError:

1353

pass

1354

# Is this a D-Bus interface?

1355

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

1356

# Create a new, but exactly alike, function

1357

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

1358

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

1359

# to the class.

1360

attr[attrname] = (

1361

dbus_interface_annotations(alt_interface)

1362

(types.FunctionType(attribute.func_code,

1363

attribute.func_globals,

1364

attribute.func_name,

1365

attribute.func_defaults,

1366

attribute.func_closure)))

1367

if deprecate:

1368

# Deprecate all alternate interfaces

1369

iname="_AlternateDBusNames_interface_annotation{}"

1370

for interface_name in interface_names:

1371

1372

@dbus_interface_annotations(interface_name)

1373

def func(self):

1374

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

1375

"true" }

1376

# Find an unused name

1377

for aname in (iname.format(i)

1378

for i in itertools.count()):

1379

if aname not in attr:

1380

attr[aname] = func

1381

break

1382

if interface_names:

1383

# Replace the class with a new subclass of it with

1384

# methods, signals, etc. as created above.

1385

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

1386

(cls, ), attr)

1387

return cls

1388

1389

return wrapper

1390

1391

1392

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

1393

"se.bsnet.fukt.Mandos"})

998

1394

class ClientDBus(Client, DBusObjectWithProperties):

999

1395

"""A Client class using D-Bus

1000

1396

1004

1400

"""

1005

1401

1006

1402

runtime_expansions = (Client.runtime_expansions

1007

+ ("dbus_object_path",))

1403

+ ("dbus_object_path", ))

1404

1405

_interface = "se.recompile.Mandos.Client"

1008

1406

1009

1407

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

1010

1408

1011

1409

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

1012

1410

self.bus = bus

1013

1411

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

1014

1015

self._approvals_pending = 0

1016

1412

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

1017

1413

# the D-Bus

1018

client_object_name = unicode(self.name).translate(

1414

client_object_name = str(self.name).translate(

1019

1415

{ord("."): ord("_"),

1020

1416

ord("-"): ord("_")})

1021

self.dbus_object_path = (dbus.ObjectPath

1022

("/clients/" + client_object_name))

1417

self.dbus_object_path = dbus.ObjectPath(

1418

"/clients/" + client_object_name)

1023

1419

DBusObjectWithProperties.__init__(self, self.bus,

1024

1420

self.dbus_object_path)

1025

1026

def notifychangeproperty(transform_func,

1027

dbus_name, type_func=lambda x: x,

1028

variant_level=1):

1421

1422

def notifychangeproperty(transform_func, dbus_name,

1423

type_func=lambda x: x,

1424

variant_level=1,

1425

invalidate_only=False,

1426

_interface=_interface):

1029

1427

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

1030

1428

its changes to DBus.

1031

1429

1036

1434

to the D-Bus. Default: no transform

1037

1435

variant_level: D-Bus variant level. Default: 1

1038

1436

"""

1039

attrname = "_{0}".format(dbus_name)

1437

attrname = "_{}".format(dbus_name)

1438

1040

1439

def setter(self, value):

1041

1440

if hasattr(self, "dbus_object_path"):

1042

1441

if (not hasattr(self, attrname) or

1043

1442

type_func(getattr(self, attrname, None))

1044

1443

!= type_func(value)):

1045

dbus_value = transform_func(type_func(value),

1046

variant_level

1047

=variant_level)

1048

self.PropertyChanged(dbus.String(dbus_name),

1049

dbus_value)

1444

if invalidate_only:

1445

self.PropertiesChanged(

1446

_interface, dbus.Dictionary(),

1447

dbus.Array((dbus_name, )))

1448

else:

1449

dbus_value = transform_func(

1450

type_func(value),

1451

variant_level = variant_level)

1452

self.PropertyChanged(dbus.String(dbus_name),

1453

dbus_value)

1454

self.PropertiesChanged(

1455

_interface,

1456

dbus.Dictionary({ dbus.String(dbus_name):

1457

dbus_value }),

1458

dbus.Array())

1050

1459

setattr(self, attrname, value)

1051

1460

1052

1461

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

1053

1462

1054

1055

1463

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1056

1464

approvals_pending = notifychangeproperty(dbus.Boolean,

1057

1465

"ApprovalPending",

1059

1467

enabled = notifychangeproperty(dbus.Boolean, "Enabled")

1060

1468

last_enabled = notifychangeproperty(datetime_to_dbus,

1061

1469

"LastEnabled")

1062

checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",

1063

type_func = lambda checker:

1064

checker is not None)

1470

checker = notifychangeproperty(

1471

dbus.Boolean, "CheckerRunning",

1472

type_func = lambda checker: checker is not None)

1065

1473

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1066

1474

"LastCheckedOK")

1475

last_checker_status = notifychangeproperty(dbus.Int16,

1476

"LastCheckerStatus")

1067

1477

last_approval_request = notifychangeproperty(

1068

1478

datetime_to_dbus, "LastApprovalRequest")

1069

1479

approved_by_default = notifychangeproperty(dbus.Boolean,

1070

1480

"ApprovedByDefault")

1071

approval_delay = notifychangeproperty(dbus.UInt16,

1072

"ApprovalDelay",

1073

type_func =

1074

_timedelta_to_milliseconds)

1481

approval_delay = notifychangeproperty(

1482

dbus.UInt64, "ApprovalDelay",

1483

type_func = lambda td: td.total_seconds() * 1000)

1075

1484

approval_duration = notifychangeproperty(

1076

dbus.UInt16, "ApprovalDuration",

1077

type_func = _timedelta_to_milliseconds)

1485

dbus.UInt64, "ApprovalDuration",

1486

type_func = lambda td: td.total_seconds() * 1000)

1078

1487

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

1079

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

1080

type_func =

1081

_timedelta_to_milliseconds)

1488

timeout = notifychangeproperty(

1489

dbus.UInt64, "Timeout",

1490

type_func = lambda td: td.total_seconds() * 1000)

1082

1491

extended_timeout = notifychangeproperty(

1083

dbus.UInt16, "ExtendedTimeout",

1084

type_func = _timedelta_to_milliseconds)

1085

interval = notifychangeproperty(dbus.UInt16,

1086

"Interval",

1087

type_func =

1088

_timedelta_to_milliseconds)

1492

dbus.UInt64, "ExtendedTimeout",

1493

type_func = lambda td: td.total_seconds() * 1000)

1494

interval = notifychangeproperty(

1495

dbus.UInt64, "Interval",

1496

type_func = lambda td: td.total_seconds() * 1000)

1089

1497

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

1498

secret = notifychangeproperty(dbus.ByteArray, "Secret",

1499

invalidate_only=True)

1090

1500

1091

1501

del notifychangeproperty

1092

1502

1099

1509

DBusObjectWithProperties.__del__(self, *args, **kwargs)

1100

1510

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

1101

1511

1102

def checker_callback(self, pid, condition, command,

1103

*args, **kwargs):

1104

self.checker_callback_tag = None

1105

self.checker = None

1106

if os.WIFEXITED(condition):

1107

exitstatus = os.WEXITSTATUS(condition)

1512

def checker_callback(self, source, condition,

1513

connection, command, *args, **kwargs):

1514

ret = Client.checker_callback(self, source, condition,

1515

connection, command, *args,

1516

**kwargs)

1517

exitstatus = self.last_checker_status

1518

if exitstatus >= 0:

1108

1519

# Emit D-Bus signal

1109

1520

self.CheckerCompleted(dbus.Int16(exitstatus),

1110

dbus.Int64(condition),

1521

# This is specific to GNU libC

1522

dbus.Int64(exitstatus << 8),

1111

1523

dbus.String(command))

1112

1524

else:

1113

1525

# Emit D-Bus signal

1114

1526

self.CheckerCompleted(dbus.Int16(-1),

1115

dbus.Int64(condition),

1527

dbus.Int64(

1528

# This is specific to GNU libC

1529

(exitstatus << 8)

1530

| self.last_checker_signal),

1116

1531

dbus.String(command))

1117

1118

return Client.checker_callback(self, pid, condition, command,

1119

*args, **kwargs)

1532

return ret

1120

1533

1121

1534

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

1122

old_checker = self.checker

1123

if self.checker is not None:

1124

old_checker_pid = self.checker.pid

1125

else:

1126

old_checker_pid = None

1535

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

1127

1536

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

1128

1537

# Only if new checker process was started

1129

1538

if (self.checker is not None

1133

1542

return r

1134

1543

1135

1544

def _reset_approved(self):

1136

self._approved = None

1545

self.approved = None

1137

1546

return False

1138

1547

1139

1548

def approve(self, value=True):

1549

self.approved = value

1550

gobject.timeout_add(int(self.approval_duration.total_seconds()

1551

* 1000), self._reset_approved)

1140

1552

self.send_changedstate()

1141

self._approved = value

1142

gobject.timeout_add(_timedelta_to_milliseconds

1143

(self.approval_duration),

1144

self._reset_approved)

1145

1146

1553

1147

1554

## D-Bus methods, signals & properties

1148

_interface = "se.recompile.Mandos.Client"

1555

1556

## Interfaces

1149

1557

1150

1558

## Signals

1151

1559

1162

1570

pass

1163

1571

1164

1572

# PropertyChanged - signal

1573

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

1165

1574

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

1166

1575

def PropertyChanged(self, property, value):

1167

1576

"D-Bus signal"

1188

1597

"D-Bus signal"

1189

1598

return self.need_approval()

1190

1599

1191

# NeRwequest - signal

1192

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

1193

def NewRequest(self, ip):

1194

"""D-Bus signal

1195

Is sent after a client request a password.

1196

"""

1197

pass

1198

1199

1600

## Methods

1200

1601

1201

1602

# Approve - method

1209

1610

self.checked_ok()

1210

1611

1211

1612

# Enable - method

1613

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

1212

1614

@dbus.service.method(_interface)

1213

1615

def Enable(self):

1214

1616

"D-Bus method"

1215

1617

self.enable()

1216

1618

1217

1619

# StartChecker - method

1620

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

1218

1621

@dbus.service.method(_interface)

1219

1622

def StartChecker(self):

1220

1623

"D-Bus method"

1221

1624

self.start_checker()

1222

1625

1223

1626

# Disable - method

1627

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

1224

1628

@dbus.service.method(_interface)

1225

1629

def Disable(self):

1226

1630

"D-Bus method"

1227

1631

self.disable()

1228

1632

1229

1633

# StopChecker - method

1634

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

1230

1635

@dbus.service.method(_interface)

1231

1636

def StopChecker(self):

1232

1637

self.stop_checker()

1239

1644

return dbus.Boolean(bool(self.approvals_pending))

1240

1645

1241

1646

# ApprovedByDefault - property

1242

@dbus_service_property(_interface, signature="b",

1647

@dbus_service_property(_interface,

1648

signature="b",

1243

1649

access="readwrite")

1244

1650

def ApprovedByDefault_dbus_property(self, value=None):

1245

1651

if value is None: # get

1247

1653

self.approved_by_default = bool(value)

1248

1654

1249

1655

# ApprovalDelay - property

1250

@dbus_service_property(_interface, signature="t",

1656

@dbus_service_property(_interface,

1657

signature="t",

1251

1658

access="readwrite")

1252

1659

def ApprovalDelay_dbus_property(self, value=None):

1253

1660

if value is None: # get

1254

return dbus.UInt64(self.approval_delay_milliseconds())

1661

return dbus.UInt64(self.approval_delay.total_seconds()

1662

* 1000)

1255

1663

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

1256

1664

1257

1665

# ApprovalDuration - property

1258

@dbus_service_property(_interface, signature="t",

1666

@dbus_service_property(_interface,

1667

signature="t",

1259

1668

access="readwrite")

1260

1669

def ApprovalDuration_dbus_property(self, value=None):

1261

1670

if value is None: # get

1262

return dbus.UInt64(_timedelta_to_milliseconds(

1263

self.approval_duration))

1671

return dbus.UInt64(self.approval_duration.total_seconds()

1672

* 1000)

1264

1673

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

1265

1674

1266

1675

# Name - property

1676

@dbus_annotations(

1677

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1267

1678

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

1268

1679

def Name_dbus_property(self):

1269

1680

return dbus.String(self.name)

1270

1681

1271

1682

# Fingerprint - property

1683

@dbus_annotations(

1684

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1272

1685

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

1273

1686

def Fingerprint_dbus_property(self):

1274

1687

return dbus.String(self.fingerprint)

1275

1688

1276

1689

# Host - property

1277

@dbus_service_property(_interface, signature="s",

1690

@dbus_service_property(_interface,

1691

signature="s",

1278

1692

access="readwrite")

1279

1693

def Host_dbus_property(self, value=None):

1280

1694

if value is None: # get

1281

1695

return dbus.String(self.host)

1282

self.host = value

1696

self.host = str(value)

1283

1697

1284

1698

# Created - property

1699

@dbus_annotations(

1700

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1285

1701

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

1286

1702

def Created_dbus_property(self):

1287

1703

return datetime_to_dbus(self.created)

1292

1708

return datetime_to_dbus(self.last_enabled)

1293

1709

1294

1710

# Enabled - property

1295

@dbus_service_property(_interface, signature="b",

1711

@dbus_service_property(_interface,

1712

signature="b",

1296

1713

access="readwrite")

1297

1714

def Enabled_dbus_property(self, value=None):

1298

1715

if value is None: # get

1303

1720

self.disable()

1304

1721

1305

1722

# LastCheckedOK - property

1306

@dbus_service_property(_interface, signature="s",

1723

@dbus_service_property(_interface,

1724

signature="s",

1307

1725

access="readwrite")

1308

1726

def LastCheckedOK_dbus_property(self, value=None):

1309

1727

if value is not None:

1311

1729

return

1312

1730

return datetime_to_dbus(self.last_checked_ok)

1313

1731

1732

# LastCheckerStatus - property

1733

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

1734

def LastCheckerStatus_dbus_property(self):

1735

return dbus.Int16(self.last_checker_status)

1736

1314

1737

# Expires - property

1315

1738

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

1316

1739

def Expires_dbus_property(self):

1322

1745

return datetime_to_dbus(self.last_approval_request)

1323

1746

1324

1747

# Timeout - property

1325

@dbus_service_property(_interface, signature="t",

1748

@dbus_service_property(_interface,

1749

signature="t",

1326

1750

access="readwrite")

1327

1751

def Timeout_dbus_property(self, value=None):

1328

1752

if value is None: # get

1329

return dbus.UInt64(self.timeout_milliseconds())

1753

return dbus.UInt64(self.timeout.total_seconds() * 1000)

1754

old_timeout = self.timeout

1330

1755

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

1331

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

1332

return

1333

# Reschedule timeout

1334

gobject.source_remove(self.disable_initiator_tag)

1335

self.disable_initiator_tag = None

1336

self.expires = None

1337

time_to_die = _timedelta_to_milliseconds((self

1338

.last_checked_ok

1339

+ self.timeout)

1340

- datetime.datetime

1341

.utcnow())

1342

if time_to_die <= 0:

1343

# The timeout has passed

1344

self.disable()

1345

else:

1346

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

1347

+ datetime.timedelta(milliseconds =

1348

time_to_die))

1349

self.disable_initiator_tag = (gobject.timeout_add

1350

(time_to_die, self.disable))

1756

# Reschedule disabling

1757

if self.enabled:

1758

now = datetime.datetime.utcnow()

1759

self.expires += self.timeout - old_timeout

1760

if self.expires <= now:

1761

# The timeout has passed

1762

self.disable()

1763

else:

1764

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

1765

is None):

1766

return

1767

gobject.source_remove(self.disable_initiator_tag)

1768

self.disable_initiator_tag = gobject.timeout_add(

1769

int((self.expires - now).total_seconds() * 1000),

1770

self.disable)

1351

1771

1352

1772

# ExtendedTimeout - property

1353

@dbus_service_property(_interface, signature="t",

1773

@dbus_service_property(_interface,

1774

signature="t",

1354

1775

access="readwrite")

1355

1776

def ExtendedTimeout_dbus_property(self, value=None):

1356

1777

if value is None: # get

1357

return dbus.UInt64(self.extended_timeout_milliseconds())

1778

return dbus.UInt64(self.extended_timeout.total_seconds()

1779

* 1000)

1358

1780

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

1359

1781

1360

1782

# Interval - property

1361

@dbus_service_property(_interface, signature="t",

1783

@dbus_service_property(_interface,

1784

signature="t",

1362

1785

access="readwrite")

1363

1786

def Interval_dbus_property(self, value=None):

1364

1787

if value is None: # get

1365

return dbus.UInt64(self.interval_milliseconds())

1788

return dbus.UInt64(self.interval.total_seconds() * 1000)

1366

1789

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

1367

1790

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

1368

1791

return

1369

1792

if self.enabled:

1370

1793

# Reschedule checker run

1371

1794

gobject.source_remove(self.checker_initiator_tag)

1372

self.checker_initiator_tag = (gobject.timeout_add

1373

(value, self.start_checker))

1374

self.start_checker() # Start one now, too

1795

self.checker_initiator_tag = gobject.timeout_add(

1796

value, self.start_checker)

1797

self.start_checker() # Start one now, too

1375

1798

1376

1799

# Checker - property

1377

@dbus_service_property(_interface, signature="s",

1800

@dbus_service_property(_interface,

1801

signature="s",

1378

1802

access="readwrite")

1379

1803

def Checker_dbus_property(self, value=None):

1380

1804

if value is None: # get

1381

1805

return dbus.String(self.checker_command)

1382

self.checker_command = value

1806

self.checker_command = str(value)

1383

1807

1384

1808

# CheckerRunning - property

1385

@dbus_service_property(_interface, signature="b",

1809

@dbus_service_property(_interface,

1810

signature="b",

1386

1811

access="readwrite")

1387

1812

def CheckerRunning_dbus_property(self, value=None):

1388

1813

if value is None: # get

1393

1818

self.stop_checker()

1394

1819

1395

1820

# ObjectPath - property

1821

@dbus_annotations(

1822

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",

1823

"org.freedesktop.DBus.Deprecated": "true"})

1396

1824

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

1397

1825

def ObjectPath_dbus_property(self):

1398

1826

return self.dbus_object_path # is already a dbus.ObjectPath

1399

1827

1400

1828

# Secret = property

1401

@dbus_service_property(_interface, signature="ay",

1402

access="write", byte_arrays=True)

1829

@dbus_annotations(

1830

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

1831

"invalidates"})

1832

@dbus_service_property(_interface,

1833

signature="ay",

1834

access="write",

1835

byte_arrays=True)

1403

1836

def Secret_dbus_property(self, value):

1404

self.secret = str(value)

1837

self.secret = bytes(value)

1405

1838

1406

1839

del _interface

1407

1840

1411

1844

self._pipe = child_pipe

1412

1845

self._pipe.send(('init', fpr, address))

1413

1846

if not self._pipe.recv():

1414

raise KeyError()

1847

raise KeyError(fpr)

1415

1848

1416

1849

def __getattribute__(self, name):

1417

if(name == '_pipe'):

1850

if name == '_pipe':

1418

1851

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

1419

1852

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

1420

1853

data = self._pipe.recv()

1421

1854

if data[0] == 'data':

1422

1855

return data[1]

1423

1856

if data[0] == 'function':

1857

1424

1858

def func(*args, **kwargs):

1425

1859

self._pipe.send(('funcall', name, args, kwargs))

1426

1860

return self._pipe.recv()[1]

1861

1427

1862

return func

1428

1863

1429

1864

def __setattr__(self, name, value):

1430

if(name == '_pipe'):

1865

if name == '_pipe':

1431

1866

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

1432

1867

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

1433

1868

1434

1869

1435

class ClientDBusTransitional(ClientDBus):

1436

__metaclass__ = AlternateDBusNamesMetaclass

1437

1438

1439

1870

class ClientHandler(socketserver.BaseRequestHandler, object):

1440

1871

"""A class to handle client connections.

1441

1872

1445

1876

def handle(self):

1446

1877

with contextlib.closing(self.server.child_pipe) as child_pipe:

1447

1878

logger.info("TCP connection from: %s",

1448

unicode(self.client_address))

1879

str(self.client_address))

1449

1880

logger.debug("Pipe FD: %d",

1450

1881

self.server.child_pipe.fileno())

1451

1882

1452

session = (gnutls.connection

1453

.ClientSession(self.request,

1454

gnutls.connection

1455

.X509Credentials()))

1883

session = gnutls.connection.ClientSession(

1884

self.request, gnutls.connection .X509Credentials())

1456

1885

1457

1886

# Note: gnutls.connection.X509Credentials is really a

1458

1887

# generic GnuTLS certificate credentials object so long as

1467

1896

priority = self.server.gnutls_priority

1468

1897

if priority is None:

1469

1898

priority = "NORMAL"

1470

(gnutls.library.functions

1471

.gnutls_priority_set_direct(session._c_object,

1472

priority, None))

1899

gnutls.library.functions.gnutls_priority_set_direct(

1900

session._c_object, priority, None)

1473

1901

1474

1902

# Start communication using the Mandos protocol

1475

1903

# Get protocol number

1477

1905

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

1478

1906

try:

1479

1907

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

1480

raise RuntimeError

1908

raise RuntimeError(line)

1481

1909

except (ValueError, IndexError, RuntimeError) as error:

1482

1910

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

1483

1911

return

1495

1923

approval_required = False

1496

1924

try:

1497

1925

try:

1498

fpr = self.fingerprint(self.peer_certificate

1499

(session))

1926

fpr = self.fingerprint(

1927

self.peer_certificate(session))

1500

1928

except (TypeError,

1501

1929

gnutls.errors.GNUTLSError) as error:

1502

1930

logger.warning("Bad certificate: %s", error)

1503

1931

return

1504

1932

logger.debug("Fingerprint: %s", fpr)

1505

if self.server.use_dbus:

1506

# Emit D-Bus signal

1507

client.NewRequest(str(self.client_address))

1508

1933

1509

1934

try:

1510

1935

client = ProxyClient(child_pipe, fpr,

1520

1945

while True:

1521

1946

if not client.enabled:

1522

1947

logger.info("Client %s is disabled",

1523

client.name)

1948

client.name)

1524

1949

if self.server.use_dbus:

1525

1950

# Emit D-Bus signal

1526

1951

client.Rejected("Disabled")

1527

1952

return

1528

1953

1529

if client._approved or not client.approval_delay:

1954

if client.approved or not client.approval_delay:

1530

1955

#We are approved or approval is disabled

1531

1956

break

1532

elif client._approved is None:

1957

elif client.approved is None:

1533

1958

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

1534

1959

client.name)

1535

1960

if self.server.use_dbus:

1536

1961

# Emit D-Bus signal

1537

1962

client.NeedApproval(

1538

client.approval_delay_milliseconds(),

1539

client.approved_by_default)

1963

client.approval_delay.total_seconds()

1964

* 1000, client.approved_by_default)

1540

1965

else:

1541

1966

logger.warning("Client %s was not approved",

1542

1967

client.name)

1548

1973

#wait until timeout or approved

1549

1974

time = datetime.datetime.now()

1550

1975

client.changedstate.acquire()

1551

(client.changedstate.wait

1552

(float(client._timedelta_to_milliseconds(delay)

1553

/ 1000)))

1976

client.changedstate.wait(delay.total_seconds())

1554

1977

client.changedstate.release()

1555

1978

time2 = datetime.datetime.now()

1556

1979

if (time2 - time) >= delay:

1572

1995

try:

1573

1996

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

1574

1997

except gnutls.errors.GNUTLSError as error:

1575

logger.warning("gnutls send failed")

1998

logger.warning("gnutls send failed",

1999

exc_info=error)

1576

2000

return

1577

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

1578

sent, len(client.secret)

1579

- (sent_size + sent))

2001

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

2002

len(client.secret) - (sent_size

2003

+ sent))

1580

2004

sent_size += sent

1581

2005

1582

2006

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

1583

2007

# bump the timeout using extended_timeout

1584

client.checked_ok(client.extended_timeout)

2008

client.bump_timeout(client.extended_timeout)

1585

2009

if self.server.use_dbus:

1586

2010

# Emit D-Bus signal

1587

2011

client.GotSecret()

1592

2016

try:

1593

2017

session.bye()

1594

2018

except gnutls.errors.GNUTLSError as error:

1595

logger.warning("GnuTLS bye failed")

2019

logger.warning("GnuTLS bye failed",

2020

exc_info=error)

1596

2021

1597

2022

@staticmethod

1598

2023

def peer_certificate(session):

1599

2024

"Return the peer's OpenPGP certificate as a bytestring"

1600

2025

# If not an OpenPGP certificate...

1601

if (gnutls.library.functions

1602

.gnutls_certificate_type_get(session._c_object)

2026

if (gnutls.library.functions.gnutls_certificate_type_get(

2027

session._c_object)

1603

2028

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1604

2029

# ...do the normal thing

1605

2030

return session.peer_certificate

1619

2044

def fingerprint(openpgp):

1620

2045

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1621

2046

# New GnuTLS "datum" with the OpenPGP public key

1622

datum = (gnutls.library.types

1623

.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),

1624

ctypes.POINTER

1625

(ctypes.c_ubyte)),

1626

ctypes.c_uint(len(openpgp))))

2047

datum = gnutls.library.types.gnutls_datum_t(

2048

ctypes.cast(ctypes.c_char_p(openpgp),

2049

ctypes.POINTER(ctypes.c_ubyte)),

2050

ctypes.c_uint(len(openpgp)))

1627

2051

# New empty GnuTLS certificate

1628

2052

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1629

(gnutls.library.functions

1630

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2053

gnutls.library.functions.gnutls_openpgp_crt_init(

2054

ctypes.byref(crt))

1631

2055

# Import the OpenPGP public key into the certificate

1632

(gnutls.library.functions

1633

.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),

1634

gnutls.library.constants

1635

.GNUTLS_OPENPGP_FMT_RAW))

2056

gnutls.library.functions.gnutls_openpgp_crt_import(

2057

crt, ctypes.byref(datum),

2058

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1636

2059

# Verify the self signature in the key

1637

2060

crtverify = ctypes.c_uint()

1638

(gnutls.library.functions

1639

.gnutls_openpgp_crt_verify_self(crt, 0,

1640

ctypes.byref(crtverify)))

2061

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2062

crt, 0, ctypes.byref(crtverify))

1641

2063

if crtverify.value != 0:

1642

2064

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1643

raise (gnutls.errors.CertificateSecurityError

1644

("Verify failed"))

2065

raise gnutls.errors.CertificateSecurityError(

2066

"Verify failed")

1645

2067

# New buffer for the fingerprint

1646

2068

buf = ctypes.create_string_buffer(20)

1647

2069

buf_len = ctypes.c_size_t()

1648

2070

# Get the fingerprint from the certificate into the buffer

1649

(gnutls.library.functions

1650

.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),

1651

ctypes.byref(buf_len)))

2071

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2072

crt, ctypes.byref(buf), ctypes.byref(buf_len))

1652

2073

# Deinit the certificate

1653

2074

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1654

2075

# Convert the buffer to a Python bytestring

1660

2081

1661

2082

class MultiprocessingMixIn(object):

1662

2083

"""Like socketserver.ThreadingMixIn, but with multiprocessing"""

2084

1663

2085

def sub_process_main(self, request, address):

1664

2086

try:

1665

2087

self.finish_request(request, address)

1666

except:

2088

except Exception:

1667

2089

self.handle_error(request, address)

1668

2090

self.close_request(request)

1669

2091

1670

2092

def process_request(self, request, address):

1671

2093

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

1672

2094

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

1673

args = (request,

1674

address))

2095

args = (request, address))

1675

2096

proc.start()

1676

2097

return proc

1677

2098

1678

2099

1679

2100

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1680

2101

""" adds a pipe to the MixIn """

2102

1681

2103

def process_request(self, request, client_address):

1682

2104

"""Overrides and wraps the original process_request().

1683

2105

1692

2114

1693

2115

def add_pipe(self, parent_pipe, proc):

1694

2116

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

1695

raise NotImplementedError

2117

raise NotImplementedError()

1696

2118

1697

2119

1698

2120

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1704

2126

interface: None or a network interface name (string)

1705

2127

use_ipv6: Boolean; to use IPv6 or not

1706

2128

"""

2129

1707

2130

def __init__(self, server_address, RequestHandlerClass,

1708

interface=None, use_ipv6=True):

2131

interface=None,

2132

use_ipv6=True,

2133

socketfd=None):

2134

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

2135

creating a new one with socket.socket().

2136

"""

1709

2137

self.interface = interface

1710

2138

if use_ipv6:

1711

2139

self.address_family = socket.AF_INET6

2140

if socketfd is not None:

2141

# Save the file descriptor

2142

self.socketfd = socketfd

2143

# Save the original socket.socket() function

2144

self.socket_socket = socket.socket

2145

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

2146

#

2147

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

2148

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

2149

# patching socket.socket.)

2150

#

2151

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

2152

@functools.wraps(socket.socket)

2153

def socket_wrapper(*args, **kwargs):

2154

# Restore original function so subsequent calls are

2155

# not affected.

2156

socket.socket = self.socket_socket

2157

del self.socket_socket

2158

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

2159

# saved file descriptor.

2160

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

2161

# Replace socket.socket() function with wrapper

2162

socket.socket = socket_wrapper

2163

# The socketserver.TCPServer.__init__ will call

2164

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

2165

# socket_wrapper(), if socketfd was set.

1712

2166

socketserver.TCPServer.__init__(self, server_address,

1713

2167

RequestHandlerClass)

2168

1714

2169

def server_bind(self):

1715

2170

"""This overrides the normal server_bind() function

1716

2171

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

1722

2177

self.interface)

1723

2178

else:

1724

2179

try:

1725

self.socket.setsockopt(socket.SOL_SOCKET,

1726

SO_BINDTODEVICE,

1727

str(self.interface

1728

+ '\0'))

2180

self.socket.setsockopt(

2181

socket.SOL_SOCKET, SO_BINDTODEVICE,

2182

(self.interface + "\0").encode("utf-8"))

1729

2183

except socket.error as error:

1730

if error[0] == errno.EPERM:

1731

logger.error("No permission to"

1732

" bind to interface %s",

1733

self.interface)

1734

elif error[0] == errno.ENOPROTOOPT:

2184

if error.errno == errno.EPERM:

2185

logger.error("No permission to bind to"

2186

" interface %s", self.interface)

2187

elif error.errno == errno.ENOPROTOOPT:

1735

2188

logger.error("SO_BINDTODEVICE not available;"

1736

2189

" cannot bind to interface %s",

1737

2190

self.interface)

2191

elif error.errno == errno.ENODEV:

2192

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

2193

" cannot bind", self.interface)

1738

2194

else:

1739

2195

raise

1740

2196

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

1743

2199

if self.address_family == socket.AF_INET6:

1744

2200

any_address = "::" # in6addr_any

1745

2201

else:

1746

any_address = socket.INADDR_ANY

2202

any_address = "0.0.0.0" # INADDR_ANY

1747

2203

self.server_address = (any_address,

1748

2204

self.server_address[1])

1749

2205

elif not self.server_address[1]:

1750

self.server_address = (self.server_address[0],

1751

0)

2206

self.server_address = (self.server_address[0], 0)

1752

2207

# if self.interface:

1753

2208

# self.server_address = (self.server_address[0],

1754

2209

# 0, # port

1768

2223

1769

2224

Assumes a gobject.MainLoop event loop.

1770

2225

"""

2226

1771

2227

def __init__(self, server_address, RequestHandlerClass,

1772

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

1773

gnutls_priority=None, use_dbus=True):

2228

interface=None,

2229

use_ipv6=True,

2230

clients=None,

2231

gnutls_priority=None,

2232

use_dbus=True,

2233

socketfd=None):

1774

2234

self.enabled = False

1775

2235

self.clients = clients

1776

2236

if self.clients is None:

1780

2240

IPv6_TCPServer.__init__(self, server_address,

1781

2241

RequestHandlerClass,

1782

2242

interface = interface,

1783

use_ipv6 = use_ipv6)

2243

use_ipv6 = use_ipv6,

2244

socketfd = socketfd)

2245

1784

2246

def server_activate(self):

1785

2247

if self.enabled:

1786

2248

return socketserver.TCPServer.server_activate(self)

1790

2252

1791

2253

def add_pipe(self, parent_pipe, proc):

1792

2254

# Call "handle_ipc" for both data and EOF events

1793

gobject.io_add_watch(parent_pipe.fileno(),

1794

gobject.IO_IN | gobject.IO_HUP,

1795

functools.partial(self.handle_ipc,

1796

parent_pipe =

1797

parent_pipe,

1798

proc = proc))

2255

gobject.io_add_watch(

2256

parent_pipe.fileno(),

2257

gobject.IO_IN | gobject.IO_HUP,

2258

functools.partial(self.handle_ipc,

2259

parent_pipe = parent_pipe,

2260

proc = proc))

1799

2261

1800

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

1801

proc = None, client_object=None):

1802

condition_names = {

1803

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

1804

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

1805

# blocking).

1806

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

1807

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

1808

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

1809

# broken, usually for pipes and

1810

# sockets).

1811

}

1812

conditions_string = ' | '.join(name

1813

for cond, name in

1814

condition_names.iteritems()

1815

if cond & condition)

2262

def handle_ipc(self, source, condition,

2263

parent_pipe=None,

2264

proc = None,

2265

client_object=None):

1816

2266

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

1817

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

2267

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

1818

2268

# Wait for other process to exit

1819

2269

proc.join()

1820

2270

return False

1841

2291

parent_pipe.send(False)

1842

2292

return False

1843

2293

1844

gobject.io_add_watch(parent_pipe.fileno(),

1845

gobject.IO_IN | gobject.IO_HUP,

1846

functools.partial(self.handle_ipc,

1847

parent_pipe =

1848

parent_pipe,

1849

proc = proc,

1850

client_object =

1851

client))

2294

gobject.io_add_watch(

2295

parent_pipe.fileno(),

2296

gobject.IO_IN | gobject.IO_HUP,

2297

functools.partial(self.handle_ipc,

2298

parent_pipe = parent_pipe,

2299

proc = proc,

2300

client_object = client))

1852

2301

parent_pipe.send(True)

1853

2302

# remove the old hook in favor of the new above hook on

1854

2303

# same fileno

1860

2309

1861

2310

parent_pipe.send(('data', getattr(client_object,

1862

2311

funcname)(*args,

1863

**kwargs)))

2312

**kwargs)))

1864

2313

1865

2314

if command == 'getattr':

1866

2315

attrname = request[1]

1867

if callable(client_object.__getattribute__(attrname)):

1868

parent_pipe.send(('function',))

2316

if isinstance(client_object.__getattribute__(attrname),

2317

collections.Callable):

2318

parent_pipe.send(('function', ))

1869

2319

else:

1870

parent_pipe.send(('data', client_object

1871

.__getattribute__(attrname)))

2320

parent_pipe.send((

2321

'data', client_object.__getattribute__(attrname)))

1872

2322

1873

2323

if command == 'setattr':

1874

2324

attrname = request[1]

1878

2328

return True

1879

2329

1880

2330

2331

def rfc3339_duration_to_delta(duration):

2332

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

2333

2334

>>> rfc3339_duration_to_delta("P7D")

2335

datetime.timedelta(7)

2336

>>> rfc3339_duration_to_delta("PT60S")

2337

datetime.timedelta(0, 60)

2338

>>> rfc3339_duration_to_delta("PT60M")

2339

datetime.timedelta(0, 3600)

2340

>>> rfc3339_duration_to_delta("PT24H")

2341

datetime.timedelta(1)

2342

>>> rfc3339_duration_to_delta("P1W")

2343

datetime.timedelta(7)

2344

>>> rfc3339_duration_to_delta("PT5M30S")

2345

datetime.timedelta(0, 330)

2346

>>> rfc3339_duration_to_delta("P1DT3M20S")

2347

datetime.timedelta(1, 200)

2348

"""

2349

2350

# Parsing an RFC 3339 duration with regular expressions is not

2351

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

2352

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

2353

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

2354

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

2355

# avoid excessive use of external libraries.

2356

2357

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

2358

Token = collections.namedtuple("Token", (

2359

"regexp", # To match token; if "value" is not None, must have

2360

# a "group" containing digits

2361

"value", # datetime.timedelta or None

2362

"followers")) # Tokens valid after this token

2363

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

2364

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

2365

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

2366

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

2367

datetime.timedelta(seconds=1),

2368

frozenset((token_end, )))

2369

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

2370

datetime.timedelta(minutes=1),

2371

frozenset((token_second, token_end)))

2372

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

2373

datetime.timedelta(hours=1),

2374

frozenset((token_minute, token_end)))

2375

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

2376

None,

2377

frozenset((token_hour, token_minute,

2378

token_second)))

2379

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

2380

datetime.timedelta(days=1),

2381

frozenset((token_time, token_end)))

2382

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

2383

datetime.timedelta(weeks=4),

2384

frozenset((token_day, token_end)))

2385

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

2386

datetime.timedelta(weeks=52),

2387

frozenset((token_month, token_end)))

2388

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

2389

datetime.timedelta(weeks=1),

2390

frozenset((token_end, )))

2391

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

2392

frozenset((token_year, token_month,

2393

token_day, token_time,

2394

token_week)))

2395

# Define starting values

2396

value = datetime.timedelta() # Value so far

2397

found_token = None

2398

followers = frozenset((token_duration, )) # Following valid tokens

2399

s = duration # String left to parse

2400

# Loop until end token is found

2401

while found_token is not token_end:

2402

# Search for any currently valid tokens

2403

for token in followers:

2404

match = token.regexp.match(s)

2405

if match is not None:

2406

# Token found

2407

if token.value is not None:

2408

# Value found, parse digits

2409

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

2410

# Add to value so far

2411

value += factor * token.value

2412

# Strip token from string

2413

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

2414

# Go to found token

2415

found_token = token

2416

# Set valid next tokens

2417

followers = found_token.followers

2418

break

2419

else:

2420

# No currently valid tokens were found

2421

raise ValueError("Invalid RFC 3339 duration: {!r}"

2422

.format(duration))

2423

# End token found

2424

return value

2425

2426

1881

2427

def string_to_delta(interval):

1882

2428

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

1883

2429

1894

2440

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

1895

2441

datetime.timedelta(0, 330)

1896

2442

"""

2443

2444

try:

2445

return rfc3339_duration_to_delta(interval)

2446

except ValueError:

2447

pass

2448

1897

2449

timevalue = datetime.timedelta(0)

1898

2450

for s in interval.split():

1899

2451

try:

1900

suffix = unicode(s[-1])

2452

suffix = s[-1]

1901

2453

value = int(s[:-1])

1902

2454

if suffix == "d":

1903

2455

delta = datetime.timedelta(value)

1910

2462

elif suffix == "w":

1911

2463

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

1912

2464

else:

1913

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

1914

except (ValueError, IndexError) as e:

2465

raise ValueError("Unknown suffix {!r}".format(suffix))

2466

except IndexError as e:

1915

2467

raise ValueError(*(e.args))

1916

2468

timevalue += delta

1917

2469

return timevalue

1930

2482

sys.exit()

1931

2483

if not noclose:

1932

2484

# Close all standard open file descriptors

1933

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

2485

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

1934

2486

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

1935

2487

raise OSError(errno.ENODEV,

1936

"%s not a character device"

1937

% os.path.devnull)

2488

"{} not a character device"

2489

.format(os.devnull))

1938

2490

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

1939

2491

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

1940

2492

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

1949

2501

1950

2502

parser = argparse.ArgumentParser()

1951

2503

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

1952

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

2504

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

1953

2505

help="show version number and exit")

1954

2506

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

1955

2507

help="Bind to interface IF")

1961

2513

help="Run self-test")

1962

2514

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

1963

2515

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

1964

" to terminal")

2516

" to terminal", default=None)

1965

2517

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

1966

2518

help="Debug level for stdout output")

1967

2519

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

1974

2526

" files")

1975

2527

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

1976

2528

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

1977

" system bus interface")

2529

" system bus interface", default=None)

1978

2530

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

1979

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

2531

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

2532

default=None)

1980

2533

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

1981

2534

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

1982

" state")

2535

" state", default=None)

2536

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

2537

help="Specify a file descriptor to a network"

2538

" socket to use instead of creating one")

1983

2539

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

1984

2540

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

2541

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

2542

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

2543

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

2544

dest="zeroconf", help="Do not use Zeroconf",

2545

default=None)

1985

2546

1986

2547

options = parser.parse_args()

1987

2548

1988

2549

if options.check:

1989

2550

import doctest

1990

doctest.testmod()

1991

sys.exit()

2551

fail_count, test_count = doctest.testmod()

2552

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

1992

2553

1993

2554

# Default values for config file for server-global settings

1994

2555

server_defaults = { "interface": "",

1996

2557

"port": "",

1997

2558

"debug": "False",

1998

2559

"priority":

1999

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

2560

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

2561

":+SIGN-DSA-SHA256",

2000

2562

"servicename": "Mandos",

2001

2563

"use_dbus": "True",

2002

2564

"use_ipv6": "True",

2003

2565

"debuglevel": "",

2004

2566

"restore": "True",

2005

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

2006

}

2567

"socket": "",

2568

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

2569

"foreground": "False",

2570

"zeroconf": "True",

2571

}

2007

2572

2008

2573

# Parse config file for server-global settings

2009

2574

server_config = configparser.SafeConfigParser(server_defaults)

2010

2575

del server_defaults

2011

server_config.read(os.path.join(options.configdir,

2012

"mandos.conf"))

2576

server_config.read(os.path.join(options.configdir, "mandos.conf"))

2013

2577

# Convert the SafeConfigParser object to a dict

2014

2578

server_settings = server_config.defaults()

2015

2579

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

2016

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

2580

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

2017

2581

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

2018

2582

option)

2019

2583

if server_settings["port"]:

2020

2584

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

2021

2585

"port")

2586

if server_settings["socket"]:

2587

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

2588

"socket")

2589

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

2590

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

2591

# happen with a supplied network socket.

2592

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

2593

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

2594

["socket"])

2022

2595

del server_config

2023

2596

2024

2597

# Override the settings from the config file with command line

2025

2598

# options, if set.

2026

2599

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

2027

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

2028

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

2029

"statedir"):

2600

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

2601

"use_ipv6", "debuglevel", "restore", "statedir",

2602

"socket", "foreground", "zeroconf"):

2030

2603

value = getattr(options, option)

2031

2604

if value is not None:

2032

2605

server_settings[option] = value

2033

2606

del options

2034

2607

# Force all strings to be unicode

2035

2608

for option in server_settings.keys():

2036

if type(server_settings[option]) is str:

2037

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

2609

if isinstance(server_settings[option], bytes):

2610

server_settings[option] = (server_settings[option]

2611

.decode("utf-8"))

2612

# Force all boolean options to be boolean

2613

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

2614

"foreground", "zeroconf"):

2615

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

2616

# Debug implies foreground

2617

if server_settings["debug"]:

2618

server_settings["foreground"] = True

2038

2619

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

2039

2620

2040

2621

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

2041

2622

2623

if (not server_settings["zeroconf"]

2624

and not (server_settings["port"]

2625

or server_settings["socket"] != "")):

2626

parser.error("Needs port or socket to work without Zeroconf")

2627

2042

2628

# For convenience

2043

2629

debug = server_settings["debug"]

2044

2630

debuglevel = server_settings["debuglevel"]

2046

2632

use_ipv6 = server_settings["use_ipv6"]

2047

2633

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

2048

2634

stored_state_file)

2635

foreground = server_settings["foreground"]

2636

zeroconf = server_settings["zeroconf"]

2049

2637

2050

2638

if debug:

2051

initlogger(logging.DEBUG)

2639

initlogger(debug, logging.DEBUG)

2052

2640

else:

2053

2641

if not debuglevel:

2054

initlogger()

2642

initlogger(debug)

2055

2643

else:

2056

2644

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

2057

initlogger(level)

2645

initlogger(debug, level)

2058

2646

2059

2647

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

2060

syslogger.setFormatter(logging.Formatter

2061

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

2062

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

2063

% server_settings["servicename"]))

2648

syslogger.setFormatter(

2649

logging.Formatter('Mandos ({}) [%(process)d]:'

2650

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

2651

server_settings["servicename"])))

2064

2652

2065

2653

# Parse config file with clients

2066

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

2067

"extended_timeout": "15m",

2068

"interval": "2m",

2069

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

2070

"host": "",

2071

"approval_delay": "0s",

2072

"approval_duration": "1s",

2073

}

2074

client_config = configparser.SafeConfigParser(client_defaults)

2654

client_config = configparser.SafeConfigParser(Client

2655

.client_defaults)

2075

2656

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

2076

2657

"clients.conf"))

2077

2658

2078

2659

global mandos_dbus_service

2079

2660

mandos_dbus_service = None

2080

2661

2081

tcp_server = MandosServer((server_settings["address"],

2082

server_settings["port"]),

2083

ClientHandler,

2084

interface=(server_settings["interface"]

2085

or None),

2086

use_ipv6=use_ipv6,

2087

gnutls_priority=

2088

server_settings["priority"],

2089

use_dbus=use_dbus)

2090

if not debug:

2091

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

2662

socketfd = None

2663

if server_settings["socket"] != "":

2664

socketfd = server_settings["socket"]

2665

tcp_server = MandosServer(

2666

(server_settings["address"], server_settings["port"]),

2667

ClientHandler,

2668

interface=(server_settings["interface"] or None),

2669

use_ipv6=use_ipv6,

2670

gnutls_priority=server_settings["priority"],

2671

use_dbus=use_dbus,

2672

socketfd=socketfd)

2673

if not foreground:

2674

pidfilename = "/run/mandos.pid"

2675

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

2676

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

2677

pidfile = None

2092

2678

try:

2093

pidfile = open(pidfilename, "w")

2094

except IOError:

2095

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

2679

pidfile = codecs.open(pidfilename, "w", encoding="utf-8")

2680

except IOError as e:

2681

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

2682

exc_info=e)

2096

2683

2097

try:

2098

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

2099

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

2100

except KeyError:

2684

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

2101

2685

try:

2102

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

2103

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

2686

uid = pwd.getpwnam(name).pw_uid

2687

gid = pwd.getpwnam(name).pw_gid

2688

break

2104

2689

except KeyError:

2105

try:

2106

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

2107

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

2108

except KeyError:

2109

uid = 65534

2110

gid = 65534

2690

continue

2691

else:

2692

uid = 65534

2693

gid = 65534

2111

2694

try:

2112

2695

os.setgid(gid)

2113

2696

os.setuid(uid)

2114

2697

except OSError as error:

2115

if error[0] != errno.EPERM:

2116

raise error

2698

if error.errno != errno.EPERM:

2699

raise

2117

2700

2118

2701

if debug:

2119

2702

# Enable all possible GnuTLS debugging

2126

2709

def debug_gnutls(level, string):

2127

2710

logger.debug("GnuTLS: %s", string[:-1])

2128

2711

2129

(gnutls.library.functions

2130

.gnutls_global_set_log_function(debug_gnutls))

2712

gnutls.library.functions.gnutls_global_set_log_function(

2713

debug_gnutls)

2131

2714

2132

2715

# Redirect stdin so all checkers get /dev/null

2133

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

2716

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

2134

2717

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

2135

2718

if null > 2:

2136

2719

os.close(null)

2137

else:

2138

# No console logging

2139

logger.removeHandler(console)

2140

2720

2141

2721

# Need to fork before connecting to D-Bus

2142

if not debug:

2722

if not foreground:

2143

2723

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

2144

2724

daemon()

2145

2725

2726

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

2727

# need to inform gobject that threads will be used.

2728

gobject.threads_init()

2729

2146

2730

global main_loop

2147

2731

# From the Avahi example code

2148

DBusGMainLoop(set_as_default=True )

2732

DBusGMainLoop(set_as_default=True)

2149

2733

main_loop = gobject.MainLoop()

2150

2734

bus = dbus.SystemBus()

2151

2735

# End of Avahi example code

2152

2736

if use_dbus:

2153

2737

try:

2154

2738

bus_name = dbus.service.BusName("se.recompile.Mandos",

2155

bus, do_not_queue=True)

2156

old_bus_name = (dbus.service.BusName

2157

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

2158

do_not_queue=True))

2159

except dbus.exceptions.NameExistsException as e:

2160

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

2739

bus,

2740

do_not_queue=True)

2741

old_bus_name = dbus.service.BusName(

2742

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

2743

do_not_queue=True)

2744

except dbus.exceptions.DBusException as e:

2745

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

2161

2746

use_dbus = False

2162

2747

server_settings["use_dbus"] = False

2163

2748

tcp_server.use_dbus = False

2164

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2165

service = AvahiServiceToSyslog(name =

2166

server_settings["servicename"],

2167

servicetype = "_mandos._tcp",

2168

protocol = protocol, bus = bus)

2169

if server_settings["interface"]:

2170

service.interface = (if_nametoindex

2171

(str(server_settings["interface"])))

2749

if zeroconf:

2750

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2751

service = AvahiServiceToSyslog(

2752

name = server_settings["servicename"],

2753

servicetype = "_mandos._tcp",

2754

protocol = protocol,

2755

bus = bus)

2756

if server_settings["interface"]:

2757

service.interface = if_nametoindex(

2758

server_settings["interface"].encode("utf-8"))

2172

2759

2173

2760

global multiprocessing_manager

2174

2761

multiprocessing_manager = multiprocessing.Manager()

2175

2762

2176

2763

client_class = Client

2177

2764

if use_dbus:

2178

client_class = functools.partial(ClientDBusTransitional,

2179

bus = bus)

2180

2181

special_settings = {

2182

# Some settings need to be accessd by special methods;

2183

# booleans need .getboolean(), etc. Here is a list of them:

2184

"approved_by_default":

2185

lambda section:

2186

client_config.getboolean(section, "approved_by_default"),

2187

"enabled":

2188

lambda section:

2189

client_config.getboolean(section, "enabled"),

2190

}

2191

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

2192

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

2193

# with exceptions for any special settings as defined above

2194

client_settings = dict((clientname,

2195

dict((setting,

2196

(value

2197

if setting not in special_settings

2198

else special_settings[setting]

2199

(clientname)))

2200

for setting, value in

2201

client_config.items(clientname)))

2202

for clientname in client_config.sections())

2203

2765

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

2766

2767

client_settings = Client.config_parser(client_config)

2204

2768

old_client_settings = {}

2205

clients_data = []

2769

clients_data = {}

2770

2771

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

2772

global wnull

2773

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

2774

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

2775

# mode

2776

if debug or not foreground:

2777

wnull.close()

2206

2778

2207

2779

# Get client data and settings from last running state.

2208

2780

if server_settings["restore"]:

2209

2781

try:

2210

2782

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

2211

clients_data, old_client_settings = (pickle.load

2212

(stored_state))

2783

clients_data, old_client_settings = pickle.load(

2784

stored_state)

2213

2785

os.remove(stored_state_path)

2214

2786

except IOError as e:

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

2787

if e.errno == errno.ENOENT:

2788

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

2789

" {}".format(os.strerror(e.errno)))

2790

else:

2791

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

2792

exc_info=e)

2218

2793

raise

2794

except EOFError as e:

2795

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

2796

"EOFError:",

2797

exc_info=e)

2219

2798

2220

with Crypto() as crypt:

2221

for client in clients_data:

2222

client_name = client["name"]

2799

with PGPEngine() as pgp:

2800

for client_name, client in clients_data.items():

2801

# Skip removed clients

2802

if client_name not in client_settings:

2803

continue

2223

2804

2224

2805

# Decide which value to use after restoring saved state.

2225

2806

# We have three different values: Old config file,

2231

2812

# For each value in new config, check if it

2232

2813

# differs from the old config value (Except for

2233

2814

# the "secret" attribute)

2234

if (name != "secret" and

2235

value != old_client_settings[client_name]

2236

[name]):

2237

setattr(client, name, value)

2815

if (name != "secret"

2816

and (value !=

2817

old_client_settings[client_name][name])):

2818

client[name] = value

2238

2819

except KeyError:

2239

2820

pass

2240

2821

2241

2822

# Clients who has passed its expire date can still be

2242

# enabled if its last checker was sucessful. Clients

2243

# whose checker failed before we stored its state is

2244

# assumed to have failed all checkers during downtime.

2245

if client["enabled"] and client["last_checked_ok"]:

2246

if ((datetime.datetime.utcnow()

2247

- client["last_checked_ok"])

2248

> client["interval"]):

2249

if client["last_checker_status"] != 0:

2823

# enabled if its last checker was successful. A Client

2824

# whose checker succeeded before we stored its state is

2825

# assumed to have successfully run all checkers during

2826

# downtime.

2827

if client["enabled"]:

2828

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

2829

if not client["last_checked_ok"]:

2830

logger.warning(

2831

"disabling client {} - Client never "

2832

"performed a successful checker".format(

2833

client_name))

2834

client["enabled"] = False

2835

elif client["last_checker_status"] != 0:

2836

logger.warning(

2837

"disabling client {} - Client last"

2838

" checker failed with error code"

2839

" {}".format(

2840

client_name,

2841

client["last_checker_status"]))

2250

2842

client["enabled"] = False

2251

2843

else:

2252

client["expires"] = (datetime.datetime

2253

.utcnow()

2254

+ client["timeout"])

2255

2256

client["changedstate"] = (multiprocessing_manager

2257

.Condition

2258

(multiprocessing_manager

2259

.Lock()))

2260

if use_dbus:

2261

new_client = (ClientDBusTransitional.__new__

2262

(ClientDBusTransitional))

2263

tcp_server.clients[client_name] = new_client

2264

new_client.bus = bus

2265

for name, value in client.iteritems():

2266

setattr(new_client, name, value)

2267

client_object_name = unicode(client_name).translate(

2268

{ord("."): ord("_"),

2269

ord("-"): ord("_")})

2270

new_client.dbus_object_path = (dbus.ObjectPath

2271

("/clients/"

2272

+ client_object_name))

2273

DBusObjectWithProperties.__init__(new_client,

2274

new_client.bus,

2275

new_client

2276

.dbus_object_path)

2277

else:

2278

tcp_server.clients[client_name] = (Client.__new__

2279

(Client))

2280

for name, value in client.iteritems():

2281

setattr(tcp_server.clients[client_name],

2282

name, value)

2283

2844

client["expires"] = (

2845

datetime.datetime.utcnow()

2846

+ client["timeout"])

2847

logger.debug("Last checker succeeded,"

2848

" keeping {} enabled".format(

2849

client_name))

2284

2850

try:

2285

tcp_server.clients[client_name].secret = (

2286

crypt.decrypt(tcp_server.clients[client_name]

2287

.encrypted_secret,

2288

client_settings[client_name]

2289

["secret"]))

2290

except CryptoError:

2851

client["secret"] = pgp.decrypt(

2852

client["encrypted_secret"],

2853

client_settings[client_name]["secret"])

2854

except PGPError:

2291

2855

# If decryption fails, we use secret from new settings

2292

tcp_server.clients[client_name].secret = (

2293

client_settings[client_name]["secret"])

2294

2295

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

2296

for clientname in set(old_client_settings) - set(client_settings):

2297

del tcp_server.clients[clientname]

2298

for clientname in set(client_settings) - set(old_client_settings):

2299

tcp_server.clients[clientname] = (client_class(name

2300

= clientname,

2301

config =

2302

client_settings

2303

[clientname]))

2856

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

2857

client_name))

2858

client["secret"] = (client_settings[client_name]

2859

["secret"])

2860

2861

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

2862

for client_name in (set(old_client_settings)

2863

- set(client_settings)):

2864

del clients_data[client_name]

2865

for client_name in (set(client_settings)

2866

- set(old_client_settings)):

2867

clients_data[client_name] = client_settings[client_name]

2868

2869

# Create all client objects

2870

for client_name, client in clients_data.items():

2871

tcp_server.clients[client_name] = client_class(

2872

name = client_name,

2873

settings = client,

2874

server_settings = server_settings)

2304

2875

2305

2876

if not tcp_server.clients:

2306

2877

logger.warning("No clients defined")

2307

2308

if not debug:

2309

try:

2310

with pidfile:

2311

pid = os.getpid()

2312

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

2313

del pidfile

2314

except IOError:

2315

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

2316

pidfilename, pid)

2317

except NameError:

2318

# "pidfile" was never created

2319

pass

2878

2879

if not foreground:

2880

if pidfile is not None:

2881

pid = os.getpid()

2882

try:

2883

with pidfile:

2884

print(pid, file=pidfile)

2885

except IOError:

2886

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

2887

pidfilename, pid)

2888

del pidfile

2320

2889

del pidfilename

2321

2322

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

2323

2890

2324

2891

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

2325

2892

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

2326

2893

2327

2894

if use_dbus:

2328

class MandosDBusService(dbus.service.Object):

2895

2896

@alternate_dbus_interfaces(

2897

{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })

2898

class MandosDBusService(DBusObjectWithObjectManager):

2329

2899

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

2900

2330

2901

def __init__(self):

2331

2902

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

2903

2332

2904

_interface = "se.recompile.Mandos"

2333

2905

2334

2906

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

2341

2913

"D-Bus signal"

2342

2914

pass

2343

2915

2916

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

2917

"true"})

2344

2918

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

2345

2919

def ClientRemoved(self, objpath, name):

2346

2920

"D-Bus signal"

2347

2921

pass

2348

2922

2923

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

2924

"true"})

2349

2925

@dbus.service.method(_interface, out_signature="ao")

2350

2926

def GetAllClients(self):

2351

2927

"D-Bus method"

2352

return dbus.Array(c.dbus_object_path

2353

for c in

2928

return dbus.Array(c.dbus_object_path for c in

2354

2929

tcp_server.clients.itervalues())

2355

2930

2931

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

2932

"true"})

2356

2933

@dbus.service.method(_interface,

2357

2934

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

2358

2935

def GetAllClientsWithProperties(self):

2359

2936

"D-Bus method"

2360

2937

return dbus.Dictionary(

2361

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

2362

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

2938

{ c.dbus_object_path: c.GetAll(

2939

"se.recompile.Mandos.Client")

2940

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

2363

2941

signature="oa{sv}")

2364

2942

2365

2943

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

2369

2947

if c.dbus_object_path == object_path:

2370

2948

del tcp_server.clients[c.name]

2371

2949

c.remove_from_connection()

2372

# Don't signal anything except ClientRemoved

2950

# Don't signal the disabling

2373

2951

c.disable(quiet=True)

2374

# Emit D-Bus signal

2375

self.ClientRemoved(object_path, c.name)

2952

# Emit D-Bus signal for removal

2953

self.client_removed_signal(c)

2376

2954

return

2377

2955

raise KeyError(object_path)

2378

2956

2379

2957

del _interface

2958

2959

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

2960

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

2961

def GetManagedObjects(self):

2962

"""D-Bus method"""

2963

return dbus.Dictionary(

2964

{ client.dbus_object_path:

2965

dbus.Dictionary(

2966

{ interface: client.GetAll(interface)

2967

for interface in

2968

client._get_all_interface_names()})

2969

for client in tcp_server.clients.values()})

2970

2971

def client_added_signal(self, client):

2972

"""Send the new standard signal and the old signal"""

2973

if use_dbus:

2974

# New standard signal

2975

self.InterfacesAdded(

2976

client.dbus_object_path,

2977

dbus.Dictionary(

2978

{ interface: client.GetAll(interface)

2979

for interface in

2980

client._get_all_interface_names()}))

2981

# Old signal

2982

self.ClientAdded(client.dbus_object_path)

2983

2984

def client_removed_signal(self, client):

2985

"""Send the new standard signal and the old signal"""

2986

if use_dbus:

2987

# New standard signal

2988

self.InterfacesRemoved(

2989

client.dbus_object_path,

2990

client._get_all_interface_names())

2991

# Old signal

2992

self.ClientRemoved(client.dbus_object_path,

2993

client.name)

2380

2994

2381

class MandosDBusServiceTransitional(MandosDBusService):

2382

__metaclass__ = AlternateDBusNamesMetaclass

2383

mandos_dbus_service = MandosDBusServiceTransitional()

2995

mandos_dbus_service = MandosDBusService()

2384

2996

2385

2997

def cleanup():

2386

2998

"Cleanup function; run on exit"

2387

service.cleanup()

2999

if zeroconf:

3000

service.cleanup()

2388

3001

2389

3002

multiprocessing.active_children()

3003

wnull.close()

2390

3004

if not (tcp_server.clients or client_settings):

2391

3005

return

2392

3006

2393

3007

# Store client before exiting. Secrets are encrypted with key

2394

3008

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

2395

3009

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

2396

clients = []

2397

with Crypto() as crypt:

3010

clients = {}

3011

with PGPEngine() as pgp:

2398

3012

for client in tcp_server.clients.itervalues():

2399

3013

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

2400

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

2401

key)

3014

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

3015

key)

2402

3016

client_dict = {}

2403

3017

2404

# A list of attributes that will not be stored when

2405

# shutting down.

2406

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

2407

for name, typ in (inspect.getmembers

2408

(dbus.service.Object)):

3018

# A list of attributes that can not be pickled

3019

# + secret.

3020

exclude = { "bus", "changedstate", "secret",

3021

"checker", "server_settings" }

3022

for name, typ in inspect.getmembers(dbus.service

3023

.Object):

2409

3024

exclude.add(name)

2410

3025

2411

3026

client_dict["encrypted_secret"] = (client

2414

3029

if attr not in exclude:

2415

3030

client_dict[attr] = getattr(client, attr)

2416

3031

2417

clients.append(client_dict)

3032

clients[client.name] = client_dict

2418

3033

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

2419

3034

2420

3035

try:

2421

with os.fdopen(os.open(stored_state_path,

2422

os.O_CREAT|os.O_WRONLY|os.O_TRUNC,

2423

0600), "wb") as stored_state:

3036

with tempfile.NamedTemporaryFile(

3037

mode='wb',

3038

suffix=".pickle",

3039

prefix='clients-',

3040

dir=os.path.dirname(stored_state_path),

3041

delete=False) as stored_state:

2424

3042

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

3043

tempname = stored_state.name

3044

os.rename(tempname, stored_state_path)

2425

3045

except (IOError, OSError) as e:

2426

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

2427

.format(e))

2428

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

3046

if not debug:

3047

try:

3048

os.remove(tempname)

3049

except NameError:

3050

pass

3051

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

3052

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

3053

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

3054

else:

3055

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

3056

exc_info=e)

2429

3057

raise

2430

3058

2431

3059

# Delete all clients, and settings from config

2433

3061

name, client = tcp_server.clients.popitem()

2434

3062

if use_dbus:

2435

3063

client.remove_from_connection()

2436

# Don't signal anything except ClientRemoved

3064

# Don't signal the disabling

2437

3065

client.disable(quiet=True)

2438

if use_dbus:

2439

# Emit D-Bus signal

2440

mandos_dbus_service.ClientRemoved(client

2441

.dbus_object_path,

2442

client.name)

3066

# Emit D-Bus signal for removal

3067

mandos_dbus_service.client_removed_signal(client)

2443

3068

client_settings.clear()

2444

3069

2445

3070

atexit.register(cleanup)

2446

3071

2447

3072

for client in tcp_server.clients.itervalues():

2448

3073

if use_dbus:

2449

# Emit D-Bus signal

2450

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3074

# Emit D-Bus signal for adding

3075

mandos_dbus_service.client_added_signal(client)

2451

3076

# Need to initiate checking of clients

2452

3077

if client.enabled:

2453

3078

client.init_checker()

2456

3081

tcp_server.server_activate()

2457

3082

2458

3083

# Find out what port we got

2459

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

3084

if zeroconf:

3085

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

2460

3086

if use_ipv6:

2461

3087

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

2462

" flowinfo %d, scope_id %d"

2463

% tcp_server.socket.getsockname())

3088

" flowinfo %d, scope_id %d",

3089

*tcp_server.socket.getsockname())

2464

3090

else: # IPv4

2465

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

2466

% tcp_server.socket.getsockname())

3091

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

3092

*tcp_server.socket.getsockname())

2467

3093

2468

3094

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

2469

3095

2470

3096

try:

2471

# From the Avahi example code

2472

try:

2473

service.activate()

2474

except dbus.exceptions.DBusException as error:

2475

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

2476

cleanup()

2477

sys.exit(1)

2478

# End of Avahi example code

3097

if zeroconf:

3098

# From the Avahi example code

3099

try:

3100

service.activate()

3101

except dbus.exceptions.DBusException as error:

3102

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

3103

cleanup()

3104

sys.exit(1)

3105

# End of Avahi example code

2479

3106

2480

3107

gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,

2481

3108

lambda *args, **kwargs:

2485

3112

logger.debug("Starting main loop")

2486

3113

main_loop.run()

2487

3114

except AvahiError as error:

2488

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

3115

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

2489

3116

cleanup()

2490

3117

sys.exit(1)

2491

3118

except KeyboardInterrupt: