/mandos/release : revision 237.7.335

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

28

# along with this program. If not, see

29

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

30

#

31

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

31

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

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

38

43

import socket

39

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, signature = "oas")

1158

def InterfacesRemoved(self, object_path, interfaces):

1159

pass

1160

1161

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1162

out_signature = "s",

1163

path_keyword = 'object_path',

1164

connection_keyword = 'connection')

1165

def Introspect(self, object_path, connection):

1166

"""Overloading of standard D-Bus method.

1167

1168

Override return argument name of GetManagedObjects to be

1169

"objpath_interfaces_and_properties"

1170

"""

1171

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1172

object_path,

1173

connection)

1174

try:

1175

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

1176

1177

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

1178

# Fix argument name for the GetManagedObjects method

1179

if (if_tag.getAttribute("name")

1180

== dbus.OBJECT_MANAGER_IFACE):

1181

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

1182

if (cn.getAttribute("name")

1183

== "GetManagedObjects"):

1184

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

1185

if (arg.getAttribute("direction")

1186

== "out"):

1187

arg.setAttribute(

1188

"name",

1189

"objpath_interfaces"

1190

"_and_properties")

1191

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

1192

document.unlink()

1193

except (AttributeError, xml.dom.DOMException,

1194

xml.parsers.expat.ExpatError) as error:

1195

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

1196

exc_info = error)

1197

return xmlstring

1198

1199

def datetime_to_dbus(dt, variant_level=0):

1200

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

1201

if dt is None:

1202

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

1203

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

1204

1205

1206

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1207

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

1208

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

1209

interface names according to the "alt_interface_names" mapping.

1210

Usage:

1211

1212

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

1213

"net.example.AlternateInterface"})

1214

class SampleDBusObject(dbus.service.Object):

1215

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

1216

def SampleDBusMethod():

1217

pass

1218

1219

The above "SampleDBusMethod" on "SampleDBusObject" will be

1220

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

1221

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

1222

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

1223

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

1224

1225

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

1226

(from DBusObjectWithProperties) and interfaces (from the

1227

dbus_interface_annotations decorator).

1228

"""

1229

1230

def wrapper(cls):

1231

for orig_interface_name, alt_interface_name in (

1232

alt_interface_names.items()):

1233

attr = {}

1234

interface_names = set()

1235

# Go though all attributes of the class

1236

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

1237

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

1238

# with the wrong interface name

1239

if (not hasattr(attribute, "_dbus_interface")

1240

or not attribute._dbus_interface.startswith(

1241

orig_interface_name)):

1242

continue

1243

# Create an alternate D-Bus interface name based on

1244

# the current name

1245

alt_interface = attribute._dbus_interface.replace(

1246

orig_interface_name, alt_interface_name)

1247

interface_names.add(alt_interface)

1248

# Is this a D-Bus signal?

1249

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

1250

if sys.version_info.major == 2:

1251

# Extract the original non-method undecorated

1252

# function by black magic

1253

nonmethod_func = (dict(

1254

zip(attribute.func_code.co_freevars,

1255

attribute.__closure__))

1256

["func"].cell_contents)

1257

else:

1258

nonmethod_func = attribute

1259

# Create a new, but exactly alike, function

1260

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

1261

# with the alternate D-Bus interface name

1262

if sys.version_info.major == 2:

1263

new_function = types.FunctionType(

1264

nonmethod_func.func_code,

1265

nonmethod_func.func_globals,

1266

nonmethod_func.func_name,

1267

nonmethod_func.func_defaults,

1268

nonmethod_func.func_closure)

1269

else:

1270

new_function = types.FunctionType(

1271

nonmethod_func.__code__,

1272

nonmethod_func.__globals__,

1273

nonmethod_func.__name__,

1274

nonmethod_func.__defaults__,

1275

nonmethod_func.__closure__)

1276

new_function = (dbus.service.signal(

1277

alt_interface,

1278

attribute._dbus_signature)(new_function))

1279

# Copy annotations, if any

1280

try:

1281

new_function._dbus_annotations = dict(

1282

attribute._dbus_annotations)

1283

except AttributeError:

1284

pass

1285

# Define a creator of a function to call both the

1286

# original and alternate functions, so both the

1287

# original and alternate signals gets sent when

1288

# the function is called

1289

def fixscope(func1, func2):

1290

"""This function is a scope container to pass

1291

func1 and func2 to the "call_both" function

1292

outside of its arguments"""

1293

1294

@functools.wraps(func2)

1295

def call_both(*args, **kwargs):

1296

"""This function will emit two D-Bus

1297

signals by calling func1 and func2"""

1298

func1(*args, **kwargs)

1299

func2(*args, **kwargs)

1300

# Make wrapper function look like a D-Bus signal

1301

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

1302

if name.startswith("_dbus_"):

1303

setattr(call_both, name, attr)

1304

1305

return call_both

1306

# Create the "call_both" function and add it to

1307

# the class

1308

attr[attrname] = fixscope(attribute, new_function)

1309

# Is this a D-Bus method?

1310

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

1311

# Create a new, but exactly alike, function

1312

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

1313

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

1314

# to the class.

1315

attr[attrname] = (

1316

dbus.service.method(

1317

alt_interface,

1318

attribute._dbus_in_signature,

1319

attribute._dbus_out_signature)

1320

(types.FunctionType(attribute.func_code,

1321

attribute.func_globals,

1322

attribute.func_name,

1323

attribute.func_defaults,

1324

attribute.func_closure)))

1325

# Copy annotations, if any

1326

try:

1327

attr[attrname]._dbus_annotations = dict(

1328

attribute._dbus_annotations)

1329

except AttributeError:

1330

pass

1331

# Is this a D-Bus property?

1332

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

1333

# Create a new, but exactly alike, function

1334

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

1335

# property with the alternate D-Bus interface

1336

# name. Add it to the class.

1337

attr[attrname] = (dbus_service_property(

1338

alt_interface, attribute._dbus_signature,

1339

attribute._dbus_access,

1340

attribute._dbus_get_args_options

1341

["byte_arrays"])

1342

(types.FunctionType(

1343

attribute.func_code,

1344

attribute.func_globals,

1345

attribute.func_name,

1346

attribute.func_defaults,

1347

attribute.func_closure)))

1348

# Copy annotations, if any

1349

try:

1350

attr[attrname]._dbus_annotations = dict(

1351

attribute._dbus_annotations)

1352

except AttributeError:

1353

pass

1354

# Is this a D-Bus interface?

1355

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

1356

# Create a new, but exactly alike, function

1357

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

1358

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

1359

# to the class.

1360

attr[attrname] = (

1361

dbus_interface_annotations(alt_interface)

1362

(types.FunctionType(attribute.func_code,

1363

attribute.func_globals,

1364

attribute.func_name,

1365

attribute.func_defaults,

1366

attribute.func_closure)))

1367

if deprecate:

1368

# Deprecate all alternate interfaces

1369

iname="_AlternateDBusNames_interface_annotation{}"

1370

for interface_name in interface_names:

1371

1372

@dbus_interface_annotations(interface_name)

1373

def func(self):

1374

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

1375

"true" }

1376

# Find an unused name

1377

for aname in (iname.format(i)

1378

for i in itertools.count()):

1379

if aname not in attr:

1380

attr[aname] = func

1381

break

1382

if interface_names:

1383

# Replace the class with a new subclass of it with

1384

# methods, signals, etc. as created above.

1385

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

1386

(cls, ), attr)

1387

return cls

1388

1389

return wrapper

1390

1391

1392

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

1393

"se.bsnet.fukt.Mandos"})

713

1394

class ClientDBus(Client, DBusObjectWithProperties):

714

1395

"""A Client class using D-Bus

