/mandos/trunk : revision 482

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

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@recompile.se>.

31

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

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

37

import SocketServer as socketserver

43

38

import socket

44

39

import argparse

45

40

import datetime

50

45

import gnutls.library.functions

51

46

import gnutls.library.constants

52

47

import gnutls.library.types

53

try:

54

import ConfigParser as configparser

55

except ImportError:

56

import configparser

48

import ConfigParser as configparser

57

49

import sys

58

50

import re

59

51

import os

68

60

import struct

69

61

import fcntl

70

62

import functools

71

try:

72

import cPickle as pickle

73

except ImportError:

74

import pickle

63

import cPickle as pickle

75

64

import multiprocessing

76

import types

77

import binascii

78

import tempfile

79

import itertools

80

import collections

81

import codecs

82

65

83

66

import dbus

84

67

import dbus.service

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

68

import gobject

89

69

import avahi

90

70

from dbus.mainloop.glib import DBusGMainLoop

91

71

import ctypes

101

81

except ImportError:

102

82

SO_BINDTODEVICE = None

103

83

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

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)

236

102

237

103

class AvahiError(Exception):

238

104

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

239

105

self.value = value

240

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

241

**kwargs)

242

106

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

107

def __unicode__(self):

108

return unicode(repr(self.value))

243

109

244

110

class AvahiServiceError(AvahiError):

245

111

pass

246

112

247

248

113

class AvahiGroupError(AvahiError):

249

114

pass

250

115

257

122

Used to optionally bind to the specified interface.

258

123

name: string; Example: 'Mandos'

259

124

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

260

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

125

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

261

126

port: integer; what port to announce

262

127

TXT: list of strings; TXT record for the service

263

128

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

269

134

server: D-Bus Server

270

135

bus: dbus.SystemBus()

271

136

"""

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

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

284

141

self.interface = interface

285

142

self.name = name

286

143

self.type = servicetype

295

152

self.server = None

296

153

self.bus = bus

297

154

self.entry_group_state_changed_match = None

298

299

def rename(self, remove=True):

155

def rename(self):

300

156

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

301

157

if self.rename_count >= self.max_renames:

302

158

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

303

159

" after %i retries, exiting.",

304

160

self.rename_count)

305

161

raise AvahiServiceError("Too many renames")

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

162

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

309

163

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

310

164

self.name)

311

if remove:

312

self.remove()

165

syslogger.setFormatter(logging.Formatter

166

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

167

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

168

% self.name))

169

self.remove()

313

170

try:

314

171

self.add()

315

172

except dbus.exceptions.DBusException as error:

316

if (error.get_dbus_name()

317

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

318

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

319

return self.rename(remove=False)

320

else:

321

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

322

self.cleanup()

323

os._exit(1)

324

173

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

174

self.cleanup()

175

os._exit(1)

176

self.rename_count += 1

325

177

def remove(self):

326

178

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

327

186

if self.entry_group_state_changed_match is not None:

328

187

self.entry_group_state_changed_match.remove()

329

188

self.entry_group_state_changed_match = None

330

if self.group is not None:

331

self.group.Reset()

332

333

189

def add(self):

334

190

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

335

191

self.remove()

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)

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)

341

197

self.entry_group_state_changed_match = (

342

198

self.group.connect_to_signal(

343

'StateChanged', self.entry_group_state_changed))

199

'StateChanged', self .entry_group_state_changed))

344

200

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

345

201

self.name, self.type)

346

202

self.group.AddService(

352

208

dbus.UInt16(self.port),

353

209

avahi.string_array_to_txt_array(self.TXT))

354

210

self.group.Commit()

355

356

211

def entry_group_state_changed(self, state, error):

357

212

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

358

213

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

364

219

self.rename()

365

220

elif state == avahi.ENTRY_GROUP_FAILURE:

366

221

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

367

str(error))

368

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

369

222

unicode(error))

223

raise AvahiGroupError("State changed: %s"

224

% unicode(error))

370

225

def cleanup(self):

371

226

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

379

227

self.remove()

380

381

228

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

382

229

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

383

230

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

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

}

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

390

238

if state in bad_states:

391

if bad_states[state] is not None:

392

if error is None:

393

logger.error(bad_states[state])

394

else:

395

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

396

self.cleanup()

239

if bad_states[state]:

240

logger.error(bad_states[state])

241

self.remove()

397

242

elif state == avahi.SERVER_RUNNING:

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)

243

self.add()

410

244

else:

411

if error is None:

412

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

413

else:

414

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

415

245

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

416

246

def activate(self):

417

247

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

418

248

if self.server is None:

422

252

follow_name_owner_changes=True),

423

253

avahi.DBUS_INTERFACE_SERVER)

424

254

self.server.connect_to_signal("StateChanged",

425

self.server_state_changed)

255

self.server_state_changed)

426

256

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

427

257

428

258

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

448

259

class Client(object):

449

260

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

450

261

451

262

Attributes:

452

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

263

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

453

264

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

454

265

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

455

266

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

462

273

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

463

274

checker_initiator_tag: a gobject event source tag, or None

464

275

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

467

276

current_checker_command: string; current running checker_command

277

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

468

278

disable_initiator_tag: a gobject event source tag, or None

469

279

enabled: bool()

470

280

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

473

283

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

474

284

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

475

285

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

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

286

last_enabled: datetime.datetime(); (UTC)

482

287

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

483

288

D-Bus identifiers

484

289

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

485

290

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

486

291

until this client is disabled

487

extended_timeout: extra long timeout when secret has been sent

488

292

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

492

293

"""

493

294

494

295

runtime_expansions = ("approval_delay", "approval_duration",

495

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

496

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

497

"last_approval_request", "last_checked_ok",

296

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

297

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

498

298

"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

}

510

299

511

300

@staticmethod

512

def config_parser(config):

513

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

514

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

515

with exceptions for any special settings as defined above.

516

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

517

value given the same arguments.

518

