/mandos/release : revision 237.7.333

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

import optparse

44

import argparse

40

45

import datetime

41

46

import errno

42

47

import gnutls.crypto

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

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

151

294

self.group = None # our entry group

152

295

self.server = None

153

296

self.bus = bus

154

def rename(self):

297

self.entry_group_state_changed_match = None

298

299

def rename(self, remove=True):

155

300

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

156

301

if self.rename_count >= self.max_renames:

157

302

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

158

303

" after %i retries, exiting.",

159

304

self.rename_count)

160

305

raise AvahiServiceError("Too many renames")

161

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

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

162

309

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

163

310

self.name)

164

syslogger.setFormatter(logging.Formatter

165

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

166

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

167

% self.name))

168

self.remove()

311

if remove:

312

self.remove()

169

313

try:

170

314

self.add()

171

except dbus.exceptions.DBusException, error:

172

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

173

self.cleanup()

174

os._exit(1)

175

self.rename_count += 1

315

except dbus.exceptions.DBusException as error:

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

176

325

def remove(self):

177

326

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

327

if self.entry_group_state_changed_match is not None:

328

self.entry_group_state_changed_match.remove()

329

self.entry_group_state_changed_match = None

178

330

if self.group is not None:

179

331

self.group.Reset()

332

180

333

def add(self):

181

334

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

335

self.remove()

182

336

if self.group is None:

183

337

self.group = dbus.Interface(

184

338

self.bus.get_object(avahi.DBUS_NAME,

185

339

self.server.EntryGroupNew()),

186

340

avahi.DBUS_INTERFACE_ENTRY_GROUP)

187

self.group.connect_to_signal('StateChanged',

188

self

189

.entry_group_state_changed)

341

self.entry_group_state_changed_match = (

342

self.group.connect_to_signal(

343

'StateChanged', self.entry_group_state_changed))

190

344

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

191

345

self.name, self.type)

192

346

self.group.AddService(

198

352

dbus.UInt16(self.port),

199

353

avahi.string_array_to_txt_array(self.TXT))

200

354

self.group.Commit()

355

201

356

def entry_group_state_changed(self, state, error):

202

357

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

203

358

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

209

364

self.rename()

210

365

elif state == avahi.ENTRY_GROUP_FAILURE:

211

366

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

212

unicode(error))

213

raise AvahiGroupError("State changed: %s"

214

% unicode(error))

367

str(error))

368

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

369

215

370

def cleanup(self):

216

371

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

217

372

if self.group is not None:

218

self.group.Free()

373

try:

374

self.group.Free()

375

except (dbus.exceptions.UnknownMethodException,

376

dbus.exceptions.DBusException):

377

pass

219

378

self.group = None

220

def server_state_changed(self, state):

379

self.remove()

380

381

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

221

382

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

222

383

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

223

if state == avahi.SERVER_COLLISION:

224

logger.error("Zeroconf server name collision")

225

self.remove()

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

}

390

if state in bad_states:

391

if bad_states[state] is not None:

392

if error is None:

393

logger.error(bad_states[state])

394

else:

395

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

396

self.cleanup()

226

397

elif state == avahi.SERVER_RUNNING:

227

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)

410

else:

411

if error is None:

412

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

413

else:

414

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

415

228

416

def activate(self):

229

417

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

230

418

if self.server is None:

231

419

self.server = dbus.Interface(

232

420

self.bus.get_object(avahi.DBUS_NAME,

233

avahi.DBUS_PATH_SERVER),

421

avahi.DBUS_PATH_SERVER,

422

follow_name_owner_changes=True),

234

423

avahi.DBUS_INTERFACE_SERVER)

235

424

self.server.connect_to_signal("StateChanged",

236

self.server_state_changed)

425

self.server_state_changed)

237

426

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

238

427

239

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

240

448

class Client(object):

241

449

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

242

450

243

451

Attributes:

244

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

452

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

245

453

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

246

454

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

247

455

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

254

462

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

255

463

checker_initiator_tag: a gobject event source tag, or None

256

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

257

467

current_checker_command: string; current running checker_command

258

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

259

468

disable_initiator_tag: a gobject event source tag, or None

260

469

enabled: bool()

261

470

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

264

473

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

265

474

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

266

475

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

267

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

268

482

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

269

483

D-Bus identifiers

270

484

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

271

485

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

272

486

until this client is disabled

487

extended_timeout: extra long timeout when secret has been sent

273

488

runtime_expansions: Allowed attributes for runtime expansion.

489

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

490

disabled, or None

491

server_settings: The server_settings dict from main()

274

492

"""

275

493

276

494

runtime_expansions = ("approval_delay", "approval_duration",

277

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

278

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

495

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

496

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

497

"last_approval_request", "last_checked_ok",

279

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

}

280

510

281

511

@staticmethod

282

def _timedelta_to_milliseconds(td):

283

"Convert a datetime.timedelta() to milliseconds"

284

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

285

+ (td.seconds * 1000)

286

+ (td.microseconds // 1000))

287

288

def timeout_milliseconds(self):

289

"Return the 'timeout' attribute in milliseconds"

290

return self._timedelta_to_milliseconds(self.timeout)

291

292

def interval_milliseconds(self):

293

"Return the 'interval' attribute in milliseconds"

294

return self._timedelta_to_milliseconds(self.interval)

295

296

def approval_delay_milliseconds(self):

297

return self._timedelta_to_milliseconds(self.approval_delay)

298

299

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

300

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

301

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

302

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

303

562

self.name = name

304

if config is None:

305

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

306

580

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

307

# Uppercase and remove spaces from fingerprint for later

308

# comparison purposes with return value from the fingerprint()

309

# function

310

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

311

.replace(" ", ""))

312

581

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

313

if "secret" in config:

314

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

315

elif "secfile" in config:

316

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

317

(config["secfile"])),

318

"rb") as secfile:

319

self.secret = secfile.read()

320

else:

321

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

322

% self.name)

323

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

324

self.created = datetime.datetime.utcnow()

325

self.enabled = False

326

self.last_approval_request = None

327

self.last_enabled = None

328

self.last_checked_ok = None

329

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

330

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

331

self.disable_hook = disable_hook

582

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

583

datetime.datetime.utcnow())

584

585

# attributes specific for this server instance

332

586

self.checker = None

333

587

self.checker_initiator_tag = None

334

588

self.disable_initiator_tag = None

335

589

self.checker_callback_tag = None

336

self.checker_command = config["checker"]

337

590

self.current_checker_command = None

338

self.last_connect = None

339

self._approved = None

340

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

341

True)

591

self.approved = None

342

592

self.approvals_pending = 0

343

self.approval_delay = string_to_delta(

344

config["approval_delay"])

345

self.approval_duration = string_to_delta(

346

config["approval_duration"])

347

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)

348

604

605

# Send notice to process children that client state has changed

349

606

def send_changedstate(self):

350

self.changedstate.acquire()

351

self.changedstate.notify_all()

352

self.changedstate.release()

353

607

with self.changedstate:

608

self.changedstate.notify_all()

609

354

610

def enable(self):

355

611

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

356

612

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

357

613

# Already enabled

358

614

return

359

self.send_changedstate()

615

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

616

self.enabled = True

360

617

self.last_enabled = datetime.datetime.utcnow()

361

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

362

# and every interval from then on.

363

self.checker_initiator_tag = (gobject.timeout_add

364

(self.interval_milliseconds(),

365

self.start_checker))

366

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

367

self.disable_initiator_tag = (gobject.timeout_add

368

(self.timeout_milliseconds(),

369

self.disable))

370

self.enabled = True

371

# Also start a new checker *right now*.

372

self.start_checker()

618

self.init_checker()

619

self.send_changedstate()

373

620

374

621

def disable(self, quiet=True):

375

622

"""Disable this client."""

376

623

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

377

624

return False

378

625

if not quiet:

379

self.send_changedstate()

380

if not quiet:

381

626

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

382

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

627

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

383

628

gobject.source_remove(self.disable_initiator_tag)

384

629

self.disable_initiator_tag = None

385

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

630

self.expires = None

631

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

386

632

gobject.source_remove(self.checker_initiator_tag)

387

633

self.checker_initiator_tag = None

388

634

self.stop_checker()

389

if self.disable_hook:

390

self.disable_hook(self)

391

635

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

392

638

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

393

639

return False

394

640

395

641

def __del__(self):

396

self.disable_hook = None

397

642

self.disable()

398

643

399

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

400

662

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

401

663

self.checker_callback_tag = None

402

664

self.checker = None

403

if os.WIFEXITED(condition):

404

exitstatus = os.WEXITSTATUS(condition)

405

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:

406

673

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

407

674

vars(self))

408

675

self.checked_ok()

409

676

else:

410

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

411

vars(self))

677

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

412

678

else:

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

413

681

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

414

682

vars(self))

683

return False

415

684

416

685

def checked_ok(self):

417

"""Bump up the timeout for this client.

418

419

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

420

alive and well.

421

"""

686

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

422

687

self.last_checked_ok = datetime.datetime.utcnow()

423

gobject.source_remove(self.disable_initiator_tag)

424

self.disable_initiator_tag = (gobject.timeout_add

425

(self.timeout_milliseconds(),

426

self.disable))

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

694

if timeout is None:

695

timeout = self.timeout

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

427

703

428

704

def need_approval(self):

429

705

self.last_approval_request = datetime.datetime.utcnow()

434

710

If a checker already exists, leave it running and do

435

711

nothing."""

436

712

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

437

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

438

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

439

# client would inevitably timeout, since no checker would get

440

# 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

441

717

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

442

718

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

443

719

# should be.

444

720

445

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

446

try:

447

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

448

except (AttributeError, OSError), error:

449

if (isinstance(error, OSError)

450

and error.errno != errno.ECHILD):

451

raise error

452

else:

453

if pid:

454

logger.warning("Checker was a zombie")

455

gobject.source_remove(self.checker_callback_tag)

456

self.checker_callback(pid, status,

457

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

458

725

# Start a new checker if needed

459

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 }

460

731

try:

461

# In case checker_command has exactly one % operator

462

command = self.checker_command % self.host

463

except TypeError:

464

# Escape attributes for the shell

465

escaped_attrs = dict(

466

(attr,

467

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

468

errors=

469

'replace')))

470

for attr in

471

self.runtime_expansions)

472

473

try:

474

command = self.checker_command % escaped_attrs

475

except TypeError, error:

476

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

477

' %s', self.checker_command, error)

478

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

479

738