715

1396

719

1400

"""

720

1401

721

1402

runtime_expansions = (Client.runtime_expansions

722

+ ("dbus_object_path",))

1403

+ ("dbus_object_path", ))

1404

1405

_interface = "se.recompile.Mandos.Client"

723

1406

724

1407

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

725

1408

726

1409

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

727

self._approvals_pending = 0

728

1410

self.bus = bus

729

1411

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

730

1412

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

731

1413

# the D-Bus

732

client_object_name = unicode(self.name).translate(

1414

client_object_name = str(self.name).translate(

733

1415

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

734

1416

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

735

self.dbus_object_path = (dbus.ObjectPath

736

("/clients/" + client_object_name))

1417

self.dbus_object_path = dbus.ObjectPath(

1418

"/clients/" + client_object_name)

737

1419

DBusObjectWithProperties.__init__(self, self.bus,

738

1420

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

1421

1422

def notifychangeproperty(transform_func, dbus_name,

1423

type_func=lambda x: x,

1424

variant_level=1,

1425

invalidate_only=False,

1426

_interface=_interface):

1427

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

1428

its changes to DBus.

1429

1430

transform_fun: Function that takes a value and a variant_level

1431

and transforms it to a D-Bus type.

1432

dbus_name: D-Bus name of the variable

1433

type_func: Function that transform the value before sending it

1434

to the D-Bus. Default: no transform

1435

variant_level: D-Bus variant level. Default: 1

1436

"""

1437

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

1438

1439

def setter(self, value):

1440

if hasattr(self, "dbus_object_path"):

1441

if (not hasattr(self, attrname) or

1442

type_func(getattr(self, attrname, None))

1443

!= type_func(value)):

1444

if invalidate_only:

1445

self.PropertiesChanged(

1446

_interface, dbus.Dictionary(),

1447

dbus.Array((dbus_name, )))

1448

else:

1449

dbus_value = transform_func(

1450

type_func(value),

1451

variant_level = variant_level)

1452

self.PropertyChanged(dbus.String(dbus_name),

1453

dbus_value)

1454

self.PropertiesChanged(

1455

_interface,

1456

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

1457

dbus_value }),

1458

dbus.Array())

1459

setattr(self, attrname, value)

1460

1461

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

1462

1463

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1464

approvals_pending = notifychangeproperty(dbus.Boolean,

1465

"ApprovalPending",

1466

type_func = bool)

1467

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

1468

last_enabled = notifychangeproperty(datetime_to_dbus,

1469

"LastEnabled")

1470

checker = notifychangeproperty(

1471

dbus.Boolean, "CheckerRunning",

1472

type_func = lambda checker: checker is not None)

1473

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1474

"LastCheckedOK")

1475

last_checker_status = notifychangeproperty(dbus.Int16,

1476

"LastCheckerStatus")

1477

last_approval_request = notifychangeproperty(

1478

datetime_to_dbus, "LastApprovalRequest")

1479

approved_by_default = notifychangeproperty(dbus.Boolean,

1480

"ApprovedByDefault")

1481

