/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

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

31

# Contact the authors at <mandos@fukt.bsnet.se>.

31

# Contact the authors at <mandos@recompile.se>.

32

#

33

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

76

import types

77

import binascii

78

import tempfile

79

import itertools

80

import collections

81

import codecs

65

82

66

83

import dbus

67

84

import dbus.service

68

import gobject

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

69

89

import avahi

70

90

from dbus.mainloop.glib import DBusGMainLoop

71

91

import ctypes

81

101

except ImportError:

82

102

SO_BINDTODEVICE = None

83

103

84

85

version = "1.3.1"

86

87

#logger = logging.getLogger('mandos')

88

logger = logging.Logger('mandos')

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

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

92

syslogger.setFormatter(logging.Formatter

93

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

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'

99

' %(levelname)s:'

100

' %(message)s'))

101

logger.addHandler(console)

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

108

stored_state_file = "clients.pickle"

109

110

logger = logging.getLogger()

111

syslogger = None

112

113

try:

114

if_nametoindex = ctypes.cdll.LoadLibrary(

115

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

116

except (OSError, AttributeError):

117

118

def if_nametoindex(interface):

119

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

120

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

121

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

122

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

123

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

124

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

125

return interface_index

126

127

128

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

129

"""init logger and add loglevel"""

130

131

global syslogger

132

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

135

syslogger.setFormatter(logging.Formatter

136

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

137

' %(message)s'))

138

logger.addHandler(syslogger)

139

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)

147

logger.setLevel(level)

148

149

150

class PGPError(Exception):

151

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

152

pass

153

154

155

class PGPEngine(object):

156

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

157

158

def __init__(self):

159

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

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

165

166

def __enter__(self):

167

return self

168

169

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

170

self._cleanup()

171

return False

172

173

def __del__(self):

174

self._cleanup()

175

176

def _cleanup(self):

177

if self.tempdir is not None:

178

# Delete contents of tempdir

179

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

180

topdown = False):

181

for filename in files:

182

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

183

for dirname in dirs:

184

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

185

# Remove tempdir

186

os.rmdir(self.tempdir)

187

self.tempdir = None

188

189

def password_encode(self, password):

190

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

191

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

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

199

200

def encrypt(self, data, password):

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)

216

return ciphertext

217

218

def decrypt(self, data, password):

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)

234

return decrypted_plaintext

235

102

236

103

237

class AvahiError(Exception):

104

238

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

105

239

self.value = value

106

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

107

def __unicode__(self):

108

return unicode(repr(self.value))

240

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

241

**kwargs)

242

109

243

110

244

class AvahiServiceError(AvahiError):

111

245

pass

112

246

247

113

248

class AvahiGroupError(AvahiError):

114

249

pass

115

250

122

257

Used to optionally bind to the specified interface.

123

258

name: string; Example: 'Mandos'

124

259

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

125

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

260

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

126

261

port: integer; what port to announce

127

262

TXT: list of strings; TXT record for the service

128

263

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

134

269

server: D-Bus Server

135

270

bus: dbus.SystemBus()

136

271

"""

137

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

138

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

139

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

140

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

141

284

self.interface = interface

142

285

self.name = name

143

286

self.type = servicetype

152

295

self.server = None

153

296

self.bus = bus

154

297

self.entry_group_state_changed_match = None

155

def rename(self):

298

299

def rename(self, remove=True):

156

300

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

157

301

if self.rename_count >= self.max_renames:

158

302

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

159

303

" after %i retries, exiting.",

160

304

self.rename_count)

161

305

raise AvahiServiceError("Too many renames")

162

self.name = unicode(self.server.GetAlternativeServiceName(self.name))

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

163

309

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

164

310

self.name)

165

syslogger.setFormatter(logging.Formatter

166

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

167

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

168

% self.name))

169

self.remove()

311

if remove:

312

self.remove()

170

313

try:

171

314

self.add()

172

315

except dbus.exceptions.DBusException as error:

173

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

174

self.cleanup()

175

os._exit(1)

176

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

177

325

def remove(self):

178

326

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

179

327

if self.entry_group_state_changed_match is not None:

181

329

self.entry_group_state_changed_match = None

182

330

if self.group is not None:

183

331

self.group.Reset()

332

184

333

def add(self):

185

334

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

186

335

self.remove()

191

340

avahi.DBUS_INTERFACE_ENTRY_GROUP)

192

341

self.entry_group_state_changed_match = (

193

342

self.group.connect_to_signal(

194

'StateChanged', self .entry_group_state_changed))

343

'StateChanged', self.entry_group_state_changed))

195

344

logger.debug("Adding Zeroconf service '%s' of type '%s' ...",

196

345

self.name, self.type)

197

346

self.group.AddService(

203

352

dbus.UInt16(self.port),

204

353

avahi.string_array_to_txt_array(self.TXT))

205

354

self.group.Commit()

355

206

356

def entry_group_state_changed(self, state, error):

207

357

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

208

358

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

214

364

self.rename()

215

365

elif state == avahi.ENTRY_GROUP_FAILURE:

216

366

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

217

unicode(error))

218

raise AvahiGroupError("State changed: %s"

219

% unicode(error))

367

str(error))

368

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

369

220

370

def cleanup(self):

221

371

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

222

372

if self.group is not None:

223

373

try:

224

374

self.group.Free()

225

375

except (dbus.exceptions.UnknownMethodException,

226

dbus.exceptions.DBusException) as e:

376

dbus.exceptions.DBusException):

227

377

pass

228

378

self.group = None

229

379

self.remove()

380

230

381

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

231

382

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

232

383

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

233

bad_states = { avahi.SERVER_INVALID:

234

"Zeroconf server invalid",

235

avahi.SERVER_REGISTERING: None,

236

avahi.SERVER_COLLISION:

237

"Zeroconf server name collision",

238

avahi.SERVER_FAILURE:

239

"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

}

240

390

if state in bad_states:

241

391

if bad_states[state] is not None:

242

392

if error is None:

245

395

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

246

396

self.cleanup()

247

397

elif state == avahi.SERVER_RUNNING:

248

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)

249

410

else:

250

411

if error is None:

251

412

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

252

413

else:

253

414

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

415

254

416

def activate(self):

255

417

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

256

418

if self.server is None:

260

422

follow_name_owner_changes=True),

261

423

avahi.DBUS_INTERFACE_SERVER)

262

424

self.server.connect_to_signal("StateChanged",

263

self.server_state_changed)

425

self.server_state_changed)

264

426

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

265

427

266

428

429

class AvahiServiceToSyslog(AvahiService):

430

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

431

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

432

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

433

syslogger.setFormatter(logging.Formatter(

434

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

435

.format(self.name)))

436

return ret

437

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

267

448

class Client(object):

268

449

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

269

450

270

451

Attributes:

271

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

452

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

272

453

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

273

454

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

274

455

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

281

462

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

282

463

checker_initiator_tag: a gobject event source tag, or None

283

464

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

465

client_structure: Object describing what attributes a client has

466

and is used for storing the client at exit

284

467

current_checker_command: string; current running checker_command

285

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

286

468

disable_initiator_tag: a gobject event source tag, or None

287

469

enabled: bool()

288

470

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

291

473

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

292

474

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

293

475

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

294

last_enabled: datetime.datetime(); (UTC)

476

last_checker_status: integer between 0 and 255 reflecting exit

477

status of last checker. -1 reflects crashed

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

481

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

295

482

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

296

483

D-Bus identifiers

297

484

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

298

485

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

299

486

until this client is disabled

300

extended_timeout: extra long timeout when password has been sent

487

extended_timeout: extra long timeout when secret has been sent

301

488

runtime_expansions: Allowed attributes for runtime expansion.

302

489

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

303

490

disabled, or None

491

server_settings: The server_settings dict from main()

304

492

"""

305

493

306

494

runtime_expansions = ("approval_delay", "approval_duration",

307

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

308

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

495

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

496

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

497

"last_approval_request", "last_checked_ok",

309

498

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

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

}

310

510

311

511

@staticmethod

312

def _timedelta_to_milliseconds(td):

313

"Convert a datetime.timedelta() to milliseconds"

314

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

315

+ (td.seconds * 1000)

316