self.current_checker_command = command

480

try:

481

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

482

command, self.name)

483

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

484

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

485

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

486

# always replaced by /dev/null.)

487

self.checker = subprocess.Popen(command,

488

close_fds=True,

489

shell=True, cwd="/")

490

self.checker_callback_tag = (gobject.child_watch_add

491

(self.checker.pid,

492

self.checker_callback,

493

data=command))

494

# The checker may have completed before the gobject

495

# watch was added. Check for this.

496

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

497

if pid:

498

gobject.source_remove(self.checker_callback_tag)

499

self.checker_callback(pid, status, command)

500

except OSError, error:

501

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

502

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)

503

764

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

504

765

return True

505

766

511

772

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

512

773

return

513

774

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

514

try:

515

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

516

#time.sleep(0.5)

517

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

518

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

519

except OSError, error:

520

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

521

raise

775

self.checker.terminate()

522

776

self.checker = None

523

777

524

def dbus_service_property(dbus_interface, signature="v",

525

access="readwrite", byte_arrays=False):

778

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

526

783

"""Decorators for marking methods of a DBusObjectWithProperties to

527

784

become properties on the D-Bus.

528

785

537

794

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

538

795

if byte_arrays and signature != "ay":

539

796

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

540

" signature %r" % signature)

797

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

798

541

799

def decorator(func):

542

800

func._dbus_is_property = True

543

801

func._dbus_interface = dbus_interface

548

806

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

549

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

550

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

551

853

return decorator

552

854

553

855

554

856

class DBusPropertyException(dbus.exceptions.DBusException):

555

857

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

556

858

"""

557

def __unicode__(self):

558

return unicode(str(self))

859

pass

559

860

560

861

561

862

class DBusPropertyAccessException(DBusPropertyException):

570

871

pass

571

872

572

873

573

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

574

964

"""A D-Bus object with properties.

575

965

576

966

Classes inheriting from this can use the dbus_service_property

577

967

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

578

968

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

579

969

"""

580

970

581

@staticmethod

582

def _is_dbus_property(obj):

583

return getattr(obj, "_dbus_is_property", False)

584

585

def _get_all_dbus_properties(self):

586

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

587

"""

588

return ((prop._dbus_name, prop)

589

for name, prop in

590

inspect.getmembers(self, self._is_dbus_property))

591

592

971

def _get_dbus_property(self, interface_name, property_name):

593

972

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

594

973

property with the specified name and interface.

595

974

"""

596

for name in (property_name,

597

property_name + "_dbus_property"):

598

prop = getattr(self, name, None)

599

if (prop is None

600

or not self._is_dbus_property(prop)

601

or prop._dbus_name != property_name

602

or (interface_name and prop._dbus_interface

603

and interface_name != prop._dbus_interface)):

604

continue

605

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

606

982

# No such property

607

raise DBusPropertyNotFound(self.dbus_object_path + ":"

608

+ interface_name + "."

609

+ property_name)

610

611

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

612

997

out_signature="v")

613

998

def Get(self, interface_name, property_name):

614

999

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

632

1017

# The byte_arrays option is not supported yet on

633

1018

# signatures other than "ay".

634

1019

if prop._dbus_signature != "ay":

635

raise ValueError

636

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

637

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

638

1025

prop(value)

639

1026

640

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

1027

@dbus.service.method(dbus.PROPERTIES_IFACE,

1028

in_signature="s",

641

1029

out_signature="a{sv}")

642

1030

def GetAll(self, interface_name):

643

1031

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

644

1032

standard.

645

1033

646

1034

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

647

1035

"""

648

all = {}

649

for name, prop in self._get_all_dbus_properties():

1036

properties = {}

1037

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

650

1038

if (interface_name

651

1039

and interface_name != prop._dbus_interface):

652

1040

# Interface non-empty but did not match

656

1044

continue

657

1045

value = prop()

658

1046

if not hasattr(value, "variant_level"):

659

all[name] = value

1047

properties[name] = value

660

1048

continue

661

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

662

value.variant_level+1)

663

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

664

1060

665

1061

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

666

1062

out_signature="s",

667

1063

path_keyword='object_path',

668

1064

connection_keyword='connection')

669

1065

def Introspect(self, object_path, connection):

670

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

671

1069

"""

672

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

673

connection)

1070

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1071

object_path,

1072

connection)

674

1073

try:

675

1074

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

1075

676

1076

def make_tag(document, name, prop):

677

1077

e = document.createElement("property")

678

1078

e.setAttribute("name", name)

679

1079

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

680

1080

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

681

1081

return e

1082

682

1083

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

1084

# Add property tags

683

1085

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

684

1086

for name, prop

685

in self._get_all_dbus_properties()

1087

in self._get_all_dbus_things("property")

686

1088

if prop._dbus_interface

687

1089

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

688

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)

689

1107

# Add the names to the return values for the

690

1108

# "org.freedesktop.DBus.Properties" methods

691

1109

if (if_tag.getAttribute("name")

704

1122

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

705

1123

document.unlink()

706

1124

except (AttributeError, xml.dom.DOMException,

707

xml.parsers.expat.ExpatError), error:

708

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

709

error)

710

return xmlstring

711

712

1125

xml.parsers.expat.ExpatError) as error:

1126

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

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,

1158

signature = "oas")

1159

def InterfacesRemoved(self, object_path, interfaces):

1160

pass

1161

1162

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1163

out_signature = "s",

1164

path_keyword = 'object_path',

1165

connection_keyword = 'connection')

1166

def Introspect(self, object_path, connection):

1167

"""Overloading of standard D-Bus method.

1168

1169

Override return argument name of GetManagedObjects to be

1170

"objpath_interfaces_and_properties"

1171

"""

1172

xmlstring = DBusObjectWithAnnotations(self, 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

def call_both(*args, **kwargs):

1295

"""This function will emit two D-Bus

1296

signals by calling func1 and func2"""

1297

func1(*args, **kwargs)

1298

func2(*args, **kwargs)

1299

1300

return call_both

1301

# Create the "call_both" function and add it to

1302

# the class

1303

attr[attrname] = fixscope(attribute, new_function)

1304

# Is this a D-Bus method?

1305

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

1306

# Create a new, but exactly alike, function

1307

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

1308

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

1309

# to the class.

1310

attr[attrname] = (

1311

dbus.service.method(

1312

alt_interface,

1313

attribute._dbus_in_signature,

1314

attribute._dbus_out_signature)

1315

(types.FunctionType(attribute.func_code,

1316

attribute.func_globals,

1317

attribute.func_name,

1318

attribute.func_defaults,

1319

attribute.func_closure)))

1320

# Copy annotations, if any

1321

try:

1322

attr[attrname]._dbus_annotations = dict(

1323

attribute._dbus_annotations)

1324

except AttributeError:

1325

pass

1326

# Is this a D-Bus property?

1327

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

1328

# Create a new, but exactly alike, function

1329

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

1330

# property with the alternate D-Bus interface

1331

# name. Add it to the class.

1332

attr[attrname] = (dbus_service_property(

1333

alt_interface, attribute._dbus_signature,

1334

attribute._dbus_access,

1335

attribute._dbus_get_args_options

1336

["byte_arrays"])

1337

(types.FunctionType(

1338

attribute.func_code,

1339

attribute.func_globals,

1340

attribute.func_name,

1341

attribute.func_defaults,

1342

attribute.func_closure)))

1343

# Copy annotations, if any

1344

try:

1345

attr[attrname]._dbus_annotations = dict(

1346

attribute._dbus_annotations)

1347

except AttributeError:

1348

pass

1349

# Is this a D-Bus interface?

1350

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

1351

# Create a new, but exactly alike, function

1352

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

1353

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

1354

# to the class.

1355

attr[attrname] = (

1356

dbus_interface_annotations(alt_interface)

1357

(types.FunctionType(attribute.func_code,

1358

attribute.func_globals,

1359

attribute.func_name,

1360

attribute.func_defaults,

1361

attribute.func_closure)))

1362

if deprecate:

1363

# Deprecate all alternate interfaces

1364

iname="_AlternateDBusNames_interface_annotation{}"

1365

for interface_name in interface_names:

1366

1367

@dbus_interface_annotations(interface_name)

1368

def func(self):

1369

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

1370

"true" }

1371

# Find an unused name

1372

for aname in (iname.format(i)

1373

for i in itertools.count()):

1374

if aname not in attr:

1375

attr[aname] = func

1376

break

1377

if interface_names:

1378

# Replace the class with a new subclass of it with

1379

# methods, signals, etc. as created above.

1380

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

1381

(cls, ), attr)

1382

return cls

1383

1384

return wrapper

1385

1386

1387

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

1388

"se.bsnet.fukt.Mandos"})

713

1389

class ClientDBus(Client, DBusObjectWithProperties):

714

1390

"""A Client class using D-Bus

715

1391

719

1395

"""

720

1396

721

1397

runtime_expansions = (Client.runtime_expansions

722

+ ("dbus_object_path",))

1398

+ ("dbus_object_path", ))

1399

1400

_interface = "se.recompile.Mandos.Client"

723

1401

724

1402

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

725

1403

726

1404

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

727

self._approvals_pending = 0

728

1405

self.bus = bus

729

1406

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

730

1407

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

731

1408

# the D-Bus

732

client_object_name = unicode(self.name).translate(

1409

client_object_name = str(self.name).translate(

733

1410

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

734

1411

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

735

self.dbus_object_path = (dbus.ObjectPath

736

("/clients/" + client_object_name))

1412

self.dbus_object_path = dbus.ObjectPath(

1413

"/clients/" + client_object_name)

737

1414

DBusObjectWithProperties.__init__(self, self.bus,

738

1415

self.dbus_object_path)

739

740

def _get_approvals_pending(self):

741

return self._approvals_pending

742

def _set_approvals_pending(self, value):

743

old_value = self._approvals_pending

744

self._approvals_pending = value

745

bval = bool(value)

746

if (hasattr(self, "dbus_object_path")

747

and bval is not bool(old_value)):

748

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

749

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

750

dbus_bool)

751

752

approvals_pending = property(_get_approvals_pending,

753

_set_approvals_pending)

754

del _get_approvals_pending, _set_approvals_pending

755

756

@staticmethod

757

def _datetime_to_dbus(dt, variant_level=0):

758

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

759

return dbus.String(dt.isoformat(),

760

variant_level=variant_level)

761

762

def enable(self):

763

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

764

r = Client.enable(self)

765

if oldstate != self.enabled:

766

# Emit D-Bus signals

767

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

768

dbus.Boolean(True, variant_level=1))