approval_delay = notifychangeproperty(

1482

dbus.UInt64, "ApprovalDelay",

1483

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

1484

approval_duration = notifychangeproperty(

1485

dbus.UInt64, "ApprovalDuration",

1486

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

1487

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

1488

timeout = notifychangeproperty(

1489

dbus.UInt64, "Timeout",

1490

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

1491

extended_timeout = notifychangeproperty(

1492

dbus.UInt64, "ExtendedTimeout",

1493

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

1494

interval = notifychangeproperty(

1495

dbus.UInt64, "Interval",

1496

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

1497

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

1498

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

1499

invalidate_only=True)

1500

1501

del notifychangeproperty

783

1502

784

1503

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

785

1504

try:

790

1509

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

791

1510

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

792

1511

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)

1512

def checker_callback(self, source, condition,

1513

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

1514

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

1515

connection, command, *args,

1516

**kwargs)

1517

exitstatus = self.last_checker_status

1518

if exitstatus >= 0:

802

1519

# Emit D-Bus signal

803

1520

self.CheckerCompleted(dbus.Int16(exitstatus),

804

dbus.Int64(condition),

1521

# This is specific to GNU libC

1522

dbus.Int64(exitstatus << 8),

805

1523

dbus.String(command))

806

1524

else:

807

1525

# Emit D-Bus signal

808

1526

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

809

dbus.Int64(condition),

1527

dbus.Int64(

1528

# This is specific to GNU libC

1529

(exitstatus << 8)

1530

| self.last_checker_signal),

810

1531

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

1532

return ret

832

1533

833

1534

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

1535

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

839

1536

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

840

1537

# Only if new checker process was started

841

1538

if (self.checker is not None

842

1539

and old_checker_pid != self.checker.pid):

843

1540

# Emit D-Bus signal

844

1541

self.CheckerStarted(self.current_checker_command)

845

self.PropertyChanged(

846

dbus.String("CheckerRunning"),

847

dbus.Boolean(True, variant_level=1))

848

1542

return r

849

1543

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

1544

def _reset_approved(self):

860

self._approved = None

1545

self.approved = None

861

1546

return False

862

1547

863

1548

def approve(self, value=True):

1549

self.approved = value

1550

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

1551

* 1000), self._reset_approved)

864

1552

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

1553

871

1554

## D-Bus methods, signals & properties

872

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

1555

1556

## Interfaces

873

1557

874

1558

## Signals

875

1559

886

1570

pass

887

1571

888

1572

# PropertyChanged - signal

1573

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

889

1574

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

890

1575

def PropertyChanged(self, property, value):

891

1576

"D-Bus signal"

922

1607

# CheckedOK - method

923

1608

@dbus.service.method(_interface)

924

1609

def CheckedOK(self):

925

return self.checked_ok()

1610

self.checked_ok()

926

1611

927

1612

# Enable - method

1613

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

928

1614

@dbus.service.method(_interface)

929

1615

def Enable(self):

930

1616

"D-Bus method"

931

1617

self.enable()

932

1618

933

1619

# StartChecker - method

1620

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

934

1621

@dbus.service.method(_interface)

935

1622

def StartChecker(self):

936

1623

"D-Bus method"

937

1624

self.start_checker()

938

1625

939

1626

# Disable - method

1627

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

940

1628

@dbus.service.method(_interface)

941

1629

def Disable(self):

942

1630

"D-Bus method"

943

1631

self.disable()

944

1632

945

1633

# StopChecker - method

1634

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

946

1635

@dbus.service.method(_interface)

947

1636

def StopChecker(self):

948

1637

self.stop_checker()

955

1644

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

956

1645

957

1646

# ApprovedByDefault - property

958

@dbus_service_property(_interface, signature="b",

1647

@dbus_service_property(_interface,

1648

signature="b",

959

1649

access="readwrite")

960

1650

def ApprovedByDefault_dbus_property(self, value=None):

961

1651

if value is None: # get

962

1652

return dbus.Boolean(self.approved_by_default)

963

1653

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

1654

968

1655

# ApprovalDelay - property

969

@dbus_service_property(_interface, signature="t",

1656

@dbus_service_property(_interface,

1657

signature="t",

970

1658

access="readwrite")

971

1659

def ApprovalDelay_dbus_property(self, value=None):

972

1660

if value is None: # get

973

return dbus.UInt64(self.approval_delay_milliseconds())

1661

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

1662

* 1000)

974

1663

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

1664

979

1665

# ApprovalDuration - property

980

@dbus_service_property(_interface, signature="t",

1666

@dbus_service_property(_interface,

1667

signature="t",

981

1668

access="readwrite")

982

1669

def ApprovalDuration_dbus_property(self, value=None):

983

1670

if value is None: # get

984

return dbus.UInt64(self._timedelta_to_milliseconds(

985

self.approval_duration))

1671

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

1672

* 1000)

986

1673

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

1674

991

1675

# Name - property

1676

@dbus_annotations(

1677

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

992

1678

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

993

1679

def Name_dbus_property(self):

994

1680

return dbus.String(self.name)

995

1681

996

1682

# Fingerprint - property

1683

@dbus_annotations(

1684

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

997

1685

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

998

1686

def Fingerprint_dbus_property(self):

999

1687

return dbus.String(self.fingerprint)

1000

1688

1001

1689

# Host - property

1002

@dbus_service_property(_interface, signature="s",

1690

@dbus_service_property(_interface,

1691

signature="s",

1003

1692

access="readwrite")

1004

1693

def Host_dbus_property(self, value=None):

1005

1694

if value is None: # get

1006

1695

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

1696

self.host = str(value)

1011

1697

1012

1698

# Created - property

1699

@dbus_annotations(

1700

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

1013

1701

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

1014

1702

def Created_dbus_property(self):

1015

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

1703

return datetime_to_dbus(self.created)

1016

1704

1017

1705

# LastEnabled - property

1018

1706

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

1019

1707

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

1708

return datetime_to_dbus(self.last_enabled)

1023

1709

1024

1710

# Enabled - property

1025

@dbus_service_property(_interface, signature="b",

1711

@dbus_service_property(_interface,

1712

signature="b",

1026

1713

access="readwrite")

1027

1714

def Enabled_dbus_property(self, value=None):

1028

1715

if value is None: # get

1033

1720

self.disable()

1034

1721

1035

1722

# LastCheckedOK - property

1036

@dbus_service_property(_interface, signature="s",

1723

@dbus_service_property(_interface,

1724

signature="s",

1037

1725

access="readwrite")

1038

1726

def LastCheckedOK_dbus_property(self, value=None):

1039

1727

if value is not None:

1040

1728

self.checked_ok()

1041

1729

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

1730

return datetime_to_dbus(self.last_checked_ok)

1731

1732

# LastCheckerStatus - property

1733

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

1734

def LastCheckerStatus_dbus_property(self):

1735

return dbus.Int16(self.last_checker_status)

1736

1737

# Expires - property

1738

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

1739

def Expires_dbus_property(self):

1740

return datetime_to_dbus(self.expires)

1046

1741

1047

1742

# LastApprovalRequest - property

1048

1743

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

1049

1744

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

1745

return datetime_to_dbus(self.last_approval_request)

1055

1746

1056

1747

# Timeout - property

1057

@dbus_service_property(_interface, signature="t",

1748

@dbus_service_property(_interface,

1749

signature="t",

1058

1750

access="readwrite")

1059

1751

def Timeout_dbus_property(self, value=None):

1060

1752

if value is None: # get

1061

return dbus.UInt64(self.timeout_milliseconds())

1753

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

1754

old_timeout = self.timeout

1062

1755

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

1756

# Reschedule disabling

1757

if self.enabled:

1758

now = datetime.datetime.utcnow()

1759

self.expires += self.timeout - old_timeout

1760

if self.expires <= now:

1761

# The timeout has passed

1762

self.disable()

1763

else:

1764

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

1765

is None):

1766

return

1767

gobject.source_remove(self.disable_initiator_tag)

1768

self.disable_initiator_tag = gobject.timeout_add(

1769

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

1770

self.disable)

1771

1772

# ExtendedTimeout - property

1773

@dbus_service_property(_interface,

1774

signature="t",

1775

access="readwrite")

1776

def ExtendedTimeout_dbus_property(self, value=None):

1777

if value is None: # get

1778

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

1779

* 1000)

1780

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

1083

1781

1084

1782

# Interval - property

1085

@dbus_service_property(_interface, signature="t",

1783

@dbus_service_property(_interface,

1784

signature="t",

1086

1785

access="readwrite")

1087

1786

def Interval_dbus_property(self, value=None):

1088

1787

if value is None: # get

1089

return dbus.UInt64(self.interval_milliseconds())

1788

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

1090

1789

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

1790

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

1095

1791

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

1792

if self.enabled:

1793

# Reschedule checker run

1794

gobject.source_remove(self.checker_initiator_tag)

1795

self.checker_initiator_tag = gobject.timeout_add(

1796

value, self.start_checker)

1797

self.start_checker() # Start one now, too

1798

1102

1799

# Checker - property

1103

@dbus_service_property(_interface, signature="s",

1800

@dbus_service_property(_interface,

1801

signature="s",

1104

1802

access="readwrite")

1105

1803

def Checker_dbus_property(self, value=None):

1106

1804

if value is None: # get

1107

1805

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

1806

self.checker_command = str(value)

1113

1807

1114

1808

# CheckerRunning - property

1115

@dbus_service_property(_interface, signature="b",

1809

@dbus_service_property(_interface,

1810

signature="b",

1116

1811

access="readwrite")

1117

1812

def CheckerRunning_dbus_property(self, value=None):

1118

1813

if value is None: # get

1123

1818

self.stop_checker()

1124

1819

1125

1820

# ObjectPath - property

1821

@dbus_annotations(

1822

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

1823

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

1126

1824

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

1127

1825

def ObjectPath_dbus_property(self):

1128

1826

return self.dbus_object_path # is already a dbus.ObjectPath

1129

1827

1130

1828

# Secret = property

1131

@dbus_service_property(_interface, signature="ay",

1132

access="write", byte_arrays=True)

1829

@dbus_annotations(

1830

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

1831

"invalidates"})

1832

@dbus_service_property(_interface,

1833

signature="ay",

1834

access="write",

1835

byte_arrays=True)

1133

1836

def Secret_dbus_property(self, value):

1134

self.secret = str(value)

1837

self.secret = bytes(value)

1135

1838

1136

1839

del _interface

1137

1840

1141

1844

self._pipe = child_pipe

1142

1845

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

1143

1846

if not self._pipe.recv():

1144

raise KeyError()

1145

1847

raise KeyError(fpr)

1848

1146

1849

def __getattribute__(self, name):

1147

if(name == '_pipe'):

1850

if name == '_pipe':

1148

1851

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

1149

1852

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

1150

1853

data = self._pipe.recv()

1151

1854

if data[0] == 'data':

1152

1855

return data[1]

1153

1856

if data[0] == 'function':

1857

1154

1858

def func(*args, **kwargs):

1155

1859

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

1156

1860

return self._pipe.recv()[1]

1861

1157

1862

return func

1158

1863

1159

1864

def __setattr__(self, name, value):

1160

if(name == '_pipe'):

1865

if name == '_pipe':

1161

1866

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

1162

1867

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

1163

1868

1171

1876

def handle(self):

1172

1877

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

1173

1878

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

1174

unicode(self.client_address))

1879

str(self.client_address))

1175

1880

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

1176

1881

self.server.child_pipe.fileno())

1177

1178

session = (gnutls.connection

1179

.ClientSession(self.request,

1180

gnutls.connection

1181

.X509Credentials()))

1182

1882

1883

session = gnutls.connection.ClientSession(

1884

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

1885

1183

1886

# Note: gnutls.connection.X509Credentials is really a

1184

1887

# generic GnuTLS certificate credentials object so long as

1185

1888

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

1186

1889

# here despite using OpenPGP certificates.

1187

1890

1188

1891

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

1189

1892

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

1190

1893

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

1193

1896

priority = self.server.gnutls_priority

1194

1897

if priority is None:

1195

1898

priority = "NORMAL"

1196

(gnutls.library.functions

1197

.gnutls_priority_set_direct(session._c_object,

1198

priority, None))

1199

1899

gnutls.library.functions.gnutls_priority_set_direct(

1900

session._c_object, priority, None)

1901

1200

1902

# Start communication using the Mandos protocol

1201

1903

# Get protocol number

1202

1904

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

1203

1905

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

1204

1906

try:

1205

1907

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

1206

raise RuntimeError

1207

except (ValueError, IndexError, RuntimeError), error:

1908

raise RuntimeError(line)

1909

except (ValueError, IndexError, RuntimeError) as error:

1208

1910

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

1209

1911

return

1210

1912

1211

1913

# Start GnuTLS connection

1212

1914

try:

1213

1915

session.handshake()

1214

except gnutls.errors.GNUTLSError, error:

1916

except gnutls.errors.GNUTLSError as error:

1215

1917

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

1216

1918

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

1217

1919

# established. Just abandon the request.

1218

1920

return

1219

1921

logger.debug("Handshake succeeded")

1220

1922

1221

1923

approval_required = False

1222

1924

try:

1223

1925

try:

1224

fpr = self.fingerprint(self.peer_certificate

1225

(session))

1226

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

1926

fpr = self.fingerprint(

1927

self.peer_certificate(session))

1928

except (TypeError,

1929

gnutls.errors.GNUTLSError) as error:

1227

1930

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

1228

1931

return

1229

1932

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

1230

1933

1231

1934

try:

1232

1935

client = ProxyClient(child_pipe, fpr,

1233

1936

self.client_address)

1241

1944

1242

1945

while True:

1243

1946

if not client.enabled:

1244

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

1245

client.name)

1947

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

1948

client.name)

1246

1949

if self.server.use_dbus:

1247

1950

# Emit D-Bus signal

1248

client.Rejected("Disabled")

1951

client.Rejected("Disabled")

1249

1952

return

1250

1953

1251

if client._approved or not client.approval_delay:

1954

if client.approved or not client.approval_delay:

1252

1955

#We are approved or approval is disabled

1253

1956

break

1254

elif client._approved is None:

1957

elif client.approved is None:

1255

1958

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

1256

1959

client.name)

1257

1960

if self.server.use_dbus:

1258

1961

# Emit D-Bus signal

1259

1962

client.NeedApproval(

1260

client.approval_delay_milliseconds(),

1261

client.approved_by_default)

1963

client.approval_delay.total_seconds()

1964

* 1000, client.approved_by_default)

1262

1965

else:

1263

1966

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

1264

1967

client.name)

1268

1971

return

1269

1972

1270

1973

#wait until timeout or approved

1271

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

1272

1974

time = datetime.datetime.now()

1273

1975

client.changedstate.acquire()

1274

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

1976

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

1275

1977

client.changedstate.release()

1276

1978

time2 = datetime.datetime.now()

1277

1979

if (time2 - time) >= delay:

1292

1994

while sent_size < len(client.secret):

1293

1995

try:

1294

1996

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

1295

except (gnutls.errors.GNUTLSError), error:

1296

logger.warning("gnutls send failed")

1997

except gnutls.errors.GNUTLSError as error:

1998

logger.warning("gnutls send failed",

1999

exc_info=error)

1297

2000

return

1298

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

1299

sent, len(client.secret)

1300

- (sent_size + sent))

2001

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

2002

len(client.secret) - (sent_size

2003

+ sent))

1301

2004

sent_size += sent

1302

2005

1303

2006

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

1304

# bump the timeout as if seen

1305

client.checked_ok()

2007

# bump the timeout using extended_timeout

2008

client.bump_timeout(client.extended_timeout)

1306

2009

if self.server.use_dbus:

1307

2010

# Emit D-Bus signal

1308

2011

client.GotSecret()

1312

2015

client.approvals_pending -= 1

1313

2016

try:

1314

2017

session.bye()

1315

except (gnutls.errors.GNUTLSError), error:

1316

logger.warning("GnuTLS bye failed")

2018

except gnutls.errors.GNUTLSError as error:

2019

logger.warning("GnuTLS bye failed",

2020

exc_info=error)

1317

2021

1318

2022

@staticmethod

1319

2023

def peer_certificate(session):

1320

2024

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

1321

2025

# If not an OpenPGP certificate...

1322

if (gnutls.library.functions

1323

.gnutls_certificate_type_get(session._c_object)

2026

if (gnutls.library.functions.gnutls_certificate_type_get(

2027

session._c_object)

1324

2028

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1325

2029

# ...do the normal thing

1326

2030

return session.peer_certificate

1340

2044

def fingerprint(openpgp):

1341

2045

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1342

2046

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

2047

datum = gnutls.library.types.gnutls_datum_t(

2048

ctypes.cast(ctypes.c_char_p(openpgp),

2049

ctypes.POINTER(ctypes.c_ubyte)),

2050

ctypes.c_uint(len(openpgp)))

1348

2051

# New empty GnuTLS certificate

1349

2052

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1350

(gnutls.library.functions

1351

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2053

gnutls.library.functions.gnutls_openpgp_crt_init(

2054

ctypes.byref(crt))

1352

2055

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

2056

gnutls.library.functions.gnutls_openpgp_crt_import(

2057

crt, ctypes.byref(datum),

2058

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1357

2059

# Verify the self signature in the key

1358

2060

crtverify = ctypes.c_uint()

1359

(gnutls.library.functions

1360

.gnutls_openpgp_crt_verify_self(crt, 0,

1361

ctypes.byref(crtverify)))

2061

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2062

crt, 0, ctypes.byref(crtverify))

1362

2063

if crtverify.value != 0:

1363

2064

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1364

raise (gnutls.errors.CertificateSecurityError

1365

("Verify failed"))

2065

raise gnutls.errors.CertificateSecurityError(

2066

"Verify failed")

1366

2067

# New buffer for the fingerprint

1367

2068

buf = ctypes.create_string_buffer(20)

1368

2069

buf_len = ctypes.c_size_t()

1369

2070

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

2071

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2072

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

1373

2073

# Deinit the certificate

1374

2074

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1375

2075

# Convert the buffer to a Python bytestring

1376

2076

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

1377

2077

# Convert the bytestring to hexadecimal notation

1378

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

2078

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

1379

2079

return hex_fpr

1380

2080

1381

2081

1382

2082

class MultiprocessingMixIn(object):

1383

2083

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

2084

1384

2085

def sub_process_main(self, request, address):

1385

2086

try:

1386

2087

self.finish_request(request, address)

1387

except:

2088

except Exception:

1388

2089

self.handle_error(request, address)

1389

2090

self.close_request(request)

1390

2091

1391

2092

def process_request(self, request, address):

1392

2093

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

1393

multiprocessing.Process(target = self.sub_process_main,

1394

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

2094

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

2095

args = (request, address))

2096

proc.start()

2097

return proc

2098

1395

2099

1396

2100

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1397

2101

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

2102

1398

2103

def process_request(self, request, client_address):

1399

2104

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

1400

2105

1401

2106

This function creates a new pipe in self.pipe

1402

2107

"""

1403

2108

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1404

1405

super(MultiprocessingMixInWithPipe,

1406

self).process_request(request, client_address)

2109

2110

proc = MultiprocessingMixIn.process_request(self, request,

2111

client_address)

1407

2112

self.child_pipe.close()

1408

self.add_pipe(parent_pipe)

1409

1410

def add_pipe(self, parent_pipe):

2113

self.add_pipe(parent_pipe, proc)

2114

2115

def add_pipe(self, parent_pipe, proc):

1411

2116

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

1412

raise NotImplementedError

2117

raise NotImplementedError()

2118

1413

2119

1414

2120

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1415

2121

socketserver.TCPServer, object):

1420

2126

interface: None or a network interface name (string)

1421

2127

use_ipv6: Boolean; to use IPv6 or not

1422

2128

"""

2129

1423

2130

def __init__(self, server_address, RequestHandlerClass,

1424

interface=None, use_ipv6=True):

2131

interface=None,

2132

use_ipv6=True,

2133

socketfd=None):

2134

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

2135

creating a new one with socket.socket().

2136

"""

1425

2137

self.interface = interface

1426

2138

if use_ipv6:

1427

2139

self.address_family = socket.AF_INET6

2140

if socketfd is not None:

2141

# Save the file descriptor

2142

self.socketfd = socketfd

2143

# Save the original socket.socket() function

2144

self.socket_socket = socket.socket

2145

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

2146

#

2147

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

2148

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

2149

# patching socket.socket.)

2150

#

2151

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

2152

@functools.wraps(socket.socket)

2153

def socket_wrapper(*args, **kwargs):

2154

# Restore original function so subsequent calls are

2155

# not affected.

2156

socket.socket = self.socket_socket

2157

del self.socket_socket

2158

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

2159

# saved file descriptor.

2160

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

2161

# Replace socket.socket() function with wrapper

2162

socket.socket = socket_wrapper

2163

# The socketserver.TCPServer.__init__ will call

2164

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

2165

# socket_wrapper(), if socketfd was set.

1428

2166

socketserver.TCPServer.__init__(self, server_address,

1429

2167

RequestHandlerClass)

2168

1430

2169

def server_bind(self):

1431

2170

"""This overrides the normal server_bind() function

1432

2171

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

1438

2177

self.interface)

1439

2178

else:

1440

2179

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:

2180

self.socket.setsockopt(

2181

socket.SOL_SOCKET, SO_BINDTODEVICE,

2182

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

2183

except socket.error as error:

2184

if error.errno == errno.EPERM:

2185

logger.error("No permission to bind to"

2186

" interface %s", self.interface)

2187

elif error.errno == errno.ENOPROTOOPT:

1451

2188

logger.error("SO_BINDTODEVICE not available;"

1452

2189

" cannot bind to interface %s",

1453

2190

self.interface)

2191

elif error.errno == errno.ENODEV:

2192

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

2193

" cannot bind", self.interface)

1454

2194

else:

1455

2195

raise

1456

2196

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

1459

2199

if self.address_family == socket.AF_INET6:

1460

2200

any_address = "::" # in6addr_any

1461

2201

else:

1462

any_address = socket.INADDR_ANY

2202

any_address = "0.0.0.0" # INADDR_ANY

1463

2203

self.server_address = (any_address,

1464

2204

self.server_address[1])

1465

2205

elif not self.server_address[1]:

1466

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

1467

0)

2206

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

1468

2207

# if self.interface:

1469

2208

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

1470

2209

# 0, # port

1484

2223

1485

2224

Assumes a gobject.MainLoop event loop.

1486

2225

"""

2226

1487

2227

def __init__(self, server_address, RequestHandlerClass,

1488

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

1489

gnutls_priority=None, use_dbus=True):

2228

interface=None,

2229

use_ipv6=True,

2230

clients=None,

2231

gnutls_priority=None,

2232

use_dbus=True,

2233

socketfd=None):

1490

2234

self.enabled = False

1491

2235

self.clients = clients

1492

2236

if self.clients is None:

1493

self.clients = set()

2237

self.clients = {}

1494

2238

self.use_dbus = use_dbus

1495

2239

self.gnutls_priority = gnutls_priority

1496

2240

IPv6_TCPServer.__init__(self, server_address,

1497

2241

RequestHandlerClass,

1498

2242

interface = interface,

1499

use_ipv6 = use_ipv6)

2243

use_ipv6 = use_ipv6,

2244

socketfd = socketfd)

2245

1500

2246

def server_activate(self):

1501

2247

if self.enabled:

1502

2248

return socketserver.TCPServer.server_activate(self)

2249

1503

2250

def enable(self):

1504

2251

self.enabled = True

1505

def add_pipe(self, parent_pipe):

2252

2253

def add_pipe(self, parent_pipe, proc):

1506

2254

# 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,

2255

gobject.io_add_watch(

2256

parent_pipe.fileno(),

2257

gobject.IO_IN | gobject.IO_HUP,

2258

functools.partial(self.handle_ipc,

2259

parent_pipe = parent_pipe,

2260

proc = proc))

2261

2262

def handle_ipc(self, source, condition,

2263

parent_pipe=None,

2264

proc = None,

1513

2265

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

2266

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

2267

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

2268

# Wait for other process to exit

2269

proc.join()

1530

2270

return False

1531

2271

1532

2272

# Read a request from the child

1537

2277

fpr = request[1]

1538

2278

address = request[2]

1539

2279

1540

for c in self.clients:

2280

for c in self.clients.itervalues():

1541

2281

if c.fingerprint == fpr:

1542

2282

client = c

1543

2283

break

1544

2284

else:

1545

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

1546

"dress: %s", fpr, address)

2285

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

2286

"dress: %s", fpr, address)

1547

2287

if self.use_dbus:

1548

2288

# Emit D-Bus signal

1549

mandos_dbus_service.ClientNotFound(fpr, address[0])

2289

mandos_dbus_service.ClientNotFound(fpr,

2290

address[0])

1550

2291

parent_pipe.send(False)

1551

2292

return False

1552

2293

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

2294

gobject.io_add_watch(

2295

parent_pipe.fileno(),

2296

gobject.IO_IN | gobject.IO_HUP,

2297

functools.partial(self.handle_ipc,

2298

parent_pipe = parent_pipe,

2299

proc = proc,

2300

client_object = client))

1558

2301

parent_pipe.send(True)

1559

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

2302

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

2303

# same fileno

1560

2304

return False

1561

2305

if command == 'funcall':

1562

2306

funcname = request[1]

1563

2307

args = request[2]

1564

2308

kwargs = request[3]

1565

2309

1566

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

1567

2310

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

2311

funcname)(*args,

2312

**kwargs)))

2313

1568

2314

if command == 'getattr':

1569

2315

attrname = request[1]

1570

if callable(client_object.__getattribute__(attrname)):

1571

parent_pipe.send(('function',))

2316

if isinstance(client_object.__getattribute__(attrname),

2317

collections.Callable):

2318

parent_pipe.send(('function', ))

1572

2319

else:

1573

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

2320

parent_pipe.send((

2321

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

1574

2322

1575

2323

if command == 'setattr':

1576

2324

attrname = request[1]

1577

2325

value = request[2]

1578

2326

setattr(client_object, attrname, value)

1579

2327

1580

2328

return True

1581

2329

1582

2330

2331

def rfc3339_duration_to_delta(duration):

2332

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

2333

2334

>>> rfc3339_duration_to_delta("P7D")

2335

datetime.timedelta(7)

2336

>>> rfc3339_duration_to_delta("PT60S")

2337

datetime.timedelta(0, 60)

2338

>>> rfc3339_duration_to_delta("PT60M")

2339

datetime.timedelta(0, 3600)

2340

>>> rfc3339_duration_to_delta("PT24H")

2341

datetime.timedelta(1)

2342

>>> rfc3339_duration_to_delta("P1W")

2343

datetime.timedelta(7)

2344

>>> rfc3339_duration_to_delta("PT5M30S")

2345

datetime.timedelta(0, 330)

2346

>>> rfc3339_duration_to_delta("P1DT3M20S")

2347

datetime.timedelta(1, 200)

2348

"""

2349

2350

# Parsing an RFC 3339 duration with regular expressions is not

2351

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

2352

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

2353

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

2354

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

2355

# avoid excessive use of external libraries.

2356

2357

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

2358

Token = collections.namedtuple("Token", (

2359

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

2360

# a "group" containing digits

2361

"value", # datetime.timedelta or None

2362

"followers")) # Tokens valid after this token

2363

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

2364

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

2365

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

2366

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

2367

datetime.timedelta(seconds=1),

2368

frozenset((token_end, )))