+ (td.microseconds // 1000))

317

318

def timeout_milliseconds(self):

319

"Return the 'timeout' attribute in milliseconds"

320

return self._timedelta_to_milliseconds(self.timeout)

321

322

def extended_timeout_milliseconds(self):

323

"Return the 'extended_timeout' attribute in milliseconds"

324

return self._timedelta_to_milliseconds(self.extended_timeout)

325

326

def interval_milliseconds(self):

327

"Return the 'interval' attribute in milliseconds"

328

return self._timedelta_to_milliseconds(self.interval)

329

330

def approval_delay_milliseconds(self):

331

return self._timedelta_to_milliseconds(self.approval_delay)

332

333

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

334

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

335

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

336

attribute."""

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

337

562

self.name = name

338

if config is None:

339

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

340

580

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

341

# Uppercase and remove spaces from fingerprint for later

342

# comparison purposes with return value from the fingerprint()

343

# function

344

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

345

.replace(" ", ""))

346

581

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

347

if "secret" in config:

348

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

349

elif "secfile" in config:

350

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

351

(config["secfile"])),

352

"rb") as secfile:

353

self.secret = secfile.read()

354

else:

355

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

356

% self.name)

357

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

358

self.created = datetime.datetime.utcnow()

359

self.enabled = False

360

self.last_approval_request = None

361

self.last_enabled = None

362

self.last_checked_ok = None

363

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

364

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

365

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

366

self.disable_hook = disable_hook

582

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

583

datetime.datetime.utcnow())

584

585

# attributes specific for this server instance

367

586

self.checker = None

368

587

self.checker_initiator_tag = None

369

588

self.disable_initiator_tag = None

370

self.expires = None

371

589

self.checker_callback_tag = None

372

self.checker_command = config["checker"]

373

590

self.current_checker_command = None

374

self.last_connect = None

375

self._approved = None

376

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

377

True)

591

self.approved = None

378

592

self.approvals_pending = 0

379

self.approval_delay = string_to_delta(

380

config["approval_delay"])

381

self.approval_duration = string_to_delta(

382

config["approval_duration"])

383

self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())

593

self.changedstate = multiprocessing_manager.Condition(

594

multiprocessing_manager.Lock())

595

self.client_structure = [attr

596

for attr in self.__dict__.iterkeys()

597

if not attr.startswith("_")]

598

self.client_structure.append("client_structure")

599

600

for name, t in inspect.getmembers(

601

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

602

if not name.startswith("_"):

603

self.client_structure.append(name)

384

604

605

# Send notice to process children that client state has changed

385

606

def send_changedstate(self):

386

self.changedstate.acquire()

387

self.changedstate.notify_all()

388

self.changedstate.release()

389

607

with self.changedstate:

608

self.changedstate.notify_all()

609

390

610

def enable(self):

391

611

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

392

612

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

393

613

# Already enabled

394

614

return

395

self.send_changedstate()

615

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

616

self.enabled = True

396

617

self.last_enabled = datetime.datetime.utcnow()

397

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

398

# and every interval from then on.

399

self.checker_initiator_tag = (gobject.timeout_add

400

(self.interval_milliseconds(),

401

self.start_checker))

402

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

403

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

404

self.disable_initiator_tag = (gobject.timeout_add

405

(self.timeout_milliseconds(),

406

self.disable))

407

self.enabled = True

408

# Also start a new checker *right now*.

409

self.start_checker()

618

self.init_checker()

619

self.send_changedstate()

410

620

411

621

def disable(self, quiet=True):

412

622

"""Disable this client."""

413

623

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

414

624

return False

415

625

if not quiet:

416

self.send_changedstate()

417

if not quiet:

418

626

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

419

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

627

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

420

628

gobject.source_remove(self.disable_initiator_tag)

421

629

self.disable_initiator_tag = None

422

630

self.expires = None

423

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

631

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

424

632

gobject.source_remove(self.checker_initiator_tag)

425

633

self.checker_initiator_tag = None

426

634

self.stop_checker()

427

if self.disable_hook:

428

self.disable_hook(self)

429

635

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

430

638

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

431

639

return False

432

640

433

641

def __del__(self):

434

self.disable_hook = None

435

642

self.disable()

436

643

437

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

644

def init_checker(self):

645

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

646

# and every interval from then on.

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)

652

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

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)

657

# Also start a new checker *right now*.

658

self.start_checker()

659

660

def checker_callback(self, source, condition, connection,

661

command):

438

662

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

439

663

self.checker_callback_tag = None

440

664

self.checker = None

441

if os.WIFEXITED(condition):

442

exitstatus = os.WEXITSTATUS(condition)

443

if exitstatus == 0:

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

672

if self.last_checker_status == 0:

444

673

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

445

674

vars(self))

446

675

self.checked_ok()

447

676

else:

448

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

449

vars(self))

677

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

450

678

else:

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

451

681

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

452

682

vars(self))

453

454

def checked_ok(self, timeout=None):

455

"""Bump up the timeout for this client.

456

457

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

458

alive and well.

459

"""

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

460

694

if timeout is None:

461

695

timeout = self.timeout

462

self.last_checked_ok = datetime.datetime.utcnow()

463

gobject.source_remove(self.disable_initiator_tag)

464

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

465

self.disable_initiator_tag = (gobject.timeout_add

466

(self._timedelta_to_milliseconds(timeout),

467

self.disable))

696

if self.disable_initiator_tag is not None:

697

gobject.source_remove(self.disable_initiator_tag)

698

self.disable_initiator_tag = None

699

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

700

self.disable_initiator_tag = gobject.timeout_add(

701

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

702

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

468

703

469

704

def need_approval(self):

470

705

self.last_approval_request = datetime.datetime.utcnow()

475

710

If a checker already exists, leave it running and do

476

711

nothing."""

477

712

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

478

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

479

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

480

# client would inevitably timeout, since no checker would get

481

# 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

482

717

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

483

718

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

484

719

# should be.

485

720

486

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

487

try:

488

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

489

except (AttributeError, OSError) as error:

490

if (isinstance(error, OSError)

491

and error.errno != errno.ECHILD):

492

raise error

493

else:

494

if pid:

495

logger.warning("Checker was a zombie")

496

gobject.source_remove(self.checker_callback_tag)

497

self.checker_callback(pid, status,

498

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

499

725

# Start a new checker if needed

500

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 }

501

731

try:

502

# In case checker_command has exactly one % operator

503

command = self.checker_command % self.host

504

except TypeError:

505

# Escape attributes for the shell

506

escaped_attrs = dict(

507

(attr,

508

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

509

errors=

510

'replace')))

511

for attr in

512

self.runtime_expansions)

513

514

try:

515

command = self.checker_command % escaped_attrs

516

except TypeError as error:

517

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

518

' %s', self.checker_command, error)

519

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

520

738

self.current_checker_command = command

521

try:

522

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

523

command, self.name)

524

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

525

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

526

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

527

# always replaced by /dev/null.)

528

self.checker = subprocess.Popen(command,

529

close_fds=True,

530

shell=True, cwd="/")

531

self.checker_callback_tag = (gobject.child_watch_add

532

(self.checker.pid,

533

self.checker_callback,

534

data=command))

535

# The checker may have completed before the gobject

536

# watch was added. Check for this.

537

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

538

if pid:

539

gobject.source_remove(self.checker_callback_tag)

540

self.checker_callback(pid, status, command)

541

except OSError as error:

542

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

543

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)

544

764

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

545

765

return True

546

766

552

772

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

553

773

return

554

774

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

555

try:

556

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

557

#time.sleep(0.5)

558

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

559

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

560

except OSError as error:

561

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

562

raise

775

self.checker.terminate()

563

776

self.checker = None

564

777

565

def dbus_service_property(dbus_interface, signature="v",

566

access="readwrite", byte_arrays=False):

778

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

567

783

"""Decorators for marking methods of a DBusObjectWithProperties to

568

784

become properties on the D-Bus.

569

785

578

794

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

579

795

if byte_arrays and signature != "ay":

580

796

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

581

" signature %r" % signature)

797

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

798

582

799

def decorator(func):

583

800

func._dbus_is_property = True

584

801

func._dbus_interface = dbus_interface

589

806

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

590

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

591

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

592

853

return decorator

593

854

594

855

595

856

class DBusPropertyException(dbus.exceptions.DBusException):

596

857

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

597

858

"""

598

def __unicode__(self):

599

return unicode(str(self))

859

pass

600

860

601

861

602

862

class DBusPropertyAccessException(DBusPropertyException):

611

871

pass

612

872

613

873

614

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

615

964

"""A D-Bus object with properties.

616

965

617

966

Classes inheriting from this can use the dbus_service_property

618

967

decorator to expose methods as D-Bus properties. It exposes the

619

968

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

620

969

"""

621

970

622

@staticmethod

623

def _is_dbus_property(obj):

624

return getattr(obj, "_dbus_is_property", False)

625

626

def _get_all_dbus_properties(self):

627

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

628

"""

629

return ((prop._dbus_name, prop)

630

for name, prop in

631

inspect.getmembers(self, self._is_dbus_property))

632

633

971

def _get_dbus_property(self, interface_name, property_name):

634

972

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

635

973

property with the specified name and interface.

636

974

"""

637

for name in (property_name,

638

property_name + "_dbus_property"):

639

prop = getattr(self, name, None)

640

if (prop is None

641

or not self._is_dbus_property(prop)

642

or prop._dbus_name != property_name

643

or (interface_name and prop._dbus_interface

644

and interface_name != prop._dbus_interface)):

645

continue

646

return prop

975

for cls in self.__class__.__mro__:

976

for name, value in inspect.getmembers(

977

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

978

if (value._dbus_name == property_name

979

and value._dbus_interface == interface_name):

980

return value.__get__(self)

981

647

982

# No such property

648

raise DBusPropertyNotFound(self.dbus_object_path + ":"

649

+ interface_name + "."

650

+ property_name)

651

652

@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",

653

997

out_signature="v")

654

998

def Get(self, interface_name, property_name):

655

999

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

673

1017

# The byte_arrays option is not supported yet on

674

1018

# signatures other than "ay".

675

1019

if prop._dbus_signature != "ay":

676

raise ValueError

677

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

678

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

679

1025

prop(value)

680

1026

681

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

1027

@dbus.service.method(dbus.PROPERTIES_IFACE,

1028

in_signature="s",

682

1029

out_signature="a{sv}")