769

self.PropertyChanged(

770

dbus.String("LastEnabled"),

771

self._datetime_to_dbus(self.last_enabled,

772

variant_level=1))

773

return r

774

775

def disable(self, quiet = False):

776

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

777

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

778

if not quiet and oldstate != self.enabled:

779

# Emit D-Bus signal

780

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

781

dbus.Boolean(False, variant_level=1))

782

return r

1416

1417

def notifychangeproperty(transform_func, dbus_name,

1418

type_func=lambda x: x,

1419

variant_level=1,

1420

invalidate_only=False,

1421

_interface=_interface):

1422

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

1423

its changes to DBus.

1424

1425

transform_fun: Function that takes a value and a variant_level

1426

and transforms it to a D-Bus type.

1427

dbus_name: D-Bus name of the variable

1428

type_func: Function that transform the value before sending it

1429

to the D-Bus. Default: no transform

1430

variant_level: D-Bus variant level. Default: 1

1431

"""

1432

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

1433

1434

def setter(self, value):

1435

if hasattr(self, "dbus_object_path"):

1436

if (not hasattr(self, attrname) or

1437

type_func(getattr(self, attrname, None))

1438

!= type_func(value)):

1439

if invalidate_only:

1440

self.PropertiesChanged(

1441

_interface, dbus.Dictionary(),

1442

dbus.Array((dbus_name, )))

1443

else:

1444

dbus_value = transform_func(

1445

type_func(value),

1446

variant_level = variant_level)

1447

self.PropertyChanged(dbus.String(dbus_name),

1448

dbus_value)

1449

self.PropertiesChanged(

1450

_interface,

1451

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

1452

dbus_value }),

1453

dbus.Array())

1454

setattr(self, attrname, value)

1455

1456

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

1457

1458

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1459

approvals_pending = notifychangeproperty(dbus.Boolean,

1460

"ApprovalPending",

1461

type_func = bool)

1462

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

1463

last_enabled = notifychangeproperty(datetime_to_dbus,

1464

"LastEnabled")

1465

checker = notifychangeproperty(

1466

dbus.Boolean, "CheckerRunning",

1467

type_func = lambda checker: checker is not None)

1468

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1469

"LastCheckedOK")

1470

last_checker_status = notifychangeproperty(dbus.Int16,

1471

"LastCheckerStatus")

1472

last_approval_request = notifychangeproperty(

1473

datetime_to_dbus, "LastApprovalRequest")

1474

approved_by_default = notifychangeproperty(dbus.Boolean,

1475

"ApprovedByDefault")

1476

approval_delay = notifychangeproperty(

1477

dbus.UInt64, "ApprovalDelay",

1478

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

1479

approval_duration = notifychangeproperty(

1480

dbus.UInt64, "ApprovalDuration",

1481

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

1482

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

1483

timeout = notifychangeproperty(

1484

dbus.UInt64, "Timeout",

1485

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

1486

extended_timeout = notifychangeproperty(

1487

dbus.UInt64, "ExtendedTimeout",

1488

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

1489

interval = notifychangeproperty(

1490

dbus.UInt64, "Interval",

1491

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

1492

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

1493

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

1494

invalidate_only=True)

1495

1496

del notifychangeproperty

783

1497

784

1498

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

785

1499

try:

790

1504

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

791

1505

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

792

1506

793

def checker_callback(self, pid, condition, command,

794

*args, **kwargs):

795

self.checker_callback_tag = None

796

self.checker = None

797

# Emit D-Bus signal

798

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

799

dbus.Boolean(False, variant_level=1))

800

if os.WIFEXITED(condition):

801

exitstatus = os.WEXITSTATUS(condition)

1507

def checker_callback(self, source, condition,

1508

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

1509

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

1510

connection, command, *args,

1511

**kwargs)

1512

exitstatus = self.last_checker_status

1513

if exitstatus >= 0:

802

1514

# Emit D-Bus signal

803

1515

self.CheckerCompleted(dbus.Int16(exitstatus),

804

dbus.Int64(condition),

1516

# This is specific to GNU libC

1517

dbus.Int64(exitstatus << 8),

805

1518

dbus.String(command))

806

1519

else:

807

1520

# Emit D-Bus signal

808

1521

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

809

dbus.Int64(condition),

1522

dbus.Int64(

1523

# This is specific to GNU libC

1524

(exitstatus << 8)

1525

| self.last_checker_signal),

810

1526

dbus.String(command))

811

812

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

813

*args, **kwargs)

814

815

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

816

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

817

# Emit D-Bus signal

818

self.PropertyChanged(

819

dbus.String("LastCheckedOK"),

820

(self._datetime_to_dbus(self.last_checked_ok,

821

variant_level=1)))

822

return r

823

824

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

825

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

826

# Emit D-Bus signal

827

self.PropertyChanged(

828

dbus.String("LastApprovalRequest"),

829

(self._datetime_to_dbus(self.last_approval_request,

830

variant_level=1)))

831

return r

1527

return ret

832

1528

833

1529

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

834

old_checker = self.checker

835

if self.checker is not None:

836

old_checker_pid = self.checker.pid

837

else:

838

old_checker_pid = None

1530

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

839

1531

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

840

1532

# Only if new checker process was started

841

1533

if (self.checker is not None

842

1534

and old_checker_pid != self.checker.pid):

843

1535

# Emit D-Bus signal

844

1536

self.CheckerStarted(self.current_checker_command)

845

self.PropertyChanged(

846

dbus.String("CheckerRunning"),

847

dbus.Boolean(True, variant_level=1))

848

1537

return r

849

1538

850

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

851

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

852

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

853

if (old_checker is not None

854

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

855

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

856

dbus.Boolean(False, variant_level=1))

857

return r

858

859

1539

def _reset_approved(self):

860

self._approved = None

1540

self.approved = None

861

1541

return False

862

1542

863

1543

def approve(self, value=True):

1544

self.approved = value

1545

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

1546

* 1000), self._reset_approved)

864

1547

self.send_changedstate()

865

self._approved = value

866

gobject.timeout_add(self._timedelta_to_milliseconds

867

(self.approval_duration),

868

self._reset_approved)

869

870

1548

871

1549

## D-Bus methods, signals & properties

872

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

1550

1551

## Interfaces

873

1552

874

1553

## Signals

875

1554

886

1565

pass

887

1566

888

1567

# PropertyChanged - signal

1568

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

889

1569

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

890

1570

def PropertyChanged(self, property, value):

891

1571

"D-Bus signal"

922

1602

# CheckedOK - method

923

1603

@dbus.service.method(_interface)

924

1604

def CheckedOK(self):

925

return self.checked_ok()

1605

self.checked_ok()

926

1606

927

1607

# Enable - method

1608

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

928

1609

@dbus.service.method(_interface)

929

1610

def Enable(self):

930

1611

"D-Bus method"

931

1612

self.enable()

932

1613

933

1614

# StartChecker - method

1615

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

934

1616

@dbus.service.method(_interface)

935

1617

def StartChecker(self):

936

1618

"D-Bus method"

937

1619

self.start_checker()

938

1620

939

1621

# Disable - method

1622

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

940

1623

@dbus.service.method(_interface)

941

1624

def Disable(self):

942

1625

"D-Bus method"

943

1626

self.disable()

944

1627

945

1628

# StopChecker - method

1629

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

946

1630

@dbus.service.method(_interface)

947

1631

def StopChecker(self):

948

1632

self.stop_checker()

955

1639

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

956

1640

957

1641

# ApprovedByDefault - property

958

@dbus_service_property(_interface, signature="b",

1642

@dbus_service_property(_interface,

1643

signature="b",

959

1644

access="readwrite")

960

1645

def ApprovedByDefault_dbus_property(self, value=None):

961

1646

if value is None: # get

962

1647

return dbus.Boolean(self.approved_by_default)

963

1648

self.approved_by_default = bool(value)

964

# Emit D-Bus signal

965

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

966

dbus.Boolean(value, variant_level=1))

967

1649

968

1650

# ApprovalDelay - property

969

@dbus_service_property(_interface, signature="t",

1651

@dbus_service_property(_interface,

1652

signature="t",

970

1653

access="readwrite")

971

1654

def ApprovalDelay_dbus_property(self, value=None):

972

1655

if value is None: # get

973

return dbus.UInt64(self.approval_delay_milliseconds())

1656

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

1657

* 1000)

974

1658

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

975

# Emit D-Bus signal

976

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

977

dbus.UInt64(value, variant_level=1))

978

1659

979

1660

# ApprovalDuration - property

980

@dbus_service_property(_interface, signature="t",

1661

@dbus_service_property(_interface,

1662

signature="t",

981

1663

access="readwrite")

982

1664

def ApprovalDuration_dbus_property(self, value=None):

983

1665

if value is None: # get

984

return dbus.UInt64(self._timedelta_to_milliseconds(

985

self.approval_duration))

1666

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

1667

* 1000)

986

1668

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

987

# Emit D-Bus signal

988

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

989

dbus.UInt64(value, variant_level=1))

990

1669

991

1670

# Name - property

1671

@dbus_annotations(

1672

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

992

1673

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

993

1674

def Name_dbus_property(self):

994

1675

return dbus.String(self.name)

995

1676

996

1677

# Fingerprint - property

1678

@dbus_annotations(

1679

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

997

1680

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

998

1681

def Fingerprint_dbus_property(self):

999

1682

return dbus.String(self.fingerprint)

1000

1683

1001

1684

# Host - property

1002

@dbus_service_property(_interface, signature="s",

1685

@dbus_service_property(_interface,

1686

signature="s",

1003

1687

access="readwrite")

1004

1688

def Host_dbus_property(self, value=None):

1005

1689

if value is None: # get

1006

1690

return dbus.String(self.host)

1007

self.host = value

1008

# Emit D-Bus signal

1009

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

1010

dbus.String(value, variant_level=1))

1691

self.host = str(value)

1011

1692

1012

1693

# Created - property

1694

@dbus_annotations(

1695

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

1013

1696

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

1014

1697

def Created_dbus_property(self):

1015

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

1698

return datetime_to_dbus(self.created)

1016

1699

1017

1700

# LastEnabled - property

1018

1701

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

1019

1702

def LastEnabled_dbus_property(self):

1020

if self.last_enabled is None:

1021

return dbus.String("")

1022

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

1703

return datetime_to_dbus(self.last_enabled)

1023

1704

1024

1705

# Enabled - property

1025

@dbus_service_property(_interface, signature="b",

1706

@dbus_service_property(_interface,

1707

signature="b",

1026

1708

access="readwrite")

1027

1709

def Enabled_dbus_property(self, value=None):

1028

1710

if value is None: # get

1033

1715

self.disable()

1034

1716

1035

1717

# LastCheckedOK - property

1036

@dbus_service_property(_interface, signature="s",

1718

@dbus_service_property(_interface,

1719

signature="s",

1037

1720

access="readwrite")

1038

1721

def LastCheckedOK_dbus_property(self, value=None):

1039

1722

if value is not None:

1040

1723

self.checked_ok()

1041

1724

return

1042

if self.last_checked_ok is None:

1043

return dbus.String("")

1044

return dbus.String(self._datetime_to_dbus(self

1045

.last_checked_ok))

1725

return datetime_to_dbus(self.last_checked_ok)

1726

1727

# LastCheckerStatus - property

1728

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

1729

def LastCheckerStatus_dbus_property(self):

1730

return dbus.Int16(self.last_checker_status)

1731

1732

# Expires - property

1733

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

1734

def Expires_dbus_property(self):

1735

return datetime_to_dbus(self.expires)

1046

1736

1047

1737

# LastApprovalRequest - property

1048

1738

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

1049

1739

def LastApprovalRequest_dbus_property(self):

1050

if self.last_approval_request is None:

1051

return dbus.String("")

1052

return dbus.String(self.

1053

_datetime_to_dbus(self

1054

.last_approval_request))

1740

return datetime_to_dbus(self.last_approval_request)

1055

1741

1056

1742

# Timeout - property

1057

@dbus_service_property(_interface, signature="t",

1743

@dbus_service_property(_interface,

1744

signature="t",

1058

1745

access="readwrite")

1059

1746

def Timeout_dbus_property(self, value=None):

1060

1747

if value is None: # get

1061

return dbus.UInt64(self.timeout_milliseconds())

1748

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

1749

old_timeout = self.timeout

1062

1750

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

1063

# Emit D-Bus signal

1064

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

1065

dbus.UInt64(value, variant_level=1))

1066

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

1067

return

1068

# Reschedule timeout

1069

gobject.source_remove(self.disable_initiator_tag)

1070

self.disable_initiator_tag = None

1071

time_to_die = (self.

1072

_timedelta_to_milliseconds((self

1073

.last_checked_ok

1074

+ self.timeout)

1075

- datetime.datetime

1076

.utcnow()))

1077

if time_to_die <= 0:

1078

# The timeout has passed

1079

self.disable()

1080

else:

1081

self.disable_initiator_tag = (gobject.timeout_add

1082

(time_to_die, self.disable))

1751

# Reschedule disabling

1752

if self.enabled:

1753

now = datetime.datetime.utcnow()

1754

self.expires += self.timeout - old_timeout

1755

if self.expires <= now:

1756

# The timeout has passed

1757

self.disable()

1758

else:

1759

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

1760

is None):

1761

return

1762

gobject.source_remove(self.disable_initiator_tag)

1763

self.disable_initiator_tag = gobject.timeout_add(

1764

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

1765

self.disable)

1766

1767

# ExtendedTimeout - property

1768

@dbus_service_property(_interface,

1769

signature="t",

1770

access="readwrite")

1771

def ExtendedTimeout_dbus_property(self, value=None):

1772

if value is None: # get

1773

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

1774

* 1000)

1775

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

1083

1776

1084

1777

# Interval - property

1085

@dbus_service_property(_interface, signature="t",

1778

@dbus_service_property(_interface,

1779

signature="t",

1086

1780

access="readwrite")

1087

1781

def Interval_dbus_property(self, value=None):

1088

1782

if value is None: # get

1089

return dbus.UInt64(self.interval_milliseconds())

1783

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

1090

1784

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

1091

# Emit D-Bus signal

1092

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

1093

dbus.UInt64(value, variant_level=1))

1094

1785

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

1095

1786

return

1096

# Reschedule checker run

1097

gobject.source_remove(self.checker_initiator_tag)

1098

self.checker_initiator_tag = (gobject.timeout_add

1099

(value, self.start_checker))

1100

self.start_checker() # Start one now, too

1101

1787

if self.enabled:

1788

# Reschedule checker run

1789

gobject.source_remove(self.checker_initiator_tag)

1790

self.checker_initiator_tag = gobject.timeout_add(

1791

value, self.start_checker)

1792

self.start_checker() # Start one now, too

1793

1102

1794

# Checker - property

1103

@dbus_service_property(_interface, signature="s",

1795

@dbus_service_property(_interface,

1796

signature="s",

1104

1797

access="readwrite")

1105

1798

def Checker_dbus_property(self, value=None):

1106

1799

if value is None: # get

1107

1800

return dbus.String(self.checker_command)

1108

self.checker_command = value

1109

# Emit D-Bus signal

1110

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

1111

dbus.String(self.checker_command,

1112

variant_level=1))

1801

self.checker_command = str(value)

1113

1802

1114

1803

# CheckerRunning - property

1115

@dbus_service_property(_interface, signature="b",

1804

@dbus_service_property(_interface,

1805

signature="b",

1116

1806

access="readwrite")

1117

1807

def CheckerRunning_dbus_property(self, value=None):

1118

1808

if value is None: # get

1123

1813

self.stop_checker()

1124

1814

1125

1815

# ObjectPath - property

1816

@dbus_annotations(

1817

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

1818

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

1126

1819

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

1127

1820

def ObjectPath_dbus_property(self):

1128

1821

return self.dbus_object_path # is already a dbus.ObjectPath

1129

1822

1130

1823

# Secret = property

1131

@dbus_service_property(_interface, signature="ay",

1132

access="write", byte_arrays=True)

1824

@dbus_annotations(

1825

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

1826

"invalidates"})

1827

@dbus_service_property(_interface,

1828

signature="ay",

1829

access="write",

1830

byte_arrays=True)

1133

1831

def Secret_dbus_property(self, value):

1134

self.secret = str(value)

1832

self.secret = bytes(value)

1135

1833

1136

1834

del _interface

1137

1835

1141

1839

self._pipe = child_pipe

1142

1840

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

1143

1841

if not self._pipe.recv():

1144

raise KeyError()

1145

1842

raise KeyError(fpr)

1843

1146

1844

def __getattribute__(self, name):

1147

if(name == '_pipe'):

1845

if name == '_pipe':

1148

1846

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

1149

1847

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

1150

1848

data = self._pipe.recv()

1151

1849

if data[0] == 'data':

1152

1850

return data[1]

1153

1851

if data[0] == 'function':

1852

1154

1853

def func(*args, **kwargs):

1155

1854

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

1156

1855

return self._pipe.recv()[1]

1856

1157

1857

return func

1158

1858

1159

1859

def __setattr__(self, name, value):

1160

if(name == '_pipe'):

1860

if name == '_pipe':

1161

1861

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

1162

1862

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

1163

1863

1171

1871

def handle(self):

1172

1872

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

1173

1873

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

1174

unicode(self.client_address))

1874

str(self.client_address))

1175

1875

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

1176

1876

self.server.child_pipe.fileno())

1177

1178

session = (gnutls.connection

1179

.ClientSession(self.request,

1180

gnutls.connection

1181

.X509Credentials()))

1182

1877

1878

session = gnutls.connection.ClientSession(

1879

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

1880

1183

1881

# Note: gnutls.connection.X509Credentials is really a

1184

1882

# generic GnuTLS certificate credentials object so long as

1185

1883

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

1186

1884

# here despite using OpenPGP certificates.

1187

1885

1188

1886

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

1189

1887

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

1190

1888

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

1193

1891

priority = self.server.gnutls_priority

1194

1892

if priority is None:

1195

1893

priority = "NORMAL"

1196

(gnutls.library.functions

1197

.gnutls_priority_set_direct(session._c_object,

1198

priority, None))

1199

1894

gnutls.library.functions.gnutls_priority_set_direct(

1895

session._c_object, priority, None)

1896

1200

1897

# Start communication using the Mandos protocol

1201

1898

# Get protocol number

1202

1899

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

1203

1900

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

1204

1901

try:

1205

1902

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

1206

raise RuntimeError

1207

except (ValueError, IndexError, RuntimeError), error:

1903

raise RuntimeError(line)

1904

except (ValueError, IndexError, RuntimeError) as error:

1208

1905

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

1209

1906

return

1210

1907

1211

1908

# Start GnuTLS connection

1212

1909

try:

1213

1910

session.handshake()

1214

except gnutls.errors.GNUTLSError, error:

1911

except gnutls.errors.GNUTLSError as error:

1215

1912

logger.warning("Handshake failed: %s", error)

1216

1913

# Do not run session.bye() here: the session is not

1217

1914

# established. Just abandon the request.

1218

1915

return

1219

1916

logger.debug("Handshake succeeded")

1220

1917

1221

1918

approval_required = False

1222

1919

try:

1223

1920

try:

1224

fpr = self.fingerprint(self.peer_certificate

1225

(session))

1226

except (TypeError, gnutls.errors.GNUTLSError), error:

1921

fpr = self.fingerprint(

1922

self.peer_certificate(session))

1923

except (TypeError,

1924

gnutls.errors.GNUTLSError) as error:

1227

1925

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

1228

1926

return

1229

1927

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

1230

1928

1231

1929

try:

1232

1930

client = ProxyClient(child_pipe, fpr,

1233

1931

self.client_address)

1241

1939

1242

1940

while True:

1243

1941

if not client.enabled:

1244

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

1245

client.name)

1942

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

1943

client.name)

1246

1944

if self.server.use_dbus:

1247

1945

# Emit D-Bus signal

1248

client.Rejected("Disabled")

1946

client.Rejected("Disabled")

1249

1947

return

1250

1948

1251

if client._approved or not client.approval_delay:

1949

if client.approved or not client.approval_delay:

1252

1950

#We are approved or approval is disabled

1253

1951

break

1254

elif client._approved is None:

1952

elif client.approved is None:

1255

1953

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

1256

1954

client.name)

1257

1955

if self.server.use_dbus:

1258

1956

# Emit D-Bus signal

1259

1957

client.NeedApproval(

1260

client.approval_delay_milliseconds(),

1261

client.approved_by_default)

1958

client.approval_delay.total_seconds()

1959

* 1000, client.approved_by_default)

1262

1960

else:

1263

1961

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

1264

1962

client.name)

1268

1966

return

1269

1967

1270

1968

#wait until timeout or approved

1271

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

1272

1969

time = datetime.datetime.now()

1273

1970

client.changedstate.acquire()

1274

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

1971

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

1275

1972

client.changedstate.release()

1276

1973

time2 = datetime.datetime.now()

1277

1974

if (time2 - time) >= delay:

1292

1989

while sent_size < len(client.secret):

1293

1990

try:

1294

1991

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

1295

except (gnutls.errors.GNUTLSError), error:

1296

logger.warning("gnutls send failed")

1992

except gnutls.errors.GNUTLSError as error:

1993

logger.warning("gnutls send failed",

1994

exc_info=error)

1297

1995

return

1298

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

1299

sent, len(client.secret)

1300

- (sent_size + sent))

1996

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

1997

len(client.secret) - (sent_size

1998

+ sent))

1301

1999

sent_size += sent

1302

2000

1303

2001

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

1304

# bump the timeout as if seen

1305

client.checked_ok()

2002

# bump the timeout using extended_timeout

2003

client.bump_timeout(client.extended_timeout)

1306

2004

if self.server.use_dbus:

1307

2005

# Emit D-Bus signal

1308

2006

client.GotSecret()

1312

2010

client.approvals_pending -= 1

1313

2011

try:

1314

2012

session.bye()

1315

except (gnutls.errors.GNUTLSError), error:

1316

logger.warning("GnuTLS bye failed")

2013

except gnutls.errors.GNUTLSError as error:

2014

logger.warning("GnuTLS bye failed",

2015

exc_info=error)

1317

2016

1318

2017

@staticmethod

1319

2018

def peer_certificate(session):

1320

2019

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

1321

2020

# If not an OpenPGP certificate...

1322

if (gnutls.library.functions

1323

.gnutls_certificate_type_get(session._c_object)

2021

if (gnutls.library.functions.gnutls_certificate_type_get(

2022

session._c_object)

1324

2023

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1325

2024

# ...do the normal thing

1326

2025

return session.peer_certificate

1340

2039

def fingerprint(openpgp):

1341

2040

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1342

2041

# New GnuTLS "datum" with the OpenPGP public key

1343

datum = (gnutls.library.types

1344

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

1345

ctypes.POINTER

1346

(ctypes.c_ubyte)),

1347

ctypes.c_uint(len(openpgp))))

2042

datum = gnutls.library.types.gnutls_datum_t(

2043

ctypes.cast(ctypes.c_char_p(openpgp),

2044

ctypes.POINTER(ctypes.c_ubyte)),

2045

ctypes.c_uint(len(openpgp)))

1348

2046

# New empty GnuTLS certificate

1349

2047

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1350

(gnutls.library.functions

1351

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2048

gnutls.library.functions.gnutls_openpgp_crt_init(

2049

ctypes.byref(crt))

1352

2050

# Import the OpenPGP public key into the certificate

1353

(gnutls.library.functions

1354

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

1355

gnutls.library.constants

1356

.GNUTLS_OPENPGP_FMT_RAW))

2051

gnutls.library.functions.gnutls_openpgp_crt_import(

2052

crt, ctypes.byref(datum),

2053

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1357

2054

# Verify the self signature in the key

1358

2055

crtverify = ctypes.c_uint()

1359

(gnutls.library.functions

1360

.gnutls_openpgp_crt_verify_self(crt, 0,

1361

ctypes.byref(crtverify)))

2056

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2057

crt, 0, ctypes.byref(crtverify))

1362

2058

if crtverify.value != 0:

1363

2059

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1364

raise (gnutls.errors.CertificateSecurityError

1365

("Verify failed"))

2060

raise gnutls.errors.CertificateSecurityError(

2061

"Verify failed")

1366

2062

# New buffer for the fingerprint

1367

2063

buf = ctypes.create_string_buffer(20)

1368

2064

buf_len = ctypes.c_size_t()

1369

2065

# Get the fingerprint from the certificate into the buffer

1370

(gnutls.library.functions

1371

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

1372

ctypes.byref(buf_len)))

2066

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2067

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

1373

2068

# Deinit the certificate

1374

2069

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1375

2070

# Convert the buffer to a Python bytestring

1376

2071

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

1377

2072

# Convert the bytestring to hexadecimal notation

1378

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

2073

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

1379

2074

return hex_fpr

1380

2075

1381

2076

1382

2077

class MultiprocessingMixIn(object):

1383

2078

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

2079

1384

2080

def sub_process_main(self, request, address):

1385

2081

try:

1386

2082

self.finish_request(request, address)

1387

except:

2083

except Exception:

1388

2084

self.handle_error(request, address)

1389

2085

self.close_request(request)

1390

2086

1391

2087

def process_request(self, request, address):

1392

2088

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

1393

multiprocessing.Process(target = self.sub_process_main,

1394

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

2089

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

2090

args = (request, address))

2091

proc.start()

2092

return proc

2093

1395

2094

1396

2095

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1397

2096

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

2097

1398

2098

def process_request(self, request, client_address):

1399

2099

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

1400

2100

1401

2101

This function creates a new pipe in self.pipe

1402

2102

"""