"""

519

settings = {}

520

for client_name in config.sections():

521

section = dict(config.items(client_name))

522

client = settings[client_name] = {}

523

524

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

525

# Reformat values from string types to Python types

526

client["approved_by_default"] = config.getboolean(

527

client_name, "approved_by_default")

528

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

529

"enabled")

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

534

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

535

.replace(" ", ""))

536

if "secret" in section:

537

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

538

elif "secfile" in section:

539

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

540

(section["secfile"])),

541

"rb") as secfile:

542

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

543

else:

544

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

545

.format(section))

546

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

547

client["extended_timeout"] = string_to_delta(

548

section["extended_timeout"])

549

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

550

client["approval_delay"] = string_to_delta(

551

section["approval_delay"])

552

client["approval_duration"] = string_to_delta(

553

section["approval_duration"])

554

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

555

client["last_approval_request"] = None

556

client["last_checked_ok"] = None

557

client["last_checker_status"] = -2

558

559

return settings

560

561

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

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

562

322

self.name = name

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

323

if config is None:

324

config = {}

580

325

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

581

331

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

582

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

583

datetime.datetime.utcnow())

584

585

# attributes specific for this server instance

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

586

351

self.checker = None

587

352

self.checker_initiator_tag = None

588

353

self.disable_initiator_tag = None

589

354

self.checker_callback_tag = None

355

self.checker_command = config["checker"]

590

356

self.current_checker_command = None

591

self.approved = None

357

self.last_connect = None

358

self._approved = None

359

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

360

True)

592

361

self.approvals_pending = 0

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)

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

604

367

605

# Send notice to process children that client state has changed

606

368

def send_changedstate(self):

607

with self.changedstate:

608

self.changedstate.notify_all()

609

369

self.changedstate.acquire()

370

self.changedstate.notify_all()

371

self.changedstate.release()

372

610

373

def enable(self):

611

374

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

612

375

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

613

376

# Already enabled

614

377

return

615

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

616

self.enabled = True

378

self.send_changedstate()

617

379

self.last_enabled = datetime.datetime.utcnow()

618

self.init_checker()

619

self.send_changedstate()

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

620

392

621

393

def disable(self, quiet=True):

622

394

"""Disable this client."""

623

395

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

624

396

return False

625

397

if not quiet:

398

self.send_changedstate()

399

if not quiet:

626

400

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

627

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

401

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

628

402

gobject.source_remove(self.disable_initiator_tag)

629

403

self.disable_initiator_tag = None

630

self.expires = None

631

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

404

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

632

405

gobject.source_remove(self.checker_initiator_tag)

633

406

self.checker_initiator_tag = None

634

407

self.stop_checker()

408

if self.disable_hook:

409

self.disable_hook(self)

635

410

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

638

411

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

639

412

return False

640

413

641

414

def __del__(self):

415

self.disable_hook = None

642

416

self.disable()

643

417

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

418

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

662

419

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

663

420

self.checker_callback_tag = None

664

421

self.checker = None

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:

422

if os.WIFEXITED(condition):

423

exitstatus = os.WEXITSTATUS(condition)

424

if exitstatus == 0:

673

425

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

674

426

vars(self))

675

427

self.checked_ok()

676

428

else:

677

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

429

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

430

vars(self))

678

431

else:

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

681

432

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

682

433

vars(self))

683

return False

684

434

685

435

def checked_ok(self):

686

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

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

"""

687

441

self.last_checked_ok = datetime.datetime.utcnow()

688

self.last_checker_status = 0

689

self.last_checker_signal = None

690

self.bump_timeout()

691

692

def bump_timeout(self, timeout=None):

693

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

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

442

gobject.source_remove(self.disable_initiator_tag)

443

self.disable_initiator_tag = (gobject.timeout_add

444

(self.timeout_milliseconds(),

445

self.disable))

703

446

704

447

def need_approval(self):

705

448

self.last_approval_request = datetime.datetime.utcnow()

710

453

If a checker already exists, leave it running and do

711

454

nothing."""

712

455

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

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

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

717

460

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

718

461

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

719

462

# should be.

720

463

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

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)

725

477

# Start a new checker if needed

726

478

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 }

731

479

try:

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

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

738

498

self.current_checker_command = command

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)

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)

764

522

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

765

523

return True

766

524

772

530

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

773

531

return

774

532

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

775

self.checker.terminate()

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

776

541

self.checker = None

777

542

778

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

543

def dbus_service_property(dbus_interface, signature="v",

544

access="readwrite", byte_arrays=False):

783

545

"""Decorators for marking methods of a DBusObjectWithProperties to

784

546

become properties on the D-Bus.

785

547

794

556

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

795

557

if byte_arrays and signature != "ay":

796

558

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

797

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

798

559

" signature %r" % signature)

799

560

def decorator(func):

800

561

func._dbus_is_property = True

801

562

func._dbus_interface = dbus_interface

806

567

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

807

568

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

808

569

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

853

570

return decorator

854

571

855

572

856

573

class DBusPropertyException(dbus.exceptions.DBusException):

857

574

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

858

575

"""

859

pass

576

def __unicode__(self):

577

return unicode(str(self))

860

578

861

579

862

580

class DBusPropertyAccessException(DBusPropertyException):

871

589

pass

872

590

873

591

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

592

class DBusObjectWithProperties(dbus.service.Object):

964

593

"""A D-Bus object with properties.

965

594

966

595

Classes inheriting from this can use the dbus_service_property

967

596

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

968

597

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

969

598

"""

970

599

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

971

611

def _get_dbus_property(self, interface_name, property_name):

972

612

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

973

613

property with the specified name and interface.

974

614

"""

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

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

982

625

# No such property

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

626

raise DBusPropertyNotFound(self.dbus_object_path + ":"

627

+ interface_name + "."

628

+ property_name)

629

630

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

997

631

out_signature="v")

998

632

def Get(self, interface_name, property_name):

999

633

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

1017

651

# The byte_arrays option is not supported yet on

1018

652

# signatures other than "ay".

1019

653

if prop._dbus_signature != "ay":

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

654

raise ValueError

655

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

656

for byte in value))

1025

657

prop(value)

1026

658

1027

@dbus.service.method(dbus.PROPERTIES_IFACE,

1028

in_signature="s",

659

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

1029

660

out_signature="a{sv}")

1030

661

def GetAll(self, interface_name):

1031

662

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

1032

663

standard.

1033

664

1034

665

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

1035

666

"""

1036

properties = {}

1037

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

667

all = {}

668

for name, prop in self._get_all_dbus_properties():

1038

669

if (interface_name

1039

670

and interface_name != prop._dbus_interface):

1040

671

# Interface non-empty but did not match

1044

675

continue

1045

676

value = prop()

1046

677

if not hasattr(value, "variant_level"):

1047

properties[name] = value

678

all[name] = value

1048

679

continue

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

680

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

681

value.variant_level+1)

682

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

1060

683

1061

684

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1062

685

out_signature="s",

1063

686

path_keyword='object_path',

1064

687

connection_keyword='connection')

1065

688

def Introspect(self, object_path, connection):

1066

"""Overloading of standard D-Bus method.

1067

1068

Inserts property tags and interface annotation tags.

689

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

1069

690

"""

1070

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1071

object_path,

1072

connection)

691

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

692

connection)

1073

693

try:

1074

694

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

1075

1076

695

def make_tag(document, name, prop):

1077

696

e = document.createElement("property")

1078

697

e.setAttribute("name", name)

1079

698

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

1080

699

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

1081

700

return e

1082

1083

701

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

1084

# Add property tags

1085

702

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

1086

703

for name, prop

1087

in self._get_all_dbus_things("property")

704

in self._get_all_dbus_properties()

1088

705

if prop._dbus_interface

1089

706

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

1090

707

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)

1107

708

# Add the names to the return values for the

1108

709

# "org.freedesktop.DBus.Properties" methods

1109

710

if (if_tag.getAttribute("name")

1124

725

except (AttributeError, xml.dom.DOMException,

1125

726

xml.parsers.expat.ExpatError) as error:

1126

727

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

1127

exc_info=error)

1128

return xmlstring

1129

1130

try:

1131

dbus.OBJECT_MANAGER_IFACE

1132

except AttributeError:

1133

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

1134

1135

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1136

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

1137

1138

Classes inheriting from this exposes the standard

1139

GetManagedObjects call and the InterfacesAdded and

1140

InterfacesRemoved signals on the standard

1141

"org.freedesktop.DBus.ObjectManager" interface.

1142

1143

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

1144

manually.

1145

"""

1146

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1147

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

1148

def GetManagedObjects(self):

1149

"""This function must be overridden"""

1150

raise NotImplementedError()

1151

1152

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1153

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

1154

def InterfacesAdded(self, object_path, interfaces_and_properties):