683

1030

def GetAll(self, interface_name):

684

1031

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

685

1032

standard.

686

1033

687

1034

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

688

1035

"""

689

all = {}

690

for name, prop in self._get_all_dbus_properties():

1036

properties = {}

1037

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

691

1038

if (interface_name

692

1039

and interface_name != prop._dbus_interface):

693

1040

# Interface non-empty but did not match

697

1044

continue

698

1045

value = prop()

699

1046

if not hasattr(value, "variant_level"):

700

all[name] = value

1047

properties[name] = value

701

1048

continue

702

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

703

value.variant_level+1)

704

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

1049

properties[name] = type(value)(

1050

value, variant_level = value.variant_level + 1)

1051

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

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

705

1060

706

1061

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

707

1062

out_signature="s",

708

1063

path_keyword='object_path',

709

1064

connection_keyword='connection')

710

1065

def Introspect(self, object_path, connection):

711

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

712

1069

"""

713

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

714

connection)

1070

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1071

object_path,

1072

connection)

715

1073

try:

716

1074

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

1075

717

1076

def make_tag(document, name, prop):

718

1077

e = document.createElement("property")

719

1078

e.setAttribute("name", name)

720

1079

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

721

1080

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

722

1081

return e

1082

723

1083

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

1084

# Add property tags

724

1085

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

725

1086

for name, prop

726

in self._get_all_dbus_properties()

1087

in self._get_all_dbus_things("property")

727

1088

if prop._dbus_interface

728

1089

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

729

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)

730

1107

# Add the names to the return values for the

731

1108

# "org.freedesktop.DBus.Properties" methods

732

1109

if (if_tag.getAttribute("name")

747

1124

except (AttributeError, xml.dom.DOMException,

748

1125

xml.parsers.expat.ExpatError) as error:

749

1126

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

750

error)

751

return xmlstring

752

753

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

1200

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

1201

if dt is None:

1202

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

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

1228

"""

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

1237

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

1238

# with the wrong interface name

1239

if (not hasattr(attribute, "_dbus_interface")

1240

or not attribute._dbus_interface.startswith(

1241

orig_interface_name)):

1242

continue

1243

# Create an alternate D-Bus interface name based on

1244

# the current name

1245

alt_interface = attribute._dbus_interface.replace(

1246

orig_interface_name, alt_interface_name)

1247

interface_names.add(alt_interface)

1248

# Is this a D-Bus signal?

1249

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

1250

if sys.version_info.major == 2:

1251

# Extract the original non-method undecorated

1252

# function by black magic

1253

nonmethod_func = (dict(

1254

zip(attribute.func_code.co_freevars,

1255

attribute.__closure__))

1256

["func"].cell_contents)

1257

else:

1258

nonmethod_func = attribute

1259

# Create a new, but exactly alike, function

1260

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

1261

# with the alternate D-Bus interface name

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

1285

# Define a creator of a function to call both the

1286

# original and alternate functions, so both the

1287

# original and alternate signals gets sent when

1288

# the function is called

1289

def fixscope(func1, func2):

1290

"""This function is a scope container to pass

1291

func1 and func2 to the "call_both" function

1292

outside of its arguments"""

1293

1294

@functools.wraps(func2)

1295

def call_both(*args, **kwargs):

1296

"""This function will emit two D-Bus

1297

signals by calling func1 and func2"""

1298

func1(*args, **kwargs)

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

1305

return call_both

1306

# Create the "call_both" function and add it to

1307

# the class

1308

attr[attrname] = fixscope(attribute, new_function)

1309

# Is this a D-Bus method?

1310

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

1311

# Create a new, but exactly alike, function

1312

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

1313

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

1314

# to the class.

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

1331

# Is this a D-Bus property?

1332

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

1333

# Create a new, but exactly alike, function

1334

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

1335

# property with the alternate D-Bus interface

1336

# name. Add it to the class.

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"})

754

1394

class ClientDBus(Client, DBusObjectWithProperties):

755

1395

"""A Client class using D-Bus

756

1396

760

1400

"""

761

1401

762

1402

runtime_expansions = (Client.runtime_expansions

763

+ ("dbus_object_path",))

1403

+ ("dbus_object_path", ))

1404

1405

_interface = "se.recompile.Mandos.Client"

764

1406

765

1407

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

766

1408

767

1409

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

768

self._approvals_pending = 0

769

1410

self.bus = bus

770

1411

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

771

1412

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

772

1413

# the D-Bus

773

client_object_name = unicode(self.name).translate(

1414

client_object_name = str(self.name).translate(

774

1415

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

775

1416

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

776

self.dbus_object_path = (dbus.ObjectPath

777

("/clients/" + client_object_name))

1417

self.dbus_object_path = dbus.ObjectPath(

1418

"/clients/" + client_object_name)

778

1419

DBusObjectWithProperties.__init__(self, self.bus,

779

1420

self.dbus_object_path)

780

def _set_expires(self, value):

781

old_value = getattr(self, "_expires", None)

782

self._expires = value

783

if hasattr(self, "dbus_object_path") and old_value != value:

784

dbus_time = (self._datetime_to_dbus(self._expires,

785

variant_level=1))

786

self.PropertyChanged(dbus.String("Expires"),

787

dbus_time)

788

expires = property(lambda self: self._expires, _set_expires)

789

del _set_expires

790

791

def _get_approvals_pending(self):

792

return self._approvals_pending

793

def _set_approvals_pending(self, value):

794

old_value = self._approvals_pending

795

self._approvals_pending = value

796

bval = bool(value)

797

if (hasattr(self, "dbus_object_path")

798

and bval is not bool(old_value)):

799

dbus_bool = dbus.Boolean(bval, variant_level=1)

800

self.PropertyChanged(dbus.String("ApprovalPending"),

801

dbus_bool)

802

803

approvals_pending = property(_get_approvals_pending,

804

_set_approvals_pending)

805

del _get_approvals_pending, _set_approvals_pending

806

807

@staticmethod

808

def _datetime_to_dbus(dt, variant_level=0):

809

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

810

if dt is None:

811

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

812

return dbus.String(dt.isoformat(),

813

variant_level=variant_level)

814

815

def enable(self):

816

oldstate = getattr(self, "enabled", False)

817

r = Client.enable(self)

818

if oldstate != self.enabled:

819

# Emit D-Bus signals

820

self.PropertyChanged(dbus.String("Enabled"),

821

dbus.Boolean(True, variant_level=1))

822

self.PropertyChanged(

823

dbus.String("LastEnabled"),

824

self._datetime_to_dbus(self.last_enabled,

825

variant_level=1))

826

return r

827

828

def disable(self, quiet = False):

829

oldstate = getattr(self, "enabled", False)

830

r = Client.disable(self, quiet=quiet)

831

if not quiet and oldstate != self.enabled:

832

# Emit D-Bus signal

833

self.PropertyChanged(dbus.String("Enabled"),

834

dbus.Boolean(False, variant_level=1))

835

return r

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

1427

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

1428

its changes to DBus.

1429

1430

transform_fun: Function that takes a value and a variant_level

1431

and transforms it to a D-Bus type.

1432

dbus_name: D-Bus name of the variable

1433

type_func: Function that transform the value before sending it

1434

to the D-Bus. Default: no transform

1435

variant_level: D-Bus variant level. Default: 1

1436

"""

1437

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

1438

1439

def setter(self, value):

1440

if hasattr(self, "dbus_object_path"):

1441

if (not hasattr(self, attrname) or

1442

type_func(getattr(self, attrname, None))

1443

!= type_func(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())

1459

setattr(self, attrname, value)

1460

1461

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

1462

1463

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1464

approvals_pending = notifychangeproperty(dbus.Boolean,

1465

"ApprovalPending",

1466

type_func = bool)

1467

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

1468

last_enabled = notifychangeproperty(datetime_to_dbus,

1469

"LastEnabled")

1470

checker = notifychangeproperty(

1471

dbus.Boolean, "CheckerRunning",

1472

type_func = lambda checker: checker is not None)

1473

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1474

"LastCheckedOK")

1475

last_checker_status = notifychangeproperty(dbus.Int16,

1476

"LastCheckerStatus")

1477

last_approval_request = notifychangeproperty(

1478

datetime_to_dbus, "LastApprovalRequest")

1479

approved_by_default = notifychangeproperty(dbus.Boolean,

1480

"ApprovedByDefault")

1481

approval_delay = notifychangeproperty(

1482

dbus.UInt64, "ApprovalDelay",

1483

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

1484

approval_duration = notifychangeproperty(

1485

dbus.UInt64, "ApprovalDuration",

1486

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

1487

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

1488

timeout = notifychangeproperty(

1489

dbus.UInt64, "Timeout",

1490

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

1491

extended_timeout = notifychangeproperty(

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)

1497

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

1498

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

1499

invalidate_only=True)

1500

1501

del notifychangeproperty

836

1502

837

1503

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

838

1504

try:

843

1509

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

844

1510

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

845

1511

846

def checker_callback(self, pid, condition, command,

847

*args, **kwargs):

848

self.checker_callback_tag = None

849

self.checker = None

850

# Emit D-Bus signal

851

self.PropertyChanged(dbus.String("CheckerRunning"),

852

dbus.Boolean(False, variant_level=1))

853

if os.WIFEXITED(condition):

854

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:

855

1519

# Emit D-Bus signal

856

1520

self.CheckerCompleted(dbus.Int16(exitstatus),

857

dbus.Int64(condition),

1521

# This is specific to GNU libC

1522

dbus.Int64(exitstatus << 8),

858

1523

dbus.String(command))

859

1524

else:

860

1525

# Emit D-Bus signal

861

1526

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

862

dbus.Int64(condition),

1527

dbus.Int64(

1528

# This is specific to GNU libC

1529

(exitstatus << 8)

1530

| self.last_checker_signal),

863

1531

dbus.String(command))

864

865

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

866

*args, **kwargs)

