/mandos/release : revision 237.7.333

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

28

# along with this program. If not, see

29

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

30

#

31

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

31

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

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

import SocketServer as socketserver

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

38

43

import socket

39

44

import argparse

40

45

import datetime

45

50

import gnutls.library.functions

46

51

import gnutls.library.constants

47

52

import gnutls.library.types

48

import ConfigParser as configparser

53

try:

54

import ConfigParser as configparser

55

except ImportError:

56

import configparser

49

57

import sys

50

58

import re

51

59

import os

60

68

import struct

61

69

import fcntl

62

70

import functools

63

import cPickle as pickle

71

try:

72

import cPickle as pickle

73

except ImportError:

74

import pickle

64

75

import multiprocessing

76

import types

77

import binascii

78

import tempfile

79

import itertools

80

import collections

81

import codecs

65

82

66

83

import dbus

67

84

import dbus.service

68

import gobject

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

69

89

import avahi

70

90

from dbus.mainloop.glib import DBusGMainLoop

71

91

import ctypes

81

101

except ImportError:

82

102

SO_BINDTODEVICE = None

83

103

84

85

version = "1.3.0"

86

87

#logger = logging.getLogger('mandos')

88

logger = logging.Logger('mandos')

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

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

92

syslogger.setFormatter(logging.Formatter

93

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

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

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

99

' %(levelname)s:'

100

' %(message)s'))

101

logger.addHandler(console)

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

108

stored_state_file = "clients.pickle"

109

110

logger = logging.getLogger()

111

syslogger = None

112

113

try:

114

if_nametoindex = ctypes.cdll.LoadLibrary(

115

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

116

except (OSError, AttributeError):

117

118

def if_nametoindex(interface):

119

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

120

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

121

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

122

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

123

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

124

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

125

return interface_index

126

127

128

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

129

"""init logger and add loglevel"""

130

131

global syslogger

132

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

135

syslogger.setFormatter(logging.Formatter

136

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

137

' %(message)s'))

138

logger.addHandler(syslogger)

139

140

if debug:

141

console = logging.StreamHandler()

142

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

143

' [%(process)d]:'

144

' %(levelname)s:'

145

' %(message)s'))

146

logger.addHandler(console)

147

logger.setLevel(level)

148

149

150

class PGPError(Exception):

151

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

152

pass

153

154

155

class PGPEngine(object):

156

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

157

158

def __init__(self):

159

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

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

165

166

def __enter__(self):

167

return self

168

169

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

170

self._cleanup()

171

return False

172

173

def __del__(self):

174

self._cleanup()

175

176

def _cleanup(self):

177

if self.tempdir is not None:

178

# Delete contents of tempdir

179

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

180

topdown = False):

181

for filename in files:

182

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

183

for dirname in dirs:

184

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

185

# Remove tempdir

186

os.rmdir(self.tempdir)

187

self.tempdir = None

188

189

def password_encode(self, password):

190

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

191

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

192

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

193

if len(encoded) > 2048:

194

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

195

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

196

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

197

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

198

return encoded

199

200

def encrypt(self, data, password):

201

passphrase = self.password_encode(password)

202

with tempfile.NamedTemporaryFile(

203

dir=self.tempdir) as passfile:

204

passfile.write(passphrase)

205

passfile.flush()

206

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

207

'--passphrase-file',

208

passfile.name]

209

+ self.gnupgargs,

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

214

if proc.returncode != 0:

215

raise PGPError(err)

216

return ciphertext

217

218

def decrypt(self, data, password):

219

passphrase = self.password_encode(password)

220

with tempfile.NamedTemporaryFile(

221

dir = self.tempdir) as passfile:

222

passfile.write(passphrase)

223

passfile.flush()

224

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

225

'--passphrase-file',

226

passfile.name]

227

+ self.gnupgargs,

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

232

if proc.returncode != 0:

233

raise PGPError(err)

234

return decrypted_plaintext

235

102

236

103

237

class AvahiError(Exception):

104

238

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

105

239

self.value = value

106

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

107

def __unicode__(self):

108

return unicode(repr(self.value))

240

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

241

**kwargs)

242

109

243

110

244

class AvahiServiceError(AvahiError):

111

245

pass

112

246

247

113

248

class AvahiGroupError(AvahiError):

114

249

pass

115

250

122

257

Used to optionally bind to the specified interface.

123

258

name: string; Example: 'Mandos'

124

259

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

125

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

260

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

126

261

port: integer; what port to announce

127

262

TXT: list of strings; TXT record for the service

128

263

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

134

269

server: D-Bus Server

135

270

bus: dbus.SystemBus()

136

271

"""

137

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

138

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

139

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

140

protocol = avahi.PROTO_UNSPEC, bus = None):

272

273

def __init__(self,

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

141

284

self.interface = interface

142

285

self.name = name

143

286

self.type = servicetype

152

295

self.server = None

153

296

self.bus = bus

154

297

self.entry_group_state_changed_match = None

155

def rename(self):

298

299

def rename(self, remove=True):

156

300

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

157

301

if self.rename_count >= self.max_renames:

158

302

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

159

303

" after %i retries, exiting.",

160

304

self.rename_count)

161

305

raise AvahiServiceError("Too many renames")

162

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

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

163

309

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

164

310

self.name)

165

syslogger.setFormatter(logging.Formatter

166

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

167

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

168

% self.name))

169

self.remove()

311

if remove:

312

self.remove()

170

313

try:

171

314

self.add()

172

315

except dbus.exceptions.DBusException as error:

173

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

174

self.cleanup()

175

os._exit(1)

176

self.rename_count += 1

316

if (error.get_dbus_name()

317

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

318

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

319

return self.rename(remove=False)

320

else:

321

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

322

self.cleanup()

323

os._exit(1)

324

177

325

def remove(self):

178

326

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

179

if self.group is not None:

180

try:

181

self.group.Free()

182

except (dbus.exceptions.UnknownMethodException,

183

dbus.exceptions.DBusException) as e:

184

pass

185

self.group = None

186

327

if self.entry_group_state_changed_match is not None:

187

328

self.entry_group_state_changed_match.remove()

188

329

self.entry_group_state_changed_match = None

330

if self.group is not None:

331

self.group.Reset()

332

189

333

def add(self):

190

334

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

191

335

self.remove()

192

self.group = dbus.Interface(

193

self.bus.get_object(avahi.DBUS_NAME,

194

self.server.EntryGroupNew(),

195

follow_name_owner_changes=True),

196

avahi.DBUS_INTERFACE_ENTRY_GROUP)

336

if self.group is None:

337

self.group = dbus.Interface(

338

self.bus.get_object(avahi.DBUS_NAME,

339

self.server.EntryGroupNew()),

340

avahi.DBUS_INTERFACE_ENTRY_GROUP)

197

341

self.entry_group_state_changed_match = (

198

342

self.group.connect_to_signal(

199

'StateChanged', self .entry_group_state_changed))

343

'StateChanged', self.entry_group_state_changed))

200

344

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

201

345

self.name, self.type)

202

346

self.group.AddService(

208

352

dbus.UInt16(self.port),

209

353

avahi.string_array_to_txt_array(self.TXT))

210

354

self.group.Commit()

355

211

356

def entry_group_state_changed(self, state, error):

212

357

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

213

358

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

219

364

self.rename()

220

365

elif state == avahi.ENTRY_GROUP_FAILURE:

221

366

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

222

unicode(error))

223

raise AvahiGroupError("State changed: %s"

224

% unicode(error))

367

str(error))

368

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

369

225

370

def cleanup(self):

226

371

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

372

if self.group is not None:

373

try:

374

self.group.Free()

375

except (dbus.exceptions.UnknownMethodException,

376

dbus.exceptions.DBusException):

377

pass

378

self.group = None

227

379

self.remove()

380

228

381

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

229

382

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

230

383

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

231

bad_states = { avahi.SERVER_INVALID:

232

"Zeroconf server invalid",

233

avahi.SERVER_REGISTERING: None,

234

avahi.SERVER_COLLISION:

235

"Zeroconf server name collision",

236

avahi.SERVER_FAILURE:

237

"Zeroconf server failure" }

384

bad_states = {

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

386

avahi.SERVER_REGISTERING: None,

387

avahi.SERVER_COLLISION: "Zeroconf server name collision",

388

avahi.SERVER_FAILURE: "Zeroconf server failure",

389

}

238

390

if state in bad_states:

239

if bad_states[state]:

240

logger.error(bad_states[state])

241

self.remove()

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

242

397

elif state == avahi.SERVER_RUNNING:

243

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)

244

410

else:

245

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

411

if error is None:

412

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

413

else:

414

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

415

246

416

def activate(self):

247

417

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

248

418

if self.server is None:

252

422

follow_name_owner_changes=True),

253

423

avahi.DBUS_INTERFACE_SERVER)

254

424

self.server.connect_to_signal("StateChanged",

255

self.server_state_changed)

425

self.server_state_changed)

256

426

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

257

427

258

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

259

448

class Client(object):

260

449

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

261

450

262

451

Attributes:

263

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

452

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

264

453

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

265

454

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

266

455

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

273

462

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

274

463

checker_initiator_tag: a gobject event source tag, or None

275

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

276

467

current_checker_command: string; current running checker_command

277

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

278

468

disable_initiator_tag: a gobject event source tag, or None

279

469

enabled: bool()

280

470

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

283

473

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

284

474

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

285

475

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

286

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

287

482

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

288

483

D-Bus identifiers

289

484

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

290

485

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

291

486

until this client is disabled

487

extended_timeout: extra long timeout when secret has been sent

292

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

293

492

"""

294

493

295

494

runtime_expansions = ("approval_delay", "approval_duration",

296

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

297

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

495

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

496

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

497

"last_approval_request", "last_checked_ok",

298

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

}

299

510

300

511

@staticmethod

301

def _timedelta_to_milliseconds(td):

302

"Convert a datetime.timedelta() to milliseconds"

303

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

304

+ (td.seconds * 1000)

305

+ (td.microseconds // 1000))

306

307

def timeout_milliseconds(self):

308

"Return the 'timeout' attribute in milliseconds"

309

return self._timedelta_to_milliseconds(self.timeout)

310

311

def interval_milliseconds(self):

312

"Return the 'interval' attribute in milliseconds"

313

return self._timedelta_to_milliseconds(self.interval)

314

315

def approval_delay_milliseconds(self):

316

return self._timedelta_to_milliseconds(self.approval_delay)

317

318

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

319

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

320

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

321

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

322

562

self.name = name

323

if config is None:

324

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

325

580

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

326

# Uppercase and remove spaces from fingerprint for later

327

# comparison purposes with return value from the fingerprint()

328

# function

329

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

330

.replace(" ", ""))

331

581

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

332

if "secret" in config:

333

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

334

elif "secfile" in config:

335

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

336

(config["secfile"])),

337

"rb") as secfile:

338

self.secret = secfile.read()

339

else:

340

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

341

% self.name)

342

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

343

self.created = datetime.datetime.utcnow()

344

self.enabled = False

345

self.last_approval_request = None

346

self.last_enabled = None

347

self.last_checked_ok = None

348

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

349

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

350

self.disable_hook = disable_hook

582

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

583

datetime.datetime.utcnow())

584

585

# attributes specific for this server instance

351

586

self.checker = None

352

587

self.checker_initiator_tag = None