1155

pass

1156

1157

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1158

signature = "oas")

1159

def InterfacesRemoved(self, object_path, interfaces):

1160

pass

1161

1162

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1163

out_signature = "s",

1164

path_keyword = 'object_path',

1165

connection_keyword = 'connection')

1166

def Introspect(self, object_path, connection):

1167

"""Overloading of standard D-Bus method.

1168

1169

Override return argument name of GetManagedObjects to be

1170

"objpath_interfaces_and_properties"

1171

"""

1172

xmlstring = DBusObjectWithAnnotations(self, object_path,

1173

connection)

1174

try:

1175

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

1176

1177

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

1178

# Fix argument name for the GetManagedObjects method

1179

if (if_tag.getAttribute("name")

1180

== dbus.OBJECT_MANAGER_IFACE):

1181

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

1182

if (cn.getAttribute("name")

1183

== "GetManagedObjects"):

1184

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

1185

if (arg.getAttribute("direction")

1186

== "out"):

1187

arg.setAttribute(

1188

"name",

1189

"objpath_interfaces"

1190

"_and_properties")

1191

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

1192

document.unlink()

1193

except (AttributeError, xml.dom.DOMException,

1194

xml.parsers.expat.ExpatError) as error:

1195

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

1196

exc_info = error)

1197

return xmlstring

1198

1199

def datetime_to_dbus(dt, variant_level=0):

1200

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

1201

if dt is None:

1202

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

1203

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

1204

1205

1206

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1207

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

1208

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

1209

interface names according to the "alt_interface_names" mapping.

1210

Usage:

1211

1212

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

1213

"net.example.AlternateInterface"})

1214

class SampleDBusObject(dbus.service.Object):

1215

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

1216

def SampleDBusMethod():

1217

pass

1218

1219

The above "SampleDBusMethod" on "SampleDBusObject" will be

1220

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

1221

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

1222

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

1223

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

1224

1225

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

1226

(from DBusObjectWithProperties) and interfaces (from the

1227

dbus_interface_annotations decorator).

1228

"""

1229

1230

def wrapper(cls):

1231

for orig_interface_name, alt_interface_name in (

1232

alt_interface_names.items()):

1233

attr = {}

1234

interface_names = set()

1235

# Go though all attributes of the class

1236

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

1237

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

1238

# with the wrong interface name

1239

if (not hasattr(attribute, "_dbus_interface")

1240

or not attribute._dbus_interface.startswith(

1241

orig_interface_name)):

1242

continue

1243

# Create an alternate D-Bus interface name based on

1244

# the current name

1245

alt_interface = attribute._dbus_interface.replace(

1246

orig_interface_name, alt_interface_name)

1247

interface_names.add(alt_interface)

1248

# Is this a D-Bus signal?

1249

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

1250

if sys.version_info.major == 2:

1251

# Extract the original non-method undecorated

1252

# function by black magic

1253

nonmethod_func = (dict(

1254

zip(attribute.func_code.co_freevars,

1255

attribute.__closure__))

1256

["func"].cell_contents)

1257

else:

1258

nonmethod_func = attribute

1259

# Create a new, but exactly alike, function

1260

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

1261

# with the alternate D-Bus interface name

1262

if sys.version_info.major == 2:

1263

new_function = types.FunctionType(

1264

nonmethod_func.func_code,

1265

nonmethod_func.func_globals,

1266

nonmethod_func.func_name,

1267

nonmethod_func.func_defaults,

1268

nonmethod_func.func_closure)

1269

else:

1270

new_function = types.FunctionType(

1271

nonmethod_func.__code__,

1272

nonmethod_func.__globals__,

1273

nonmethod_func.__name__,

1274

nonmethod_func.__defaults__,

1275

nonmethod_func.__closure__)

1276

new_function = (dbus.service.signal(

1277

alt_interface,

1278

attribute._dbus_signature)(new_function))

1279

# Copy annotations, if any

1280

try:

1281

new_function._dbus_annotations = dict(

1282

attribute._dbus_annotations)

1283

except AttributeError:

1284

pass

1285

# Define a creator of a function to call both the

1286

# original and alternate functions, so both the

1287

# original and alternate signals gets sent when

1288

# the function is called

1289

def fixscope(func1, func2):

1290

"""This function is a scope container to pass

1291

func1 and func2 to the "call_both" function

1292

outside of its arguments"""

1293

1294

def call_both(*args, **kwargs):

1295

"""This function will emit two D-Bus

1296

signals by calling func1 and func2"""

1297

func1(*args, **kwargs)

1298

func2(*args, **kwargs)

1299

1300

return call_both

1301

# Create the "call_both" function and add it to

1302

# the class

1303

attr[attrname] = fixscope(attribute, new_function)

1304

# Is this a D-Bus method?

1305

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

1306

# Create a new, but exactly alike, function

1307

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

1308

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

1309

# to the class.

1310

attr[attrname] = (

1311

dbus.service.method(

1312

alt_interface,

1313

attribute._dbus_in_signature,

1314

attribute._dbus_out_signature)

1315

(types.FunctionType(attribute.func_code,

1316

attribute.func_globals,

1317

attribute.func_name,

1318

attribute.func_defaults,

1319

attribute.func_closure)))

1320

# Copy annotations, if any

1321

try:

1322

attr[attrname]._dbus_annotations = dict(

1323

attribute._dbus_annotations)

1324

except AttributeError:

1325

pass

1326

# Is this a D-Bus property?

1327

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

1328

# Create a new, but exactly alike, function

1329

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

1330

# property with the alternate D-Bus interface

1331

# name. Add it to the class.

1332

attr[attrname] = (dbus_service_property(

1333

alt_interface, attribute._dbus_signature,

1334

attribute._dbus_access,

1335

attribute._dbus_get_args_options

1336

["byte_arrays"])

1337

(types.FunctionType(

1338

attribute.func_code,

1339

attribute.func_globals,

1340

attribute.func_name,

1341

attribute.func_defaults,

1342

attribute.func_closure)))

1343

# Copy annotations, if any

1344

try:

1345

attr[attrname]._dbus_annotations = dict(

1346

attribute._dbus_annotations)

1347

except AttributeError:

1348

pass

1349

# Is this a D-Bus interface?

1350

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

1351

# Create a new, but exactly alike, function

1352

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

1353

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

1354

# to the class.

1355

attr[attrname] = (

1356

dbus_interface_annotations(alt_interface)

1357

(types.FunctionType(attribute.func_code,

1358

attribute.func_globals,

1359

attribute.func_name,

1360

attribute.func_defaults,

1361

attribute.func_closure)))

1362

if deprecate:

1363

# Deprecate all alternate interfaces

1364

iname="_AlternateDBusNames_interface_annotation{}"

1365

for interface_name in interface_names:

1366

1367

@dbus_interface_annotations(interface_name)

1368

def func(self):

1369

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

1370

"true" }

1371

# Find an unused name

1372

for aname in (iname.format(i)

1373

for i in itertools.count()):

1374

if aname not in attr:

1375

attr[aname] = func

1376

break

1377

if interface_names:

1378

# Replace the class with a new subclass of it with

1379

# methods, signals, etc. as created above.

1380

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

1381

(cls, ), attr)

1382

return cls

1383

1384

return wrapper

1385

1386

1387

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

1388

"se.bsnet.fukt.Mandos"})

728

error)

729

return xmlstring

730

731

1389

732

class ClientDBus(Client, DBusObjectWithProperties):

1390

733

"""A Client class using D-Bus