867

868

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

869

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

870

# Emit D-Bus signal

871

self.PropertyChanged(

872

dbus.String("LastCheckedOK"),

873

(self._datetime_to_dbus(self.last_checked_ok,

874

variant_level=1)))

875

876

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

877

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

878

# Emit D-Bus signal

879

self.PropertyChanged(

880

dbus.String("LastApprovalRequest"),

881

(self._datetime_to_dbus(self.last_approval_request,

882

variant_level=1)))

883

return r

1532

return ret

884

1533

885

1534

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

886

old_checker = self.checker

887

if self.checker is not None:

888

old_checker_pid = self.checker.pid

889

else:

890

old_checker_pid = None

1535

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

891

1536

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

892

1537

# Only if new checker process was started

893

1538

if (self.checker is not None

894

1539

and old_checker_pid != self.checker.pid):

895

1540

# Emit D-Bus signal

896

1541

self.CheckerStarted(self.current_checker_command)

897

self.PropertyChanged(

898

dbus.String("CheckerRunning"),

899

dbus.Boolean(True, variant_level=1))

900

1542

return r

901

1543

902

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

903

old_checker = getattr(self, "checker", None)

904

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

905

if (old_checker is not None

906

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

907

self.PropertyChanged(dbus.String("CheckerRunning"),

908

dbus.Boolean(False, variant_level=1))

909

return r

910

911

1544

def _reset_approved(self):

912

self._approved = None

1545

self.approved = None

913

1546

return False

914

1547

915

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)

916

1552

self.send_changedstate()

917

self._approved = value

918

gobject.timeout_add(self._timedelta_to_milliseconds

919

(self.approval_duration),

920

self._reset_approved)

921

922

1553

923

1554

## D-Bus methods, signals & properties

924

_interface = "se.bsnet.fukt.Mandos.Client"

1555

1556

## Interfaces

925

1557

926

1558

## Signals

927

1559

938

1570

pass

939

1571

940

1572

# PropertyChanged - signal

1573

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

941

1574

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

942

1575

def PropertyChanged(self, property, value):

943

1576

"D-Bus signal"

977

1610

self.checked_ok()

978

1611

979

1612

# Enable - method

1613

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

980

1614

@dbus.service.method(_interface)

981

1615

def Enable(self):

982

1616

"D-Bus method"

983

1617

self.enable()

984

1618

985

1619

# StartChecker - method

1620

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

986

1621

@dbus.service.method(_interface)

987

1622

def StartChecker(self):

988

1623

"D-Bus method"

989

1624

self.start_checker()

990

1625

991

1626

# Disable - method

1627

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

992

1628

@dbus.service.method(_interface)

993

1629

def Disable(self):

994

1630

"D-Bus method"

995

1631

self.disable()

996

1632

997

1633

# StopChecker - method

1634

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

998

1635

@dbus.service.method(_interface)

999

1636

def StopChecker(self):

1000

1637

self.stop_checker()

1007

1644

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

1008

1645

1009

1646

# ApprovedByDefault - property

1010