1403

2103

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1404

1405

super(MultiprocessingMixInWithPipe,

1406

self).process_request(request, client_address)

2104

2105

proc = MultiprocessingMixIn.process_request(self, request,

2106

client_address)

1407

2107

self.child_pipe.close()

1408

self.add_pipe(parent_pipe)

1409

1410

def add_pipe(self, parent_pipe):

2108

self.add_pipe(parent_pipe, proc)

2109

2110

def add_pipe(self, parent_pipe, proc):

1411

2111

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

1412

raise NotImplementedError

2112

raise NotImplementedError()

2113

1413

2114

1414

2115

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1415

2116

socketserver.TCPServer, object):

1420

2121

interface: None or a network interface name (string)

1421

2122

use_ipv6: Boolean; to use IPv6 or not

1422

2123

"""

2124

1423

2125

def __init__(self, server_address, RequestHandlerClass,

1424

interface=None, use_ipv6=True):

2126

interface=None,

2127

use_ipv6=True,

2128

socketfd=None):

2129

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

2130

creating a new one with socket.socket().

2131

"""

1425

2132

self.interface = interface

1426

2133

if use_ipv6:

1427

2134

self.address_family = socket.AF_INET6

2135

if socketfd is not None:

2136

# Save the file descriptor

2137

self.socketfd = socketfd