1391

734

1395

738

"""

1396

739

1397

740

runtime_expansions = (Client.runtime_expansions

1398

+ ("dbus_object_path", ))

1399

1400

_interface = "se.recompile.Mandos.Client"

741

+ ("dbus_object_path",))

1401

742

1402

743

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

1403

744

1404

745

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

746

self._approvals_pending = 0

1405

747

self.bus = bus

1406

748

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

1407

749

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

1408

750

# the D-Bus

1409

client_object_name = str(self.name).translate(

751

client_object_name = unicode(self.name).translate(

1410

752

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

1411

753

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

1412

self.dbus_object_path = dbus.ObjectPath(

1413

"/clients/" + client_object_name)

754

self.dbus_object_path = (dbus.ObjectPath

755

("/clients/" + client_object_name))

1414

756

DBusObjectWithProperties.__init__(self, self.bus,

1415

757

self.dbus_object_path)

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

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

1497

802

1498

803

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

1499

804

try:

1504

809

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

1505

810

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

1506

811

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:

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)

1514

821

# Emit D-Bus signal

1515

822

self.CheckerCompleted(dbus.Int16(exitstatus),

1516

# This is specific to GNU libC

1517

dbus.Int64(exitstatus << 8),

823

dbus.Int64(condition),

1518

824

dbus.String(command))

1519

825

else:

1520

826

# Emit D-Bus signal

1521

827

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

1522

dbus.Int64(

1523

# This is specific to GNU libC

1524

(exitstatus << 8)

1525

| self.last_checker_signal),

828

dbus.Int64(condition),

1526

829

dbus.String(command))

1527

return ret

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

1528

850

1529

851

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

1530

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

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

1531

857

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

1532

858

# Only if new checker process was started

1533

859

if (self.checker is not None

1534

860

and old_checker_pid != self.checker.pid):

1535

861

# Emit D-Bus signal

1536

862

self.CheckerStarted(self.current_checker_command)

863

self.PropertyChanged(

864

dbus.String("CheckerRunning"),

865

dbus.Boolean(True, variant_level=1))

1537

866

return r

1538

867

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

1539

877

def _reset_approved(self):

1540

self.approved = None

878

self._approved = None

1541

879

return False

1542

880

1543

881

def approve(self, value=True):

1544

self.approved = value

1545

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

1546

* 1000), self._reset_approved)

1547

882

self.send_changedstate()

883

self._approved = value

884

gobject.timeout_add(self._timedelta_to_milliseconds

885

(self.approval_duration),

886

self._reset_approved)

887

1548

888

1549

889

## D-Bus methods, signals & properties

1550

1551

## Interfaces

890

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

1552

891

1553

892

## Signals

1554

893

1565

904

pass

1566

905

1567

906

# PropertyChanged - signal

1568

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

1569

907

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

1570

908

def PropertyChanged(self, property, value):

1571

909

"D-Bus signal"

1605

943

self.checked_ok()

1606

944

1607

945

# Enable - method

1608

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

1609

946

@dbus.service.method(_interface)

1610

947

def Enable(self):

1611

948

"D-Bus method"

1612

949

self.enable()

1613

950

1614

951

# StartChecker - method

1615

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

1616

952

@dbus.service.method(_interface)

1617

953

def StartChecker(self):

1618

954

"D-Bus method"

1619

955

self.start_checker()

1620

956

1621

957

# Disable - method

1622

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

1623

958

@dbus.service.method(_interface)

1624

959

def Disable(self):

1625

960

"D-Bus method"

1626

961

self.disable()

1627

962

1628

963

# StopChecker - method

1629

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

1630

964

@dbus.service.method(_interface)

1631

965

def StopChecker(self):

1632

966

self.stop_checker()

1639

973

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

1640

974

1641

975

# ApprovedByDefault - property

1642

@dbus_service_property(_interface,

1643

signature="b",

976

@dbus_service_property(_interface, signature="b",

1644

977

access="readwrite")

1645

978

def ApprovedByDefault_dbus_property(self, value=None):

1646

979

if value is None: # get

1647

980

return dbus.Boolean(self.approved_by_default)

1648

981

self.approved_by_default = bool(value)

982

# Emit D-Bus signal

983

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

984

dbus.Boolean(value, variant_level=1))

1649

985

1650

986

# ApprovalDelay - property

1651

@dbus_service_property(_interface,

1652

signature="t",

987

@dbus_service_property(_interface, signature="t",

1653

988

access="readwrite")

1654

989

def ApprovalDelay_dbus_property(self, value=None):

1655

990

if value is None: # get

1656

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

1657

* 1000)

991

return dbus.UInt64(self.approval_delay_milliseconds())

1658

992

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

1659

996

1660

997

# ApprovalDuration - property

1661

@dbus_service_property(_interface,

1662

signature="t",

998

@dbus_service_property(_interface, signature="t",

1663

999

access="readwrite")

1664

1000

def ApprovalDuration_dbus_property(self, value=None):

1665

1001

if value is None: # get

1666

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

1667

* 1000)

1002

return dbus.UInt64(self._timedelta_to_milliseconds(

1003

self.approval_duration))

1668

1004

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

1669

1008

1670

1009

# Name - property

1671

@dbus_annotations(

1672

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

1673

1010

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

1674

1011

def Name_dbus_property(self):

1675

1012

return dbus.String(self.name)

1676

1013

1677

1014

# Fingerprint - property

1678

@dbus_annotations(

1679

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

1680

1015

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

1681

1016

def Fingerprint_dbus_property(self):

1682

1017

return dbus.String(self.fingerprint)

1683

1018

1684

1019

# Host - property

1685

@dbus_service_property(_interface,

1686

signature="s",

1020

@dbus_service_property(_interface, signature="s",

1687

1021

access="readwrite")

1688

1022

def Host_dbus_property(self, value=None):

1689

1023

if value is None: # get

1690

1024

return dbus.String(self.host)

1691

self.host = str(value)

1025

self.host = value

1026

# Emit D-Bus signal

1027

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

1028

dbus.String(value, variant_level=1))

1692

1029

1693

1030

# Created - property

1694

@dbus_annotations(

1695

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

1696

1031

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

1697

1032

def Created_dbus_property(self):

1698

return datetime_to_dbus(self.created)

1033

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

1699

1034

1700

1035

# LastEnabled - property

1701

1036

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

1702

1037

def LastEnabled_dbus_property(self):

1703

return datetime_to_dbus(self.last_enabled)

1038

if self.last_enabled is None:

1039

return dbus.String("")

1040

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

1704

1041

1705

1042

# Enabled - property

1706

@dbus_service_property(_interface,

1707

signature="b",

1043

@dbus_service_property(_interface, signature="b",

1708

1044

access="readwrite")

1709

1045

def Enabled_dbus_property(self, value=None):

1710

1046

if value is None: # get

1715

1051

self.disable()

1716

1052

1717

1053

# LastCheckedOK - property

1718

@dbus_service_property(_interface,

1719

signature="s",

1054

@dbus_service_property(_interface, signature="s",

1720

1055

access="readwrite")

1721

1056

def LastCheckedOK_dbus_property(self, value=None):

1722

1057

if value is not None:

1723

1058

self.checked_ok()

1724

1059

return

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)

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

1736

1064

1737

1065

# LastApprovalRequest - property

1738

1066

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

1739

1067

def LastApprovalRequest_dbus_property(self):

1740

return datetime_to_dbus(self.last_approval_request)

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

1741

1073

1742

1074

# Timeout - property

1743

@dbus_service_property(_interface,

1744

signature="t",

1075

@dbus_service_property(_interface, signature="t",

1745

1076

access="readwrite")

1746

1077

def Timeout_dbus_property(self, value=None):

1747

1078

if value is None: # get

1748

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

1749

old_timeout = self.timeout

1079

return dbus.UInt64(self.timeout_milliseconds())

1750

1080

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

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)

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

1776

1101

1777

1102

# Interval - property

1778

@dbus_service_property(_interface,

1779

signature="t",

1103

@dbus_service_property(_interface, signature="t",

1780

1104

access="readwrite")

1781

1105

def Interval_dbus_property(self, value=None):

1782

1106

if value is None: # get

1783

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

1107

return dbus.UInt64(self.interval_milliseconds())

1784

1108

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

1785

1112

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

1786

1113

return

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

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

1794

1120

# Checker - property

1795

@dbus_service_property(_interface,

1796

signature="s",

1121

@dbus_service_property(_interface, signature="s",

1797

1122

access="readwrite")

1798

1123

def Checker_dbus_property(self, value=None):

1799

1124

if value is None: # get

1800

1125

return dbus.String(self.checker_command)

1801

self.checker_command = str(value)

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

1802

1131

1803

1132

# CheckerRunning - property

1804

@dbus_service_property(_interface,

1805

signature="b",

1133

@dbus_service_property(_interface, signature="b",

1806

1134

access="readwrite")

1807

1135

def CheckerRunning_dbus_property(self, value=None):

1808

1136

if value is None: # get

1813

1141

self.stop_checker()

1814

1142

1815

1143

# ObjectPath - property

1816

@dbus_annotations(

1817

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

1818

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

1819

1144

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

1820

1145

def ObjectPath_dbus_property(self):

1821

1146

return self.dbus_object_path # is already a dbus.ObjectPath

1822

1147

1823

1148

# Secret = property

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)

1149

@dbus_service_property(_interface, signature="ay",

1150

access="write", byte_arrays=True)

1831

1151

def Secret_dbus_property(self, value):

1832

self.secret = bytes(value)

1152

self.secret = str(value)

1833

1153

1834

1154

del _interface

1835

1155

1839

1159

self._pipe = child_pipe

1840

1160

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

1841

1161

if not self._pipe.recv():

1842

raise KeyError(fpr)

1843

1162

raise KeyError()

1163

1844

1164

def __getattribute__(self, name):

1845

if name == '_pipe':

1165

if(name == '_pipe'):

1846

1166

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

1847

1167

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

1848

1168

data = self._pipe.recv()

1849

1169

if data[0] == 'data':

1850

1170

return data[1]

1851

1171

if data[0] == 'function':

1852

1853

1172

def func(*args, **kwargs):

1854

1173

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

1855

1174

return self._pipe.recv()[1]

1856

1857

1175

return func

1858

1176

1859

1177

def __setattr__(self, name, value):

1860

if name == '_pipe':

1178

if(name == '_pipe'):

1861

1179

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

1862

1180

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

1863

1181

1871

1189

def handle(self):

1872

1190

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

1873

1191

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

1874

str(self.client_address))

1192

unicode(self.client_address))

1875

1193

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

1876

1194

self.server.child_pipe.fileno())

1877

1878

session = gnutls.connection.ClientSession(

1879

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

1880

1195

1196

session = (gnutls.connection

1197

.ClientSession(self.request,

1198

gnutls.connection

1199

.X509Credentials()))

1200

1881

1201

# Note: gnutls.connection.X509Credentials is really a

1882

1202

# generic GnuTLS certificate credentials object so long as

1883

1203

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

1884

1204

# here despite using OpenPGP certificates.

1885

1205

1886

1206

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

1887

1207

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

1888

1208

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

1891

1211

priority = self.server.gnutls_priority

1892

1212

if priority is None:

1893

1213

priority = "NORMAL"

1894

gnutls.library.functions.gnutls_priority_set_direct(

1895

session._c_object, priority, None)

1896

1214

(gnutls.library.functions

1215

.gnutls_priority_set_direct(session._c_object,

1216

priority, None))

1217

1897

1218

# Start communication using the Mandos protocol

1898

1219

# Get protocol number

1899

1220

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

1900

1221

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

1901

1222

try:

1902

1223

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

1903

raise RuntimeError(line)

1224

raise RuntimeError

1904

1225

except (ValueError, IndexError, RuntimeError) as error:

1905

1226

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

1906

1227

return

1907

1228

1908

1229

# Start GnuTLS connection

1909

1230

try:

1910

1231

session.handshake()

1914

1235

# established. Just abandon the request.

1915

1236

return

1916

1237

logger.debug("Handshake succeeded")

1917

1238

1918

1239

approval_required = False

1919

1240

try:

1920

1241

try:

1921

fpr = self.fingerprint(

1922

self.peer_certificate(session))

1242

fpr = self.fingerprint(self.peer_certificate

1243

(session))

1923

1244

except (TypeError,

1924

1245

gnutls.errors.GNUTLSError) as error:

1925

1246

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

1926

1247

return

1927

1248

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

1928

1249

1929

1250

try:

1930

1251

client = ProxyClient(child_pipe, fpr,

1931

1252

self.client_address)

1939

1260

1940

1261

while True:

1941

1262

if not client.enabled:

1942

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

1943

client.name)

1263

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

1264

client.name)

1944

1265

if self.server.use_dbus:

1945

1266

# Emit D-Bus signal

1946

client.Rejected("Disabled")

1267

client.Rejected("Disabled")

1947

1268

return

1948

1269

1949

if client.approved or not client.approval_delay:

1270

if client._approved or not client.approval_delay:

1950

1271

#We are approved or approval is disabled

1951

1272

break

1952

elif client.approved is None:

1273

elif client._approved is None:

1953

1274

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

1954

1275

client.name)

1955

1276

if self.server.use_dbus:

1956

1277

# Emit D-Bus signal

1957

1278

client.NeedApproval(

1958

client.approval_delay.total_seconds()

1959

* 1000, client.approved_by_default)

1279

client.approval_delay_milliseconds(),

1280

client.approved_by_default)

1960

1281

else:

1961

1282

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

1962

1283

client.name)

1966

1287

return

1967

1288

1968

1289

#wait until timeout or approved

1290

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

1969

1291

time = datetime.datetime.now()

1970

1292

client.changedstate.acquire()

1971

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

1293

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

1972

1294

client.changedstate.release()

1973

1295

time2 = datetime.datetime.now()

1974

1296

if (time2 - time) >= delay:

1990

1312

try:

1991

1313

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

1992

1314

except gnutls.errors.GNUTLSError as error:

1993

logger.warning("gnutls send failed",

1994

exc_info=error)

1315

logger.warning("gnutls send failed")

1995

1316

return

1996

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

1997

len(client.secret) - (sent_size

1998

+ sent))

1317

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

1318

sent, len(client.secret)

1319

- (sent_size + sent))

1999

1320

sent_size += sent

2000

1321

2001

1322

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

2002

# bump the timeout using extended_timeout

2003

client.bump_timeout(client.extended_timeout)

1323

# bump the timeout as if seen

1324

client.checked_ok()

2004

1325

if self.server.use_dbus:

2005

1326

# Emit D-Bus signal

2006

1327

client.GotSecret()

2011

1332

try:

2012

1333

session.bye()

2013

1334

except gnutls.errors.GNUTLSError as error:

2014

logger.warning("GnuTLS bye failed",

2015

exc_info=error)

1335

logger.warning("GnuTLS bye failed")

2016

1336

2017

1337

@staticmethod

2018

1338

def peer_certificate(session):

2019

1339

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

2020

1340

# If not an OpenPGP certificate...

2021

if (gnutls.library.functions.gnutls_certificate_type_get(

2022

session._c_object)

1341

if (gnutls.library.functions

1342

.gnutls_certificate_type_get(session._c_object)

2023

1343

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

2024

1344

# ...do the normal thing

2025

1345

return session.peer_certificate

2039

1359

def fingerprint(openpgp):

2040

1360

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2041

1361

# New GnuTLS "datum" with the OpenPGP public key

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

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

2046

1367

# New empty GnuTLS certificate

2047

1368

crt = gnutls.library.types.gnutls_openpgp_crt_t()

2048

gnutls.library.functions.gnutls_openpgp_crt_init(

2049

ctypes.byref(crt))

1369

(gnutls.library.functions

1370

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2050

1371

# Import the OpenPGP public key into the certificate

2051

gnutls.library.functions.gnutls_openpgp_crt_import(

2052

crt, ctypes.byref(datum),

2053

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1372

(gnutls.library.functions

1373

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

1374

gnutls.library.constants

1375

.GNUTLS_OPENPGP_FMT_RAW))

2054

1376

# Verify the self signature in the key

2055

1377

crtverify = ctypes.c_uint()

2056

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2057

crt, 0, ctypes.byref(crtverify))

1378

(gnutls.library.functions

1379

.gnutls_openpgp_crt_verify_self(crt, 0,

1380

ctypes.byref(crtverify)))

2058

1381

if crtverify.value != 0:

2059

1382

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2060

raise gnutls.errors.CertificateSecurityError(

2061

"Verify failed")

1383

raise (gnutls.errors.CertificateSecurityError

1384

("Verify failed"))

2062

1385

# New buffer for the fingerprint

2063

1386

buf = ctypes.create_string_buffer(20)

2064

1387

buf_len = ctypes.c_size_t()

2065

1388

# Get the fingerprint from the certificate into the buffer

2066

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2067

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

1389

(gnutls.library.functions

1390

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

1391

ctypes.byref(buf_len)))

2068

1392

# Deinit the certificate

2069

1393

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2070

1394

# Convert the buffer to a Python bytestring

2071

1395

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

2072

1396

# Convert the bytestring to hexadecimal notation

2073

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

1397

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

2074

1398

return hex_fpr

2075

1399

2076

1400

2077

1401

class MultiprocessingMixIn(object):

2078

1402

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

2079

2080

1403

def sub_process_main(self, request, address):

2081

1404

try:

2082

1405

self.finish_request(request, address)

2083

except Exception:

1406

except:

2084

1407

self.handle_error(request, address)

2085

1408

self.close_request(request)

2086

1409

2087

1410

def process_request(self, request, address):

2088

1411

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

2089

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

2090

args = (request, address))

2091

proc.start()

2092

return proc

2093

1412

multiprocessing.Process(target = self.sub_process_main,

1413

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

2094

1414

2095

1415

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2096

1416

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

2097

2098

1417

def process_request(self, request, client_address):

2099

1418

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

2100

1419

2101

1420

This function creates a new pipe in self.pipe

2102

1421

"""