@dbus_service_property(_interface, signature="b",

1647

@dbus_service_property(_interface,

1648

signature="b",

1011

1649

access="readwrite")

1012

1650

def ApprovedByDefault_dbus_property(self, value=None):

1013

1651

if value is None: # get

1014

1652

return dbus.Boolean(self.approved_by_default)

1015

old_value = self.approved_by_default

1016

1653

self.approved_by_default = bool(value)

1017

# Emit D-Bus signal

1018

if old_value != self.approved_by_default:

1019

self.PropertyChanged(dbus.String("ApprovedByDefault"),

1020

dbus.Boolean(value, variant_level=1))

1021

1654

1022

1655

# ApprovalDelay - property

1023

@dbus_service_property(_interface, signature="t",

1656

@dbus_service_property(_interface,

1657

signature="t",

1024

1658

access="readwrite")

1025

1659

def ApprovalDelay_dbus_property(self, value=None):

1026

1660

if value is None: # get

1027

return dbus.UInt64(self.approval_delay_milliseconds())

1028

old_value = self.approval_delay

1661

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

1662

* 1000)

1029

1663

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

1030

# Emit D-Bus signal

1031

if old_value != self.approval_delay:

1032

self.PropertyChanged(dbus.String("ApprovalDelay"),

1033

dbus.UInt64(value, variant_level=1))

1034

1664

1035

1665

# ApprovalDuration - property

1036

@dbus_service_property(_interface, signature="t",

1666

@dbus_service_property(_interface,

1667

signature="t",

1037

1668

access="readwrite")

1038

1669

def ApprovalDuration_dbus_property(self, value=None):

1039

1670

if value is None: # get

1040

return dbus.UInt64(self._timedelta_to_milliseconds(

1041

self.approval_duration))

1042

old_value = self.approval_duration

1671

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

1672

* 1000)

1043

1673

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

1044

# Emit D-Bus signal

1045

if old_value != self.approval_duration:

1046

self.PropertyChanged(dbus.String("ApprovalDuration"),

1047

dbus.UInt64(value, variant_level=1))

1048

1674

1049

1675

# Name - property

1676

@dbus_annotations(

1677

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

1050

1678

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

1051

1679

def Name_dbus_property(self):

1052

1680

return dbus.String(self.name)

1053

1681

1054

1682

# Fingerprint - property

1683

@dbus_annotations(

1684

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

1055

1685

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

1056

1686

def Fingerprint_dbus_property(self):

1057

1687

return dbus.String(self.fingerprint)

1058

1688

1059

1689

# Host - property

1060

@dbus_service_property(_interface, signature="s",

1690

@dbus_service_property(_interface,

1691

signature="s",

1061

1692

access="readwrite")

1062

1693

def Host_dbus_property(self, value=None):

1063

1694

if value is None: # get

1064

1695

return dbus.String(self.host)

1065

old_value = self.host

1066

self.host = value

1067

# Emit D-Bus signal

1068

if old_value != self.host:

1069

self.PropertyChanged(dbus.String("Host"),

1070

dbus.String(value, variant_level=1))

1696

self.host = str(value)

1071

1697

1072

1698

# Created - property

1699

@dbus_annotations(

1700

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

1073

1701

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

1074

1702

def Created_dbus_property(self):

1075

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

1703

return datetime_to_dbus(self.created)

1076

1704

1077

1705

# LastEnabled - property

1078

1706

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

1079

1707

def LastEnabled_dbus_property(self):

1080

return self._datetime_to_dbus(self.last_enabled)

1708

return datetime_to_dbus(self.last_enabled)

1081

1709

1082

1710

# Enabled - property

1083

@dbus_service_property(_interface, signature="b",

1711

@dbus_service_property(_interface,

1712

signature="b",

1084

1713

access="readwrite")

1085

1714

def Enabled_dbus_property(self, value=None):

1086

1715

if value is None: # get

1091

1720

self.disable()

1092

1721

1093

1722

# LastCheckedOK - property

1094

@dbus_service_property(_interface, signature="s",

1723

@dbus_service_property(_interface,

1724

signature="s",

1095

1725

access="readwrite")

1096

1726

def LastCheckedOK_dbus_property(self, value=None):

1097

1727

if value is not None:

1098

1728

self.checked_ok()

1099

1729

return

1100

return self._datetime_to_dbus(self.last_checked_ok)

1730

return datetime_to_dbus(self.last_checked_ok)

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)

1101

1736

1102

1737

# Expires - property

1103

1738

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

1104

1739

def Expires_dbus_property(self):

1105

return self._datetime_to_dbus(self.expires)

1740

return datetime_to_dbus(self.expires)

1106

1741

1107

1742

# LastApprovalRequest - property

1108

1743

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

1109

1744

def LastApprovalRequest_dbus_property(self):

1110

return self._datetime_to_dbus(self.last_approval_request)

1745

return datetime_to_dbus(self.last_approval_request)

1111

1746

1112

1747

# Timeout - property

1113

@dbus_service_property(_interface, signature="t",

1748

@dbus_service_property(_interface,

1749

signature="t",

1114

1750

access="readwrite")

1115

1751

def Timeout_dbus_property(self, value=None):

1116

1752

if value is None: # get

1117

return dbus.UInt64(self.timeout_milliseconds())

1118

old_value = self.timeout

1753

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

1754

old_timeout = self.timeout

1119

1755

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

1120

# Emit D-Bus signal

1121

if old_value != self.timeout:

1122

self.PropertyChanged(dbus.String("Timeout"),

1123

dbus.UInt64(value, variant_level=1))

1124

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

1125

return

1126

# Reschedule timeout

1127

gobject.source_remove(self.disable_initiator_tag)

1128

self.disable_initiator_tag = None

1129

self.expires = None

1130

time_to_die = (self.

1131

_timedelta_to_milliseconds((self

1132

.last_checked_ok

1133

+ self.timeout)

1134

- datetime.datetime

1135

.utcnow()))

1136

if time_to_die <= 0:

1137

# The timeout has passed

1138

self.disable()

1139

else:

1140

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

1141

+ datetime.timedelta(milliseconds = time_to_die))

1142

self.disable_initiator_tag = (gobject.timeout_add

1143

(time_to_die, self.disable))

1144

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)

1771

1145

1772

# ExtendedTimeout - property

1146

@dbus_service_property(_interface, signature="t",

1773

@dbus_service_property(_interface,

1774

signature="t",

1147

1775

access="readwrite")

1148

1776

def ExtendedTimeout_dbus_property(self, value=None):

1149

1777

if value is None: # get

1150

return dbus.UInt64(self.extended_timeout_milliseconds())

1151

old_value = self.extended_timeout

1778

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

1779

* 1000)

1152

1780

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

1153

# Emit D-Bus signal

1154

if old_value != self.extended_timeout:

1155

self.PropertyChanged(dbus.String("ExtendedTimeout"),

1156

dbus.UInt64(value, variant_level=1))

1157

1781

1158

1782

# Interval - property

1159

@dbus_service_property(_interface, signature="t",

1783

@dbus_service_property(_interface,

1784

signature="t",

1160

1785

access="readwrite")

1161

1786

def Interval_dbus_property(self, value=None):

1162

1787

if value is None: # get

1163

return dbus.UInt64(self.interval_milliseconds())

1164

old_value = self.interval

1788

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

1165

1789

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

1166

# Emit D-Bus signal

1167

if old_value != self.interval:

1168

self.PropertyChanged(dbus.String("Interval"),

1169

dbus.UInt64(value, variant_level=1))

1170

1790

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

1171

1791

return

1172

# Reschedule checker run

1173

gobject.source_remove(self.checker_initiator_tag)

1174

self.checker_initiator_tag = (gobject.timeout_add

1175

(value, self.start_checker))

1176

self.start_checker() # Start one now, too

1177

1792

if self.enabled:

1793

# Reschedule checker run

1794

gobject.source_remove(self.checker_initiator_tag)

1795

self.checker_initiator_tag = gobject.timeout_add(

1796

value, self.start_checker)

1797

self.start_checker() # Start one now, too

1798

1178

1799

# Checker - property

1179

@dbus_service_property(_interface, signature="s",

1800

@dbus_service_property(_interface,

1801

signature="s",

1180

1802

access="readwrite")

1181

1803

def Checker_dbus_property(self, value=None):

1182

1804

if value is None: # get

1183

1805

return dbus.String(self.checker_command)

1184

old_value = self.checker_command

1185

self.checker_command = value

1186

# Emit D-Bus signal

1187

if old_value != self.checker_command:

1188

self.PropertyChanged(dbus.String("Checker"),

1189

dbus.String(self.checker_command,

1190

variant_level=1))

1806

self.checker_command = str(value)

1191

1807

1192

1808

# CheckerRunning - property

1193

@dbus_service_property(_interface, signature="b",

1809

@dbus_service_property(_interface,

1810

signature="b",

1194

1811

access="readwrite")

1195

1812

def CheckerRunning_dbus_property(self, value=None):

1196

1813

if value is None: # get

1201

1818

self.stop_checker()

1202

1819

1203

1820

# ObjectPath - property

1821

@dbus_annotations(

1822

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

1823

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

1204

1824

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

1205

1825

def ObjectPath_dbus_property(self):

1206

1826

return self.dbus_object_path # is already a dbus.ObjectPath

1207

1827

1208

1828

# Secret = property

1209

@dbus_service_property(_interface, signature="ay",

1210

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)

1211

1836

def Secret_dbus_property(self, value):

1212

self.secret = str(value)

1837

self.secret = bytes(value)

1213

1838

1214

1839

del _interface

1215

1840

1219

1844

self._pipe = child_pipe

1220

1845

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

1221

1846

if not self._pipe.recv():

1222

raise KeyError()

1223

1847

raise KeyError(fpr)

1848

1224

1849

def __getattribute__(self, name):

1225

if(name == '_pipe'):

1850

if name == '_pipe':

1226

1851

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

1227

1852

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

1228

1853

data = self._pipe.recv()

1229

1854

if data[0] == 'data':

1230

1855

return data[1]

1231

1856

if data[0] == 'function':

1857

1232

1858

def func(*args, **kwargs):

1233

1859

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

1234

1860

return self._pipe.recv()[1]

1861

1235

1862

return func

1236

1863

1237

1864

def __setattr__(self, name, value):

1238

if(name == '_pipe'):

1865

if name == '_pipe':

1239

1866

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

1240

1867

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

1241

1868

1249

1876

def handle(self):

1250

1877

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

1251

1878

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

1252

unicode(self.client_address))

1879

str(self.client_address))

1253

1880

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

1254

1881

self.server.child_pipe.fileno())

1255

1256

session = (gnutls.connection

1257

.ClientSession(self.request,

1258

gnutls.connection

1259

.X509Credentials()))

1260

1882

1883

session = gnutls.connection.ClientSession(

1884

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

1885

1261

1886

# Note: gnutls.connection.X509Credentials is really a

1262

1887

# generic GnuTLS certificate credentials object so long as

1263

1888

# no X.509 keys are added to it. Therefore, we can use it

1264

1889

# here despite using OpenPGP certificates.

1265

1890

1266

1891

#priority = ':'.join(("NONE", "+VERS-TLS1.1",

1267

1892

# "+AES-256-CBC", "+SHA1",

1268

1893

# "+COMP-NULL", "+CTYPE-OPENPGP",

1271

1896

priority = self.server.gnutls_priority

1272

1897

if priority is None:

1273

1898

priority = "NORMAL"

1274

(gnutls.library.functions

1275

.gnutls_priority_set_direct(session._c_object,

1276

priority, None))

1277

1899

gnutls.library.functions.gnutls_priority_set_direct(

1900

session._c_object, priority, None)

1901

1278

1902

# Start communication using the Mandos protocol

1279

1903

# Get protocol number

1280

1904

line = self.request.makefile().readline()

1281

1905

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

1282

1906

try:

1283

1907

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

1284

raise RuntimeError

1908

raise RuntimeError(line)

1285

1909

except (ValueError, IndexError, RuntimeError) as error:

1286

1910

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

1287

1911

return

1288

1912

1289

1913

# Start GnuTLS connection

1290

1914

try:

1291

1915

session.handshake()

1295

1919

# established. Just abandon the request.

1296

1920

return

1297

1921

logger.debug("Handshake succeeded")

1298

1922

1299

1923

approval_required = False

1300

1924

try:

1301

1925

try:

1302

fpr = self.fingerprint(self.peer_certificate

1303

(session))

1926

fpr = self.fingerprint(

1927

self.peer_certificate(session))

1304

1928

except (TypeError,

1305

1929

gnutls.errors.GNUTLSError) as error:

1306

1930

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

1307

1931

return

1308

1932

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

1309

1933

1310

1934

try:

1311

1935

client = ProxyClient(child_pipe, fpr,

1312

1936

self.client_address)

1321

1945

while True:

1322

1946

if not client.enabled:

1323

1947

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

1324

client.name)

1948

client.name)

1325

1949

if self.server.use_dbus:

1326

1950

# Emit D-Bus signal

1327

client.Rejected("Disabled")

1951

client.Rejected("Disabled")

1328

1952

return

1329

1953

1330

if client._approved or not client.approval_delay:

1954

if client.approved or not client.approval_delay:

1331

1955

#We are approved or approval is disabled

1332

1956

break

1333

elif client._approved is None:

1957

elif client.approved is None:

1334

1958

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

1335

1959

client.name)

1336

1960

if self.server.use_dbus:

1337

1961

# Emit D-Bus signal

1338

1962

client.NeedApproval(

1339

client.approval_delay_milliseconds(),

1340

client.approved_by_default)

1963

client.approval_delay.total_seconds()

1964

* 1000, client.approved_by_default)

1341

1965

else:

1342

1966

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

1343

1967

client.name)

1347

1971

return

1348

1972

1349

1973

#wait until timeout or approved

1350

#x = float(client._timedelta_to_milliseconds(delay))

1351

1974

time = datetime.datetime.now()

1352

1975

client.changedstate.acquire()

1353

client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))

1976

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

1354

1977

client.changedstate.release()

1355

1978

time2 = datetime.datetime.now()

1356

1979

if (time2 - time) >= delay:

1372

1995

try:

1373

1996

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

1374

1997

except gnutls.errors.GNUTLSError as error:

1375

logger.warning("gnutls send failed")

1998

logger.warning("gnutls send failed",

1999

exc_info=error)

1376

2000

return

1377

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

1378

sent, len(client.secret)

1379

- (sent_size + sent))

2001

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

2002

len(client.secret) - (sent_size

2003

+ sent))

1380

2004

sent_size += sent

1381

2005

1382

2006

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

1383

# bump the timeout as if seen

1384

client.checked_ok(client.extended_timeout)

2007

# bump the timeout using extended_timeout

2008

client.bump_timeout(client.extended_timeout)

1385