2138

# Save the original socket.socket() function

2139

self.socket_socket = socket.socket

2140

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

2141

#

2142

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

2143

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

2144

# patching socket.socket.)

2145

#

2146

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

2147

@functools.wraps(socket.socket)

2148

def socket_wrapper(*args, **kwargs):

2149

# Restore original function so subsequent calls are

2150

# not affected.

2151

socket.socket = self.socket_socket

2152

del self.socket_socket

2153

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

2154

# saved file descriptor.

2155

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

2156

# Replace socket.socket() function with wrapper

2157

socket.socket = socket_wrapper

2158

# The socketserver.TCPServer.__init__ will call

2159

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

2160

# socket_wrapper(), if socketfd was set.

1428

2161

socketserver.TCPServer.__init__(self, server_address,

1429

2162

RequestHandlerClass)

2163

1430

2164

def server_bind(self):

1431

2165

"""This overrides the normal server_bind() function

1432

2166

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

1438

2172

self.interface)

1439

2173

else:

1440

2174

try:

1441

self.socket.setsockopt(socket.SOL_SOCKET,

1442

SO_BINDTODEVICE,

1443

str(self.interface

1444

+ '\0'))

1445

except socket.error, error:

1446

if error[0] == errno.EPERM:

1447

logger.error("No permission to"

1448

" bind to interface %s",

1449

self.interface)

1450

elif error[0] == errno.ENOPROTOOPT:

2175

self.socket.setsockopt(

2176

socket.SOL_SOCKET, SO_BINDTODEVICE,

2177

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

2178

except socket.error as error:

2179

if error.errno == errno.EPERM:

2180

logger.error("No permission to bind to"

2181

" interface %s", self.interface)

2182

elif error.errno == errno.ENOPROTOOPT:

1451

2183

logger.error("SO_BINDTODEVICE not available;"

1452

2184

" cannot bind to interface %s",

1453

2185

self.interface)

2186

elif error.errno == errno.ENODEV:

2187

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

2188

" cannot bind", self.interface)

1454

2189

else:

1455

2190

raise

1456

2191

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

1459

2194

if self.address_family == socket.AF_INET6:

1460

2195

any_address = "::" # in6addr_any

1461

2196

else:

1462

any_address = socket.INADDR_ANY

2197

any_address = "0.0.0.0" # INADDR_ANY

1463

2198

self.server_address = (any_address,

1464

2199

self.server_address[1])

1465

2200

elif not self.server_address[1]:

1466

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

1467

0)

2201

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

1468

2202

# if self.interface:

1469

2203

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

1470

2204

# 0, # port

1484

2218

1485

2219

Assumes a gobject.MainLoop event loop.

1486

2220

"""

2221

1487

2222

def __init__(self, server_address, RequestHandlerClass,

1488

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

1489

gnutls_priority=None, use_dbus=True):

2223

interface=None,

2224

use_ipv6=True,

2225

clients=None,

2226

gnutls_priority=None,

2227

use_dbus=True,

2228

socketfd=None):

1490

2229

self.enabled = False

1491

2230

self.clients = clients

1492

2231

if self.clients is None:

1493

self.clients = set()

2232

self.clients = {}

1494

2233

self.use_dbus = use_dbus

1495

2234

self.gnutls_priority = gnutls_priority

1496

2235

IPv6_TCPServer.__init__(self, server_address,

1497

2236

RequestHandlerClass,

1498

2237

interface = interface,

1499

use_ipv6 = use_ipv6)

2238

use_ipv6 = use_ipv6,

2239

socketfd = socketfd)

2240

1500

2241

def server_activate(self):

1501

2242

if self.enabled:

1502

2243

return socketserver.TCPServer.server_activate(self)

2244

1503

2245

def enable(self):

1504

2246

self.enabled = True

1505

def add_pipe(self, parent_pipe):

2247

2248

def add_pipe(self, parent_pipe, proc):

1506

2249

# Call "handle_ipc" for both data and EOF events

1507

gobject.io_add_watch(parent_pipe.fileno(),

1508

gobject.IO_IN | gobject.IO_HUP,

1509

functools.partial(self.handle_ipc,

1510

parent_pipe = parent_pipe))