353

588

self.disable_initiator_tag = None

354

589

self.checker_callback_tag = None

355

self.checker_command = config["checker"]

356

590

self.current_checker_command = None

357

self.last_connect = None

358

self._approved = None

359

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

360

True)

591

self.approved = None

361

592

self.approvals_pending = 0

362

self.approval_delay = string_to_delta(

363

config["approval_delay"])

364

self.approval_duration = string_to_delta(

365

config["approval_duration"])

366

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)

367

604

605

# Send notice to process children that client state has changed

368

606

def send_changedstate(self):

369

self.changedstate.acquire()

370

self.changedstate.notify_all()

371

self.changedstate.release()

372

607

with self.changedstate:

608

self.changedstate.notify_all()

609

373

610

def enable(self):

374

611

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

375

612

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

376

613

# Already enabled

377

614

return

378

self.send_changedstate()

615

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

616

self.enabled = True

379

617

self.last_enabled = datetime.datetime.utcnow()

380

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

381

# and every interval from then on.

382

self.checker_initiator_tag = (gobject.timeout_add

383

(self.interval_milliseconds(),

384

self.start_checker))

385

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

386

self.disable_initiator_tag = (gobject.timeout_add

387

(self.timeout_milliseconds(),

388

self.disable))

389

self.enabled = True

390

# Also start a new checker *right now*.

391

self.start_checker()

618

self.init_checker()

619

self.send_changedstate()

392

620

393

621

def disable(self, quiet=True):

394

622

"""Disable this client."""

395

623

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

396

624

return False

397

625

if not quiet:

398

self.send_changedstate()

399

if not quiet:

400

626

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

401

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

627

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

402

628

gobject.source_remove(self.disable_initiator_tag)

403

629

self.disable_initiator_tag = None

404

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

630

self.expires = None

631

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

405

632

gobject.source_remove(self.checker_initiator_tag)

406

633

self.checker_initiator_tag = None

407

634

self.stop_checker()

408

if self.disable_hook:

409

self.disable_hook(self)

410

635

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

411

638

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

412

639

return False

413

640

414

641

def __del__(self):

415

self.disable_hook = None

416

642

self.disable()

417

643

418

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

419

662

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

420

663

self.checker_callback_tag = None

421

664

self.checker = None

422

if os.WIFEXITED(condition):

423

exitstatus = os.WEXITSTATUS(condition)

424

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:

425

673

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

426

674

vars(self))

427

675

self.checked_ok()

428

676

else:

429

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

430

vars(self))

677

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

431

678

else:

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

432

681

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

433

682

vars(self))

683

return False

434

684

435

685

def checked_ok(self):

436

"""Bump up the timeout for this client.

437

438

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

439

alive and well.

440

"""

686

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

441

687

self.last_checked_ok = datetime.datetime.utcnow()

442

gobject.source_remove(self.disable_initiator_tag)

443

self.disable_initiator_tag = (gobject.timeout_add

444

(self.timeout_milliseconds(),

445

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

446

703

447

704

def need_approval(self):

448

705

self.last_approval_request = datetime.datetime.utcnow()

453

710

If a checker already exists, leave it running and do

454

711

nothing."""

455

712

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

456

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

457

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

458

# client would inevitably timeout, since no checker would get

459

# 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

460

717

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

461

718

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

462

719

# should be.

463

720

464

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

465

try:

466

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

467

except (AttributeError, OSError) as error:

468

if (isinstance(error, OSError)

469

and error.errno != errno.ECHILD):

470

raise error

471

else:

472

if pid:

473

logger.warning("Checker was a zombie")

474

gobject.source_remove(self.checker_callback_tag)

475

self.checker_callback(pid, status,

476

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

477

725

# Start a new checker if needed

478

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 }

479

731

try:

480

# In case checker_command has exactly one % operator

481

command = self.checker_command % self.host

482

except TypeError:

483

# Escape attributes for the shell

484

escaped_attrs = dict(

485

(attr,

486

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

487

errors=

488

'replace')))

489

for attr in

490

self.runtime_expansions)

491

492

try:

493

command = self.checker_command % escaped_attrs

494

except TypeError as error:

495

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

496

' %s', self.checker_command, error)

497

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

498

738

self.current_checker_command = command

499

try:

500

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

501

command, self.name)

502

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

503

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

504

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

505

# always replaced by /dev/null.)

506

self.checker = subprocess.Popen(command,

507

close_fds=True,

508

shell=True, cwd="/")

509

self.checker_callback_tag = (gobject.child_watch_add

510

(self.checker.pid,

511

self.checker_callback,

512

data=command))

513

# The checker may have completed before the gobject

514

# watch was added. Check for this.

515

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

516

if pid:

517

gobject.source_remove(self.checker_callback_tag)

518

self.checker_callback(pid, status, command)

519

except OSError as error:

520

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

521

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)

522

764

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

523

765

return True

524

766

530

772

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

531

773

return

532

774

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

533

try:

534

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

535

#time.sleep(0.5)

536

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

537

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

538

except OSError as error:

539

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

540

raise

775

self.checker.terminate()

541

776

self.checker = None

542

777

543

def dbus_service_property(dbus_interface, signature="v",

544

access="readwrite", byte_arrays=False):

778

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

545

783

"""Decorators for marking methods of a DBusObjectWithProperties to

546

784

become properties on the D-Bus.

547

785

556

794

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

557

795

if byte_arrays and signature != "ay":

558

796

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

559

" signature %r" % signature)

797

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

798

560

799

def decorator(func):

561

800

func._dbus_is_property = True

562

801

func._dbus_interface = dbus_interface

567

806

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

568

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

569

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

570

853

return decorator

571

854

572

855

573

856

class DBusPropertyException(dbus.exceptions.DBusException):

574

857

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

575

858

"""

576

def __unicode__(self):

577

return unicode(str(self))

859

pass

578

860

579

861

580

862

class DBusPropertyAccessException(DBusPropertyException):

589

871

pass

590

872

591

873

592

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

593

964

"""A D-Bus object with properties.

594

965

595

966

Classes inheriting from this can use the dbus_service_property

596

967

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

597

968

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

598

969

"""

599

970

600

@staticmethod

601

def _is_dbus_property(obj):

602

return getattr(obj, "_dbus_is_property", False)

603

604

def _get_all_dbus_properties(self):

605

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

606

"""

607

return ((prop._dbus_name, prop)

608

for name, prop in

609

inspect.getmembers(self, self._is_dbus_property))

610

611

971

def _get_dbus_property(self, interface_name, property_name):

612

972

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

613

973

property with the specified name and interface.

614

974

"""

615

for name in (property_name,

616

property_name + "_dbus_property"):

617

prop = getattr(self, name, None)

618

if (prop is None

619

or not self._is_dbus_property(prop)

620

or prop._dbus_name != property_name

621

or (interface_name and prop._dbus_interface

622

and interface_name != prop._dbus_interface)):

623

continue

624

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

625

982

# No such property

626

raise DBusPropertyNotFound(self.dbus_object_path + ":"

627

+ interface_name + "."

628

+ property_name)

629

630

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

631

997

out_signature="v")

632

998

def Get(self, interface_name, property_name):

633

999

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

651

1017

# The byte_arrays option is not supported yet on

652

1018

# signatures other than "ay".

653

1019

if prop._dbus_signature != "ay":

654

raise ValueError

655

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

656

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

657

1025

prop(value)

658

1026

659

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

1027

@dbus.service.method(dbus.PROPERTIES_IFACE,

1028

in_signature="s",

660

1029

out_signature="a{sv}")

661

1030

def GetAll(self, interface_name):

662

1031

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

663

1032

standard.

664

1033

665

1034

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

666

1035

"""

667

all = {}

668

for name, prop in self._get_all_dbus_properties():

1036

properties = {}

1037

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

669

1038

if (interface_name

670

1039

and interface_name != prop._dbus_interface):

671

1040

# Interface non-empty but did not match

675

1044

continue

676

1045

value = prop()

677

1046

if not hasattr(value, "variant_level"):

678

all[name] = value

1047

properties[name] = value

679

1048

continue

680

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

681

value.variant_level+1)

682

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

683

1060

684

1061

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

685

1062

out_signature="s",

686

1063

path_keyword='object_path',

687

1064

connection_keyword='connection')

688

1065

def Introspect(self, object_path, connection):

689

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

690

1069

"""

691

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

692

connection)

1070

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1071

object_path,

1072

connection)

693

1073

try:

694

1074

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

1075

695

1076

def make_tag(document, name, prop):

696

1077

e = document.createElement("property")

697

1078

e.setAttribute("name", name)

698

1079

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

699

1080

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

700

1081

return e

1082

701

1083

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

1084

# Add property tags

702

1085

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

703

1086

for name, prop

704

in self._get_all_dbus_properties()

1087

in self._get_all_dbus_things("property")

705

1088

if prop._dbus_interface

706

1089

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

707

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)

708

1107

# Add the names to the return values for the

709

1108

# "org.freedesktop.DBus.Properties" methods

710

1109

if (if_tag.getAttribute("name")

725

1124

except (AttributeError, xml.dom.DOMException,

726

1125

xml.parsers.expat.ExpatError) as error:

727

1126

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

728

error)

729

return xmlstring

730

731

1127

exc_info=error)

1128

return xmlstring

1129

1130

try:

1131

dbus.OBJECT_MANAGER_IFACE

1132

except AttributeError:

1133

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

1134

1135

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1136

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

1137

1138

Classes inheriting from this exposes the standard

1139

GetManagedObjects call and the InterfacesAdded and

1140

InterfacesRemoved signals on the standard

1141

"org.freedesktop.DBus.ObjectManager" interface.

1142

1143

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

1144

manually.

1145

"""

1146

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1147

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

1148

def GetManagedObjects(self):

1149

"""This function must be overridden"""

1150

raise NotImplementedError()

1151

1152

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1153

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

1154

def InterfacesAdded(self, object_path, interfaces_and_properties):

1155

pass

1156

1157

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1158

signature = "oas")

1159

def InterfacesRemoved(self, object_path, interfaces):

1160

pass

1161

1162

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1163

out_signature = "s",

1164

path_keyword = 'object_path',

1165

connection_keyword = 'connection')

1166

def Introspect(self, object_path, connection):

1167

"""Overloading of standard D-Bus method.

1168

1169

Override return argument name of GetManagedObjects to be

1170

"objpath_interfaces_and_properties"

1171

"""

1172

xmlstring = DBusObjectWithAnnotations(self, object_path,

1173

connection)

1174

try:

1175

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

1176

1177

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

1178

# Fix argument name for the GetManagedObjects method

1179

if (if_tag.getAttribute("name")

1180

== dbus.OBJECT_MANAGER_IFACE):

1181

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

1182

if (cn.getAttribute("name")

1183

== "GetManagedObjects"):

1184

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

1185

if (arg.getAttribute("direction")

1186

== "out"):

1187

arg.setAttribute(

1188

"name",

1189

"objpath_interfaces"

1190

"_and_properties")

1191

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

1192

document.unlink()

1193

except (AttributeError, xml.dom.DOMException,

1194

xml.parsers.expat.ExpatError) as error:

1195

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

1196

exc_info = error)

1197

return xmlstring

1198

1199

def datetime_to_dbus(dt, variant_level=0):

1200

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

1201

if dt is None:

1202

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