2009

if self.server.use_dbus:

1386

2010

# Emit D-Bus signal

1387

2011

client.GotSecret()

1392

2016

try:

1393

2017

session.bye()

1394

2018

except gnutls.errors.GNUTLSError as error:

1395

logger.warning("GnuTLS bye failed")

2019

logger.warning("GnuTLS bye failed",

2020

exc_info=error)

1396

2021

1397

2022

@staticmethod

1398

2023

def peer_certificate(session):

1399

2024

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

1400

2025

# If not an OpenPGP certificate...

1401

if (gnutls.library.functions

1402

.gnutls_certificate_type_get(session._c_object)

2026

if (gnutls.library.functions.gnutls_certificate_type_get(

2027

session._c_object)

1403

2028

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1404

2029

# ...do the normal thing

1405

2030

return session.peer_certificate

1419

2044

def fingerprint(openpgp):

1420

2045

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1421

2046

# New GnuTLS "datum" with the OpenPGP public key

1422

datum = (gnutls.library.types

1423

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

1424

ctypes.POINTER

1425

(ctypes.c_ubyte)),

1426

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

1427

2051

# New empty GnuTLS certificate

1428

2052

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1429

(gnutls.library.functions

1430

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2053

gnutls.library.functions.gnutls_openpgp_crt_init(

2054

ctypes.byref(crt))

1431

2055

# Import the OpenPGP public key into the certificate

1432

(gnutls.library.functions

1433

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

1434

gnutls.library.constants

1435

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

1436

2059

# Verify the self signature in the key

1437

2060

crtverify = ctypes.c_uint()

1438

(gnutls.library.functions

1439

.gnutls_openpgp_crt_verify_self(crt, 0,

1440

ctypes.byref(crtverify)))

2061

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2062

crt, 0, ctypes.byref(crtverify))

1441

2063

if crtverify.value != 0:

1442

2064

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1443

raise (gnutls.errors.CertificateSecurityError

1444

("Verify failed"))

2065

raise gnutls.errors.CertificateSecurityError(

2066

"Verify failed")

1445

2067

# New buffer for the fingerprint

1446

2068

buf = ctypes.create_string_buffer(20)

1447

2069

buf_len = ctypes.c_size_t()

1448

2070

# Get the fingerprint from the certificate into the buffer

1449

(gnutls.library.functions

1450

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

1451

ctypes.byref(buf_len)))

2071

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2072

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

1452

2073

# Deinit the certificate

1453

2074

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1454

2075

# Convert the buffer to a Python bytestring

1455

2076

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

1456

2077

# Convert the bytestring to hexadecimal notation

1457

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

2078

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

1458

2079

return hex_fpr

1459

2080

1460

2081

1461

2082

class MultiprocessingMixIn(object):

1462

2083

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

2084

1463

2085

def sub_process_main(self, request, address):

1464

2086

try:

1465

2087

self.finish_request(request, address)

1466

except:

2088

except Exception:

1467

2089

self.handle_error(request, address)

1468

2090

self.close_request(request)

1469

2091

1470

2092

def process_request(self, request, address):

1471

2093

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

1472

multiprocessing.Process(target = self.sub_process_main,

1473

args = (request, address)).start()

2094

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

2095

args = (request, address))

2096

proc.start()

2097

return proc

2098

1474

2099

1475

2100

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1476

2101

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

2102

1477

2103

def process_request(self, request, client_address):

1478

2104

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

1479

2105

1480

2106

This function creates a new pipe in self.pipe

1481

2107

"""

1482

2108

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1483

1484

super(MultiprocessingMixInWithPipe,

1485

self).process_request(request, client_address)

2109

2110

proc = MultiprocessingMixIn.process_request(self, request,

2111

client_address)

1486

2112

self.child_pipe.close()

1487

self.add_pipe(parent_pipe)

1488

1489

def add_pipe(self, parent_pipe):

2113

self.add_pipe(parent_pipe, proc)

2114

2115

def add_pipe(self, parent_pipe, proc):

1490

2116

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

1491

raise NotImplementedError

2117

raise NotImplementedError()

2118

1492

2119

1493

2120

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1494

2121

socketserver.TCPServer, object):

1499

2126

interface: None or a network interface name (string)

1500

2127

use_ipv6: Boolean; to use IPv6 or not

1501

2128

"""

2129

1502

2130

def __init__(self, server_address, RequestHandlerClass,

1503

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

"""

1504

2137

self.interface = interface

1505

2138

if use_ipv6:

1506

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.

1507

2166

socketserver.TCPServer.__init__(self, server_address,

1508

2167

RequestHandlerClass)

2168

1509

2169

def server_bind(self):

1510

2170

"""This overrides the normal server_bind() function

1511

2171

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

1517

2177

self.interface)

1518

2178

else:

1519

2179

try:

1520

self.socket.setsockopt(socket.SOL_SOCKET,

1521

SO_BINDTODEVICE,

1522

str(self.interface

1523

+ '\0'))

2180

self.socket.setsockopt(

2181

socket.SOL_SOCKET, SO_BINDTODEVICE,

2182

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

1524

2183

except socket.error as error:

1525

if error[0] == errno.EPERM:

1526

logger.error("No permission to"

1527

" bind to interface %s",

1528

self.interface)

1529

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:

1530

2188

logger.error("SO_BINDTODEVICE not available;"

1531

2189

" cannot bind to interface %s",

1532

2190

self.interface)

2191

elif error.errno == errno.ENODEV:

2192

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

2193

" cannot bind", self.interface)

1533

2194

else:

1534

2195

raise

1535

2196

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

1538

2199

if self.address_family == socket.AF_INET6:

1539

2200

any_address = "::" # in6addr_any

1540

2201

else:

1541

any_address = socket.INADDR_ANY

2202

any_address = "0.0.0.0" # INADDR_ANY

1542

2203

self.server_address = (any_address,

1543

2204

self.server_address[1])

1544

2205

elif not self.server_address[1]:

1545

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

1546

0)

2206

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

1547

2207

# if self.interface:

1548

2208

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

1549

2209

# 0, # port

1563

2223

1564

2224

Assumes a gobject.MainLoop event loop.

1565

2225

"""

2226

1566

2227

def __init__(self, server_address, RequestHandlerClass,

1567

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

1568

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

1569

2234

self.enabled = False

1570

2235

self.clients = clients

1571

2236

if self.clients is None:

1572

self.clients = set()

2237

self.clients = {}

1573

2238

self.use_dbus = use_dbus

1574

2239

self.gnutls_priority = gnutls_priority

1575

2240

IPv6_TCPServer.__init__(self, server_address,

1576

2241

RequestHandlerClass,

1577

2242

interface = interface,

1578

use_ipv6 = use_ipv6)

2243

use_ipv6 = use_ipv6,

2244

socketfd = socketfd)

2245

1579

2246

def server_activate(self):

1580

2247

if self.enabled:

1581

2248

return socketserver.TCPServer.server_activate(self)

2249

1582

2250

def enable(self):

1583

2251

self.enabled = True

1584

def add_pipe(self, parent_pipe):

2252

2253

def add_pipe(self, parent_pipe, proc):

1585

2254

# Call "handle_ipc" for both data and EOF events

1586

gobject.io_add_watch(parent_pipe.fileno(),

1587

gobject.IO_IN | gobject.IO_HUP,

1588

functools.partial(self.handle_ipc,

1589

parent_pipe = parent_pipe))

1590

1591

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

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

2261

2262

def handle_ipc(self, source, condition,

2263

parent_pipe=None,

2264

proc = None,

1592

2265

client_object=None):

1593

condition_names = {

1594

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

1595

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

1596

# blocking).

1597

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

1598

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

1599

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

1600

# broken, usually for pipes and

1601

# sockets).

1602

}

1603

conditions_string = ' | '.join(name

1604

for cond, name in

1605

condition_names.iteritems()

1606

if cond & condition)

1607

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

1608

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

2266

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

2267

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

2268

# Wait for other process to exit

2269

proc.join()

1609

2270

return False

1610

2271

1611

2272

# Read a request from the child

1616

2277

fpr = request[1]

1617

2278

address = request[2]

1618

2279

1619

for c in self.clients:

2280

for c in self.clients.itervalues():

1620

2281

if c.fingerprint == fpr:

1621

2282

client = c

1622

2283

break

1625

2286

"dress: %s", fpr, address)

1626

2287

if self.use_dbus:

1627

2288

# Emit D-Bus signal

1628

mandos_dbus_service.ClientNotFound(fpr, address[0])

2289

mandos_dbus_service.ClientNotFound(fpr,

2290

address[0])

1629

2291

parent_pipe.send(False)

1630

2292

return False

1631

2293

1632

gobject.io_add_watch(parent_pipe.fileno(),

1633

gobject.IO_IN | gobject.IO_HUP,

1634

functools.partial(self.handle_ipc,

1635

parent_pipe = parent_pipe,

1636

client_object = 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))

1637

2301

parent_pipe.send(True)

1638

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

2302

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

2303

# same fileno

1639

2304

return False

1640

2305

if command == 'funcall':

1641

2306

funcname = request[1]

1642

2307

args = request[2]

1643

2308

kwargs = request[3]

1644

2309

1645

parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))

1646

2310

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

2311

funcname)(*args,

2312

**kwargs)))

2313

1647

2314

if command == 'getattr':

1648

2315

attrname = request[1]

1649

if callable(client_object.__getattribute__(attrname)):

1650

parent_pipe.send(('function',))

2316

if isinstance(client_object.__getattribute__(attrname),

2317

collections.Callable):

2318

parent_pipe.send(('function', ))

1651

2319

else:

1652

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

2320

parent_pipe.send((

2321

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

1653

2322

1654

2323

if command == 'setattr':

1655

2324

attrname = request[1]

1656

2325

value = request[2]

1657

2326

setattr(client_object, attrname, value)

1658

2327

1659

2328

return True

1660

2329

1661

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

1662

2427

def string_to_delta(interval):

1663

2428

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

1664

2429

1675

2440

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

1676

2441

datetime.timedelta(0, 330)

1677

2442

"""