2103

1422

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2104

2105

proc = MultiprocessingMixIn.process_request(self, request,

2106

client_address)

1423

1424

super(MultiprocessingMixInWithPipe,

1425

self).process_request(request, client_address)

2107

1426

self.child_pipe.close()

2108

self.add_pipe(parent_pipe, proc)

2109

2110

def add_pipe(self, parent_pipe, proc):

1427

self.add_pipe(parent_pipe)

1428

1429

def add_pipe(self, parent_pipe):

2111

1430

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

2112

raise NotImplementedError()

2113

1431

raise NotImplementedError

2114

1432

2115

1433

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2116

1434

socketserver.TCPServer, object):

2121

1439

interface: None or a network interface name (string)

2122

1440

use_ipv6: Boolean; to use IPv6 or not

2123

1441

"""

2124

2125

1442

def __init__(self, server_address, RequestHandlerClass,

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

"""

1443

interface=None, use_ipv6=True):

2132

1444

self.interface = interface

2133

1445

if use_ipv6:

2134

1446

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.

2161

1447

socketserver.TCPServer.__init__(self, server_address,

2162

1448

RequestHandlerClass)

2163

2164

1449

def server_bind(self):

2165

1450

"""This overrides the normal server_bind() function

2166

1451

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

2172

1457

self.interface)

2173

1458

else:

2174

1459

try:

2175

self.socket.setsockopt(

2176

socket.SOL_SOCKET, SO_BINDTODEVICE,

2177

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

1460

self.socket.setsockopt(socket.SOL_SOCKET,

1461

SO_BINDTODEVICE,

1462

str(self.interface

1463

+ '\0'))

2178

1464

except socket.error as error:

2179

if error.errno == errno.EPERM:

2180

logger.error("No permission to bind to"

2181

" interface %s", self.interface)

2182

elif error.errno == errno.ENOPROTOOPT:

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:

2183

1470

logger.error("SO_BINDTODEVICE not available;"

2184

1471

" cannot bind to interface %s",

2185

1472

self.interface)

2186

elif error.errno == errno.ENODEV:

2187

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

2188

" cannot bind", self.interface)

2189

1473

else:

2190

1474

raise

2191

1475

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

2194

1478

if self.address_family == socket.AF_INET6:

2195

1479

any_address = "::" # in6addr_any

2196

1480

else:

2197

any_address = "0.0.0.0" # INADDR_ANY

1481

any_address = socket.INADDR_ANY

2198

1482

self.server_address = (any_address,

2199

1483

self.server_address[1])

2200

1484

elif not self.server_address[1]:

2201

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

1485

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

1486

0)

2202

1487

# if self.interface:

2203

1488

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

2204

1489

# 0, # port

2218

1503

2219

1504

Assumes a gobject.MainLoop event loop.

2220

1505

"""