1203

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

1204

1205

1206

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1207

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

1208

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

1209

interface names according to the "alt_interface_names" mapping.

1210

Usage:

1211

1212

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

1213

"net.example.AlternateInterface"})

1214

class SampleDBusObject(dbus.service.Object):

1215

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

1216

def SampleDBusMethod():

1217

pass

1218

1219

The above "SampleDBusMethod" on "SampleDBusObject" will be

1220

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

1221

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

1222

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

1223

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

1224

1225

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

1226

(from DBusObjectWithProperties) and interfaces (from the

1227

dbus_interface_annotations decorator).

1228

"""

1229

1230

def wrapper(cls):

1231

for orig_interface_name, alt_interface_name in (

1232

alt_interface_names.items()):

1233

attr = {}

1234

interface_names = set()

1235

# Go though all attributes of the class

1236

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

1237

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

1238

# with the wrong interface name

1239

if (not hasattr(attribute, "_dbus_interface")

1240

or not attribute._dbus_interface.startswith(

1241

orig_interface_name)):

1242

continue

1243

# Create an alternate D-Bus interface name based on

1244

# the current name

1245

alt_interface = attribute._dbus_interface.replace(

1246

orig_interface_name, alt_interface_name)

1247

interface_names.add(alt_interface)

1248

# Is this a D-Bus signal?

1249

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

1250

if sys.version_info.major == 2:

1251

# Extract the original non-method undecorated

1252

# function by black magic

1253

nonmethod_func = (dict(

1254

zip(attribute.func_code.co_freevars,

1255

attribute.__closure__))

1256

["func"].cell_contents)

1257

else:

1258

nonmethod_func = attribute

1259

# Create a new, but exactly alike, function

1260

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

1261

# with the alternate D-Bus interface name

1262

if sys.version_info.major == 2:

1263

new_function = types.FunctionType(

1264

nonmethod_func.func_code,

1265

nonmethod_func.func_globals,

1266

nonmethod_func.func_name,

1267

nonmethod_func.func_defaults,

1268

nonmethod_func.func_closure)

1269

else:

1270

new_function = types.FunctionType(

1271

nonmethod_func.__code__,

1272

nonmethod_func.__globals__,

1273

nonmethod_func.__name__,

1274

nonmethod_func.__defaults__,

1275

nonmethod_func.__closure__)

1276

new_function = (dbus.service.signal(

1277

alt_interface,

1278

attribute._dbus_signature)(new_function))

1279

# Copy annotations, if any

1280

try:

1281

new_function._dbus_annotations = dict(

1282

attribute._dbus_annotations)

1283

except AttributeError:

1284

pass

1285

# Define a creator of a function to call both the

1286

# original and alternate functions, so both the

1287

# original and alternate signals gets sent when

1288

# the function is called

1289

def fixscope(func1, func2):

1290

"""This function is a scope container to pass

1291

func1 and func2 to the "call_both" function

1292

outside of its arguments"""

1293

1294

def call_both(*args, **kwargs):

1295

"""This function will emit two D-Bus

1296

signals by calling func1 and func2"""

1297

func1(*args, **kwargs)

1298

func2(*args, **kwargs)

1299

1300

return call_both

1301

# Create the "call_both" function and add it to

1302

# the class

1303

attr[attrname] = fixscope(attribute, new_function)

1304

# Is this a D-Bus method?

1305

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

1306

# Create a new, but exactly alike, function

1307

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

1308

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

1309

# to the class.

1310

attr[attrname] = (

1311

dbus.service.method(

1312

alt_interface,

1313

attribute._dbus_in_signature,

1314

attribute._dbus_out_signature)

1315

(types.FunctionType(attribute.func_code,

1316

attribute.func_globals,

1317

attribute.func_name,

1318

attribute.func_defaults,

1319

attribute.func_closure)))

1320

# Copy annotations, if any

1321

try:

1322

attr[attrname]._dbus_annotations = dict(

1323

attribute._dbus_annotations)

1324

except AttributeError:

1325

pass

1326

# Is this a D-Bus property?

1327

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

1328

# Create a new, but exactly alike, function

1329

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

1330

# property with the alternate D-Bus interface

1331

# name. Add it to the class.

1332

attr[attrname] = (dbus_service_property(

1333

alt_interface, attribute._dbus_signature,

1334

attribute._dbus_access,

1335

attribute._dbus_get_args_options

1336

["byte_arrays"])

1337

(types.FunctionType(

1338

attribute.func_code,

1339

attribute.func_globals,

1340

attribute.func_name,

1341

attribute.func_defaults,

1342

attribute.func_closure)))

1343

# Copy annotations, if any

1344

try:

1345

attr[attrname]._dbus_annotations = dict(

1346

attribute._dbus_annotations)

1347

except AttributeError:

1348

pass

1349

# Is this a D-Bus interface?

1350

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

1351

# Create a new, but exactly alike, function

1352

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

1353

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

1354

# to the class.

1355

attr[attrname] = (

1356

dbus_interface_annotations(alt_interface)

1357

(types.FunctionType(attribute.func_code,

1358

attribute.func_globals,

1359

attribute.func_name,

1360

attribute.func_defaults,

1361

attribute.func_closure)))

1362

if deprecate:

1363

# Deprecate all alternate interfaces

1364

iname="_AlternateDBusNames_interface_annotation{}"

1365

for interface_name in interface_names:

1366

1367

@dbus_interface_annotations(interface_name)

1368

def func(self):

1369

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

1370

"true" }

1371

# Find an unused name

1372

for aname in (iname.format(i)

1373

for i in itertools.count()):

1374

if aname not in attr:

1375

attr[aname] = func

1376

break

1377

if interface_names:

1378

# Replace the class with a new subclass of it with

1379

# methods, signals, etc. as created above.

1380

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

1381

(cls, ), attr)

1382

return cls

1383

1384

return wrapper

1385

1386

1387

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

1388

"se.bsnet.fukt.Mandos"})

732

1389

class ClientDBus(Client, DBusObjectWithProperties):

733

1390

"""A Client class using D-Bus

734

1391

738

1395

"""

739

1396

740

1397

runtime_expansions = (Client.runtime_expansions

741

+ ("dbus_object_path",))

1398

+ ("dbus_object_path", ))

1399

1400

_interface = "se.recompile.Mandos.Client"

742

1401

743

1402

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

744

1403

745

1404

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

746

self._approvals_pending = 0

747

1405

self.bus = bus

748

1406

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

749

1407

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

750

1408

# the D-Bus

751

client_object_name = unicode(self.name).translate(

1409

client_object_name = str(self.name).translate(

752

1410

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

753

1411

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

754

self.dbus_object_path = (dbus.ObjectPath

755

("/clients/" + client_object_name))

1412

self.dbus_object_path = dbus.ObjectPath(

1413

"/clients/" + client_object_name)

756

1414

DBusObjectWithProperties.__init__(self, self.bus,

757

1415

self.dbus_object_path)

758

759

def _get_approvals_pending(self):

760

return self._approvals_pending

761

def _set_approvals_pending(self, value):

762

old_value = self._approvals_pending

763

self._approvals_pending = value

764

bval = bool(value)

765

if (hasattr(self, "dbus_object_path")

766

and bval is not bool(old_value)):

767

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

768

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

769

dbus_bool)

770

771

approvals_pending = property(_get_approvals_pending,

772

_set_approvals_pending)

773

del _get_approvals_pending, _set_approvals_pending

774

775

@staticmethod

776

def _datetime_to_dbus(dt, variant_level=0):

777

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

778

return dbus.String(dt.isoformat(),

779

variant_level=variant_level)

780

781

def enable(self):

782

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

783

r = Client.enable(self)

784

if oldstate != self.enabled:

785

# Emit D-Bus signals

786

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

787

dbus.Boolean(True, variant_level=1))

788

self.PropertyChanged(

789

dbus.String("LastEnabled"),

790

self._datetime_to_dbus(self.last_enabled,

791

variant_level=1))

792

return r

793

794

def disable(self, quiet = False):

795

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

796

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

797

if not quiet and oldstate != self.enabled:

798

# Emit D-Bus signal

799

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

800

dbus.Boolean(False, variant_level=1))

801

return r

1416

1417

def notifychangeproperty(transform_func, dbus_name,

1418

type_func=lambda x: x,

1419

variant_level=1,

1420

invalidate_only=False,

1421

_interface=_interface):

1422

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

1423

its changes to DBus.

1424

1425

transform_fun: Function that takes a value and a variant_level

1426

and transforms it to a D-Bus type.

1427

dbus_name: D-Bus name of the variable

1428

type_func: Function that transform the value before sending it

1429

to the D-Bus. Default: no transform

1430

variant_level: D-Bus variant level. Default: 1

1431

"""

1432

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

1433

1434

def setter(self, value):

1435

if hasattr(self, "dbus_object_path"):

1436

if (not hasattr(self, attrname) or

1437

type_func(getattr(self, attrname, None))

1438

!= type_func(value)):

1439

if invalidate_only:

1440

self.PropertiesChanged(

1441

_interface, dbus.Dictionary(),

1442

dbus.Array((dbus_name, )))

1443

else:

1444

dbus_value = transform_func(

1445

type_func(value),

1446

variant_level = variant_level)

1447

self.PropertyChanged(dbus.String(dbus_name),

1448

dbus_value)

1449

self.PropertiesChanged(

1450

_interface,

1451

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

1452

dbus_value }),

1453

dbus.Array())

1454

setattr(self, attrname, value)

1455

1456

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

1457

1458

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1459

approvals_pending = notifychangeproperty(dbus.Boolean,

1460

"ApprovalPending",

1461

type_func = bool)

1462

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

1463

last_enabled = notifychangeproperty(datetime_to_dbus,

1464

"LastEnabled")

1465

checker = notifychangeproperty(

1466

dbus.Boolean, "CheckerRunning",

1467

type_func = lambda checker: checker is not None)

1468

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1469

"LastCheckedOK")

1470

last_checker_status = notifychangeproperty(dbus.Int16,

1471

"LastCheckerStatus")

1472

last_approval_request = notifychangeproperty(

1473

datetime_to_dbus, "LastApprovalRequest")

1474

approved_by_default = notifychangeproperty(dbus.Boolean,

1475

"ApprovedByDefault")

1476