2369

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

2370

datetime.timedelta(minutes=1),

2371

frozenset((token_second, token_end)))

2372

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

2373

datetime.timedelta(hours=1),

2374

frozenset((token_minute, token_end)))

2375

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

2376

None,

2377

frozenset((token_hour, token_minute,

2378

token_second)))

2379

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

2380

datetime.timedelta(days=1),

2381

frozenset((token_time, token_end)))

2382

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

2383

datetime.timedelta(weeks=4),

2384

frozenset((token_day, token_end)))

2385

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

2386

datetime.timedelta(weeks=52),

2387

frozenset((token_month, token_end)))

2388

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

2389

datetime.timedelta(weeks=1),

2390

frozenset((token_end, )))

2391

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

2392

frozenset((token_year, token_month,

2393

token_day, token_time,

2394

token_week)))

2395

# Define starting values

2396

value = datetime.timedelta() # Value so far

2397

found_token = None

2398

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

2399

s = duration # String left to parse

2400

# Loop until end token is found

2401

while found_token is not token_end:

2402

# Search for any currently valid tokens

2403

for token in followers:

2404

match = token.regexp.match(s)

2405

if match is not None:

2406

# Token found

2407

if token.value is not None:

2408

# Value found, parse digits

2409

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

2410

# Add to value so far