2221

2222

1506

def __init__(self, server_address, RequestHandlerClass,

2223

interface=None,

2224

use_ipv6=True,

2225

clients=None,

2226

gnutls_priority=None,

2227

use_dbus=True,

2228

socketfd=None):

1507

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

1508

gnutls_priority=None, use_dbus=True):

2229

1509

self.enabled = False

2230

1510

self.clients = clients

2231

1511

if self.clients is None:

2232

self.clients = {}

1512

self.clients = set()

2233

1513

self.use_dbus = use_dbus

2234

1514

self.gnutls_priority = gnutls_priority

2235

1515

IPv6_TCPServer.__init__(self, server_address,

2236

1516

RequestHandlerClass,

2237

1517

interface = interface,

2238

use_ipv6 = use_ipv6,

2239

socketfd = socketfd)

2240

1518

use_ipv6 = use_ipv6)

2241

1519

def server_activate(self):

2242

1520

if self.enabled:

2243

1521

return socketserver.TCPServer.server_activate(self)

2244

2245

1522

def enable(self):

2246

1523

self.enabled = True

2247

2248

def add_pipe(self, parent_pipe, proc):

1524

def add_pipe(self, parent_pipe):

2249

1525

# Call "handle_ipc" for both data and EOF events

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,

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,

2260