approval_delay = notifychangeproperty(

1477

dbus.UInt64, "ApprovalDelay",

1478

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

1479

approval_duration = notifychangeproperty(

1480

dbus.UInt64, "ApprovalDuration",

1481

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

1482

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

1483

timeout = notifychangeproperty(

1484

dbus.UInt64, "Timeout",

1485

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

1486

extended_timeout = notifychangeproperty(

1487

dbus.UInt64, "ExtendedTimeout",

1488

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

1489

interval = notifychangeproperty(

1490

dbus.UInt64, "Interval",

1491

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

1492

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

1493

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

1494

invalidate_only=True)

1495

1496

del notifychangeproperty

802

1497

803

1498

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

804

1499

try:

809

1504

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

810

1505

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

811

1506

812

def checker_callback(self, pid, condition, command,

813

*args, **kwargs):

814

self.checker_callback_tag = None

815

self.checker = None

816

# Emit D-Bus signal

817

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

818

dbus.Boolean(False, variant_level=1))

819

if os.WIFEXITED(condition):

820

exitstatus = os.WEXITSTATUS(condition)

1507

def checker_callback(self, source, condition,

1508

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

1509

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

1510

connection, command, *args,

1511

**kwargs)

1512

exitstatus = self.last_checker_status

1513

if exitstatus >= 0:

821

1514

# Emit D-Bus signal

822

1515

self.CheckerCompleted(dbus.Int16(exitstatus),

823

dbus.Int64(condition),

1516

# This is specific to GNU libC

1517

dbus.Int64(exitstatus << 8),

824

1518

dbus.String(command))

825

1519

else:

826

1520

# Emit D-Bus signal

827

1521

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

828

dbus.Int64(condition),

1522

dbus.Int64(

1523

# This is specific to GNU libC

1524

(exitstatus << 8)

1525

| self.last_checker_signal),

829

1526

dbus.String(command))

830

831

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

832

*args, **kwargs)

833

834

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

835

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

836

# Emit D-Bus signal

837

self.PropertyChanged(

838

dbus.String("LastCheckedOK"),

839

(self._datetime_to_dbus(self.last_checked_ok,

840

variant_level=1)))

841

842

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

843

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

844

# Emit D-Bus signal

845

self.PropertyChanged(

846

dbus.String("LastApprovalRequest"),

847

(self._datetime_to_dbus(self.last_approval_request,

848

variant_level=1)))

849

return r

1527

return ret

850

1528

851

1529

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

852

old_checker = self.checker

853

if self.checker is not None:

854

old_checker_pid = self.checker.pid

855

else:

856

old_checker_pid = None

1530

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

857

1531

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

858

1532

# Only if new checker process was started

859

1533

if (self.checker is not None

860

1534

and old_checker_pid != self.checker.pid):

861

1535

# Emit D-Bus signal

862

1536

self.CheckerStarted(self.current_checker_command)

863

self.PropertyChanged(

864

dbus.String("CheckerRunning"),

865

dbus.Boolean(True, variant_level=1))

866

1537

return r

867

1538

868

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

869

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

870

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

871

if (old_checker is not None

872

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

873

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

874

dbus.Boolean(False, variant_level=1))

875

return r

876

877

1539

def _reset_approved(self):

878

self._approved = None

1540

self.approved = None

879

1541

return False

880

1542

881

1543

def approve(self, value=True):

1544

self.approved = value

1545

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

1546

* 1000), self._reset_approved)

882

1547

self.send_changedstate()

883

self._approved = value

884

gobject.timeout_add(self._timedelta_to_milliseconds

885

(self.approval_duration),

886

self._reset_approved)

887

888

1548

889

1549

## D-Bus methods, signals & properties

890

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

1550

1551

## Interfaces

891

1552

892

1553

## Signals

893

1554

904

1565

pass

905

1566

906

1567

# PropertyChanged - signal

1568

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

907

1569

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

908

1570

def PropertyChanged(self, property, value):

909

1571

"D-Bus signal"

943

1605

self.checked_ok()

944

1606

945

1607

# Enable - method

1608

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

946

1609

@dbus.service.method(_interface)

947

1610

def Enable(self):

948

1611

"D-Bus method"

949

1612

self.enable()

950

1613

951

1614

# StartChecker - method

1615

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

952

1616

@dbus.service.method(_interface)

953

1617

def StartChecker(self):

954

1618

"D-Bus method"

955

1619

self.start_checker()

956

1620

957

1621

# Disable - method

1622

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

958

1623

@dbus.service.method(_interface)

959

1624

def Disable(self):

960

1625

"D-Bus method"

961

1626

self.disable()

962

1627

963

1628

# StopChecker - method

1629

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

964

1630

@dbus.service.method(_interface)

965

1631

def StopChecker(self):

966

1632

self.stop_checker()

973

1639

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

974

1640

975

1641

# ApprovedByDefault - property

976

@dbus_service_property(_interface, signature="b",

1642

@dbus_service_property(_interface,

1643

signature="b",

977

1644

access="readwrite")

978

1645

def ApprovedByDefault_dbus_property(self, value=None):

979

1646

if value is None: # get

980

1647

return dbus.Boolean(self.approved_by_default)

981

1648

self.approved_by_default = bool(value)

982

# Emit D-Bus signal

983

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

984

dbus.Boolean(value, variant_level=1))

985

1649

986

1650

# ApprovalDelay - property

987

@dbus_service_property(_interface, signature="t",

1651

@dbus_service_property(_interface,

1652

signature="t",

988

1653

access="readwrite")

989

1654

def ApprovalDelay_dbus_property(self, value=None):

990

1655

if value is None: # get

991

return dbus.UInt64(self.approval_delay_milliseconds())

1656

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

1657

* 1000)

992

1658

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

993

# Emit D-Bus signal

994

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

995

dbus.UInt64(value, variant_level=1))

996

1659

997

1660

# ApprovalDuration - property

998

@dbus_service_property(_interface, signature="t",

1661

@dbus_service_property(_interface,

1662

signature="t",

999

1663

access="readwrite")

1000

1664

def ApprovalDuration_dbus_property(self, value=None):

1001

1665

if value is None: # get

1002

return dbus.UInt64(self._timedelta_to_milliseconds(

1003

self.approval_duration))

1666

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

1667

* 1000)

1004

1668

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

1005

# Emit D-Bus signal

1006

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

1007

dbus.UInt64(value, variant_level=1))

1008

1669

1009

1670

# Name - property

1671

@dbus_annotations(

1672

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

1010

1673

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

1011

1674

def Name_dbus_property(self):

1012

1675

return dbus.String(self.name)

1013

1676

1014

1677

# Fingerprint - property

1678

@dbus_annotations(

1679

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

1015

1680

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

1016

1681

def Fingerprint_dbus_property(self):

1017

1682

return dbus.String(self.fingerprint)

1018

1683

1019

1684

# Host - property

1020

@dbus_service_property(_interface, signature="s",

1685

@dbus_service_property(_interface,

1686

signature="s",

1021

1687

access="readwrite")

1022

1688

def Host_dbus_property(self, value=None):

1023

1689

if value is None: # get

1024

1690

return dbus.String(self.host)

1025

self.host = value

1026

# Emit D-Bus signal

1027

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

1028

dbus.String(value, variant_level=1))

1691

self.host = str(value)

1029

1692

1030

1693

# Created - property

1694

@dbus_annotations(

1695

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

1031

1696

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

1032

1697

def Created_dbus_property(self):

1033

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

1698

return datetime_to_dbus(self.created)

1034

1699

1035

1700

# LastEnabled - property

1036

1701

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

1037

1702

def LastEnabled_dbus_property(self):

1038

if self.last_enabled is None:

1039

return dbus.String("")

1040

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

1703

return datetime_to_dbus(self.last_enabled)

1041

1704

1042

1705

# Enabled - property

1043

@dbus_service_property(_interface, signature="b",

1706

@dbus_service_property(_interface,

1707

signature="b",

1044

1708

access="readwrite")

1045

1709

def Enabled_dbus_property(self, value=None):

1046

1710

if value is None: # get

1051

1715

self.disable()

1052

1716

1053

1717

# LastCheckedOK - property

1054

@dbus_service_property(_interface, signature="s",

1718

@dbus_service_property(_interface,

1719

signature="s",

1055

1720

access="readwrite")

1056

1721

def LastCheckedOK_dbus_property(self, value=None):

1057

1722

if value is not None:

1058

1723

self.checked_ok()

1059

1724

return

1060

if self.last_checked_ok is None:

1061

return dbus.String("")

1062

return dbus.String(self._datetime_to_dbus(self

1063

.last_checked_ok))

1725

return datetime_to_dbus(self.last_checked_ok)

1726

1727

# LastCheckerStatus - property

1728

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

1729

def LastCheckerStatus_dbus_property(self):

1730

return dbus.Int16(self.last_checker_status)

1731

1732

# Expires - property

1733

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

1734

def Expires_dbus_property(self):

1735

return datetime_to_dbus(self.expires)

1064

1736

1065

1737

# LastApprovalRequest - property

1066

1738

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

1067

1739

def LastApprovalRequest_dbus_property(self):

1068

if self.last_approval_request is None:

1069

return dbus.String("")

1070

return dbus.String(self.

1071

_datetime_to_dbus(self

1072

.last_approval_request))

1740

return datetime_to_dbus(self.last_approval_request)

1073

1741

1074

1742

# Timeout - property

1075

@dbus_service_property(_interface, signature="t",

1743

@dbus_service_property(_interface,

1744

signature="t",

1076

1745

access="readwrite")

1077

1746

def Timeout_dbus_property(self, value=None):

1078

1747

if value is None: # get

1079

return dbus.UInt64(self.timeout_milliseconds())

1748

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

1749

old_timeout = self.timeout

1080

1750

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

1081

# Emit D-Bus signal

1082

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

1083

dbus.UInt64(value, variant_level=1))

1084

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

1085

return

1086

# Reschedule timeout

1087

gobject.source_remove(self.disable_initiator_tag)

1088

self.disable_initiator_tag = None

1089

time_to_die = (self.

1090

_timedelta_to_milliseconds((self

1091

.last_checked_ok

1092

+ self.timeout)

1093

- datetime.datetime

1094

.utcnow()))

1095

if time_to_die <= 0:

1096

# The timeout has passed

1097

self.disable()

1098

else:

1099

self.disable_initiator_tag = (gobject.timeout_add

1100

(time_to_die, self.disable))

1751

# Reschedule disabling

1752

if self.enabled:

1753

now = datetime.datetime.utcnow()

1754

self.expires += self.timeout - old_timeout

1755

if self.expires <= now:

1756

# The timeout has passed

1757

self.disable()

1758

else:

1759

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

1760

is None):

1761

return

1762

gobject.source_remove(self.disable_initiator_tag)

1763

self.disable_initiator_tag = gobject.timeout_add(

1764

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

1765

self.disable)

1766

1767

# ExtendedTimeout - property

1768

@dbus_service_property(_interface,

1769

signature="t",

1770

access="readwrite")

1771

def ExtendedTimeout_dbus_property(self, value=None):

1772

if value is None: # get

1773

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

1774

* 1000)

1775

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

1101

1776

1102

1777

# Interval - property

1103

@dbus_service_property(_interface, signature="t",

1778

@dbus_service_property(_interface,

1779

signature="t",

1104

1780

access="readwrite")

1105

1781

def Interval_dbus_property(self, value=None):

1106

1782

if value is None: # get

1107

return dbus.UInt64(self.interval_milliseconds())

1783

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

1108

1784

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

1109

# Emit D-Bus signal

1110

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

1111

dbus.UInt64(value, variant_level=1))

1112

1785

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

1113

1786

return

1114

# Reschedule checker run

1115

gobject.source_remove(self.checker_initiator_tag)

1116

self.checker_initiator_tag = (gobject.timeout_add

1117

(value, self.start_checker))

1118

self.start_checker() # Start one now, too

1119

1787

if self.enabled:

1788

# Reschedule checker run

1789

gobject.source_remove(self.checker_initiator_tag)

1790

self.checker_initiator_tag = gobject.timeout_add(

1791

value, self.start_checker)

1792

self.start_checker() # Start one now, too

1793

1120

1794

# Checker - property

1121

@dbus_service_property(_interface, signature="s",

1795

@dbus_service_property(_interface,

1796

signature="s",

1122

1797

access="readwrite")

1123

1798

def Checker_dbus_property(self, value=None):

1124

1799

if value is None: # get

1125

1800

return dbus.String(self.checker_command)

1126

self.checker_command = value

1127

# Emit D-Bus signal

1128

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

1129

dbus.String(self.checker_command,

1130

variant_level=1))

1801

self.checker_command = str(value)

1131

1802

1132

1803

# CheckerRunning - property

1133

@dbus_service_property(_interface, signature="b",

1804

@dbus_service_property(_interface,

1805

signature="b",

1134

1806

access="readwrite")

1135

1807

def CheckerRunning_dbus_property(self, value=None):

1136

1808

if value is None: # get

1141

1813

self.stop_checker()

1142

1814

1143

1815

# ObjectPath - property

1816

@dbus_annotations(

1817

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

1818

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

1144

1819

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

1145

1820

def ObjectPath_dbus_property(self):

1146

1821

return self.dbus_object_path # is already a dbus.ObjectPath

1147

1822

1148

1823

# Secret = property

1149

@dbus_service_property(_interface, signature="ay",

1150

access="write", byte_arrays=True)

1824

@dbus_annotations(

1825

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

1826

"invalidates"})

1827

@dbus_service_property(_interface,

1828

signature="ay",

1829

access="write",

1830

byte_arrays=True)

1151

1831

def Secret_dbus_property(self, value):

1152

self.secret = str(value)

1832

self.secret = bytes(value)

1153

1833

1154

1834

del _interface

1155

1835

1159

1839

self._pipe = child_pipe

1160

1840

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

1161

1841

if not self._pipe.recv():

1162

raise KeyError()

1163

1842

raise KeyError(fpr)

1843

1164

1844

def __getattribute__(self, name):

1165

if(name == '_pipe'):

1845

if name == '_pipe':

1166

1846

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

1167

1847

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

1168

1848

data = self._pipe.recv()

1169

1849

if data[0] == 'data':

1170

1850

return data[1]

1171

1851

if data[0] == 'function':

1852

1172

1853

def func(*args, **kwargs):

1173

1854

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

1174

1855

return self._pipe.recv()[1]

1856

1175

1857

return func

1176

1858

1177

1859

def __setattr__(self, name, value):

1178

if(name == '_pipe'):

1860

if name == '_pipe':

1179

1861

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

1180

1862

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

1181

1863

1189

1871

def handle(self):

1190

1872

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

1191

1873

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

1192

unicode(self.client_address))

1874

str(self.client_address))

1193

1875

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

1194

1876

self.server.child_pipe.fileno())

1195

1196

session = (gnutls.connection

1197

.ClientSession(self.request,

1198

gnutls.connection

1199

.X509Credentials()))

1200

1877

1878

session = gnutls.connection.ClientSession(

1879

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

1880

1201

1881

# Note: gnutls.connection.X509Credentials is really a

1202

1882

# generic GnuTLS certificate credentials object so long as

1203

1883

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

1204

1884

# here despite using OpenPGP certificates.

1205

1885

1206

1886

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

1207

1887

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

1208

1888

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

1211

1891

priority = self.server.gnutls_priority

1212

1892

if priority is None:

1213

1893

priority = "NORMAL"

1214

(gnutls.library.functions

1215

.gnutls_priority_set_direct(session._c_object,

1216

priority, None))

1217

1894

gnutls.library.functions.gnutls_priority_set_direct(

1895

session._c_object, priority, None)

1896

1218

1897

# Start communication using the Mandos protocol

1219

1898

# Get protocol number

1220

1899

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

1221

1900

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

1222

1901

try:

1223

1902

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

1224

raise RuntimeError

1903

raise RuntimeError(line)

1225

1904

except (ValueError, IndexError, RuntimeError) as error:

1226

1905

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

1227

1906

return

1228

1907

1229

1908

# Start GnuTLS connection

1230

1909

try:

1231

1910

session.handshake()

1235

1914

# established. Just abandon the request.

1236

1915

return

1237

1916

logger.debug("Handshake succeeded")

1238

1917

1239

1918

approval_required = False

1240

1919

try:

1241

1920

try:

1242

fpr = self.fingerprint(self.peer_certificate

1243

(session))

1921

fpr = self.fingerprint(

1922

self.peer_certificate(session))

1244

1923

except (TypeError,

1245

1924

gnutls.errors.GNUTLSError) as error:

1246

1925

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

1247

1926

return

1248

1927

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

1249

1928

1250

1929

try:

1251

1930

client = ProxyClient(child_pipe, fpr,

1252

1931

self.client_address)

1260

1939

1261

1940

while True:

1262

1941

if not client.enabled:

1263

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

1264

client.name)

1942

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

1943

client.name)