2443

2444

try:

2445

return rfc3339_duration_to_delta(interval)

2446

except ValueError:

2447

pass

2448

1678

2449

timevalue = datetime.timedelta(0)

1679

2450

for s in interval.split():

1680

2451

try:

1681

suffix = unicode(s[-1])

2452

suffix = s[-1]

1682

2453

value = int(s[:-1])

1683

2454

if suffix == "d":

1684

2455

delta = datetime.timedelta(value)

1691

2462

elif suffix == "w":

1692

2463

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

1693

2464

else:

1694

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

1695

except (ValueError, IndexError) as e:

2465

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

2466

except IndexError as e:

1696

2467

raise ValueError(*(e.args))

1697

2468

timevalue += delta

1698

2469

return timevalue

1699

2470

1700

2471

1701

def if_nametoindex(interface):

1702

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

1703

1704

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

1705

global if_nametoindex

1706

try:

1707

if_nametoindex = (ctypes.cdll.LoadLibrary

1708

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

1709

.if_nametoindex)

1710

except (OSError, AttributeError):

1711

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

1712

def if_nametoindex(interface):

1713

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

1714

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

1715

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

1716

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1717

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

1718

interface))

1719

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

1720

ifreq[16:20])[0]

1721

return interface_index

1722

return if_nametoindex(interface)

1723

1724

1725

2472

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

1726

2473

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

1727

2474

1735

2482

sys.exit()

1736

2483

if not noclose:

1737

2484

# Close all standard open file descriptors

1738

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

2485

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

1739

2486

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

1740

2487

raise OSError(errno.ENODEV,

1741

"%s not a character device"

1742

% os.path.devnull)

2488

"{} not a character device"

2489

.format(os.devnull))

1743

2490

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

1744

2491

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

1745

2492

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

1754

2501

1755

2502

parser = argparse.ArgumentParser()

1756

2503

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

1757

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

2504

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

1758

2505

help="show version number and exit")

1759

2506

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

1760

2507

help="Bind to interface IF")

1766

2513

help="Run self-test")

1767

2514

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

1768

2515

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

1769

" to terminal")

2516

" to terminal", default=None)

1770

2517

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

1771

2518

help="Debug level for stdout output")

1772

2519

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

1779

2526

" files")

1780

2527

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

1781

2528

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

1782

" system bus interface")

2529

" system bus interface", default=None)

1783

2530

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

1784

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

2531

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

2532

default=None)

2533

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

2534

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

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

2539

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

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)

2546

1785

2547

options = parser.parse_args()

1786

2548

1787

2549

if options.check:

1788

2550

import doctest

1789

doctest.testmod()

1790

sys.exit()

2551

fail_count, test_count = doctest.testmod()

2552

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

1791

2553

1792

2554

# Default values for config file for server-global settings

1793

2555

server_defaults = { "interface": "",

1795

2557

"port": "",

1796

2558

"debug": "False",

1797

2559

"priority":

1798

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

2560

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

2561

":+SIGN-DSA-SHA256",

1799

2562

"servicename": "Mandos",

1800

2563

"use_dbus": "True",

1801

2564

"use_ipv6": "True",

1802

2565

"debuglevel": "",

1803

}

2566

"restore": "True",

2567

"socket": "",

2568

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

2569

"foreground": "False",

2570

"zeroconf": "True",

2571

}

1804

2572

1805

2573

# Parse config file for server-global settings

1806

2574

server_config = configparser.SafeConfigParser(server_defaults)

1807

2575

del server_defaults

1808

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

1809

"mandos.conf"))

2576

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

1810

2577

# Convert the SafeConfigParser object to a dict

1811

2578

server_settings = server_config.defaults()

1812

2579

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

1813

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

2580

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

1814

2581

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

1815

2582

option)

1816

2583

if server_settings["port"]:

1817

2584

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

1818

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"])

1819

2595

del server_config

1820

2596

1821

2597

# Override the settings from the config file with command line

1822

2598

# options, if set.

1823

2599

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

1824

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

1825

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

2600

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

2601

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

2602

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

1826

2603

value = getattr(options, option)

1827

2604

if value is not None:

1828

2605

server_settings[option] = value

1829

2606

del options

1830

2607

# Force all strings to be unicode

1831

2608

for option in server_settings.keys():

1832

if type(server_settings[option]) is str:

1833

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

1834

2619

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

1835

2620

1836

2621

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

1837

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

1838

2628

# For convenience

1839

2629

debug = server_settings["debug"]

1840

2630

debuglevel = server_settings["debuglevel"]

1841

2631

use_dbus = server_settings["use_dbus"]

1842

2632

use_ipv6 = server_settings["use_ipv6"]

1843

2633

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

2634

stored_state_file)

2635

foreground = server_settings["foreground"]

2636

zeroconf = server_settings["zeroconf"]

2637

2638

if debug:

2639

initlogger(debug, logging.DEBUG)

2640

else:

2641

if not debuglevel:

2642

initlogger(debug)

2643

else:

2644

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

2645

initlogger(debug, level)

2646

1844

2647

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

1845

syslogger.setFormatter(logging.Formatter

1846

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

1847

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

1848

% server_settings["servicename"]))

2648

syslogger.setFormatter(

2649

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

2650

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

2651

server_settings["servicename"])))

1849

2652

1850

2653

# Parse config file with clients

1851

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

1852

"extended_timeout": "15m",

1853

"interval": "2m",

1854

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

1855

"host": "",

1856

"approval_delay": "0s",

1857

"approval_duration": "1s",

1858

}

1859

client_config = configparser.SafeConfigParser(client_defaults)

2654

client_config = configparser.SafeConfigParser(Client

2655

.client_defaults)

1860

2656

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

1861

2657

"clients.conf"))

1862

2658

1863

2659

global mandos_dbus_service

1864

2660

mandos_dbus_service = None

1865

2661

1866

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

1867

server_settings["port"]),

1868

ClientHandler,

1869

interface=(server_settings["interface"]

1870

or None),

1871

use_ipv6=use_ipv6,

1872

gnutls_priority=

1873

server_settings["priority"],

1874

use_dbus=use_dbus)

1875

if not debug:

1876

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

1877

2678

try:

1878

pidfile = open(pidfilename, "w")

1879

except IOError:

1880

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)

1881

2683

1882

try:

1883

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

1884

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

1885

except KeyError:

2684

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

1886

2685

try:

1887

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

1888

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

2686

uid = pwd.getpwnam(name).pw_uid

2687

gid = pwd.getpwnam(name).pw_gid

2688

break

1889

2689

except KeyError:

1890

try:

1891

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

1892

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

1893

except KeyError:

1894

uid = 65534

1895

gid = 65534

2690

continue

2691

else:

2692

uid = 65534

2693

gid = 65534

1896

2694

try:

1897

2695

os.setgid(gid)

1898

2696

os.setuid(uid)

1899

2697

except OSError as error:

1900

if error[0] != errno.EPERM:

1901

raise error

2698

if error.errno != errno.EPERM:

2699

raise

1902

2700

1903

if not debug and not debuglevel:

1904

syslogger.setLevel(logging.WARNING)

1905

console.setLevel(logging.WARNING)

1906

if debuglevel:

1907

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

1908

syslogger.setLevel(level)

1909

console.setLevel(level)

1910

1911

2701

if debug:

1912

2702

# Enable all possible GnuTLS debugging

1913

2703

1919

2709

def debug_gnutls(level, string):

1920

2710

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

1921

2711

1922

(gnutls.library.functions

1923

.gnutls_global_set_log_function(debug_gnutls))

2712

gnutls.library.functions.gnutls_global_set_log_function(

2713

debug_gnutls)

1924

2714

1925

2715

# Redirect stdin so all checkers get /dev/null

1926

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

2716

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

1927

2717

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

1928

2718

if null > 2:

1929

2719

os.close(null)

1930

else:

1931

# No console logging

1932

logger.removeHandler(console)

1933

2720

1934

2721

# Need to fork before connecting to D-Bus

1935

if not debug:

2722

if not foreground:

1936

2723

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

1937

2724

daemon()

1938

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

1939

2730

global main_loop

1940

2731

# From the Avahi example code

1941

DBusGMainLoop(set_as_default=True )

2732

DBusGMainLoop(set_as_default=True)

1942

2733

main_loop = gobject.MainLoop()

1943

2734

bus = dbus.SystemBus()

1944

2735

# End of Avahi example code

1945

2736

if use_dbus:

1946

2737

try:

1947

bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",

1948