1511

1512

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

2250

gobject.io_add_watch(

2251

parent_pipe.fileno(),

2252

gobject.IO_IN | gobject.IO_HUP,

2253

functools.partial(self.handle_ipc,

2254

parent_pipe = parent_pipe,

2255

proc = proc))

2256

2257

def handle_ipc(self, source, condition,

2258

parent_pipe=None,

2259

proc = None,

1513

2260

client_object=None):

1514

condition_names = {

1515

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

1516

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

1517

# blocking).

1518

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

1519

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

1520

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

1521

# broken, usually for pipes and

1522

# sockets).

1523

}

1524

conditions_string = ' | '.join(name

1525

for cond, name in

1526

condition_names.iteritems()

1527

if cond & condition)

1528

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

1529

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

2261

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

2262

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

2263

# Wait for other process to exit

2264

proc.join()

1530

2265

return False

1531

2266

1532

2267

# Read a request from the child

1537

2272

fpr = request[1]

1538

2273

address = request[2]

1539

2274

1540

for c in self.clients:

2275

for c in self.clients.itervalues():

1541

2276

if c.fingerprint == fpr:

1542

2277

client = c

1543

2278

break

1544

2279

else:

1545

logger.warning("Client not found for fingerprint: %s, ad"

1546

"dress: %s", fpr, address)

2280

logger.info("Client not found for fingerprint: %s, ad"

2281

"dress: %s", fpr, address)

1547

2282

if self.use_dbus:

1548

2283

# Emit D-Bus signal

1549

mandos_dbus_service.ClientNotFound(fpr, address[0])

2284

mandos_dbus_service.ClientNotFound(fpr,

2285

address[0])

1550

2286

parent_pipe.send(False)

1551

2287

return False

1552

2288

1553

gobject.io_add_watch(parent_pipe.fileno(),

1554

gobject.IO_IN | gobject.IO_HUP,

1555

functools.partial(self.handle_ipc,

1556

parent_pipe = parent_pipe,

1557

client_object = client))

2289

gobject.io_add_watch(

2290

parent_pipe.fileno(),

2291

gobject.IO_IN | gobject.IO_HUP,

2292

functools.partial(self.handle_ipc,

2293

parent_pipe = parent_pipe,

2294

proc = proc,

2295

client_object = client))

1558

2296

parent_pipe.send(True)

1559

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

2297

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

2298

# same fileno

1560

2299

return False

1561

2300

if command == 'funcall':

1562

2301

funcname = request[1]

1563

2302

args = request[2]

1564

2303

kwargs = request[3]

1565

2304

1566

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

1567

2305

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

2306

funcname)(*args,

2307

**kwargs)))

2308

1568

2309

if command == 'getattr':

1569

2310

attrname = request[1]

1570

if callable(client_object.__getattribute__(attrname)):

1571

parent_pipe.send(('function',))

2311

if isinstance(client_object.__getattribute__(attrname),

2312

collections.Callable):

2313

parent_pipe.send(('function', ))

1572

2314

else:

1573

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

2315

parent_pipe.send((

2316

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

1574

2317

1575

2318

if command == 'setattr':

1576

2319

attrname = request[1]

1577

2320

value = request[2]

1578

2321

setattr(client_object, attrname, value)

1579

2322

1580

2323

return True

1581

2324

1582

2325

2326

def rfc3339_duration_to_delta(duration):

2327

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

2328

2329

>>> rfc3339_duration_to_delta("P7D")

2330

datetime.timedelta(7)

2331

>>> rfc3339_duration_to_delta("PT60S")

2332

datetime.timedelta(0, 60)

2333

>>> rfc3339_duration_to_delta("PT60M")

2334

datetime.timedelta(0, 3600)

2335

>>> rfc3339_duration_to_delta("PT24H")

2336

datetime.timedelta(1)

2337

>>> rfc3339_duration_to_delta("P1W")

2338

datetime.timedelta(7)

2339

>>> rfc3339_duration_to_delta("PT5M30S")

2340

datetime.timedelta(0, 330)

2341

>>> rfc3339_duration_to_delta("P1DT3M20S")

2342

datetime.timedelta(1, 200)

2343

"""

2344

2345

# Parsing an RFC 3339 duration with regular expressions is not

2346

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

2347

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

2348

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

2349

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

2350

# avoid excessive use of external libraries.

2351

2352

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

2353

Token = collections.namedtuple("Token", (

2354

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

2355

# a "group" containing digits

2356

"value", # datetime.timedelta or None

2357

"followers")) # Tokens valid after this token

2358

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

2359

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

2360

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

2361

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

2362

datetime.timedelta(seconds=1),

2363

frozenset((token_end, )))

2364

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

2365

datetime.timedelta(minutes=1),

2366

frozenset((token_second, token_end)))

2367

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

2368

datetime.timedelta(hours=1),

2369

frozenset((token_minute, token_end)))

2370

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

2371

None,

2372

frozenset((token_hour, token_minute,

2373

token_second)))

2374

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

2375

datetime.timedelta(days=1),

2376

frozenset((token_time, token_end)))

2377

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

2378

datetime.timedelta(weeks=4),

2379

frozenset((token_day, token_end)))

2380

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

2381

datetime.timedelta(weeks=52),

2382

frozenset((token_month, token_end)))

2383

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

2384

datetime.timedelta(weeks=1),

2385

frozenset((token_end, )))

2386

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

2387

frozenset((token_year, token_month,

2388

token_day, token_time,

2389

token_week)))

2390

# Define starting values

2391

value = datetime.timedelta() # Value so far

2392

found_token = None

2393

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

2394

s = duration # String left to parse

2395

# Loop until end token is found

2396

while found_token is not token_end:

2397

# Search for any currently valid tokens

2398

for token in followers:

2399

match = token.regexp.match(s)

2400

if match is not None:

2401

# Token found

2402

if token.value is not None:

2403

# Value found, parse digits

2404

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

2405

# Add to value so far

2406

value += factor * token.value

2407

# Strip token from string

2408

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

2409

# Go to found token

2410

found_token = token

2411

# Set valid next tokens

2412

followers = found_token.followers

2413

break

2414

else:

2415

# No currently valid tokens were found

2416

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

2417

.format(duration))

2418

# End token found

2419

return value

2420

2421

1583

2422

def string_to_delta(interval):

1584

2423

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

1585

2424

1596

2435

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

1597

2436

datetime.timedelta(0, 330)

1598

2437

"""

2438

2439

try:

2440

return rfc3339_duration_to_delta(interval)

2441

except ValueError:

2442

pass

2443

1599

2444

timevalue = datetime.timedelta(0)

1600

2445

for s in interval.split():

1601

2446

try:

1602

suffix = unicode(s[-1])

2447

suffix = s[-1]

1603

2448

value = int(s[:-1])

1604

2449

if suffix == "d":

1605

2450

delta = datetime.timedelta(value)

1612

2457

elif suffix == "w":

1613

2458

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

1614

2459

else:

1615

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

1616

except (ValueError, IndexError), e:

2460

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

2461

except IndexError as e:

1617

2462

raise ValueError(*(e.args))

1618

2463

timevalue += delta

1619

2464

return timevalue

1620

2465

1621

2466

1622

def if_nametoindex(interface):

1623

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

1624

1625

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

1626

global if_nametoindex

1627

try:

1628

if_nametoindex = (ctypes.cdll.LoadLibrary

1629

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

1630

.if_nametoindex)

1631

except (OSError, AttributeError):

1632

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

1633

def if_nametoindex(interface):

1634

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

1635

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

1636

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

1637

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1638

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

1639

interface))

1640

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

1641

ifreq[16:20])[0]

1642

return interface_index

1643

return if_nametoindex(interface)

1644

1645

1646

2467

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

1647

2468

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

1648

2469

1656

2477

sys.exit()

1657

2478

if not noclose:

1658

2479

# Close all standard open file descriptors

1659

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

2480

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

1660

2481

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

1661

2482

raise OSError(errno.ENODEV,

1662

"%s not a character device"

1663

% os.path.devnull)

2483

"{} not a character device"

2484

.format(os.devnull))

1664

2485

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

1665

2486

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

1666

2487

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

1673

2494

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

1674

2495

# Parsing of options, both command line and config file

1675

2496

1676

parser = optparse.OptionParser(version = "%%prog %s" % version)

1677

parser.add_option("-i", "--interface", type="string",

1678

metavar="IF", help="Bind to interface IF")

1679

parser.add_option("-a", "--address", type="string",

1680

help="Address to listen for requests on")

1681

parser.add_option("-p", "--port", type="int",

1682

help="Port number to receive requests on")

1683

parser.add_option("--check", action="store_true",

1684

help="Run self-test")

1685

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

1686

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

1687

" terminal")

1688

parser.add_option("--debuglevel", type="string", metavar="LEVEL",

1689

help="Debug level for stdout output")

1690

parser.add_option("--priority", type="string", help="GnuTLS"

1691

" priority string (see GnuTLS documentation)")

1692

parser.add_option("--servicename", type="string",

1693

metavar="NAME", help="Zeroconf service name")

1694

parser.add_option("--configdir", type="string",

1695

default="/etc/mandos", metavar="DIR",

1696

help="Directory to search for configuration"

1697

" files")

1698

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

1699

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

1700

" system bus interface")

1701

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

1702

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

1703

options = parser.parse_args()[0]

2497

parser = argparse.ArgumentParser()

2498

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

2499

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

2500

help="show version number and exit")

2501

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

2502

help="Bind to interface IF")

2503

parser.add_argument("-a", "--address",

2504

help="Address to listen for requests on")

2505

parser.add_argument("-p", "--port", type=int,

2506

help="Port number to receive requests on")

2507

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

2508

help="Run self-test")

2509

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

2510

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

2511

" to terminal", default=None)

2512

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

2513

help="Debug level for stdout output")

2514

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

2515

" priority string (see GnuTLS documentation)")

2516

parser.add_argument("--servicename",

2517

metavar="NAME", help="Zeroconf service name")

2518

parser.add_argument("--configdir",

2519

default="/etc/mandos", metavar="DIR",

2520

help="Directory to search for configuration"

2521

" files")

2522

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

2523

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

2524

" system bus interface", default=None)

2525

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

2526

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

2527

default=None)

2528

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

2529

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

2530

" state", default=None)

2531

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

2532

help="Specify a file descriptor to a network"

2533

" socket to use instead of creating one")

2534

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

2535

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

2536

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