1532

client_object=None):

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

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

2265

1549

return False

2266

1550

2267

1551

# Read a request from the child

2272

1556

fpr = request[1]

2273

1557

address = request[2]

2274

1558

2275

for c in self.clients.itervalues():

1559

for c in self.clients:

2276

1560

if c.fingerprint == fpr:

2277

1561

client = c

2278

1562

break

2279

1563

else:

2280

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

2281

"dress: %s", fpr, address)

1564

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

1565

"dress: %s", fpr, address)

2282

1566

if self.use_dbus:

2283

1567

# Emit D-Bus signal

2284

mandos_dbus_service.ClientNotFound(fpr,

2285

address[0])

1568

mandos_dbus_service.ClientNotFound(fpr, address[0])

2286

1569

parent_pipe.send(False)

2287

1570

return False

2288

1571

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

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

2296

1577

parent_pipe.send(True)

2297

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

2298

# same fileno

1578

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

2299

1579

return False

2300

1580

if command == 'funcall':

2301

1581

funcname = request[1]

2302

1582

args = request[2]

2303

1583

kwargs = request[3]

2304

1584

2305

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

2306

funcname)(*args,

2307

**kwargs)))

2308

1585

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

1586

2309

1587

if command == 'getattr':

2310

1588

attrname = request[1]

2311

if isinstance(client_object.__getattribute__(attrname),

2312

collections.Callable):

2313

parent_pipe.send(('function', ))

1589

if callable(client_object.__getattribute__(attrname)):

1590

parent_pipe.send(('function',))

2314

1591

else:

2315