bus, do_not_queue=True)

1949

except dbus.exceptions.NameExistsException as e:

1950

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

2738

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

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)

1951

2746

use_dbus = False

1952

2747

server_settings["use_dbus"] = False

1953

2748

tcp_server.use_dbus = False

1954

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1955

service = AvahiService(name = server_settings["servicename"],

1956

servicetype = "_mandos._tcp",

1957

protocol = protocol, bus = bus)

1958

if server_settings["interface"]:

1959

service.interface = (if_nametoindex

1960

(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"))

1961

2759

1962

2760

global multiprocessing_manager

1963

2761

multiprocessing_manager = multiprocessing.Manager()

1965

2763

client_class = Client

1966

2764

if use_dbus:

1967

2765

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

1968

def client_config_items(config, section):

1969

special_settings = {

1970

"approved_by_default":

1971

lambda: config.getboolean(section,

1972

"approved_by_default"),

1973

}

1974

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

2766

2767

client_settings = Client.config_parser(client_config)

2768

old_client_settings = {}

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

2778

2779

# Get client data and settings from last running state.

2780

if server_settings["restore"]:

2781

try:

2782

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

2783

clients_data, old_client_settings = pickle.load(

2784

stored_state)

2785

os.remove(stored_state_path)

2786

except IOError as e:

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)

2793

raise

2794

except EOFError as e:

2795

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

2796

"EOFError:",

2797

exc_info=e)

2798

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

2804

2805

# Decide which value to use after restoring saved state.

2806

# We have three different values: Old config file,

2807

# new config file, and saved state.

2808

# New config value takes precedence if it differs from old

2809

# config value, otherwise use saved state.

2810

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

2811

try:

2812

# For each value in new config, check if it

2813

# differs from the old config value (Except for

2814

# the "secret" attribute)

2815

if (name != "secret"

2816

and (value !=

2817

old_client_settings[client_name][name])):

2818

client[name] = value

2819

except KeyError:

2820

pass

2821

2822

# Clients who has passed its expire date can still be

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"]))

2842

client["enabled"] = False

2843

else:

2844

client["expires"] = (

2845

datetime.datetime.utcnow()

2846

+ client["timeout"])

2847

logger.debug("Last checker succeeded,"

2848

" keeping {} enabled".format(

2849

client_name))

1975

2850

try:

1976

yield (name, special_settings[name]())

1977

except KeyError:

1978

yield (name, value)

1979

1980

tcp_server.clients.update(set(

1981

client_class(name = section,

1982

config= dict(client_config_items(

1983

client_config, section)))

1984

for section in client_config.sections()))

2851

client["secret"] = pgp.decrypt(

2852

client["encrypted_secret"],

2853

client_settings[client_name]["secret"])

2854

except PGPError:

2855

# If decryption fails, we use secret from new settings

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)

2875

1985

2876

if not tcp_server.clients:

1986

2877

logger.warning("No clients defined")

1987

1988

if not debug:

1989

try:

1990

with pidfile:

1991

pid = os.getpid()

1992

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

1993

del pidfile

1994

except IOError:

1995

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

1996

pidfilename, pid)

1997

except NameError:

1998

# "pidfile" was never created

1999

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

2000

2889

del pidfilename

2001

2002

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

2003

2890

2004

2891

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

2005

2892

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

2006

2893

2007

2894

if use_dbus:

2008

class MandosDBusService(dbus.service.Object):

2895

2896

@alternate_dbus_interfaces(

2897

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

2898

class MandosDBusService(DBusObjectWithObjectManager):

2009

2899

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

2900

2010

2901

def __init__(self):

2011

2902

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

2012

_interface = "se.bsnet.fukt.Mandos"

2903

2904

_interface = "se.recompile.Mandos"

2013

2905

2014

2906

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

2015

2907

def ClientAdded(self, objpath):

2021

2913

"D-Bus signal"

2022

2914

pass

2023

2915

2916

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

2917

"true"})

2024

2918

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

2025

2919

def ClientRemoved(self, objpath, name):

2026

2920

"D-Bus signal"

2027

2921

pass

2028

2922

2923

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

2924

"true"})

2029

2925

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

2030

2926

def GetAllClients(self):

2031

2927

"D-Bus method"

2032

return dbus.Array(c.dbus_object_path

2033

for c in tcp_server.clients)

2928

return dbus.Array(c.dbus_object_path for c in

2929

tcp_server.clients.itervalues())

2034

2930

2931

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

2932

"true"})

2035

2933

@dbus.service.method(_interface,

2036

2934

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

2037

2935

def GetAllClientsWithProperties(self):

2038

2936

"D-Bus method"

2039

2937

return dbus.Dictionary(

2040

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

2041

for c in tcp_server.clients),

2938

{ c.dbus_object_path: c.GetAll(

2939

"se.recompile.Mandos.Client")

2940

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

2042

2941

signature="oa{sv}")

2043

2942

2044

2943

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

2045

2944

def RemoveClient(self, object_path):

2046

2945

"D-Bus method"

2047

for c in tcp_server.clients:

2946

for c in tcp_server.clients.itervalues():

2048

2947

if c.dbus_object_path == object_path:

2049

tcp_server.clients.remove(c)

2948

del tcp_server.clients[c.name]

2050

2949

c.remove_from_connection()

2051

# Don't signal anything except ClientRemoved

2950

# Don't signal the disabling

2052

2951

c.disable(quiet=True)

2053

# Emit D-Bus signal

2054

self.ClientRemoved(object_path, c.name)

2952

# Emit D-Bus signal for removal

2953

self.client_removed_signal(c)

2055

2954

return

2056

2955

raise KeyError(object_path)

2057

2956

2058

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)

2059

2994

2060

2995

mandos_dbus_service = MandosDBusService()

2061

2996

2062

2997

def cleanup():

2063

2998

"Cleanup function; run on exit"

2064

service.cleanup()

2065

2999

if zeroconf:

3000

service.cleanup()

3001

3002

multiprocessing.active_children()

3003

wnull.close()

3004

if not (tcp_server.clients or client_settings):

3005

return

3006

3007

# Store client before exiting. Secrets are encrypted with key

3008

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

3009

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

3010

clients = {}

3011

with PGPEngine() as pgp:

3012

for client in tcp_server.clients.itervalues():

3013

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

3014

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

3015

key)

3016

client_dict = {}

3017

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

3024

exclude.add(name)

3025

3026

client_dict["encrypted_secret"] = (client

3027

.encrypted_secret)

3028

for attr in client.client_structure:

3029

if attr not in exclude:

3030

client_dict[attr] = getattr(client, attr)

3031

3032

clients[client.name] = client_dict

3033

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

3034

3035

try:

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:

3042

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

3043

tempname = stored_state.name

3044

os.rename(tempname, stored_state_path)

3045

except (IOError, OSError) as e:

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)

3057

raise

3058

3059

# Delete all clients, and settings from config

2066

3060

while tcp_server.clients:

2067

client = tcp_server.clients.pop()

3061

name, client = tcp_server.clients.popitem()

2068

3062

if use_dbus:

2069

3063

client.remove_from_connection()

2070

client.disable_hook = None

2071

# Don't signal anything except ClientRemoved

3064

# Don't signal the disabling

2072

3065

client.disable(quiet=True)

2073

if use_dbus:

2074

# Emit D-Bus signal

2075

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2076

client.name)

3066

# Emit D-Bus signal for removal

3067

mandos_dbus_service.client_removed_signal(client)

3068

client_settings.clear()

2077

3069

2078

3070

atexit.register(cleanup)

2079

3071

2080

for client in tcp_server.clients:

3072

for client in tcp_server.clients.itervalues():

2081

3073

if use_dbus:

2082

# Emit D-Bus signal

2083

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2084

client.enable()

3074

# Emit D-Bus signal for adding

3075

mandos_dbus_service.client_added_signal(client)

3076

# Need to initiate checking of clients

3077

if client.enabled:

3078

client.init_checker()

2085

3079

2086

3080

tcp_server.enable()

2087

3081

tcp_server.server_activate()

2088

3082

2089

3083

# Find out what port we got

2090

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

3084

if zeroconf:

3085

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

2091

3086

if use_ipv6:

2092

3087

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

2093

" flowinfo %d, scope_id %d"

2094

% tcp_server.socket.getsockname())

3088

" flowinfo %d, scope_id %d",

3089

*tcp_server.socket.getsockname())

2095

3090

else: # IPv4

2096

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

2097

% tcp_server.socket.getsockname())

3091

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

3092

*tcp_server.socket.getsockname())

2098

3093

2099

3094

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

2100

3095

2101

3096

try:

2102

# From the Avahi example code

2103

try:

2104

service.activate()

2105

except dbus.exceptions.DBusException as error:

2106

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

2107

cleanup()

2108

sys.exit(1)

2109

# 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

2110

3106

2111

3107

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

2112

3108

lambda *args, **kwargs:

2116

3112

logger.debug("Starting main loop")

2117

3113

main_loop.run()

2118

3114

except AvahiError as error:

2119

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

3115

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

2120

3116

cleanup()

2121

3117

sys.exit(1)

2122

3118

except KeyboardInterrupt:

2127

3123

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

2128

3124

cleanup()

2129

3125

3126

2130

3127

if __name__ == '__main__':

2131

3128

main()