2411

value += factor * token.value

2412

# Strip token from string

2413

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

2414

# Go to found token

2415

found_token = token

2416

# Set valid next tokens

2417

followers = found_token.followers

2418

break

2419

else:

2420

# No currently valid tokens were found

2421

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

2422

.format(duration))

2423

# End token found

2424

return value

2425

2426

1583

2427

def string_to_delta(interval):

1584

2428

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

1585

2429

1596

2440

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

1597

2441

datetime.timedelta(0, 330)

1598

2442

"""

2443

2444

try:

2445

return rfc3339_duration_to_delta(interval)

2446

except ValueError:

2447

pass

2448

1599

2449

timevalue = datetime.timedelta(0)

1600

2450

for s in interval.split():

1601

2451

try:

1602

suffix = unicode(s[-1])

2452

suffix = s[-1]

1603

2453

value = int(s[:-1])

1604

2454

if suffix == "d":

1605

2455

delta = datetime.timedelta(value)

1612

2462

elif suffix == "w":

1613

2463

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

1614

2464

else:

1615

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

1616

except (ValueError, IndexError), e:

2465

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

2466

except IndexError as e:

1617

2467

raise ValueError(*(e.args))

1618

2468

timevalue += delta

1619

2469

return timevalue

1620

2470

1621

2471

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

2472

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

1647

2473

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

1648

2474

1656

2482

sys.exit()

1657

2483

if not noclose:

1658

2484

# Close all standard open file descriptors

1659

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

2485

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

1660

2486

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

1661

2487

raise OSError(errno.ENODEV,

1662

"%s not a character device"

1663

% os.path.devnull)

2488

"{} not a character device"

2489

.format(os.devnull))

1664

2490

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

1665

2491

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

1666

2492

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

1673

2499

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

1674

2500

# Parsing of options, both command line and config file

1675

2501

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]

2502

parser = argparse.ArgumentParser()

2503

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

2504

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

2505

help="show version number and exit")

2506

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

2507

help="Bind to interface IF")

2508

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

2509

help="Address to listen for requests on")

2510

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

2511

help="Port number to receive requests on")

2512

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

2513

help="Run self-test")

2514

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

2515

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

2516

" to terminal", default=None)

2517

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

2518

help="Debug level for stdout output")

2519

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

2520

" priority string (see GnuTLS documentation)")

2521

parser.add_argument("--servicename",

2522

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

2523

parser.add_argument("--configdir",

2524

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

2525

help="Directory to search for configuration"

2526

" files")

2527

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

2528

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

2529

" system bus interface", default=None)

2530

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

2531

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

2532

default=None)

2533

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

2534

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

2535

" state", default=None)

2536

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

2537

help="Specify a file descriptor to a network"

2538

" socket to use instead of creating one")

2539

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

2540

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

2541

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

2542

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

2543

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

2544

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

2545

default=None)

2546

2547

options = parser.parse_args()

1704

2548

1705

2549

if options.check:

1706

2550

import doctest

1707

doctest.testmod()

1708

sys.exit()

2551

fail_count, test_count = doctest.testmod()

2552

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

1709

2553

1710

2554

# Default values for config file for server-global settings

1711

2555

server_defaults = { "interface": "",

1713

2557

"port": "",

1714

2558

"debug": "False",

1715

2559

"priority":

1716

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

2560

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

2561

":+SIGN-DSA-SHA256",

1717

2562

"servicename": "Mandos",

1718

2563

"use_dbus": "True",

1719

2564

"use_ipv6": "True",

1720

2565

"debuglevel": "",

1721

}

2566

"restore": "True",

2567

"socket": "",

2568

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

2569

"foreground": "False",

2570

"zeroconf": "True",

2571

}

1722

2572

1723

2573

# Parse config file for server-global settings

1724

2574

server_config = configparser.SafeConfigParser(server_defaults)

1725

2575

del server_defaults

1726

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

1727

"mandos.conf"))

2576

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

1728

2577

# Convert the SafeConfigParser object to a dict

1729

2578

server_settings = server_config.defaults()

1730

2579

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

1731

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

2580

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

1732

2581

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

1733

2582

option)

1734

2583

if server_settings["port"]:

1735

2584

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

1736

2585

"port")

2586

if server_settings["socket"]:

2587

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

2588

"socket")

2589

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

2590

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

2591

# happen with a supplied network socket.

2592

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

2593

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

2594

["socket"])

1737

2595

del server_config

1738

2596

1739

2597

# Override the settings from the config file with command line

1740

2598

# options, if set.

1741

2599

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

1742

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

1743

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

2600

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

2601

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

2602

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

1744

2603

value = getattr(options, option)

1745

2604

if value is not None:

1746

2605

server_settings[option] = value

1747

2606

del options

1748

2607

# Force all strings to be unicode

1749

2608

for option in server_settings.keys():

1750

if type(server_settings[option]) is str:

1751

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

2609

if isinstance(server_settings[option], bytes):

2610

server_settings[option] = (server_settings[option]

2611

.decode("utf-8"))

2612

# Force all boolean options to be boolean

2613

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

2614

"foreground", "zeroconf"):

2615

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

2616

# Debug implies foreground

2617

if server_settings["debug"]:

2618

server_settings["foreground"] = True

1752

2619

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

1753

2620

1754

2621

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

1755

2622

2623

if (not server_settings["zeroconf"]

2624

and not (server_settings["port"]

2625

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

2626

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

2627

1756

2628

# For convenience

1757

2629

debug = server_settings["debug"]

1758

2630

debuglevel = server_settings["debuglevel"]

1759

2631

use_dbus = server_settings["use_dbus"]

1760

2632

use_ipv6 = server_settings["use_ipv6"]

1761

2633

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

2634

stored_state_file)

2635

foreground = server_settings["foreground"]

2636

zeroconf = server_settings["zeroconf"]

2637

2638

if debug:

2639

initlogger(debug, logging.DEBUG)

2640

else:

2641

if not debuglevel:

2642

initlogger(debug)

2643

else:

2644

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

2645

initlogger(debug, level)

2646

1762

2647

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

1763

syslogger.setFormatter(logging.Formatter

1764

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

1765

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

1766

% server_settings["servicename"]))

2648

syslogger.setFormatter(

2649

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

2650

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

2651

server_settings["servicename"])))

1767

2652

1768

2653

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

2654

client_config = configparser.SafeConfigParser(Client

2655

.client_defaults)

1777

2656

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

1778

2657

"clients.conf"))

1779

2658

1780

2659

global mandos_dbus_service

1781

2660

mandos_dbus_service = None

1782

2661

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"

2662

socketfd = None

2663

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

2664

socketfd = server_settings["socket"]

2665

tcp_server = MandosServer(

2666

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

2667

ClientHandler,

2668

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

2669

use_ipv6=use_ipv6,

2670

gnutls_priority=server_settings["priority"],

2671

use_dbus=use_dbus,

2672

socketfd=socketfd)

2673

if not foreground:

2674

pidfilename = "/run/mandos.pid"

2675

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

2676

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

2677

pidfile = None

1794

2678

try:

1795

pidfile = open(pidfilename, "w")

1796

except IOError:

1797

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

2679

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

2680

except IOError as e:

2681

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

2682

exc_info=e)

1798

2683

1799

try:

1800

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

1801

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

1802

except KeyError:

2684

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

1803

2685

try:

1804

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

1805

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

2686

uid = pwd.getpwnam(name).pw_uid

2687

gid = pwd.getpwnam(name).pw_gid

2688

break

1806

2689

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

2690

continue

2691

else:

2692

uid = 65534

2693

gid = 65534

1813

2694

try:

1814

2695

os.setgid(gid)

1815

2696

os.setuid(uid)

1816

except OSError, error:

1817

if error[0] != errno.EPERM:

1818

raise error

2697

except OSError as error:

2698

if error.errno != errno.EPERM:

2699

raise

1819

2700

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

2701

if debug:

1829

2702

# Enable all possible GnuTLS debugging

1830

2703

1836

2709

def debug_gnutls(level, string):

1837

2710

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

1838

2711

1839

(gnutls.library.functions

1840

.gnutls_global_set_log_function(debug_gnutls))

2712

gnutls.library.functions.gnutls_global_set_log_function(

2713

debug_gnutls)

1841

2714

1842

2715

# Redirect stdin so all checkers get /dev/null

1843

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

2716

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

1844

2717

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

1845

2718

if null > 2:

1846

2719

os.close(null)

1847

else:

1848

# No console logging

1849

logger.removeHandler(console)

1850

2720

1851

2721

# Need to fork before connecting to D-Bus

1852

if not debug:

2722

if not foreground:

1853

2723

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

1854

2724

daemon()

1855

2725

2726

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

2727

# need to inform gobject that threads will be used.

2728

gobject.threads_init()

2729

1856

2730

global main_loop

1857

2731

# From the Avahi example code

1858

DBusGMainLoop(set_as_default=True )

2732

DBusGMainLoop(set_as_default=True)

1859

2733

main_loop = gobject.MainLoop()

1860

2734

bus = dbus.SystemBus()

1861

2735

# End of Avahi example code

1862

2736

if use_dbus:

1863

2737

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

2738

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

2739

bus,

2740

do_not_queue=True)

2741

old_bus_name = dbus.service.BusName(

2742

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

2743

do_not_queue=True)

2744

except dbus.exceptions.DBusException as e:

2745

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

1868

2746

use_dbus = False

1869

2747

server_settings["use_dbus"] = False

1870

2748

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

2749

if zeroconf:

2750

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2751

service = AvahiServiceToSyslog(

2752

name = server_settings["servicename"],

2753

servicetype = "_mandos._tcp",

2754

protocol = protocol,

2755

bus = bus)

2756

if server_settings["interface"]:

2757

service.interface = if_nametoindex(

2758

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

1878

2759

1879

2760

global multiprocessing_manager

1880

2761

multiprocessing_manager = multiprocessing.Manager()

1882

2763

client_class = Client

1883

2764

if use_dbus:

1884

2765

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

2766

2767

client_settings = Client.config_parser(client_config)

2768

old_client_settings = {}

2769

clients_data = {}

2770

2771

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

2772

global wnull

2773

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

2774

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

2775

# mode

2776

if debug or not foreground:

2777

wnull.close()

2778

2779

# Get client data and settings from last running state.

2780

if server_settings["restore"]:

2781

try:

2782

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

2783

clients_data, old_client_settings = pickle.load(

2784

stored_state)

2785

os.remove(stored_state_path)

2786

except IOError as e:

2787

if e.errno == errno.ENOENT:

2788

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

2789

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

2790

else:

2791

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

2792

exc_info=e)

2793

raise

2794

except EOFError as e:

2795

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

2796

"EOFError:",

2797

exc_info=e)

2798

2799

with PGPEngine() as pgp:

2800

for client_name, client in clients_data.items():

2801

# Skip removed clients

2802

if client_name not in client_settings:

2803

continue

2804

2805

# Decide which value to use after restoring saved state.

2806

# We have three different values: Old config file,

2807

# new config file, and saved state.

2808

# New config value takes precedence if it differs from old

2809

# config value, otherwise use saved state.

2810

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

2811

try:

2812

# For each value in new config, check if it

2813

# differs from the old config value (Except for

2814

# the "secret" attribute)

2815

if (name != "secret"

2816

and (value !=

2817

old_client_settings[client_name][name])):

2818

client[name] = value

2819

except KeyError:

2820

pass

2821

2822

# Clients who has passed its expire date can still be

2823

# enabled if its last checker was successful. A Client

2824

# whose checker succeeded before we stored its state is

2825

# assumed to have successfully run all checkers during

2826

# downtime.

2827

if client["enabled"]:

2828

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

2829

if not client["last_checked_ok"]:

2830

logger.warning(

2831

"disabling client {} - Client never "

2832

"performed a successful checker".format(

2833

client_name))

2834

client["enabled"] = False

2835

elif client["last_checker_status"] != 0:

2836

logger.warning(

2837

"disabling client {} - Client last"

2838

" checker failed with error code"

2839

" {}".format(

2840

client_name,

2841

client["last_checker_status"]))

2842

client["enabled"] = False

2843

else:

2844

client["expires"] = (

2845

datetime.datetime.utcnow()

2846

+ client["timeout"])

2847

logger.debug("Last checker succeeded,"

2848

" keeping {} enabled".format(

2849

client_name))

1892

2850

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

2851

client["secret"] = pgp.decrypt(

2852

client["encrypted_secret"],

2853

client_settings[client_name]["secret"])

2854

except PGPError:

2855

# If decryption fails, we use secret from new settings

2856

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

2857

client_name))

2858

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

2859

["secret"])

2860

2861

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

2862

for client_name in (set(old_client_settings)

2863

- set(client_settings)):

2864

del clients_data[client_name]

2865

for client_name in (set(client_settings)

2866

- set(old_client_settings)):

2867

clients_data[client_name] = client_settings[client_name]

2868

2869

# Create all client objects

2870

for client_name, client in clients_data.items():

2871

tcp_server.clients[client_name] = client_class(

2872

name = client_name,

2873

settings = client,

2874

server_settings = server_settings)

2875

1902

2876

if not tcp_server.clients:

1903

2877

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

2878

2879

if not foreground:

2880

if pidfile is not None:

2881

pid = os.getpid()

2882

try:

2883

with pidfile:

2884

print(pid, file=pidfile)

2885

except IOError:

2886

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

2887

pidfilename, pid)

2888

del pidfile

1917

2889

del pidfilename

1918

1919

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

1920

2890

1921

2891

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

1922

2892

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

1923

2893

1924

2894

if use_dbus:

1925

class MandosDBusService(dbus.service.Object):

2895

2896

@alternate_dbus_interfaces(

2897

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

2898

class MandosDBusService(DBusObjectWithObjectManager):

1926

2899

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

2900

1927

2901

def __init__(self):

1928

2902

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

1929

_interface = "se.bsnet.fukt.Mandos"

2903

2904

_interface = "se.recompile.Mandos"

1930

2905

1931

2906

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

1932

2907

def ClientAdded(self, objpath):

1938

2913

"D-Bus signal"

1939

2914

pass

1940

2915

2916

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

2917

"true"})

1941

2918

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

1942

2919

def ClientRemoved(self, objpath, name):

1943

2920

"D-Bus signal"

1944

2921

pass

1945

2922

2923

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

2924

"true"})

1946

2925

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

1947

2926

def GetAllClients(self):

1948

2927

"D-Bus method"

1949

return dbus.Array(c.dbus_object_path

1950

for c in tcp_server.clients)

2928

return dbus.Array(c.dbus_object_path for c in

2929

tcp_server.clients.itervalues())

1951

2930

2931

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

2932

"true"})

1952

2933

@dbus.service.method(_interface,

1953

2934

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

1954

2935

def GetAllClientsWithProperties(self):

1955

2936

"D-Bus method"

1956

2937

return dbus.Dictionary(

1957

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

1958

for c in tcp_server.clients),

2938

{ c.dbus_object_path: c.GetAll(

2939

"se.recompile.Mandos.Client")

2940

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

1959

2941

signature="oa{sv}")

1960

2942

1961

2943

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

1962

2944

def RemoveClient(self, object_path):

1963

2945

"D-Bus method"

1964

for c in tcp_server.clients:

2946

for c in tcp_server.clients.itervalues():

1965

2947

if c.dbus_object_path == object_path:

1966

tcp_server.clients.remove(c)

2948

del tcp_server.clients[c.name]

1967

2949

c.remove_from_connection()

1968

# Don't signal anything except ClientRemoved

2950

# Don't signal the disabling

1969

2951

c.disable(quiet=True)

1970

# Emit D-Bus signal

1971

self.ClientRemoved(object_path, c.name)

2952

# Emit D-Bus signal for removal

2953

self.client_removed_signal(c)

1972

2954

return

1973

2955

raise KeyError(object_path)

1974

2956

1975

2957

del _interface

2958

2959

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

2960

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

2961

def GetManagedObjects(self):

2962

"""D-Bus method"""

2963

return dbus.Dictionary(

2964

{ client.dbus_object_path:

2965

dbus.Dictionary(

2966

{ interface: client.GetAll(interface)

2967

for interface in

2968

client._get_all_interface_names()})

2969

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

2970

2971

def client_added_signal(self, client):

2972

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

2973

if use_dbus:

2974

# New standard signal

2975

self.InterfacesAdded(

2976

client.dbus_object_path,

2977

dbus.Dictionary(

2978

{ interface: client.GetAll(interface)

2979

for interface in

2980

client._get_all_interface_names()}))

2981

# Old signal

2982

self.ClientAdded(client.dbus_object_path)

2983

2984

def client_removed_signal(self, client):

2985

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

2986

if use_dbus:

2987

# New standard signal

2988

self.InterfacesRemoved(

2989

client.dbus_object_path,

2990

client._get_all_interface_names())

2991

# Old signal

2992

self.ClientRemoved(client.dbus_object_path,

2993

client.name)

1976

2994

1977

2995

mandos_dbus_service = MandosDBusService()

1978

2996

1979

2997

def cleanup():

1980

2998

"Cleanup function; run on exit"

1981

service.cleanup()

1982

2999

if zeroconf:

3000

service.cleanup()

3001

3002

multiprocessing.active_children()

3003

wnull.close()

3004

if not (tcp_server.clients or client_settings):

3005

return

3006

3007

# Store client before exiting. Secrets are encrypted with key

3008

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

3009

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

3010

clients = {}

3011

with PGPEngine() as pgp:

3012

for client in tcp_server.clients.itervalues():

3013

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

3014

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

3015

key)

3016

client_dict = {}

3017

3018

# A list of attributes that can not be pickled

3019

# + secret.

3020

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

3021

"checker", "server_settings" }

3022

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

3023

.Object):

3024

exclude.add(name)

3025

3026

client_dict["encrypted_secret"] = (client

3027

.encrypted_secret)

3028

for attr in client.client_structure:

3029

if attr not in exclude:

3030

client_dict[attr] = getattr(client, attr)

3031

3032

clients[client.name] = client_dict

3033

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

3034

3035

try:

3036

with tempfile.NamedTemporaryFile(

3037

mode='wb',

3038

suffix=".pickle",

3039

prefix='clients-',

3040

dir=os.path.dirname(stored_state_path),

3041

delete=False) as stored_state:

3042

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

3043

tempname = stored_state.name

3044

os.rename(tempname, stored_state_path)

3045

except (IOError, OSError) as e:

3046

if not debug:

3047

try:

3048

os.remove(tempname)

3049

except NameError:

3050

pass

3051

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

3052

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

3053

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

3054

else:

3055

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

3056

exc_info=e)

3057

raise

3058

3059

# Delete all clients, and settings from config

1983

3060

while tcp_server.clients:

1984

client = tcp_server.clients.pop()

3061

name, client = tcp_server.clients.popitem()

1985

3062

if use_dbus:

1986

3063

client.remove_from_connection()

1987

client.disable_hook = None

1988

# Don't signal anything except ClientRemoved

3064

# Don't signal the disabling

1989

3065

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)

3066

# Emit D-Bus signal for removal

3067

mandos_dbus_service.client_removed_signal(client)

3068

client_settings.clear()

1994

3069

1995

3070

atexit.register(cleanup)

1996

3071

1997

for client in tcp_server.clients:

3072

for client in tcp_server.clients.itervalues():

1998

3073

if use_dbus:

1999

# Emit D-Bus signal

2000

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2001

client.enable()

3074

# Emit D-Bus signal for adding

3075

mandos_dbus_service.client_added_signal(client)

3076

# Need to initiate checking of clients

3077

if client.enabled:

3078

client.init_checker()

2002

3079

2003

3080

tcp_server.enable()

2004

3081

tcp_server.server_activate()

2005

3082

2006

3083

# Find out what port we got

2007

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

3084

if zeroconf:

3085

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

2008

3086

if use_ipv6:

2009

3087

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

2010

" flowinfo %d, scope_id %d"

2011

% tcp_server.socket.getsockname())

3088

" flowinfo %d, scope_id %d",

3089

*tcp_server.socket.getsockname())

2012

3090

else: # IPv4

2013

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

2014

% tcp_server.socket.getsockname())

3091

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

3092

*tcp_server.socket.getsockname())

2015

3093

2016

3094

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

2017

3095

2018

3096

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

3097

if zeroconf:

3098

# From the Avahi example code

3099

try:

3100

service.activate()

3101

except dbus.exceptions.DBusException as error:

3102

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

3103

cleanup()

3104

sys.exit(1)

3105

# End of Avahi example code

2027

3106

2028

3107

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

2029

3108

lambda *args, **kwargs:

2032

3111

2033

3112

logger.debug("Starting main loop")

2034

3113

main_loop.run()

2035

except AvahiError, error:

2036

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

3114

except AvahiError as error:

3115

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

2037

3116

cleanup()

2038

3117

sys.exit(1)

2039

3118

except KeyboardInterrupt:

2044

3123

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

2045

3124

cleanup()

2046

3125

3126

2047

3127

if __name__ == '__main__':

2048

3128

main()