1265

1944

if self.server.use_dbus:

1266

1945

# Emit D-Bus signal

1267

client.Rejected("Disabled")

1946

client.Rejected("Disabled")

1268

1947

return

1269

1948

1270

if client._approved or not client.approval_delay:

1949

if client.approved or not client.approval_delay:

1271

1950

#We are approved or approval is disabled

1272

1951

break

1273

elif client._approved is None:

1952

elif client.approved is None:

1274

1953

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

1275

1954

client.name)

1276

1955

if self.server.use_dbus:

1277

1956

# Emit D-Bus signal

1278

1957

client.NeedApproval(

1279

client.approval_delay_milliseconds(),

1280

client.approved_by_default)

1958

client.approval_delay.total_seconds()

1959

* 1000, client.approved_by_default)

1281

1960

else:

1282

1961

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

1283

1962

client.name)

1287

1966

return

1288

1967

1289

1968

#wait until timeout or approved

1290

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

1291

1969

time = datetime.datetime.now()

1292

1970

client.changedstate.acquire()

1293

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

1971

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

1294

1972

client.changedstate.release()

1295

1973

time2 = datetime.datetime.now()

1296

1974

if (time2 - time) >= delay:

1312

1990

try:

1313

1991

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

1314

1992

except gnutls.errors.GNUTLSError as error:

1315

logger.warning("gnutls send failed")

1993

logger.warning("gnutls send failed",

1994

exc_info=error)

1316

1995

return

1317

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

1318

sent, len(client.secret)

1319

- (sent_size + sent))

1996

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

1997

len(client.secret) - (sent_size

1998

+ sent))

1320

1999

sent_size += sent

1321

2000

1322

2001

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

1323

# bump the timeout as if seen

1324

client.checked_ok()

2002

# bump the timeout using extended_timeout

2003

client.bump_timeout(client.extended_timeout)

1325

2004

if self.server.use_dbus:

1326

2005

# Emit D-Bus signal

1327

2006

client.GotSecret()

1332

2011

try:

1333

2012

session.bye()

1334

2013

except gnutls.errors.GNUTLSError as error:

1335

logger.warning("GnuTLS bye failed")

2014

logger.warning("GnuTLS bye failed",

2015

exc_info=error)

1336

2016

1337

2017

@staticmethod

1338

2018

def peer_certificate(session):

1339

2019

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

1340

2020

# If not an OpenPGP certificate...

1341

if (gnutls.library.functions

1342

.gnutls_certificate_type_get(session._c_object)

2021

if (gnutls.library.functions.gnutls_certificate_type_get(

2022

session._c_object)

1343

2023

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1344

2024

# ...do the normal thing

1345

2025

return session.peer_certificate

1359

2039

def fingerprint(openpgp):

1360

2040

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1361

2041

# New GnuTLS "datum" with the OpenPGP public key

1362

datum = (gnutls.library.types

1363

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

1364

ctypes.POINTER

1365

(ctypes.c_ubyte)),

1366

ctypes.c_uint(len(openpgp))))

2042

datum = gnutls.library.types.gnutls_datum_t(

2043

ctypes.cast(ctypes.c_char_p(openpgp),

2044

ctypes.POINTER(ctypes.c_ubyte)),

2045

ctypes.c_uint(len(openpgp)))

1367

2046

# New empty GnuTLS certificate

1368

2047

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1369

(gnutls.library.functions

1370

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2048

gnutls.library.functions.gnutls_openpgp_crt_init(

2049

ctypes.byref(crt))

1371

2050

# Import the OpenPGP public key into the certificate

1372

(gnutls.library.functions

1373

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

1374

gnutls.library.constants

1375

.GNUTLS_OPENPGP_FMT_RAW))

2051

gnutls.library.functions.gnutls_openpgp_crt_import(

2052

crt, ctypes.byref(datum),

2053

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1376

2054

# Verify the self signature in the key

1377

2055

crtverify = ctypes.c_uint()

1378

(gnutls.library.functions

1379

.gnutls_openpgp_crt_verify_self(crt, 0,

1380

ctypes.byref(crtverify)))

2056

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2057

crt, 0, ctypes.byref(crtverify))

1381

2058

if crtverify.value != 0:

1382

2059

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1383

raise (gnutls.errors.CertificateSecurityError

1384

("Verify failed"))

2060

raise gnutls.errors.CertificateSecurityError(

2061

"Verify failed")

1385

2062

# New buffer for the fingerprint

1386

2063

buf = ctypes.create_string_buffer(20)

1387

2064

buf_len = ctypes.c_size_t()

1388

2065

# Get the fingerprint from the certificate into the buffer

1389

(gnutls.library.functions

1390

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

1391

ctypes.byref(buf_len)))

2066

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2067

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

1392

2068

# Deinit the certificate

1393

2069

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1394

2070

# Convert the buffer to a Python bytestring

1395

2071

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

1396

2072

# Convert the bytestring to hexadecimal notation

1397

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

2073

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

1398

2074

return hex_fpr

1399

2075

1400

2076

1401

2077

class MultiprocessingMixIn(object):

1402

2078

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

2079

1403

2080

def sub_process_main(self, request, address):

1404

2081

try:

1405

2082

self.finish_request(request, address)

1406

except:

2083

except Exception:

1407

2084

self.handle_error(request, address)

1408

2085

self.close_request(request)

1409

2086

1410

2087

def process_request(self, request, address):

1411

2088

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

1412

multiprocessing.Process(target = self.sub_process_main,

1413

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

2089

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

2090

args = (request, address))

2091

proc.start()

2092

return proc

2093

1414

2094

1415

2095

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1416

2096

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

2097

1417

2098

def process_request(self, request, client_address):

1418

2099

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

1419

2100

1420

2101

This function creates a new pipe in self.pipe

1421

2102

"""

1422

2103

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1423

1424

super(MultiprocessingMixInWithPipe,

1425

self).process_request(request, client_address)

2104

2105

proc = MultiprocessingMixIn.process_request(self, request,

2106

client_address)

1426

2107

self.child_pipe.close()

1427

self.add_pipe(parent_pipe)

1428

1429

def add_pipe(self, parent_pipe):

2108

self.add_pipe(parent_pipe, proc)

2109

2110

def add_pipe(self, parent_pipe, proc):

1430

2111

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

1431

raise NotImplementedError

2112

raise NotImplementedError()

2113

1432

2114

1433

2115

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1434

2116

socketserver.TCPServer, object):

1439

2121

interface: None or a network interface name (string)

1440

2122

use_ipv6: Boolean; to use IPv6 or not

1441

2123

"""

2124

1442

2125

def __init__(self, server_address, RequestHandlerClass,

1443

interface=None, use_ipv6=True):

2126

interface=None,

2127

use_ipv6=True,

2128

socketfd=None):

2129

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