parent_pipe.send((

2316

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

1592

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

2317

1593

2318

1594

if command == 'setattr':

2319

1595

attrname = request[1]

2320

1596

value = request[2]

2321

1597

setattr(client_object, attrname, value)

2322

1598

2323

1599

return True

2324

1600

2325

1601

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

2422

1602

def string_to_delta(interval):

2423

1603

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

2424

1604

2435

1615

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

2436

1616

datetime.timedelta(0, 330)

2437

1617

"""

2438

2439

try:

2440

return rfc3339_duration_to_delta(interval)

2441

except ValueError:

2442

pass

2443

2444

1618

timevalue = datetime.timedelta(0)

2445

1619

for s in interval.split():

2446

1620

try:

2447

suffix = s[-1]

1621

suffix = unicode(s[-1])

2448

1622

value = int(s[:-1])

2449

1623

if suffix == "d":

2450

1624

delta = datetime.timedelta(value)

2457

1631

elif suffix == "w":

2458

1632

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

2459

1633

else:

2460

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

2461

except IndexError as e:

1634

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

1635

except (ValueError, IndexError) as e:

2462

1636

raise ValueError(*(e.args))

2463

1637

timevalue += delta

2464

1638

return timevalue

2465

1639

2466

1640

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

2467

1665

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

2468

1666

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

2469

1667

2477

1675

sys.exit()

2478

1676

if not noclose:

2479

1677

# Close all standard open file descriptors

2480

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

1678

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

2481

1679

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

2482

1680

raise OSError(errno.ENODEV,

2483

"{} not a character device"

2484

.format(os.devnull))

1681

"%s not a character device"

1682

% os.path.devnull)

2485

1683

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

2486

1684

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

2487

1685

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

2496

1694

2497

1695

parser = argparse.ArgumentParser()

2498

1696

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

2499

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

1697

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

2500

1698

help="show version number and exit")

2501

1699

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

2502

1700

help="Bind to interface IF")

2508

1706

help="Run self-test")

2509

1707

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

2510

1708

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

2511

" to terminal", default=None)

1709

" to terminal")

2512

1710

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

2513

1711

help="Debug level for stdout output")

2514

1712

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

2521

1719

" files")

2522

1720

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

2523

1721

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

2524

" system bus interface", default=None)

1722

" system bus interface")

2525

1723

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

2526

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

2527

default=None)

2528

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

2529

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

2530

" state", default=None)

2531

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

2532

help="Specify a file descriptor to a network"

2533

" socket to use instead of creating one")

2534

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

2535

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

2536

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

2537

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

2538

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

2539

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

2540

default=None)

2541

1724

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

2542

1725

options = parser.parse_args()

2543

1726

2544

1727

if options.check:

2545

1728

import doctest

2546

fail_count, test_count = doctest.testmod()

2547

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

1729

doctest.testmod()

1730

sys.exit()

2548

1731

2549

1732

# Default values for config file for server-global settings

2550

1733

server_defaults = { "interface": "",

2552

1735

"port": "",

2553

1736

"debug": "False",

2554

1737

"priority":

2555

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

2556

":+SIGN-DSA-SHA256",

1738

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

2557

1739

"servicename": "Mandos",

2558

1740

"use_dbus": "True",

2559

1741

"use_ipv6": "True",

2560

1742

"debuglevel": "",

2561

"restore": "True",

2562

"socket": "",

2563

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

2564

"foreground": "False",

2565

"zeroconf": "True",

2566

}

1743

}

2567

1744

2568

1745

# Parse config file for server-global settings

2569

1746

server_config = configparser.SafeConfigParser(server_defaults)

2570

1747

del server_defaults

2571

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

1748

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

1749

"mandos.conf"))

2572

1750

# Convert the SafeConfigParser object to a dict

2573

1751

server_settings = server_config.defaults()

2574

1752

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

2575

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

1753

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

2576

1754

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

2577

1755

option)

2578

1756

if server_settings["port"]:

2579

1757

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

2580

1758

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

2590

1759

del server_config

2591

1760

2592

1761

# Override the settings from the config file with command line

2593

1762

# options, if set.

2594

1763

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

2595

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

2596

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

2597

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

1764

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

1765

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

2598

1766

value = getattr(options, option)

2599

1767

if value is not None:

2600

1768

server_settings[option] = value

2601

1769

del options

2602

1770

# Force all strings to be unicode

2603

1771

for option in server_settings.keys():

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

1772

if type(server_settings[option]) is str:

1773

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

2614

1774

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

2615

1775

2616

1776

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

2617

1777

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

2623

1778

# For convenience

2624

1779

debug = server_settings["debug"]

2625

1780

debuglevel = server_settings["debuglevel"]

2626

1781

use_dbus = server_settings["use_dbus"]

2627

1782

use_ipv6 = server_settings["use_ipv6"]

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

1783

2642

1784

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

2643

syslogger.setFormatter(

2644

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

2645

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

2646

server_settings["servicename"])))

1785

syslogger.setFormatter(logging.Formatter

1786

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

1787

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

1788

% server_settings["servicename"]))

2647

1789

2648

1790

# Parse config file with clients

2649

client_config = configparser.SafeConfigParser(Client

2650

.client_defaults)

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)

2651

1799

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

2652

1800

"clients.conf"))

2653

1801

2654

1802

global mandos_dbus_service

2655

1803

mandos_dbus_service = None

2656

1804

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

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"

2673

1816

try:

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)

1817

pidfile = open(pidfilename, "w")

1818

except IOError:

1819

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

2678

1820

2679

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

1821

try:

1822

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

1823

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

1824

except KeyError:

2680

1825

try:

2681

uid = pwd.getpwnam(name).pw_uid

2682

gid = pwd.getpwnam(name).pw_gid

2683

break

1826

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

1827

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

2684

1828

except KeyError:

2685

continue

2686

else:

2687

uid = 65534

2688

gid = 65534

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

2689

1835

try:

2690

1836

os.setgid(gid)

2691

1837

os.setuid(uid)

2692

1838

except OSError as error:

2693

if error.errno != errno.EPERM:

2694

raise

1839

if error[0] != errno.EPERM:

1840

raise error

2695

1841

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

2696

1850

if debug:

2697

1851

# Enable all possible GnuTLS debugging

2698

1852

2704

1858

def debug_gnutls(level, string):

2705

1859

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

2706

1860

2707

gnutls.library.functions.gnutls_global_set_log_function(

2708

debug_gnutls)

1861

(gnutls.library.functions

1862

.gnutls_global_set_log_function(debug_gnutls))

2709

1863

2710

1864

# Redirect stdin so all checkers get /dev/null

2711

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

1865

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

2712

1866

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

2713

1867

if null > 2:

2714

1868

os.close(null)

1869

else:

1870

# No console logging

1871

logger.removeHandler(console)

2715

1872

2716

1873

# Need to fork before connecting to D-Bus

2717

if not foreground:

1874

if not debug:

2718

1875

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

2719

1876

daemon()

2720

1877

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

2725

1878

global main_loop

2726

1879

# From the Avahi example code

2727

DBusGMainLoop(set_as_default=True)

1880

DBusGMainLoop(set_as_default=True )

2728

1881

main_loop = gobject.MainLoop()

2729

1882

bus = dbus.SystemBus()

2730

1883

# End of Avahi example code

2731

1884

if use_dbus:

2732

1885

try:

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)

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

2741

1890

use_dbus = False

2742

1891

server_settings["use_dbus"] = False

2743

1892

tcp_server.use_dbus = False

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

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

2754

1900

2755

1901

global multiprocessing_manager

2756

1902

multiprocessing_manager = multiprocessing.Manager()

2758

1904

client_class = Client

2759

1905

if use_dbus:

2760

1906

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

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

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

2845

1914

try:

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

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

2871

1924

if not tcp_server.clients:

2872

1925

logger.warning("No clients defined")

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

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

2884

1939

del pidfilename

2885

1940

1941

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

1942

2886

1943

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

2887

1944

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

2888

1945

2889

1946

if use_dbus:

2890

2891

@alternate_dbus_interfaces(

2892

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

2893

class MandosDBusService(DBusObjectWithObjectManager):

1947

class MandosDBusService(dbus.service.Object):

2894

1948

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

2895

2896

1949

def __init__(self):

2897

1950

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

2898

2899

_interface = "se.recompile.Mandos"

1951

_interface = "se.bsnet.fukt.Mandos"

2900

1952

2901

1953

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

2902

1954

def ClientAdded(self, objpath):

2908

1960

"D-Bus signal"

2909

1961

pass

2910

1962

2911

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

2912

"true"})

2913

1963

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

2914

1964

def ClientRemoved(self, objpath, name):

2915

1965

"D-Bus signal"

2916

1966

pass

2917

1967

2918

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

2919

"true"})

2920

1968

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

2921

1969

def GetAllClients(self):

2922

1970

"D-Bus method"

2923

return dbus.Array(c.dbus_object_path for c in

2924

tcp_server.clients.itervalues())

1971

return dbus.Array(c.dbus_object_path

1972

for c in tcp_server.clients)

2925

1973

2926

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

2927

"true"})

2928

1974

@dbus.service.method(_interface,

2929

1975

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

2930

1976

def GetAllClientsWithProperties(self):

2931

1977

"D-Bus method"

2932

1978

return dbus.Dictionary(

2933

{ c.dbus_object_path: c.GetAll(

2934

"se.recompile.Mandos.Client")

2935

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

1979

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

1980

for c in tcp_server.clients),

2936

1981

signature="oa{sv}")

2937

1982

2938

1983

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

2939

1984

def RemoveClient(self, object_path):

2940

1985

"D-Bus method"

2941

for c in tcp_server.clients.itervalues():

1986

for c in tcp_server.clients:

2942

1987

if c.dbus_object_path == object_path:

2943

del tcp_server.clients[c.name]

1988

tcp_server.clients.remove(c)

2944

1989

c.remove_from_connection()

2945

# Don't signal the disabling

1990

# Don't signal anything except ClientRemoved

2946

1991

c.disable(quiet=True)

2947

# Emit D-Bus signal for removal

2948

self.client_removed_signal(c)

1992

# Emit D-Bus signal

1993

self.ClientRemoved(object_path, c.name)

2949

1994

return

2950

1995

raise KeyError(object_path)

2951

1996

2952

1997

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)

2989

1998

2990

1999

mandos_dbus_service = MandosDBusService()

2991

2000

2992

2001

def cleanup():

2993

2002

"Cleanup function; run on exit"

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

2003

service.cleanup()

2004

3055

2005

while tcp_server.clients:

3056

name, client = tcp_server.clients.popitem()

2006

client = tcp_server.clients.pop()

3057

2007

if use_dbus:

3058

2008

client.remove_from_connection()

3059

# Don't signal the disabling

2009

client.disable_hook = None

2010

# Don't signal anything except ClientRemoved

3060

2011

client.disable(quiet=True)

3061

# Emit D-Bus signal for removal

3062

mandos_dbus_service.client_removed_signal(client)

3063

client_settings.clear()

2012

if use_dbus:

2013

# Emit D-Bus signal

2014

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2015

client.name)

3064

2016

3065

2017

atexit.register(cleanup)

3066

2018

3067

for client in tcp_server.clients.itervalues():

2019

for client in tcp_server.clients:

3068

2020

if use_dbus:

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

2021

# Emit D-Bus signal

2022

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2023

client.enable()

3074

2024

3075

2025

tcp_server.enable()

3076

2026

tcp_server.server_activate()

3077

2027

3078

2028

# Find out what port we got

3079

if zeroconf:

3080

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

2029

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

3081

2030

if use_ipv6:

3082

2031

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

3083

" flowinfo %d, scope_id %d",

3084

*tcp_server.socket.getsockname())

2032

" flowinfo %d, scope_id %d"

2033

% tcp_server.socket.getsockname())

3085

2034

else: # IPv4

3086

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

3087

*tcp_server.socket.getsockname())

2035

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

2036

% tcp_server.socket.getsockname())

3088

2037

3089

2038

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

3090

2039

3091

2040

try:

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

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

3101

2049

3102

2050

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

3103

2051

lambda *args, **kwargs:

3107

2055

logger.debug("Starting main loop")

3108

2056

main_loop.run()

3109

2057

except AvahiError as error:

3110

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

2058

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

3111

2059

cleanup()

3112

2060

sys.exit(1)

3113

2061

except KeyboardInterrupt:

3118

2066

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

3119

2067

cleanup()

3120

2068

3121

3122

2069

if __name__ == '__main__':

3123

2070

main()