2537

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

2538

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

2539

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

2540

default=None)

2541

2542

options = parser.parse_args()

1704

2543

1705

2544

if options.check:

1706

2545

import doctest

1707

doctest.testmod()

1708

sys.exit()

2546

fail_count, test_count = doctest.testmod()

2547

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

1709

2548

1710

2549

# Default values for config file for server-global settings

1711

2550

server_defaults = { "interface": "",

1713

2552

"port": "",

1714

2553

"debug": "False",

1715

2554

"priority":

1716

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

2555

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

2556

":+SIGN-DSA-SHA256",

1717

2557

"servicename": "Mandos",

1718

2558

"use_dbus": "True",

1719

2559

"use_ipv6": "True",

1720

2560

"debuglevel": "",

1721

}

2561

"restore": "True",

2562

"socket": "",

2563

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

2564

"foreground": "False",

2565

"zeroconf": "True",

2566

}

1722

2567

1723

2568

# Parse config file for server-global settings

1724

2569

server_config = configparser.SafeConfigParser(server_defaults)

1725

2570

del server_defaults

1726

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

1727

"mandos.conf"))

2571

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

1728

2572

# Convert the SafeConfigParser object to a dict

1729

2573

server_settings = server_config.defaults()

1730

2574

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

1731

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

2575

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

1732

2576

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

1733

2577

option)

1734

2578

if server_settings["port"]:

1735

2579

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

1736

2580

"port")

2581

if server_settings["socket"]:

2582

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

2583

"socket")

2584

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

2585

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

2586

# happen with a supplied network socket.

2587

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

2588

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

2589

["socket"])

1737

2590

del server_config

1738

2591

1739

2592

# Override the settings from the config file with command line

1740

2593

# options, if set.

1741

2594

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

1742

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

1743

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

2595

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

2596

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

2597

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

1744

2598

value = getattr(options, option)

1745

2599

if value is not None:

1746

2600

server_settings[option] = value

1747

2601

del options

1748

2602

# Force all strings to be unicode

1749

2603

for option in server_settings.keys():

1750

if type(server_settings[option]) is str:

1751

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

2604

if isinstance(server_settings[option], bytes):

2605

server_settings[option] = (server_settings[option]

2606

.decode("utf-8"))

2607

# Force all boolean options to be boolean

2608

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

2609

"foreground", "zeroconf"):

2610

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

2611

# Debug implies foreground

2612

if server_settings["debug"]:

2613

server_settings["foreground"] = True

1752

2614

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

1753

2615

1754

2616

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

1755

2617

2618

if (not server_settings["zeroconf"]

2619

and not (server_settings["port"]

2620

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

2621

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

2622

1756

2623

# For convenience

1757

2624

debug = server_settings["debug"]

1758

2625

debuglevel = server_settings["debuglevel"]

1759

2626

use_dbus = server_settings["use_dbus"]

1760

2627

use_ipv6 = server_settings["use_ipv6"]

1761

2628

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

2629

stored_state_file)

2630

foreground = server_settings["foreground"]

2631

zeroconf = server_settings["zeroconf"]

2632

2633

if debug:

2634

initlogger(debug, logging.DEBUG)

2635

else:

2636

if not debuglevel:

2637

initlogger(debug)

2638

else:

2639

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

2640

initlogger(debug, level)

2641

1762

2642

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

1763

syslogger.setFormatter(logging.Formatter

1764

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

1765

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

1766

% server_settings["servicename"]))

2643

syslogger.setFormatter(

2644

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

2645

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

2646

server_settings["servicename"])))

1767

2647

1768

2648

# Parse config file with clients

1769

client_defaults = { "timeout": "1h",

1770

"interval": "5m",

1771

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

1772

"host": "",

1773

"approval_delay": "0s",

1774

"approval_duration": "1s",

1775

}

1776

client_config = configparser.SafeConfigParser(client_defaults)

2649

client_config = configparser.SafeConfigParser(Client

2650

.client_defaults)

1777

2651

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

1778

2652

"clients.conf"))

1779

2653

1780

2654

global mandos_dbus_service

1781

2655

mandos_dbus_service = None

1782

2656

1783

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

1784

server_settings["port"]),

1785

ClientHandler,

1786

interface=(server_settings["interface"]

1787

or None),

1788

use_ipv6=use_ipv6,

1789

gnutls_priority=

1790

server_settings["priority"],

1791

use_dbus=use_dbus)

1792

if not debug:

1793

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

2657

socketfd = None

2658

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

2659

socketfd = server_settings["socket"]

2660

tcp_server = MandosServer(

2661

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

2662

ClientHandler,

2663

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

2664

use_ipv6=use_ipv6,

2665

gnutls_priority=server_settings["priority"],

2666

use_dbus=use_dbus,

2667

socketfd=socketfd)

2668

if not foreground:

2669

pidfilename = "/run/mandos.pid"

2670

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

2671

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

2672

pidfile = None

1794

2673

try:

1795

pidfile = open(pidfilename, "w")

1796

except IOError:

1797

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

2674

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

2675

except IOError as e:

2676

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

2677

exc_info=e)

1798

2678

1799

try:

1800

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

1801

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

1802

except KeyError:

2679

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

1803

2680

try:

1804

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

1805

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

2681

uid = pwd.getpwnam(name).pw_uid

2682

gid = pwd.getpwnam(name).pw_gid

2683

break

1806

2684

except KeyError:

1807

try:

1808

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

1809

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

1810

except KeyError:

1811

uid = 65534

1812

gid = 65534

2685

continue

2686

else:

2687

uid = 65534

2688

gid = 65534

1813

2689

try:

1814

2690

os.setgid(gid)

1815

2691

os.setuid(uid)

1816

except OSError, error:

1817

if error[0] != errno.EPERM:

1818

raise error

2692

except OSError as error:

2693

if error.errno != errno.EPERM:

2694

raise

1819

2695

1820

if not debug and not debuglevel:

1821

syslogger.setLevel(logging.WARNING)

1822

console.setLevel(logging.WARNING)

1823

if debuglevel:

1824

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

1825

syslogger.setLevel(level)

1826

console.setLevel(level)

1827

1828

2696

if debug:

1829

2697

# Enable all possible GnuTLS debugging

1830

2698

1836

2704

def debug_gnutls(level, string):

1837

2705

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

1838

2706

1839

(gnutls.library.functions

1840

.gnutls_global_set_log_function(debug_gnutls))

2707

gnutls.library.functions.gnutls_global_set_log_function(

2708

debug_gnutls)

1841

2709

1842

2710

# Redirect stdin so all checkers get /dev/null

1843

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

2711

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

1844

2712

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

1845

2713

if null > 2:

1846

2714

os.close(null)

1847

else:

1848

# No console logging

1849

logger.removeHandler(console)

1850

2715

1851

2716

# Need to fork before connecting to D-Bus

1852

if not debug:

2717

if not foreground:

1853

2718

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

1854

2719

daemon()

1855

2720

2721

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

2722

# need to inform gobject that threads will be used.

2723

gobject.threads_init()

2724

1856

2725

global main_loop

1857

2726

# From the Avahi example code

1858

DBusGMainLoop(set_as_default=True )

2727

DBusGMainLoop(set_as_default=True)

1859

2728

main_loop = gobject.MainLoop()

1860

2729

bus = dbus.SystemBus()

1861

2730

# End of Avahi example code

1862

2731

if use_dbus:

1863

2732

try:

1864

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

1865

bus, do_not_queue=True)

1866

except dbus.exceptions.NameExistsException, e:

1867

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

2733

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

2734

bus,

2735

do_not_queue=True)

2736

old_bus_name = dbus.service.BusName(

2737

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

2738

do_not_queue=True)

2739

except dbus.exceptions.DBusException as e:

2740

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

1868

2741

use_dbus = False

1869

2742

server_settings["use_dbus"] = False

1870

2743

tcp_server.use_dbus = False

1871

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1872

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

1873

servicetype = "_mandos._tcp",

1874

protocol = protocol, bus = bus)

1875

if server_settings["interface"]:

1876

service.interface = (if_nametoindex

1877

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

2744

if zeroconf:

2745

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2746

service = AvahiServiceToSyslog(

2747

name = server_settings["servicename"],

2748

servicetype = "_mandos._tcp",

2749

protocol = protocol,

2750

bus = bus)

2751

if server_settings["interface"]:

2752

service.interface = if_nametoindex(

2753

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

1878

2754

1879

2755

global multiprocessing_manager

1880

2756

multiprocessing_manager = multiprocessing.Manager()

1882

2758

client_class = Client

1883

2759

if use_dbus:

1884

2760

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

1885

def client_config_items(config, section):

1886

special_settings = {

1887

"approved_by_default":

1888

lambda: config.getboolean(section,

1889

"approved_by_default"),

1890

}

1891

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

2761

2762

client_settings = Client.config_parser(client_config)

2763

old_client_settings = {}

2764

clients_data = {}

2765

2766

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

2767

global wnull

2768

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

2769

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

2770

# mode

2771

if debug or not foreground:

2772

wnull.close()

2773

2774

# Get client data and settings from last running state.

2775

if server_settings["restore"]:

2776

try:

2777

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

2778

clients_data, old_client_settings = pickle.load(

2779

stored_state)

2780

os.remove(stored_state_path)

2781

except IOError as e:

2782

if e.errno == errno.ENOENT:

2783

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

2784

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

2785

else:

2786

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

2787

exc_info=e)

2788

raise

2789

except EOFError as e:

2790

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

2791

"EOFError:",

2792

exc_info=e)

2793

2794

with PGPEngine() as pgp:

2795

for client_name, client in clients_data.items():

2796

# Skip removed clients

2797

if client_name not in client_settings:

2798

continue

2799

2800

# Decide which value to use after restoring saved state.

2801

# We have three different values: Old config file,

2802

# new config file, and saved state.

2803

# New config value takes precedence if it differs from old

2804

# config value, otherwise use saved state.

2805

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

2806

try:

2807

# For each value in new config, check if it

2808

# differs from the old config value (Except for

2809

# the "secret" attribute)

2810

if (name != "secret"

2811

and (value !=

2812

old_client_settings[client_name][name])):

2813

client[name] = value

2814

except KeyError:

2815

pass

2816

2817

# Clients who has passed its expire date can still be

2818

# enabled if its last checker was successful. A Client

2819

# whose checker succeeded before we stored its state is

2820

# assumed to have successfully run all checkers during

2821

# downtime.

2822

if client["enabled"]:

2823

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

2824

if not client["last_checked_ok"]:

2825

logger.warning(

2826

"disabling client {} - Client never "

2827

"performed a successful checker".format(

2828

client_name))

2829

client["enabled"] = False

2830

elif client["last_checker_status"] != 0:

2831

logger.warning(

2832

"disabling client {} - Client last"

2833

" checker failed with error code"

2834

" {}".format(

2835

client_name,

2836

client["last_checker_status"]))

2837

client["enabled"] = False

2838

else:

2839

client["expires"] = (

2840

datetime.datetime.utcnow()

2841

+ client["timeout"])

2842

logger.debug("Last checker succeeded,"

2843

" keeping {} enabled".format(

2844

client_name))

1892

2845

try:

1893

yield (name, special_settings[name]())

1894

except KeyError:

1895

yield (name, value)

1896

1897

tcp_server.clients.update(set(

1898

client_class(name = section,

1899

config= dict(client_config_items(

1900

client_config, section)))

1901

for section in client_config.sections()))

2846

client["secret"] = pgp.decrypt(

2847

client["encrypted_secret"],

2848

client_settings[client_name]["secret"])

2849

except PGPError:

2850

# If decryption fails, we use secret from new settings

2851

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

2852

client_name))

2853

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

2854

["secret"])

2855

2856

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

2857

for client_name in (set(old_client_settings)

2858

- set(client_settings)):

2859

del clients_data[client_name]

2860

for client_name in (set(client_settings)

2861

- set(old_client_settings)):

2862

clients_data[client_name] = client_settings[client_name]

2863

2864

# Create all client objects

2865

for client_name, client in clients_data.items():

2866

tcp_server.clients[client_name] = client_class(

2867

name = client_name,

2868

settings = client,

2869

server_settings = server_settings)

2870

1902

2871

if not tcp_server.clients:

1903

2872

logger.warning("No clients defined")

1904

1905

if not debug:

1906

try:

1907

with pidfile:

1908

pid = os.getpid()

1909

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

1910

del pidfile

1911

except IOError:

1912

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

1913

pidfilename, pid)

1914

except NameError:

1915

# "pidfile" was never created

1916

pass

2873

2874

if not foreground:

2875

if pidfile is not None:

2876

pid = os.getpid()

2877

try:

2878

with pidfile:

2879

print(pid, file=pidfile)

2880

except IOError:

2881

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

2882

pidfilename, pid)

2883

del pidfile

1917

2884

del pidfilename

1918

1919

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

1920

2885

1921

2886

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

1922

2887

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

1923

2888

1924

2889

if use_dbus:

1925

class MandosDBusService(dbus.service.Object):

2890

2891

@alternate_dbus_interfaces(

2892

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

2893

class MandosDBusService(DBusObjectWithObjectManager):

1926

2894

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

2895

1927

2896

def __init__(self):

1928

2897

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

1929

_interface = "se.bsnet.fukt.Mandos"

2898

2899

_interface = "se.recompile.Mandos"

1930

2900

1931

2901

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

1932

2902

def ClientAdded(self, objpath):

1938

2908

"D-Bus signal"

1939

2909

pass

1940

2910

2911

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

2912

"true"})

1941

2913

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

1942

2914

def ClientRemoved(self, objpath, name):

1943

2915

"D-Bus signal"

1944

2916

pass

1945

2917

2918

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

2919

"true"})

1946

2920

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

1947

2921

def GetAllClients(self):

1948

2922

"D-Bus method"

1949

return dbus.Array(c.dbus_object_path

1950

for c in tcp_server.clients)

2923

return dbus.Array(c.dbus_object_path for c in

2924

tcp_server.clients.itervalues())

1951

2925

2926

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

2927

"true"})

1952

2928

@dbus.service.method(_interface,

1953

2929

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

1954

2930

def GetAllClientsWithProperties(self):

1955

2931

"D-Bus method"

1956

2932

return dbus.Dictionary(

1957

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

1958

for c in tcp_server.clients),

2933

{ c.dbus_object_path: c.GetAll(

2934

"se.recompile.Mandos.Client")

2935

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

1959

2936

signature="oa{sv}")

1960

2937

1961

2938

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

1962

2939

def RemoveClient(self, object_path):

1963

2940

"D-Bus method"

1964

for c in tcp_server.clients:

2941

for c in tcp_server.clients.itervalues():

1965

2942

if c.dbus_object_path == object_path:

1966

tcp_server.clients.remove(c)

2943

del tcp_server.clients[c.name]

1967

2944

c.remove_from_connection()

1968

# Don't signal anything except ClientRemoved

2945

# Don't signal the disabling

1969

2946

c.disable(quiet=True)

1970

# Emit D-Bus signal

1971

self.ClientRemoved(object_path, c.name)

2947

# Emit D-Bus signal for removal

2948

self.client_removed_signal(c)

1972

2949

return

1973

2950

raise KeyError(object_path)

1974

2951

1975

2952

del _interface

2953

2954

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

2955

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

2956

def GetManagedObjects(self):

2957

"""D-Bus method"""

2958

return dbus.Dictionary(

2959

{ client.dbus_object_path:

2960

dbus.Dictionary(

2961

{ interface: client.GetAll(interface)

2962

for interface in

2963

client._get_all_interface_names()})

2964

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

2965

2966

def client_added_signal(self, client):

2967

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

2968

if use_dbus:

2969

# New standard signal

2970

self.InterfacesAdded(

2971

client.dbus_object_path,

2972

dbus.Dictionary(

2973

{ interface: client.GetAll(interface)

2974

for interface in

2975

client._get_all_interface_names()}))

2976

# Old signal

2977

self.ClientAdded(client.dbus_object_path)

2978

2979

def client_removed_signal(self, client):

2980

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

2981

if use_dbus:

2982

# New standard signal

2983

self.InterfacesRemoved(

2984

client.dbus_object_path,

2985

client._get_all_interface_names())

2986

# Old signal

2987

self.ClientRemoved(client.dbus_object_path,

2988

client.name)

1976

2989

1977

2990

mandos_dbus_service = MandosDBusService()

1978

2991

1979

2992

def cleanup():

1980

2993

"Cleanup function; run on exit"

1981

service.cleanup()

1982

2994

if zeroconf:

2995

service.cleanup()

2996

2997

multiprocessing.active_children()

2998

wnull.close()

2999

if not (tcp_server.clients or client_settings):

3000

return

3001

3002

# Store client before exiting. Secrets are encrypted with key

3003

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

3004

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

3005

clients = {}

3006

with PGPEngine() as pgp:

3007

for client in tcp_server.clients.itervalues():

3008

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

3009

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

3010

key)

3011

client_dict = {}

3012

3013

# A list of attributes that can not be pickled

3014

# + secret.

3015

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

3016

"checker", "server_settings" }

3017

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

3018

.Object):

3019

exclude.add(name)

3020

3021

client_dict["encrypted_secret"] = (client

3022

.encrypted_secret)

3023

for attr in client.client_structure:

3024

if attr not in exclude:

3025

client_dict[attr] = getattr(client, attr)

3026

3027

clients[client.name] = client_dict

3028

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

3029

3030

try:

3031

with tempfile.NamedTemporaryFile(

3032

mode='wb',

3033

suffix=".pickle",

3034

prefix='clients-',

3035

dir=os.path.dirname(stored_state_path),

3036

delete=False) as stored_state:

3037

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

3038

tempname = stored_state.name

3039

os.rename(tempname, stored_state_path)

3040

except (IOError, OSError) as e:

3041

if not debug:

3042

try:

3043

os.remove(tempname)

3044

except NameError:

3045

pass

3046

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

3047

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

3048

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

3049

else:

3050

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

3051

exc_info=e)

3052

raise

3053

3054

# Delete all clients, and settings from config

1983

3055

while tcp_server.clients:

1984

client = tcp_server.clients.pop()

3056

name, client = tcp_server.clients.popitem()

1985

3057

if use_dbus:

1986

3058

client.remove_from_connection()

1987

client.disable_hook = None

1988

# Don't signal anything except ClientRemoved

3059

# Don't signal the disabling

1989

3060

client.disable(quiet=True)

1990

if use_dbus:

1991

# Emit D-Bus signal

1992

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

1993

client.name)

3061

# Emit D-Bus signal for removal

3062

mandos_dbus_service.client_removed_signal(client)

3063

client_settings.clear()

1994

3064

1995

3065

atexit.register(cleanup)

1996

3066

1997

for client in tcp_server.clients:

3067

for client in tcp_server.clients.itervalues():

1998

3068

if use_dbus:

1999

# Emit D-Bus signal

2000

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2001

client.enable()

3069

# Emit D-Bus signal for adding

3070

mandos_dbus_service.client_added_signal(client)

3071

# Need to initiate checking of clients

3072

if client.enabled:

3073

client.init_checker()

2002

3074

2003

3075

tcp_server.enable()

2004

3076

tcp_server.server_activate()

2005

3077

2006

3078

# Find out what port we got

2007

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

3079

if zeroconf:

3080

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

2008

3081

if use_ipv6:

2009

3082

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

2010

" flowinfo %d, scope_id %d"

2011

% tcp_server.socket.getsockname())

3083

" flowinfo %d, scope_id %d",

3084

*tcp_server.socket.getsockname())

2012

3085

else: # IPv4

2013

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

2014

% tcp_server.socket.getsockname())

3086

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

3087

*tcp_server.socket.getsockname())

2015

3088

2016

3089

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

2017

3090

2018

3091

try:

2019

# From the Avahi example code

2020

try:

2021

service.activate()

2022

except dbus.exceptions.DBusException, error:

2023

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

2024

cleanup()

2025

sys.exit(1)

2026

# End of Avahi example code

3092

if zeroconf:

3093

# From the Avahi example code

3094

try:

3095

service.activate()

3096

except dbus.exceptions.DBusException as error:

3097

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

3098

cleanup()

3099

sys.exit(1)

3100

# End of Avahi example code

2027

3101

2028

3102

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

2029

3103

lambda *args, **kwargs:

2032

3106

2033

3107

logger.debug("Starting main loop")

2034

3108

main_loop.run()

2035

except AvahiError, error:

2036

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

3109

except AvahiError as error:

3110

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

2037

3111

cleanup()

2038

3112

sys.exit(1)

2039

3113

except KeyboardInterrupt:

2044

3118

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

2045

3119

cleanup()

2046

3120

3121

2047

3122

if __name__ == '__main__':

2048

3123

main()