2130

creating a new one with socket.socket().

2131

"""

1444

2132

self.interface = interface

1445

2133

if use_ipv6:

1446

2134

self.address_family = socket.AF_INET6

2135

if socketfd is not None:

2136

# Save the file descriptor

2137

self.socketfd = socketfd

2138

# Save the original socket.socket() function

2139

self.socket_socket = socket.socket

2140

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

2141

#

2142

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

2143

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

2144

# patching socket.socket.)

2145

#

2146

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

2147

@functools.wraps(socket.socket)

2148

def socket_wrapper(*args, **kwargs):

2149

# Restore original function so subsequent calls are

2150

# not affected.

2151

socket.socket = self.socket_socket

2152

del self.socket_socket

2153

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

2154

# saved file descriptor.

2155

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

2156

# Replace socket.socket() function with wrapper

2157

socket.socket = socket_wrapper

2158

# The socketserver.TCPServer.__init__ will call

2159

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

2160

# socket_wrapper(), if socketfd was set.

1447

2161

socketserver.TCPServer.__init__(self, server_address,

1448

2162

RequestHandlerClass)

2163

1449

2164

def server_bind(self):

1450

2165

"""This overrides the normal server_bind() function

1451

2166

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

1457

2172

self.interface)

1458

2173

else:

1459

2174

try:

1460

self.socket.setsockopt(socket.SOL_SOCKET,

1461

SO_BINDTODEVICE,

1462

str(self.interface

1463

+ '\0'))

2175

self.socket.setsockopt(

2176

socket.SOL_SOCKET, SO_BINDTODEVICE,

2177

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

1464

2178

except socket.error as error:

1465

if error[0] == errno.EPERM:

1466

logger.error("No permission to"

1467

" bind to interface %s",

1468

self.interface)

1469

elif error[0] == errno.ENOPROTOOPT:

2179

if error.errno == errno.EPERM:

2180

logger.error("No permission to bind to"

2181

" interface %s", self.interface)

2182

elif error.errno == errno.ENOPROTOOPT:

1470

2183

logger.error("SO_BINDTODEVICE not available;"

1471

2184

" cannot bind to interface %s",

1472

2185

self.interface)

2186

elif error.errno == errno.ENODEV:

2187

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

2188

" cannot bind", self.interface)

1473

2189

else:

1474

2190

raise

1475

2191

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

1478

2194

if self.address_family == socket.AF_INET6:

1479

2195

any_address = "::" # in6addr_any

1480

2196

else:

1481

any_address = socket.INADDR_ANY

2197

any_address = "0.0.0.0" # INADDR_ANY

1482

2198

self.server_address = (any_address,

1483

2199

self.server_address[1])

1484

2200

elif not self.server_address[1]:

1485

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

1486

0)

2201

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

1487

2202

# if self.interface:

1488

2203

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

1489

2204

# 0, # port

1503

2218

1504

2219

Assumes a gobject.MainLoop event loop.

1505

2220

"""

2221

1506

2222

def __init__(self, server_address, RequestHandlerClass,

1507

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

1508

gnutls_priority=None, use_dbus=True):

2223

interface=None,

2224

use_ipv6=True,

2225

clients=None,

2226

gnutls_priority=None,

2227

use_dbus=True,

2228

socketfd=None):

1509

2229

self.enabled = False

1510

2230

self.clients = clients

1511

2231

if self.clients is None:

1512

self.clients = set()

2232

self.clients = {}

1513

2233

self.use_dbus = use_dbus

1514

2234

self.gnutls_priority = gnutls_priority

1515

2235

IPv6_TCPServer.__init__(self, server_address,

1516

2236

RequestHandlerClass,

1517

2237

interface = interface,

1518

use_ipv6 = use_ipv6)

2238

use_ipv6 = use_ipv6,

2239

socketfd = socketfd)

2240

1519

2241

def server_activate(self):

1520

2242

if self.enabled:

1521

2243

return socketserver.TCPServer.server_activate(self)

2244

1522

2245

def enable(self):

1523

2246

self.enabled = True

1524

def add_pipe(self, parent_pipe):

2247

2248

def add_pipe(self, parent_pipe, proc):

1525

2249

# Call "handle_ipc" for both data and EOF events

1526

gobject.io_add_watch(parent_pipe.fileno(),

1527

gobject.IO_IN | gobject.IO_HUP,

1528

functools.partial(self.handle_ipc,

1529

parent_pipe = parent_pipe))

1530

1531

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

2250

gobject.io_add_watch(

2251

parent_pipe.fileno(),

2252

gobject.IO_IN | gobject.IO_HUP,

2253

functools.partial(self.handle_ipc,

2254

parent_pipe = parent_pipe,

2255

proc = proc))

2256

2257

def handle_ipc(self, source, condition,

2258

parent_pipe=None,

2259

proc = None,

1532

2260

client_object=None):

1533

condition_names = {

1534

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

1535

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

1536

# blocking).

1537

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

1538

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

1539

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

1540

# broken, usually for pipes and

1541

# sockets).

1542

}

1543

conditions_string = ' | '.join(name

1544

for cond, name in

1545

condition_names.iteritems()

1546

if cond & condition)

1547

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

1548

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

2261

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

2262

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

2263

# Wait for other process to exit

2264

proc.join()

1549

2265

return False

1550

2266

1551

2267

# Read a request from the child

1556

2272

fpr = request[1]

1557

2273

address = request[2]

1558

2274

1559

for c in self.clients:

2275

for c in self.clients.itervalues():

1560

2276

if c.fingerprint == fpr:

1561

2277

client = c

1562

2278

break

1563

2279

else:

1564

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

1565

"dress: %s", fpr, address)

2280

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

2281

"dress: %s", fpr, address)

1566

2282

if self.use_dbus:

1567

2283

# Emit D-Bus signal

1568

mandos_dbus_service.ClientNotFound(fpr, address[0])

2284

mandos_dbus_service.ClientNotFound(fpr,

2285

address[0])

1569

2286

parent_pipe.send(False)

1570

2287

return False

1571

2288

1572

gobject.io_add_watch(parent_pipe.fileno(),

1573

gobject.IO_IN | gobject.IO_HUP,

1574

functools.partial(self.handle_ipc,

1575

parent_pipe = parent_pipe,

1576

client_object = client))

2289

gobject.io_add_watch(

2290

parent_pipe.fileno(),

2291

gobject.IO_IN | gobject.IO_HUP,

2292

functools.partial(self.handle_ipc,

2293

parent_pipe = parent_pipe,

2294

proc = proc,

2295

client_object = client))

1577

2296

parent_pipe.send(True)

1578

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

2297

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

2298

# same fileno

1579

2299

return False

1580

2300

if command == 'funcall':

1581

2301

funcname = request[1]

1582

2302

args = request[2]

1583

2303

kwargs = request[3]

1584

2304

1585

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

1586

2305

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

2306

funcname)(*args,

2307

**kwargs)))

2308

1587

2309

if command == 'getattr':

1588

2310

attrname = request[1]

1589

if callable(client_object.__getattribute__(attrname)):

1590

parent_pipe.send(('function',))

2311

if isinstance(client_object.__getattribute__(attrname),

2312

collections.Callable):

2313

parent_pipe.send(('function', ))

1591

2314

else:

1592

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

2315

parent_pipe.send((

2316

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

1593

2317

1594

2318

if command == 'setattr':

1595

2319

attrname = request[1]

1596

2320

value = request[2]

1597

2321

setattr(client_object, attrname, value)

1598

2322

1599

2323

return True

1600

2324

1601

2325

2326

def rfc3339_duration_to_delta(duration):

2327

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

2328

2329

>>> rfc3339_duration_to_delta("P7D")

2330

datetime.timedelta(7)

2331

>>> rfc3339_duration_to_delta("PT60S")

2332

datetime.timedelta(0, 60)

2333

>>> rfc3339_duration_to_delta("PT60M")

2334

datetime.timedelta(0, 3600)

2335

>>> rfc3339_duration_to_delta("PT24H")

2336

datetime.timedelta(1)

2337

>>> rfc3339_duration_to_delta("P1W")

2338

datetime.timedelta(7)

2339

>>> rfc3339_duration_to_delta("PT5M30S")

2340

datetime.timedelta(0, 330)

2341

>>> rfc3339_duration_to_delta("P1DT3M20S")

2342

datetime.timedelta(1, 200)

2343

"""

2344

2345

# Parsing an RFC 3339 duration with regular expressions is not

2346

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

2347

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

2348

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

2349

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

2350

# avoid excessive use of external libraries.

2351

2352

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

2353

Token = collections.namedtuple("Token", (

2354

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

2355

# a "group" containing digits

2356

"value", # datetime.timedelta or None

2357

"followers")) # Tokens valid after this token

2358

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

2359

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

2360

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

2361

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

2362

datetime.timedelta(seconds=1),

2363

frozenset((token_end, )))

2364

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

2365

datetime.timedelta(minutes=1),

2366

frozenset((token_second, token_end)))

2367

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

2368

datetime.timedelta(hours=1),

2369

frozenset((token_minute, token_end)))

2370

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

2371

None,

2372

frozenset((token_hour, token_minute,

2373

token_second)))

2374

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

2375

datetime.timedelta(days=1),

2376

frozenset((token_time, token_end)))

2377

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

2378

datetime.timedelta(weeks=4),

2379

frozenset((token_day, token_end)))

2380

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

2381

datetime.timedelta(weeks=52),

2382

frozenset((token_month, token_end)))

2383

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

2384

datetime.timedelta(weeks=1),

2385

frozenset((token_end, )))

2386

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

2387

frozenset((token_year, token_month,

2388

token_day, token_time,

2389

token_week)))

2390

# Define starting values

2391

value = datetime.timedelta() # Value so far

2392

found_token = None

2393

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

2394

s = duration # String left to parse

2395

# Loop until end token is found

2396

while found_token is not token_end:

2397

# Search for any currently valid tokens

2398

for token in followers:

2399

match = token.regexp.match(s)

2400

if match is not None:

2401

# Token found

2402

if token.value is not None:

2403

# Value found, parse digits

2404

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

2405

# Add to value so far

2406

value += factor * token.value

2407

# Strip token from string

2408

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

2409

# Go to found token

2410

found_token = token

2411

# Set valid next tokens

2412

followers = found_token.followers

2413

break

2414

else:

2415

# No currently valid tokens were found

2416

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

2417

.format(duration))

2418

# End token found

2419

return value

2420

2421

1602

2422

def string_to_delta(interval):

1603

2423

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

1604

2424

1615

2435

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

1616

2436

datetime.timedelta(0, 330)

1617

2437

"""

2438

2439

try:

2440

return rfc3339_duration_to_delta(interval)

2441

except ValueError:

2442

pass

2443

1618

2444

timevalue = datetime.timedelta(0)

1619

2445

for s in interval.split():

1620

2446

try:

1621

suffix = unicode(s[-1])

2447

suffix = s[-1]

1622

2448

value = int(s[:-1])

1623

2449

if suffix == "d":

1624

2450

delta = datetime.timedelta(value)

1631

2457

elif suffix == "w":

1632

2458

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

1633

2459

else:

1634

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

1635

except (ValueError, IndexError) as e:

2460

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

2461

except IndexError as e:

1636

2462

raise ValueError(*(e.args))

1637

2463

timevalue += delta

1638

2464

return timevalue

1639

2465

1640

2466

1641

def if_nametoindex(interface):

1642

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

1643

1644

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

1645

global if_nametoindex

1646

try:

1647

if_nametoindex = (ctypes.cdll.LoadLibrary

1648

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

1649

.if_nametoindex)

1650

except (OSError, AttributeError):

1651

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

1652

def if_nametoindex(interface):

1653

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

1654

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

1655

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

1656

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1657

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

1658

interface))

1659

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

1660

ifreq[16:20])[0]

1661

return interface_index

1662

return if_nametoindex(interface)

1663

1664

1665

2467

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

1666

2468

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

1667

2469

1675

2477

sys.exit()

1676

2478

if not noclose:

1677

2479

# Close all standard open file descriptors

1678

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

2480

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

1679

2481

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

1680

2482

raise OSError(errno.ENODEV,

1681

"%s not a character device"

1682

% os.path.devnull)

2483

"{} not a character device"

2484

.format(os.devnull))

1683

2485

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

1684

2486

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

1685

2487

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

1694

2496

1695

2497

parser = argparse.ArgumentParser()

1696

2498

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

1697

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

2499

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

1698

2500

help="show version number and exit")

1699

2501

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

1700

2502

help="Bind to interface IF")

1706

2508

help="Run self-test")

1707

2509

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

1708

2510

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

1709

" to terminal")

2511

" to terminal", default=None)

1710

2512

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

1711

2513

help="Debug level for stdout output")

1712

2514

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

1719

2521

" files")

1720

2522

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

1721

2523

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

1722

" system bus interface")

2524

" system bus interface", default=None)

1723

2525

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

1724

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

2526

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

2527

default=None)

2528

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

2529

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

2530

" state", default=None)

2531

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

2532

help="Specify a file descriptor to a network"

2533

" socket to use instead of creating one")

2534

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

2535

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

2536

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

2537

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

2538

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

2539

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

2540

default=None)

2541

1725

2542

options = parser.parse_args()

1726

2543

1727

2544

if options.check:

1728

2545

import doctest

1729

doctest.testmod()

1730

sys.exit()

2546

fail_count, test_count = doctest.testmod()

2547

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

1731

2548

1732

2549

# Default values for config file for server-global settings

1733

2550

server_defaults = { "interface": "",

1735

2552

"port": "",

1736

2553

"debug": "False",

1737

2554

"priority":

1738

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

2555

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

2556

":+SIGN-DSA-SHA256",

1739

2557

"servicename": "Mandos",

1740

2558

"use_dbus": "True",

1741

2559

"use_ipv6": "True",

1742

2560

"debuglevel": "",

1743

}

2561

"restore": "True",

2562

"socket": "",

2563

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

2564

"foreground": "False",

2565

"zeroconf": "True",

2566

}

1744

2567

1745

2568

# Parse config file for server-global settings

1746

2569

server_config = configparser.SafeConfigParser(server_defaults)

1747

2570

del server_defaults

1748

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

1749

"mandos.conf"))

2571

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

1750

2572

# Convert the SafeConfigParser object to a dict

1751

2573

server_settings = server_config.defaults()

1752

2574

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

1753

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

2575

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

1754

2576

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

1755

2577

option)

1756

2578

if server_settings["port"]:

1757

2579

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

1758

2580

"port")

2581

if server_settings["socket"]:

2582

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

2583

"socket")

2584

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

2585

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

2586

# happen with a supplied network socket.

2587

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

2588

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

2589

["socket"])

1759

2590

del server_config

1760

2591

1761

2592

# Override the settings from the config file with command line

1762

2593

# options, if set.

1763

2594

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

1764

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

1765

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

2595

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

2596

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

2597

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

1766

2598

value = getattr(options, option)

1767

2599

if value is not None:

1768

2600

server_settings[option] = value

1769

2601

del options

1770

2602

# Force all strings to be unicode

1771

2603

for option in server_settings.keys():

1772

if type(server_settings[option]) is str:

1773

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

2604

if isinstance(server_settings[option], bytes):

2605

server_settings[option] = (server_settings[option]

2606

.decode("utf-8"))

2607

# Force all boolean options to be boolean

2608

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

2609

"foreground", "zeroconf"):

2610

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

2611

# Debug implies foreground

2612

if server_settings["debug"]:

2613

server_settings["foreground"] = True

1774

2614

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

1775

2615

1776

2616

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

1777

2617

2618

if (not server_settings["zeroconf"]

2619

and not (server_settings["port"]

2620

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

2621

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

2622

1778

2623

# For convenience

1779

2624

debug = server_settings["debug"]

1780

2625

debuglevel = server_settings["debuglevel"]

1781

2626

use_dbus = server_settings["use_dbus"]

1782

2627

use_ipv6 = server_settings["use_ipv6"]

1783

2628

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

2629

stored_state_file)

2630

foreground = server_settings["foreground"]

2631

zeroconf = server_settings["zeroconf"]

2632

2633

if debug:

2634

initlogger(debug, logging.DEBUG)

2635

else:

2636

if not debuglevel:

2637

initlogger(debug)

2638

else:

2639

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

2640

initlogger(debug, level)

2641

1784

2642

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

1785

syslogger.setFormatter(logging.Formatter

1786

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

1787

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

1788

% server_settings["servicename"]))

2643

syslogger.setFormatter(

2644

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

2645

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

2646

server_settings["servicename"])))

1789

2647

1790

2648

# Parse config file with clients

1791

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

1792

"interval": "5m",

1793

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

1794

"host": "",

1795

"approval_delay": "0s",

1796

"approval_duration": "1s",

1797

}

1798

client_config = configparser.SafeConfigParser(client_defaults)

2649

client_config = configparser.SafeConfigParser(Client

2650

.client_defaults)

1799

2651

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

1800

2652

"clients.conf"))

1801

2653

1802

2654

global mandos_dbus_service

1803

2655

mandos_dbus_service = None

1804

2656

1805

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

1806

server_settings["port"]),

1807

ClientHandler,

1808

interface=(server_settings["interface"]

1809

or None),

1810

use_ipv6=use_ipv6,

1811

gnutls_priority=

1812

server_settings["priority"],

1813

use_dbus=use_dbus)

1814

if not debug:

1815

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

2657

socketfd = None

2658

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

2659

socketfd = server_settings["socket"]

2660

tcp_server = MandosServer(

2661

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

2662

ClientHandler,

2663

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

2664

use_ipv6=use_ipv6,

2665

gnutls_priority=server_settings["priority"],

2666

use_dbus=use_dbus,

2667

socketfd=socketfd)

2668

if not foreground:

2669

pidfilename = "/run/mandos.pid"

2670

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

2671

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

2672

pidfile = None

1816

2673

try:

1817

pidfile = open(pidfilename, "w")

1818

except IOError:

1819

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

2674

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

2675

except IOError as e:

2676

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

2677

exc_info=e)

1820

2678

1821

try:

1822

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

1823

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

1824

except KeyError:

2679

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

1825

2680

try:

1826

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

1827

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

2681

uid = pwd.getpwnam(name).pw_uid

2682

gid = pwd.getpwnam(name).pw_gid

2683

break

1828

2684

except KeyError:

1829

try:

1830

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

1831

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

1832

except KeyError:

1833

uid = 65534

1834

gid = 65534

2685

continue

2686

else:

2687

uid = 65534

2688

gid = 65534

1835

2689

try:

1836

2690

os.setgid(gid)

1837

2691

os.setuid(uid)

1838

2692

except OSError as error:

1839

if error[0] != errno.EPERM:

1840

raise error

2693

if error.errno != errno.EPERM:

2694

raise

1841

2695

1842

if not debug and not debuglevel:

1843

syslogger.setLevel(logging.WARNING)

1844

console.setLevel(logging.WARNING)

1845

if debuglevel:

1846

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

1847

syslogger.setLevel(level)

1848

console.setLevel(level)

1849

1850

2696

if debug:

1851

2697

# Enable all possible GnuTLS debugging

1852

2698

1858

2704

def debug_gnutls(level, string):

1859

2705

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

1860

2706

1861

(gnutls.library.functions

1862

.gnutls_global_set_log_function(debug_gnutls))

2707

gnutls.library.functions.gnutls_global_set_log_function(

2708

debug_gnutls)

1863

2709

1864

2710

# Redirect stdin so all checkers get /dev/null

1865

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

2711

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

1866

2712

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

1867

2713

if null > 2:

1868

2714

os.close(null)

1869

else:

1870

# No console logging

1871

logger.removeHandler(console)

1872

2715

1873

2716

# Need to fork before connecting to D-Bus

1874

if not debug:

2717

if not foreground:

1875

2718

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

1876

2719

daemon()

1877

2720

2721

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

2722

# need to inform gobject that threads will be used.

2723

gobject.threads_init()

2724

1878

2725

global main_loop

1879

2726

# From the Avahi example code

1880

DBusGMainLoop(set_as_default=True )

2727

DBusGMainLoop(set_as_default=True)

1881

2728

main_loop = gobject.MainLoop()

1882

2729

bus = dbus.SystemBus()

1883

2730

# End of Avahi example code

1884

2731

if use_dbus:

1885

2732

try:

1886

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

1887

bus, do_not_queue=True)

1888

except dbus.exceptions.NameExistsException as e:

1889

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

2733

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

2734

bus,

2735

do_not_queue=True)

2736

old_bus_name = dbus.service.BusName(

2737

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

2738

do_not_queue=True)

2739

except dbus.exceptions.DBusException as e:

2740

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

1890

2741

use_dbus = False

1891

2742

server_settings["use_dbus"] = False

1892

2743

tcp_server.use_dbus = False

1893

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1894

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

1895

servicetype = "_mandos._tcp",

1896

protocol = protocol, bus = bus)

1897

if server_settings["interface"]:

1898

service.interface = (if_nametoindex

1899

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

2744

if zeroconf:

2745

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2746

service = AvahiServiceToSyslog(

2747

name = server_settings["servicename"],

2748

servicetype = "_mandos._tcp",

2749

protocol = protocol,

2750

bus = bus)

2751

if server_settings["interface"]:

2752

service.interface = if_nametoindex(

2753

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

1900

2754

1901

2755

global multiprocessing_manager

1902

2756

multiprocessing_manager = multiprocessing.Manager()

1904

2758

client_class = Client

1905

2759

if use_dbus:

1906

2760

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

1907

def client_config_items(config, section):

1908

special_settings = {

1909

"approved_by_default":

1910

lambda: config.getboolean(section,

1911

"approved_by_default"),

1912

}

1913

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

2761

2762

client_settings = Client.config_parser(client_config)

2763

old_client_settings = {}

2764

clients_data = {}

2765

2766

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

2767

global wnull

2768

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

2769

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

2770

# mode

2771

if debug or not foreground:

2772

wnull.close()

2773

2774

# Get client data and settings from last running state.

2775

if server_settings["restore"]:

2776

try:

2777

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

2778

clients_data, old_client_settings = pickle.load(

2779

stored_state)

2780

os.remove(stored_state_path)

2781

except IOError as e:

2782

if e.errno == errno.ENOENT:

2783

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

2784

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

2785

else:

2786

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

2787

exc_info=e)

2788

raise

2789

except EOFError as e:

2790

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

2791

"EOFError:",

2792

exc_info=e)

2793

2794

with PGPEngine() as pgp:

2795

for client_name, client in clients_data.items():

2796

# Skip removed clients

2797

if client_name not in client_settings:

2798

continue

2799

2800

# Decide which value to use after restoring saved state.

2801

# We have three different values: Old config file,

2802

# new config file, and saved state.

2803

# New config value takes precedence if it differs from old

2804

# config value, otherwise use saved state.

2805

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

2806

try:

2807

# For each value in new config, check if it

2808

# differs from the old config value (Except for

2809

# the "secret" attribute)

2810

if (name != "secret"

2811

and (value !=

2812

old_client_settings[client_name][name])):

2813

client[name] = value

2814

except KeyError:

2815

pass

2816

2817

# Clients who has passed its expire date can still be

2818

# enabled if its last checker was successful. A Client

2819

# whose checker succeeded before we stored its state is

2820

# assumed to have successfully run all checkers during

2821

# downtime.

2822

if client["enabled"]:

2823

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

2824

if not client["last_checked_ok"]:

2825

logger.warning(

2826

"disabling client {} - Client never "

2827

"performed a successful checker".format(

2828

client_name))

2829

client["enabled"] = False

2830

elif client["last_checker_status"] != 0:

2831

logger.warning(

2832

"disabling client {} - Client last"

2833

" checker failed with error code"

2834

" {}".format(

2835

client_name,

2836

client["last_checker_status"]))

2837

client["enabled"] = False

2838

else:

2839

client["expires"] = (

2840

datetime.datetime.utcnow()

2841

+ client["timeout"])

2842

logger.debug("Last checker succeeded,"

2843

" keeping {} enabled".format(

2844

client_name))

1914

2845

try:

1915

yield (name, special_settings[name]())

1916

except KeyError:

1917

yield (name, value)

1918

1919

tcp_server.clients.update(set(

1920

client_class(name = section,

1921

config= dict(client_config_items(

1922

client_config, section)))

1923

for section in client_config.sections()))

2846

client["secret"] = pgp.decrypt(

2847

client["encrypted_secret"],

2848

client_settings[client_name]["secret"])

2849

except PGPError:

2850

# If decryption fails, we use secret from new settings

2851

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

2852

client_name))

2853

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

2854

["secret"])

2855

2856

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

2857

for client_name in (set(old_client_settings)

2858

- set(client_settings)):

2859

del clients_data[client_name]

2860

for client_name in (set(client_settings)

2861

- set(old_client_settings)):

2862

clients_data[client_name] = client_settings[client_name]

2863

2864

# Create all client objects

2865

for client_name, client in clients_data.items():

2866

tcp_server.clients[client_name] = client_class(

2867

name = client_name,

2868

settings = client,

2869

server_settings = server_settings)

2870

1924

2871

if not tcp_server.clients:

1925

2872

logger.warning("No clients defined")

1926

1927

if not debug:

1928

try:

1929

with pidfile:

1930

pid = os.getpid()

1931

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

1932

del pidfile

1933

except IOError:

1934

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

1935

pidfilename, pid)

1936

except NameError:

1937

# "pidfile" was never created

1938

pass

2873

2874

if not foreground:

2875

if pidfile is not None:

2876

pid = os.getpid()

2877

try:

2878

with pidfile:

2879

print(pid, file=pidfile)

2880

except IOError:

2881

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

2882

pidfilename, pid)

2883

del pidfile

1939

2884

del pidfilename

1940

1941

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

1942

2885

1943

2886

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

1944

2887

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

1945

2888

1946

2889

if use_dbus:

1947

class MandosDBusService(dbus.service.Object):

2890

2891

@alternate_dbus_interfaces(

2892

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

2893

class MandosDBusService(DBusObjectWithObjectManager):

1948

2894

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

2895

1949

2896

def __init__(self):

1950

2897

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

1951

_interface = "se.bsnet.fukt.Mandos"

2898

2899

_interface = "se.recompile.Mandos"

1952

2900

1953

2901

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

1954

2902

def ClientAdded(self, objpath):

1960

2908

"D-Bus signal"

1961

2909

pass

1962

2910

2911

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

2912

"true"})

1963

2913

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

1964

2914

def ClientRemoved(self, objpath, name):

1965

2915

"D-Bus signal"

1966

2916

pass

1967

2917

2918

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

2919

"true"})

1968

2920

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

1969

2921

def GetAllClients(self):

1970

2922

"D-Bus method"

1971

return dbus.Array(c.dbus_object_path

1972

for c in tcp_server.clients)

2923

return dbus.Array(c.dbus_object_path for c in

2924

tcp_server.clients.itervalues())

1973

2925

2926

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

2927

"true"})

1974

2928

@dbus.service.method(_interface,

1975

2929

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

1976

2930

def GetAllClientsWithProperties(self):

1977

2931

"D-Bus method"

1978

2932

return dbus.Dictionary(

1979

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

1980

for c in tcp_server.clients),

2933

{ c.dbus_object_path: c.GetAll(

2934

"se.recompile.Mandos.Client")

2935

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

1981

2936

signature="oa{sv}")

1982

2937

1983

2938

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

1984

2939

def RemoveClient(self, object_path):

1985

2940

"D-Bus method"

1986

for c in tcp_server.clients:

2941

for c in tcp_server.clients.itervalues():

1987

2942

if c.dbus_object_path == object_path:

1988

tcp_server.clients.remove(c)

2943

del tcp_server.clients[c.name]

1989

2944

c.remove_from_connection()

1990

# Don't signal anything except ClientRemoved

2945

# Don't signal the disabling

1991

2946

c.disable(quiet=True)

1992

# Emit D-Bus signal

1993

self.ClientRemoved(object_path, c.name)

2947

# Emit D-Bus signal for removal

2948

self.client_removed_signal(c)

1994

2949

return

1995

2950

raise KeyError(object_path)

1996

2951

1997

2952

del _interface

2953

2954

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

2955

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

2956

def GetManagedObjects(self):

2957

"""D-Bus method"""

2958

return dbus.Dictionary(

2959

{ client.dbus_object_path:

2960

dbus.Dictionary(

2961

{ interface: client.GetAll(interface)

2962

for interface in

2963

client._get_all_interface_names()})

2964

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

2965

2966

def client_added_signal(self, client):

2967

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

2968

if use_dbus:

2969

# New standard signal

2970

self.InterfacesAdded(

2971

client.dbus_object_path,

2972

dbus.Dictionary(

2973

{ interface: client.GetAll(interface)

2974

for interface in

2975

client._get_all_interface_names()}))

2976

# Old signal

2977

self.ClientAdded(client.dbus_object_path)

2978

2979

def client_removed_signal(self, client):

2980

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

2981

if use_dbus:

2982

# New standard signal

2983

self.InterfacesRemoved(

2984

client.dbus_object_path,

2985

client._get_all_interface_names())

2986

# Old signal

2987

self.ClientRemoved(client.dbus_object_path,

2988

client.name)

1998

2989

1999

2990

mandos_dbus_service = MandosDBusService()

2000

2991

2001

2992

def cleanup():

2002

2993

"Cleanup function; run on exit"

2003

service.cleanup()

2004

2994

if zeroconf:

2995

service.cleanup()

2996

2997

multiprocessing.active_children()

2998

wnull.close()

2999

if not (tcp_server.clients or client_settings):

3000

return

3001

3002

# Store client before exiting. Secrets are encrypted with key

3003

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

3004

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

3005

clients = {}

3006

with PGPEngine() as pgp:

3007

for client in tcp_server.clients.itervalues():

3008

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

3009

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

3010

key)

3011

client_dict = {}

3012

3013

# A list of attributes that can not be pickled

3014

# + secret.

3015

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

3016

"checker", "server_settings" }

3017

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

3018

.Object):

3019

exclude.add(name)

3020

3021

client_dict["encrypted_secret"] = (client

3022

.encrypted_secret)

3023

for attr in client.client_structure:

3024

if attr not in exclude:

3025

client_dict[attr] = getattr(client, attr)

3026

3027

clients[client.name] = client_dict

3028

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

3029

3030

try:

3031

with tempfile.NamedTemporaryFile(

3032

mode='wb',

3033

suffix=".pickle",

3034

prefix='clients-',

3035

dir=os.path.dirname(stored_state_path),

3036

delete=False) as stored_state:

3037

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

3038

tempname = stored_state.name

3039

os.rename(tempname, stored_state_path)

3040

except (IOError, OSError) as e:

3041

if not debug:

3042

try:

3043

os.remove(tempname)

3044

except NameError:

3045

pass

3046

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

3047

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

3048

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

3049

else:

3050

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

3051

exc_info=e)

3052

raise

3053

3054

# Delete all clients, and settings from config

2005

3055

while tcp_server.clients:

2006

client = tcp_server.clients.pop()

3056

name, client = tcp_server.clients.popitem()

2007

3057

if use_dbus:

2008

3058

client.remove_from_connection()

2009

client.disable_hook = None

2010

# Don't signal anything except ClientRemoved

3059

# Don't signal the disabling

2011

3060

client.disable(quiet=True)

2012

if use_dbus:

2013

# Emit D-Bus signal

2014

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2015

client.name)

3061

# Emit D-Bus signal for removal

3062

mandos_dbus_service.client_removed_signal(client)

3063

client_settings.clear()

2016

3064

2017

3065

atexit.register(cleanup)

2018

3066

2019

for client in tcp_server.clients:

3067

for client in tcp_server.clients.itervalues():

2020

3068

if use_dbus:

2021

# Emit D-Bus signal

2022

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2023

client.enable()

3069

# Emit D-Bus signal for adding

3070

mandos_dbus_service.client_added_signal(client)

3071

# Need to initiate checking of clients

3072

if client.enabled:

3073

client.init_checker()

2024

3074

2025

3075

tcp_server.enable()

2026

3076

tcp_server.server_activate()

2027

3077

2028

3078

# Find out what port we got

2029

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

3079

if zeroconf:

3080

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

2030

3081

if use_ipv6:

2031

3082

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

2032

" flowinfo %d, scope_id %d"

2033

% tcp_server.socket.getsockname())

3083

" flowinfo %d, scope_id %d",

3084

*tcp_server.socket.getsockname())

2034

3085

else: # IPv4

2035

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

2036

% tcp_server.socket.getsockname())

3086

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

3087

*tcp_server.socket.getsockname())

2037

3088

2038

3089

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

2039

3090

2040

3091

try:

2041

# From the Avahi example code

2042

try:

2043

service.activate()

2044

except dbus.exceptions.DBusException as error:

2045

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

2046

cleanup()

2047

sys.exit(1)

2048

# End of Avahi example code

3092

if zeroconf:

3093

# From the Avahi example code

3094

try:

3095

service.activate()

3096

except dbus.exceptions.DBusException as error:

3097

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

3098

cleanup()

3099

sys.exit(1)

3100

# End of Avahi example code

2049

3101

2050

3102

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

2051

3103

lambda *args, **kwargs:

2055

3107

logger.debug("Starting main loop")

2056

3108

main_loop.run()

2057

3109

except AvahiError as error:

2058

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

3110

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

2059

3111

cleanup()

2060

3112

sys.exit(1)

2061

3113

except KeyboardInterrupt:

2066

3118

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

2067

3119

cleanup()

2068

3120

3121

2069

3122

if __name__ == '__main__':

2070

3123

main()