/mandos/trunk : revision 502.1.1

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

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

86

87

#logger = logging.getLogger('mandos')

88

logger = logging.Logger('mandos')

89

syslogger = (logging.handlers.SysLogHandler

90

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

91

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

92

syslogger.setFormatter(logging.Formatter

93

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

94

' %(message)s'))

95

logger.addHandler(syslogger)

96

97

console = logging.StreamHandler()

98

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

99

' %(levelname)s:'

100

' %(message)s'))

101

logger.addHandler(console)

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

327

179

if self.entry_group_state_changed_match is not None:

329

181

self.entry_group_state_changed_match = None

330

182

if self.group is not None:

331

183

self.group.Reset()

332

333

184

def add(self):

334

185

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

335

186

self.remove()

340

191

avahi.DBUS_INTERFACE_ENTRY_GROUP)

341

192

self.entry_group_state_changed_match = (

342

193

self.group.connect_to_signal(

343

'StateChanged', self.entry_group_state_changed))

194

'StateChanged', self .entry_group_state_changed))

344

195

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

345

196

self.name, self.type)

346

197

self.group.AddService(

352

203

dbus.UInt16(self.port),

353

204

avahi.string_array_to_txt_array(self.TXT))

354

205

self.group.Commit()

355

356

206

def entry_group_state_changed(self, state, error):

357

207

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

358

208

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

364

214

self.rename()

365

215

elif state == avahi.ENTRY_GROUP_FAILURE:

366

216

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

367

str(error))

368

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

369

217

unicode(error))

218

raise AvahiGroupError("State changed: %s"

219

% unicode(error))

370

220

def cleanup(self):

371

221

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

372

222

if self.group is not None:

373

223

try:

374

224

self.group.Free()

375

225

except (dbus.exceptions.UnknownMethodException,

376

dbus.exceptions.DBusException):

226

dbus.exceptions.DBusException) as e:

377

227

pass

378

228

self.group = None

379

229

self.remove()

380

381

230

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

382

231

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

383

232

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

}

233

bad_states = { avahi.SERVER_INVALID:

234

"Zeroconf server invalid",

235

avahi.SERVER_REGISTERING: None,

236

avahi.SERVER_COLLISION:

237

"Zeroconf server name collision",

238

avahi.SERVER_FAILURE:

239

"Zeroconf server failure" }

390

240

if state in bad_states:

391

241

if bad_states[state] is not None:

392

242

if error is None:

395

245

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

396

246

self.cleanup()

397

247

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)

248

self.add()

410

249

else:

411

250

if error is None:

412

251

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

413

252

else:

414

253

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

415

416

254

def activate(self):

417

255

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

418

256

if self.server is None:

422

260

follow_name_owner_changes=True),

423

261

avahi.DBUS_INTERFACE_SERVER)

424

262

self.server.connect_to_signal("StateChanged",

425

self.server_state_changed)

263

self.server_state_changed)

426

264

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

427

265

428

266

429

class AvahiServiceToSyslog(AvahiService):

430

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

431

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

432

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

433

syslogger.setFormatter(logging.Formatter(

434

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

435

.format(self.name)))

436

return ret

437

438

def call_pipe(connection, # : multiprocessing.Connection

439

func, *args, **kwargs):

440

"""This function is meant to be called by multiprocessing.Process

441

442

This function runs func(*args, **kwargs), and writes the resulting

443

return value on the provided multiprocessing.Connection.

444

"""

445

connection.send(func(*args, **kwargs))

446

connection.close()

447

267

def _timedelta_to_milliseconds(td):

268

"Convert a datetime.timedelta() to milliseconds"

269

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

270

+ (td.seconds * 1000)

271

+ (td.microseconds // 1000))

272

448

273

class Client(object):

449

274

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

450

275

451

276

Attributes:

452

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

277

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

453

278

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

454

279

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

455

280

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

462

287

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

463

288

checker_initiator_tag: a gobject event source tag, or None

464

289

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

290

current_checker_command: string; current running checker_command

291

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

468

292

disable_initiator_tag: a gobject event source tag, or None

469

293

enabled: bool()

470

294

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

473

297

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

474

298

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

475

299

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

300

last_enabled: datetime.datetime(); (UTC)

482

301

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

483

302

D-Bus identifiers

484

303

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

485

304

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

486

305

until this client is disabled

487

extended_timeout: extra long timeout when secret has been sent

306

extended_timeout: extra long timeout when password has been sent

488

307

runtime_expansions: Allowed attributes for runtime expansion.

489

308

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

490

309

disabled, or None

491

server_settings: The server_settings dict from main()

492

310

"""

493

311

494

312

runtime_expansions = ("approval_delay", "approval_duration",

495

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

496

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

497

"last_approval_request", "last_checked_ok",

313

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

314

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

498

315

"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

511

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

316

317

def timeout_milliseconds(self):

318

"Return the 'timeout' attribute in milliseconds"

319

return _timedelta_to_milliseconds(self.timeout)

320

321

def extended_timeout_milliseconds(self):

322

"Return the 'extended_timeout' attribute in milliseconds"

323

return _timedelta_to_milliseconds(self.extended_timeout)

324

325

def interval_milliseconds(self):

326

"Return the 'interval' attribute in milliseconds"

327

return _timedelta_to_milliseconds(self.interval)

328

329

def approval_delay_milliseconds(self):

330

return _timedelta_to_milliseconds(self.approval_delay)

331

332

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

333

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

334

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

335

attribute."""

562

336

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

337

if config is None:

338

config = {}

580

339

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

340

# Uppercase and remove spaces from fingerprint for later

341

# comparison purposes with return value from the fingerprint()

342

# function

343

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

344

.replace(" ", ""))

581

345

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

582

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

583

datetime.datetime.utcnow())

584

585

# attributes specific for this server instance

346

if "secret" in config:

347

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

348

elif "secfile" in config:

349

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

350

(config["secfile"])),

351

"rb") as secfile:

352

self.secret = secfile.read()

353

else:

354

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

355

% self.name)

356

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

357

self.created = datetime.datetime.utcnow()

358

self.enabled = False

359

self.last_approval_request = None

360

self.last_enabled = None

361

self.last_checked_ok = None

362

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

363

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

364

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

365

self.disable_hook = disable_hook

586

366

self.checker = None

587

367

self.checker_initiator_tag = None

588

368

self.disable_initiator_tag = None

369

self.expires = None

589

370

self.checker_callback_tag = None

371

self.checker_command = config["checker"]

590

372

self.current_checker_command = None

591

self.approved = None

373

self.last_connect = None

374

self._approved = None

375

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

376

True)

592

377

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)

378

self.approval_delay = string_to_delta(

379

config["approval_delay"])

380

self.approval_duration = string_to_delta(

381

config["approval_duration"])

382

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

604

383

605

# Send notice to process children that client state has changed

606

384

def send_changedstate(self):

607

with self.changedstate:

608

self.changedstate.notify_all()

609

385

self.changedstate.acquire()

386

self.changedstate.notify_all()

387

self.changedstate.release()

388

610

389

def enable(self):

611

390

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

612

391

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

613

392

# Already enabled

614

393

return

394

self.send_changedstate()

395

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

396

# and every interval from then on.

397

self.checker_initiator_tag = (gobject.timeout_add

398

(self.interval_milliseconds(),

399

self.start_checker))

400

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

615

401

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

402

self.disable_initiator_tag = (gobject.timeout_add

403

(self.timeout_milliseconds(),

404

self.disable))

616

405

self.enabled = True

617

406

self.last_enabled = datetime.datetime.utcnow()

618

self.init_checker()

619

self.send_changedstate()

407

# Also start a new checker *right now*.

408

self.start_checker()

620

409

621

410

def disable(self, quiet=True):

622

411

"""Disable this client."""

623

412

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

624

413

return False

625

414

if not quiet:

415

self.send_changedstate()

416

if not quiet:

626

417

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

627

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

418

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

628

419

gobject.source_remove(self.disable_initiator_tag)

629

420

self.disable_initiator_tag = None

630

421

self.expires = None

631

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

422

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

632

423

gobject.source_remove(self.checker_initiator_tag)

633

424

self.checker_initiator_tag = None

634

425

self.stop_checker()

426

if self.disable_hook:

427

self.disable_hook(self)

635

428

self.enabled = False

636

if not quiet:

637

self.send_changedstate()

638

429

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

639

430

return False

640

431

641

432

def __del__(self):

433

self.disable_hook = None

642

434

self.disable()

643

435

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

436

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

662

437

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

663

438

self.checker_callback_tag = None

664

439

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:

440

if os.WIFEXITED(condition):

441

exitstatus = os.WEXITSTATUS(condition)

442

if exitstatus == 0:

673

443

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

674

444

vars(self))

675

445

self.checked_ok()

676

446

else:

677

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

447

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

448

vars(self))

678

449

else:

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

681

450

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

682

451

vars(self))

683

return False

684

685

def checked_ok(self):

686

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

687

self.last_checked_ok = datetime.datetime.utcnow()

688

self.last_checker_status = 0

689

self.last_checker_signal = None

690

self.bump_timeout()

691

692

def bump_timeout(self, timeout=None):

693

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

452

453

def checked_ok(self, timeout=None):

454

"""Bump up the timeout for this client.

455

456

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

457

alive and well.

458

"""

694

459

if timeout is None:

695

460

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

461

self.last_checked_ok = datetime.datetime.utcnow()

462

gobject.source_remove(self.disable_initiator_tag)

463

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

464

self.disable_initiator_tag = (gobject.timeout_add

465

(_timedelta_to_milliseconds(timeout),

466

self.disable))

703

467

704

468

def need_approval(self):

705

469

self.last_approval_request = datetime.datetime.utcnow()

710

474

If a checker already exists, leave it running and do

711

475

nothing."""

712

476

# 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

477

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

478

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

479

# client would inevitably timeout, since no checker would get

480

# a chance to run to completion. If we instead leave running

717

481

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

718

482

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

719

483

# should be.

720

484

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

485

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

486

try:

487

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

488

except (AttributeError, OSError) as error:

489

if (isinstance(error, OSError)

490

and error.errno != errno.ECHILD):

491

raise error

492

else:

493

if pid:

494

logger.warning("Checker was a zombie")

495

gobject.source_remove(self.checker_callback_tag)

496

self.checker_callback(pid, status,

497

self.current_checker_command)

725

498

# Start a new checker if needed

726

499

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

500

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

501

# In case checker_command has exactly one % operator

502

command = self.checker_command % self.host

503

except TypeError:

504

# Escape attributes for the shell

505

escaped_attrs = dict(

506

(attr,

507

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

508

errors=

509

'replace')))

510

for attr in

511

self.runtime_expansions)

512

513

try:

514

command = self.checker_command % escaped_attrs

515

except TypeError as error:

516

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

517

' %s', self.checker_command, error)

518

return True # Try again later

738

519

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)

520

try:

521

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

522

command, self.name)

523

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

524

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

525

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

526

# always replaced by /dev/null.)

527

self.checker = subprocess.Popen(command,

528

close_fds=True,

529

shell=True, cwd="/")

530

self.checker_callback_tag = (gobject.child_watch_add

531

(self.checker.pid,

532

self.checker_callback,

533

data=command))

534

# The checker may have completed before the gobject

535

# watch was added. Check for this.

536

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

537

if pid:

538

gobject.source_remove(self.checker_callback_tag)

539

self.checker_callback(pid, status, command)

540

except OSError as error:

541

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

542

error)

764

543

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

765

544

return True

766

545

772

551

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

773

552

return

774

553

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

775

self.checker.terminate()

554

try:

555

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

556

#time.sleep(0.5)

557

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

558

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

559

except OSError as error:

560

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

561

raise

776

562

self.checker = None

777

563

778

564

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

565

def dbus_service_property(dbus_interface, signature="v",

566

access="readwrite", byte_arrays=False):

783

567

"""Decorators for marking methods of a DBusObjectWithProperties to

784

568

become properties on the D-Bus.

785

569

794

578

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

795

579

if byte_arrays and signature != "ay":

796

580

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

797

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

798

581

" signature %r" % signature)

799

582

def decorator(func):

800

583

func._dbus_is_property = True

801

584

func._dbus_interface = dbus_interface

806

589

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

807

590

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

808

591

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

592

return decorator

854

593

855

594

856

595

class DBusPropertyException(dbus.exceptions.DBusException):

857

596

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

858

597

"""

859

pass

598

def __unicode__(self):

599

return unicode(str(self))

860

600

861

601

862

602

class DBusPropertyAccessException(DBusPropertyException):

871

611

pass

872

612

873

613

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

614

class DBusObjectWithProperties(dbus.service.Object):

964

615

"""A D-Bus object with properties.

965

616

966

617

Classes inheriting from this can use the dbus_service_property

968

619

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

969

620

"""

970

621

622

@staticmethod

623

def _is_dbus_property(obj):

624

return getattr(obj, "_dbus_is_property", False)

625

626

def _get_all_dbus_properties(self):

627

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

628

"""

629

return ((prop._dbus_name, prop)

630

for name, prop in

631

inspect.getmembers(self, self._is_dbus_property))

632

971

633

def _get_dbus_property(self, interface_name, property_name):

972

634

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

973

635

property with the specified name and interface.

974

636

"""

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

637

for name in (property_name,

638

property_name + "_dbus_property"):

639

prop = getattr(self, name, None)

640

if (prop is None

641

or not self._is_dbus_property(prop)

642

or prop._dbus_name != property_name

643

or (interface_name and prop._dbus_interface

644

and interface_name != prop._dbus_interface)):

645

continue

646

return prop

982

647

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

648

raise DBusPropertyNotFound(self.dbus_object_path + ":"

649

+ interface_name + "."

650

+ property_name)

651

652

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

997

653

out_signature="v")

998

654

def Get(self, interface_name, property_name):

999

655

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

1017

673

# The byte_arrays option is not supported yet on

1018

674

# signatures other than "ay".

1019

675

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

676

raise ValueError

677

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

678

for byte in value))

1025

679

prop(value)

1026

680

1027

@dbus.service.method(dbus.PROPERTIES_IFACE,

1028

in_signature="s",

681

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

1029

682

out_signature="a{sv}")

1030

683

def GetAll(self, interface_name):

1031

684

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

1033

686

1034

687

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

1035

688

"""

1036

properties = {}

1037

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

689

all = {}

690

for name, prop in self._get_all_dbus_properties():

1038

691

if (interface_name

1039

692

and interface_name != prop._dbus_interface):

1040

693

# Interface non-empty but did not match

1044

697

continue

1045

698

value = prop()

1046

699

if not hasattr(value, "variant_level"):

1047

properties[name] = value

700

all[name] = value

1048

701

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

702

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

703

value.variant_level+1)

704

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

1060

705

1061

706

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1062

707

out_signature="s",

1063

708

path_keyword='object_path',

1064

709

connection_keyword='connection')

1065

710

def Introspect(self, object_path, connection):

1066

"""Overloading of standard D-Bus method.

1067

1068

Inserts property tags and interface annotation tags.

711

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

1069

712

"""

1070

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1071

object_path,

1072

connection)

713

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

714

connection)

1073

715

try:

1074

716

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

1075

1076

717

def make_tag(document, name, prop):

1077

718

e = document.createElement("property")

1078

719

e.setAttribute("name", name)

1079

720

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

1080

721

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

1081

722

return e

1082

1083

723

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

1084

# Add property tags

1085

724

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

1086

725

for name, prop

1087

in self._get_all_dbus_things("property")

726

in self._get_all_dbus_properties()

1088

727

if prop._dbus_interface

1089

728

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

1090

729

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

730

# Add the names to the return values for the

1108

731

# "org.freedesktop.DBus.Properties" methods

1109

732

if (if_tag.getAttribute("name")

1124

747

except (AttributeError, xml.dom.DOMException,

1125

748

xml.parsers.expat.ExpatError) as error:

1126

749

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

1127

exc_info=error)

1128

return xmlstring

1129

1130

try:

1131

dbus.OBJECT_MANAGER_IFACE

1132

except AttributeError:

1133

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

1134

1135

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1136

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

1137

1138

Classes inheriting from this exposes the standard

1139

GetManagedObjects call and the InterfacesAdded and

1140

InterfacesRemoved signals on the standard

1141

"org.freedesktop.DBus.ObjectManager" interface.

1142

1143

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

1144

manually.

1145

"""

1146

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1147

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

1148

def GetManagedObjects(self):

1149

"""This function must be overridden"""

1150

raise NotImplementedError()

1151

1152

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1153

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

1154

def InterfacesAdded(self, object_path, interfaces_and_properties):

1155

pass

1156

1157

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")

1158

def InterfacesRemoved(self, object_path, interfaces):

1159

pass

1160

1161

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1162

out_signature = "s",

1163

path_keyword = 'object_path',

1164

connection_keyword = 'connection')

1165

def Introspect(self, object_path, connection):

1166

"""Overloading of standard D-Bus method.

1167

1168

Override return argument name of GetManagedObjects to be

1169

"objpath_interfaces_and_properties"

1170

"""

1171

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1172

object_path,

1173

connection)

1174

try:

1175

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

1176

1177

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

1178

# Fix argument name for the GetManagedObjects method

1179

if (if_tag.getAttribute("name")

1180

== dbus.OBJECT_MANAGER_IFACE):

1181

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

1182

if (cn.getAttribute("name")

1183

== "GetManagedObjects"):

1184

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

1185

if (arg.getAttribute("direction")

1186

== "out"):

1187

arg.setAttribute(

1188

"name",

1189

"objpath_interfaces"

1190

"_and_properties")

1191

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

1192

document.unlink()

1193

except (AttributeError, xml.dom.DOMException,

1194

xml.parsers.expat.ExpatError) as error:

1195

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

1196

exc_info = error)

1197

return xmlstring

1198

1199

def datetime_to_dbus(dt, variant_level=0):

750

error)

751

return xmlstring

752

753

754

def datetime_to_dbus (dt, variant_level=0):

1200

755

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

1201

756

if dt is None:

1202

757

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

1203

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

1204

1205

1206

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1207

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

1208

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

1209

interface names according to the "alt_interface_names" mapping.

1210

Usage:

1211

1212

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

1213

"net.example.AlternateInterface"})

1214

class SampleDBusObject(dbus.service.Object):

1215

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

1216

def SampleDBusMethod():

1217

pass

1218

1219

The above "SampleDBusMethod" on "SampleDBusObject" will be

1220

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

1221

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

1222

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

1223

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

1224

1225

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

1226

(from DBusObjectWithProperties) and interfaces (from the

1227

dbus_interface_annotations decorator).

1228

"""

1229

1230

def wrapper(cls):

1231

for orig_interface_name, alt_interface_name in (

1232

alt_interface_names.items()):

1233

attr = {}

1234

interface_names = set()

1235

# Go though all attributes of the class

1236

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

1237

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

1238

# with the wrong interface name

1239

if (not hasattr(attribute, "_dbus_interface")

1240

or not attribute._dbus_interface.startswith(

1241

orig_interface_name)):

1242

continue

1243

# Create an alternate D-Bus interface name based on

1244

# the current name

1245

alt_interface = attribute._dbus_interface.replace(

1246

orig_interface_name, alt_interface_name)

1247

interface_names.add(alt_interface)

1248

# Is this a D-Bus signal?

1249

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

1250

if sys.version_info.major == 2:

1251

# Extract the original non-method undecorated

1252

# function by black magic

1253

nonmethod_func = (dict(

1254

zip(attribute.func_code.co_freevars,

1255

attribute.__closure__))

1256

["func"].cell_contents)

1257

else:

1258

nonmethod_func = attribute

1259

# Create a new, but exactly alike, function

1260

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

1261

# with the alternate D-Bus interface name

1262

if sys.version_info.major == 2:

1263

new_function = types.FunctionType(

1264

nonmethod_func.func_code,

1265

nonmethod_func.func_globals,

1266

nonmethod_func.func_name,

1267

nonmethod_func.func_defaults,

1268

nonmethod_func.func_closure)

1269

else:

1270

new_function = types.FunctionType(

1271

nonmethod_func.__code__,

1272

nonmethod_func.__globals__,

1273

nonmethod_func.__name__,

1274

nonmethod_func.__defaults__,

1275

nonmethod_func.__closure__)

1276

new_function = (dbus.service.signal(

1277

alt_interface,

1278

attribute._dbus_signature)(new_function))

1279

# Copy annotations, if any

1280

try:

1281

new_function._dbus_annotations = dict(

1282

attribute._dbus_annotations)

1283

except AttributeError:

1284

pass

1285

# Define a creator of a function to call both the

1286

# original and alternate functions, so both the

1287

# original and alternate signals gets sent when

1288

# the function is called

1289

def fixscope(func1, func2):

1290

"""This function is a scope container to pass

1291

func1 and func2 to the "call_both" function

1292

outside of its arguments"""

1293

1294

@functools.wraps(func2)

1295

def call_both(*args, **kwargs):

1296

"""This function will emit two D-Bus

1297

signals by calling func1 and func2"""

1298

func1(*args, **kwargs)

1299

func2(*args, **kwargs)

1300

# Make wrapper function look like a D-Bus signal

1301

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

1302

if name.startswith("_dbus_"):

1303

setattr(call_both, name, attr)

1304

1305

return call_both

1306

# Create the "call_both" function and add it to

1307

# the class

1308

attr[attrname] = fixscope(attribute, new_function)

1309

# Is this a D-Bus method?

1310

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

1311

# Create a new, but exactly alike, function

1312

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

1313

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

1314

# to the class.

1315

attr[attrname] = (

1316

dbus.service.method(

1317

alt_interface,

1318

attribute._dbus_in_signature,

1319

attribute._dbus_out_signature)

1320

(types.FunctionType(attribute.func_code,

1321

attribute.func_globals,

1322

attribute.func_name,

1323

attribute.func_defaults,

1324

attribute.func_closure)))

1325

# Copy annotations, if any

1326

try:

1327

attr[attrname]._dbus_annotations = dict(

1328

attribute._dbus_annotations)

1329

except AttributeError:

1330

pass

1331

# Is this a D-Bus property?

1332

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

1333

# Create a new, but exactly alike, function

1334

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

1335

# property with the alternate D-Bus interface

1336

# name. Add it to the class.

1337

attr[attrname] = (dbus_service_property(

1338

alt_interface, attribute._dbus_signature,

1339

attribute._dbus_access,

1340

attribute._dbus_get_args_options

1341

["byte_arrays"])

1342

(types.FunctionType(

1343

attribute.func_code,

1344

attribute.func_globals,

1345

attribute.func_name,

1346

attribute.func_defaults,

1347

attribute.func_closure)))

1348

# Copy annotations, if any

1349

try:

1350

attr[attrname]._dbus_annotations = dict(

1351

attribute._dbus_annotations)

1352

except AttributeError:

1353

pass

1354

# Is this a D-Bus interface?

1355

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

1356

# Create a new, but exactly alike, function

1357

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

1358

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

1359

# to the class.

1360

attr[attrname] = (

1361

dbus_interface_annotations(alt_interface)

1362

(types.FunctionType(attribute.func_code,

1363

attribute.func_globals,

1364

attribute.func_name,

1365

attribute.func_defaults,

1366

attribute.func_closure)))

1367

if deprecate:

1368

# Deprecate all alternate interfaces

1369

iname="_AlternateDBusNames_interface_annotation{}"

1370

for interface_name in interface_names:

1371

1372

@dbus_interface_annotations(interface_name)

1373

def func(self):

1374

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

1375

"true" }

1376

# Find an unused name

1377

for aname in (iname.format(i)

1378

for i in itertools.count()):

1379

if aname not in attr:

1380

attr[aname] = func

1381

break

1382

if interface_names:

1383

# Replace the class with a new subclass of it with

1384

# methods, signals, etc. as created above.

1385

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

1386

(cls, ), attr)

1387

return cls

1388

1389

return wrapper

1390

1391

1392

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

1393

"se.bsnet.fukt.Mandos"})

758

return dbus.String(dt.isoformat(),

759

variant_level=variant_level)

760

761

1394

762

class ClientDBus(Client, DBusObjectWithProperties):

1395

763

"""A Client class using D-Bus

1396

764

1400

768

"""

1401

769

1402

770

runtime_expansions = (Client.runtime_expansions

1403

+ ("dbus_object_path", ))

1404

1405

_interface = "se.recompile.Mandos.Client"

771

+ ("dbus_object_path",))

1406

772

1407

773

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

1408

774

1409

775

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

776

self._approvals_pending = 0

1410

777

self.bus = bus

1411

778

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

1412

779

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

1413

780

# the D-Bus

1414

client_object_name = str(self.name).translate(

781

client_object_name = unicode(self.name).translate(

1415

782

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

1416

783

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

1417

self.dbus_object_path = dbus.ObjectPath(

1418

"/clients/" + client_object_name)

784

self.dbus_object_path = (dbus.ObjectPath

785

("/clients/" + client_object_name))

1419

786

DBusObjectWithProperties.__init__(self, self.bus,

1420

787

self.dbus_object_path)

1421

1422

def notifychangeproperty(transform_func, dbus_name,

1423

type_func=lambda x: x,

1424

variant_level=1,

1425

invalidate_only=False,

1426

_interface=_interface):

1427

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

1428

its changes to DBus.

1429

788

1430

transform_fun: Function that takes a value and a variant_level

1431

and transforms it to a D-Bus type.

1432

dbus_name: D-Bus name of the variable

789

def notifychangeproperty(transform_func,

790

dbus_name, type_func=lambda x: x,

791

variant_level=1):

792

""" Modify a variable so that its a property that announce its

793

changes to DBus.

794

transform_fun: Function that takes a value and transform it to

795

DBus type.

796

dbus_name: DBus name of the variable

1433

797

type_func: Function that transform the value before sending it

1434

to the D-Bus. Default: no transform

1435

variant_level: D-Bus variant level. Default: 1

798

to DBus

799

variant_level: DBus variant level. default: 1

1436

800

"""

1437

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

1438

801

real_value = [None,]

1439

802

def setter(self, value):

803

old_value = real_value[0]

804

real_value[0] = value

1440

805

if hasattr(self, "dbus_object_path"):

1441

if (not hasattr(self, attrname) or

1442

type_func(getattr(self, attrname, None))

1443

!= type_func(value)):

1444

if invalidate_only:

1445

self.PropertiesChanged(

1446

_interface, dbus.Dictionary(),

1447

dbus.Array((dbus_name, )))

1448

else:

1449

dbus_value = transform_func(

1450

type_func(value),

1451

variant_level = variant_level)

1452

self.PropertyChanged(dbus.String(dbus_name),

1453

dbus_value)

1454

self.PropertiesChanged(

1455

_interface,

1456

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

1457

dbus_value }),

1458

dbus.Array())

1459

setattr(self, attrname, value)

806

if type_func(old_value) != type_func(real_value[0]):

807

dbus_value = transform_func(type_func(real_value[0]),

808

variant_level)

809

self.PropertyChanged(dbus.String(dbus_name),

810

dbus_value)

1460

811

1461

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

812

return property(lambda self: real_value[0], setter)

813

1462

814

1463

815

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1464

816

approvals_pending = notifychangeproperty(dbus.Boolean,

1467

819

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

1468

820

last_enabled = notifychangeproperty(datetime_to_dbus,

1469

821

"LastEnabled")

1470

checker = notifychangeproperty(

1471

dbus.Boolean, "CheckerRunning",

1472

type_func = lambda checker: checker is not None)

822

checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",

823

type_func = lambda checker: checker is not None)

1473

824

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1474

825

"LastCheckedOK")

1475

last_checker_status = notifychangeproperty(dbus.Int16,

1476

"LastCheckerStatus")

1477

last_approval_request = notifychangeproperty(

1478

datetime_to_dbus, "LastApprovalRequest")

826

last_approval_request = notifychangeproperty(datetime_to_dbus,

827

"LastApprovalRequest")

1479

828

approved_by_default = notifychangeproperty(dbus.Boolean,

1480

829

"ApprovedByDefault")

1481

approval_delay = notifychangeproperty(

1482

dbus.UInt64, "ApprovalDelay",

1483

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

1484

approval_duration = notifychangeproperty(

1485

dbus.UInt64, "ApprovalDuration",

1486

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

830

approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",

831

type_func = _timedelta_to_milliseconds)

832

approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",

833

type_func = _timedelta_to_milliseconds)

1487

834

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

1488

timeout = notifychangeproperty(

1489

dbus.UInt64, "Timeout",

1490

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

1491

extended_timeout = notifychangeproperty(

1492

dbus.UInt64, "ExtendedTimeout",

1493

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

1494

interval = notifychangeproperty(

1495

dbus.UInt64, "Interval",

1496

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

835

timeout = notifychangeproperty(dbus.UInt16, "Timeout",

836

type_func = _timedelta_to_milliseconds)

837

extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",

838

type_func = _timedelta_to_milliseconds)

839

interval = notifychangeproperty(dbus.UInt16, "Interval",

840

type_func = _timedelta_to_milliseconds)

1497

841

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

1498

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

1499

invalidate_only=True)

1500

842

1501

843

del notifychangeproperty

1502

844

1509

851

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

1510

852

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

1511

853

1512

def checker_callback(self, source, condition,

1513

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

1514

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

1515

connection, command, *args,

1516

**kwargs)

1517

exitstatus = self.last_checker_status

1518

if exitstatus >= 0:

854

def checker_callback(self, pid, condition, command,

855

*args, **kwargs):

856

self.checker_callback_tag = None

857

self.checker = None

858

if os.WIFEXITED(condition):

859

exitstatus = os.WEXITSTATUS(condition)

1519

860

# Emit D-Bus signal

1520

861

self.CheckerCompleted(dbus.Int16(exitstatus),

1521

# This is specific to GNU libC

1522

dbus.Int64(exitstatus << 8),

862

dbus.Int64(condition),

1523

863

dbus.String(command))

1524

864

else:

1525

865

# Emit D-Bus signal

1526

866

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

1527

dbus.Int64(

1528

# This is specific to GNU libC

1529

(exitstatus << 8)

1530

| self.last_checker_signal),

867

dbus.Int64(condition),

1531

868

dbus.String(command))

1532

return ret

869

870

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

871

*args, **kwargs)

1533

872

1534

873

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

1535

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

874

old_checker = self.checker

875

if self.checker is not None:

876

old_checker_pid = self.checker.pid

877

else:

878

old_checker_pid = None

1536

879

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

1537

880

# Only if new checker process was started

1538

881

if (self.checker is not None

1542

885

return r

1543

886

1544

887

def _reset_approved(self):

1545

self.approved = None

888

self._approved = None

1546

889

return False

1547

890

1548

891

def approve(self, value=True):

1549

self.approved = value

1550

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

1551

* 1000), self._reset_approved)

1552

892

self.send_changedstate()

893

self._approved = value

894

gobject.timeout_add(_timedelta_to_milliseconds

895

(self.approval_duration),

896

self._reset_approved)

897

1553

898

1554

899

## D-Bus methods, signals & properties

1555

1556

## Interfaces

900

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

1557

901

1558

902

## Signals

1559

903

1570

914

pass

1571

915

1572

916

# PropertyChanged - signal

1573

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

1574

917

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

1575

918

def PropertyChanged(self, property, value):

1576

919

"D-Bus signal"

1610

953

self.checked_ok()

1611

954

1612

955

# Enable - method

1613

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

1614

956

@dbus.service.method(_interface)

1615

957

def Enable(self):

1616

958

"D-Bus method"

1617

959

self.enable()

1618

960

1619

961

# StartChecker - method

1620

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

1621

962

@dbus.service.method(_interface)

1622

963

def StartChecker(self):

1623

964

"D-Bus method"

1624

965

self.start_checker()

1625

966

1626

967

# Disable - method

1627

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

1628

968

@dbus.service.method(_interface)

1629

969

def Disable(self):

1630

970

"D-Bus method"

1631

971

self.disable()

1632

972

1633

973

# StopChecker - method

1634

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

1635

974

@dbus.service.method(_interface)

1636

975

def StopChecker(self):

1637

976

self.stop_checker()

1644

983

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

1645

984

1646

985

# ApprovedByDefault - property

1647

@dbus_service_property(_interface,

1648

signature="b",

986

@dbus_service_property(_interface, signature="b",

1649

987

access="readwrite")

1650

988

def ApprovedByDefault_dbus_property(self, value=None):

1651

989

if value is None: # get

1653

991

self.approved_by_default = bool(value)

1654

992

1655

993

# ApprovalDelay - property

1656

@dbus_service_property(_interface,

1657

signature="t",

994

@dbus_service_property(_interface, signature="t",

1658

995

access="readwrite")

1659

996

def ApprovalDelay_dbus_property(self, value=None):

1660

997

if value is None: # get

1661

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

1662

* 1000)

998

return dbus.UInt64(self.approval_delay_milliseconds())

1663

999

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

1664

1000

1665

1001

# ApprovalDuration - property

1666

@dbus_service_property(_interface,

1667

signature="t",

1002

@dbus_service_property(_interface, signature="t",

1668

1003

access="readwrite")

1669

1004

def ApprovalDuration_dbus_property(self, value=None):

1670

1005

if value is None: # get

1671

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

1672

* 1000)

1006

return dbus.UInt64(_timedelta_to_milliseconds(

1007

self.approval_duration))

1673

1008

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

1674

1009

1675

1010

# Name - property

1676

@dbus_annotations(

1677

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

1678

1011

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

1679

1012

def Name_dbus_property(self):

1680

1013

return dbus.String(self.name)

1681

1014

1682

1015

# Fingerprint - property

1683

@dbus_annotations(

1684

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

1685

1016

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

1686

1017

def Fingerprint_dbus_property(self):

1687

1018

return dbus.String(self.fingerprint)

1688

1019

1689

1020

# Host - property

1690

@dbus_service_property(_interface,

1691

signature="s",

1021

@dbus_service_property(_interface, signature="s",

1692

1022

access="readwrite")

1693

1023

def Host_dbus_property(self, value=None):

1694

1024

if value is None: # get

1695

1025

return dbus.String(self.host)

1696

self.host = str(value)

1026

self.host = value

1697

1027

1698

1028

# Created - property

1699

@dbus_annotations(

1700

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

1701

1029

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

1702

1030

def Created_dbus_property(self):

1703

return datetime_to_dbus(self.created)

1031

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

1704

1032

1705

1033

# LastEnabled - property

1706

1034

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

1708

1036

return datetime_to_dbus(self.last_enabled)

1709

1037

1710

1038

# Enabled - property

1711

@dbus_service_property(_interface,

1712

signature="b",

1039

@dbus_service_property(_interface, signature="b",

1713

1040

access="readwrite")

1714

1041

def Enabled_dbus_property(self, value=None):

1715

1042

if value is None: # get

1720

1047

self.disable()

1721

1048

1722

1049

# LastCheckedOK - property

1723

@dbus_service_property(_interface,

1724

signature="s",

1050

@dbus_service_property(_interface, signature="s",

1725

1051

access="readwrite")

1726

1052

def LastCheckedOK_dbus_property(self, value=None):

1727

1053

if value is not None:

1729

1055

return

1730

1056

return datetime_to_dbus(self.last_checked_ok)

1731

1057

1732

# LastCheckerStatus - property

1733

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

1734

def LastCheckerStatus_dbus_property(self):

1735

return dbus.Int16(self.last_checker_status)

1736

1737

1058

# Expires - property

1738

1059

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

1739

1060

def Expires_dbus_property(self):

1745

1066

return datetime_to_dbus(self.last_approval_request)

1746

1067

1747

1068

# Timeout - property

1748

@dbus_service_property(_interface,

1749

signature="t",

1069

@dbus_service_property(_interface, signature="t",

1750

1070

access="readwrite")

1751

1071

def Timeout_dbus_property(self, value=None):

1752

1072

if value is None: # get

1753

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

1754

old_timeout = self.timeout

1073

return dbus.UInt64(self.timeout_milliseconds())

1755

1074

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

1756

# Reschedule disabling

1757

if self.enabled:

1758

now = datetime.datetime.utcnow()

1759

self.expires += self.timeout - old_timeout

1760

if self.expires <= now:

1761

# The timeout has passed

1762

self.disable()

1763

else:

1764

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

1765

is None):

1766

return

1767

gobject.source_remove(self.disable_initiator_tag)

1768

self.disable_initiator_tag = gobject.timeout_add(

1769

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

1770

self.disable)

1075

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

1076

return

1077

# Reschedule timeout

1078

gobject.source_remove(self.disable_initiator_tag)

1079

self.disable_initiator_tag = None

1080

self.expires = None

1081

time_to_die = (self.

1082

_timedelta_to_milliseconds((self

1083

.last_checked_ok

1084

+ self.timeout)

1085

- datetime.datetime

1086

.utcnow()))

1087

if time_to_die <= 0:

1088

# The timeout has passed

1089

self.disable()

1090

else:

1091

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

1092

+ datetime.timedelta(milliseconds = time_to_die))

1093

self.disable_initiator_tag = (gobject.timeout_add

1094

(time_to_die, self.disable))

1771

1095

1772

1096

# ExtendedTimeout - property

1773

@dbus_service_property(_interface,

1774

signature="t",

1097

@dbus_service_property(_interface, signature="t",

1775

1098

access="readwrite")

1776

1099

def ExtendedTimeout_dbus_property(self, value=None):

1777

1100

if value is None: # get

1778

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

1779

* 1000)

1101

return dbus.UInt64(self.extended_timeout_milliseconds())

1780

1102

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

1781

1103

1782

1104

# Interval - property

1783

@dbus_service_property(_interface,

1784

signature="t",

1105

@dbus_service_property(_interface, signature="t",

1785

1106

access="readwrite")

1786

1107

def Interval_dbus_property(self, value=None):

1787

1108

if value is None: # get

1788

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

1109

return dbus.UInt64(self.interval_milliseconds())

1789

1110

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

1790

1111

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

1791

1112

return

1792

if self.enabled:

1793

# Reschedule checker run

1794

gobject.source_remove(self.checker_initiator_tag)

1795

self.checker_initiator_tag = gobject.timeout_add(

1796

value, self.start_checker)

1797

self.start_checker() # Start one now, too

1113

# Reschedule checker run

1114

gobject.source_remove(self.checker_initiator_tag)

1115

self.checker_initiator_tag = (gobject.timeout_add

1116

(value, self.start_checker))

1117

self.start_checker() # Start one now, too

1798

1118

1799

1119

# Checker - property

1800

@dbus_service_property(_interface,

1801

signature="s",

1120

@dbus_service_property(_interface, signature="s",

1802

1121

access="readwrite")

1803

1122

def Checker_dbus_property(self, value=None):

1804

1123

if value is None: # get

1805

1124

return dbus.String(self.checker_command)

1806

self.checker_command = str(value)

1125

self.checker_command = value

1807

1126

1808

1127

# CheckerRunning - property

1809

@dbus_service_property(_interface,

1810

signature="b",

1128

@dbus_service_property(_interface, signature="b",

1811

1129

access="readwrite")

1812

1130

def CheckerRunning_dbus_property(self, value=None):

1813

1131

if value is None: # get

1818

1136

self.stop_checker()

1819

1137

1820

1138

# ObjectPath - property

1821

@dbus_annotations(

1822

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

1823

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

1824

1139

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

1825

1140

def ObjectPath_dbus_property(self):

1826

1141

return self.dbus_object_path # is already a dbus.ObjectPath

1827

1142

1828

1143

# Secret = property

1829

@dbus_annotations(

1830

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

1831

"invalidates"})

1832

@dbus_service_property(_interface,

1833

signature="ay",

1834

access="write",

1835

byte_arrays=True)

1144

@dbus_service_property(_interface, signature="ay",

1145

access="write", byte_arrays=True)

1836

1146

def Secret_dbus_property(self, value):

1837

self.secret = bytes(value)

1147

self.secret = str(value)

1838

1148

1839

1149

del _interface

1840

1150

1844

1154

self._pipe = child_pipe

1845

1155

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

1846

1156

if not self._pipe.recv():

1847

raise KeyError(fpr)

1157

raise KeyError()

1848

1158

1849

1159

def __getattribute__(self, name):

1850

if name == '_pipe':

1160

if(name == '_pipe'):

1851

1161

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

1852

1162

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

1853

1163

data = self._pipe.recv()

1854

1164

if data[0] == 'data':

1855

1165

return data[1]

1856

1166

if data[0] == 'function':

1857

1858

1167

def func(*args, **kwargs):

1859

1168

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

1860

1169

return self._pipe.recv()[1]

1861

1862

1170

return func

1863

1171

1864

1172

def __setattr__(self, name, value):

1865

if name == '_pipe':

1173

if(name == '_pipe'):

1866

1174

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

1867

1175

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

1868

1176

1876

1184

def handle(self):

1877

1185

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

1878

1186

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

1879

str(self.client_address))

1187

unicode(self.client_address))

1880

1188

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

1881

1189

self.server.child_pipe.fileno())

1882

1190

1883

session = gnutls.connection.ClientSession(

1884

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

1191

session = (gnutls.connection

1192

.ClientSession(self.request,

1193

gnutls.connection

1194

.X509Credentials()))

1885

1195

1886

1196

# Note: gnutls.connection.X509Credentials is really a

1887

1197

# generic GnuTLS certificate credentials object so long as

1896

1206

priority = self.server.gnutls_priority

1897

1207

if priority is None:

1898

1208

priority = "NORMAL"

1899

gnutls.library.functions.gnutls_priority_set_direct(

1900

session._c_object, priority, None)

1209

(gnutls.library.functions

1210

.gnutls_priority_set_direct(session._c_object,

1211

priority, None))

1901

1212

1902

1213

# Start communication using the Mandos protocol

1903

1214

# Get protocol number

1905

1216

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

1906

1217

try:

1907

1218

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

1908

raise RuntimeError(line)

1219

raise RuntimeError

1909

1220

except (ValueError, IndexError, RuntimeError) as error:

1910

1221

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

1911

1222

return

1923

1234

approval_required = False

1924

1235

try:

1925

1236

try:

1926

fpr = self.fingerprint(

1927

self.peer_certificate(session))

1237

fpr = self.fingerprint(self.peer_certificate

1238

(session))

1928

1239

except (TypeError,

1929

1240

gnutls.errors.GNUTLSError) as error:

1930

1241

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

1945

1256

while True:

1946

1257

if not client.enabled:

1947

1258

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

1948

client.name)

1259

client.name)

1949

1260

if self.server.use_dbus:

1950

1261

# Emit D-Bus signal

1951

client.Rejected("Disabled")

1262

client.Rejected("Disabled")

1952

1263

return

1953

1264

1954

if client.approved or not client.approval_delay:

1265

if client._approved or not client.approval_delay:

1955

1266

#We are approved or approval is disabled

1956

1267

break

1957

elif client.approved is None:

1268

elif client._approved is None:

1958

1269

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

1959

1270

client.name)

1960

1271

if self.server.use_dbus:

1961

1272

# Emit D-Bus signal

1962

1273

client.NeedApproval(

1963

client.approval_delay.total_seconds()

1964

* 1000, client.approved_by_default)

1274

client.approval_delay_milliseconds(),

1275

client.approved_by_default)

1965

1276

else:

1966

1277

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

1967

1278

client.name)

1971

1282

return

1972

1283

1973

1284

#wait until timeout or approved

1285

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

1974

1286

time = datetime.datetime.now()

1975

1287

client.changedstate.acquire()

1976

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

1288

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

1977

1289

client.changedstate.release()

1978

1290

time2 = datetime.datetime.now()

1979

1291

if (time2 - time) >= delay:

1995

1307

try:

1996

1308

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

1997

1309

except gnutls.errors.GNUTLSError as error:

1998

logger.warning("gnutls send failed",

1999

exc_info=error)

1310

logger.warning("gnutls send failed")

2000

1311

return

2001

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

2002

len(client.secret) - (sent_size

2003

+ sent))

1312

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

1313

sent, len(client.secret)

1314

- (sent_size + sent))

2004

1315

sent_size += sent

2005

1316

2006

1317

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

2007

# bump the timeout using extended_timeout

2008

client.bump_timeout(client.extended_timeout)

1318

# bump the timeout as if seen

1319

client.checked_ok(client.extended_timeout)

2009

1320

if self.server.use_dbus:

2010

1321

# Emit D-Bus signal

2011

1322

client.GotSecret()

2016

1327

try:

2017

1328

session.bye()

2018

1329

except gnutls.errors.GNUTLSError as error:

2019

logger.warning("GnuTLS bye failed",

2020

exc_info=error)

1330

logger.warning("GnuTLS bye failed")

2021

1331

2022

1332

@staticmethod

2023

1333

def peer_certificate(session):

2024

1334

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

2025

1335

# If not an OpenPGP certificate...

2026

if (gnutls.library.functions.gnutls_certificate_type_get(

2027

session._c_object)

1336

if (gnutls.library.functions

1337

.gnutls_certificate_type_get(session._c_object)

2028

1338

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

2029

1339

# ...do the normal thing

2030

1340

return session.peer_certificate

2044

1354

def fingerprint(openpgp):

2045

1355

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2046

1356

# New GnuTLS "datum" with the OpenPGP public key

2047

datum = gnutls.library.types.gnutls_datum_t(

2048

ctypes.cast(ctypes.c_char_p(openpgp),

2049

ctypes.POINTER(ctypes.c_ubyte)),

2050

ctypes.c_uint(len(openpgp)))

1357

datum = (gnutls.library.types

1358

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

1359

ctypes.POINTER

1360

(ctypes.c_ubyte)),

1361

ctypes.c_uint(len(openpgp))))

2051

1362

# New empty GnuTLS certificate

2052

1363

crt = gnutls.library.types.gnutls_openpgp_crt_t()

2053

gnutls.library.functions.gnutls_openpgp_crt_init(

2054

ctypes.byref(crt))

1364

(gnutls.library.functions

1365

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2055

1366

# Import the OpenPGP public key into the certificate

2056

gnutls.library.functions.gnutls_openpgp_crt_import(

2057

crt, ctypes.byref(datum),

2058

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1367

(gnutls.library.functions

1368

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

1369

gnutls.library.constants

1370

.GNUTLS_OPENPGP_FMT_RAW))

2059

1371

# Verify the self signature in the key

2060

1372

crtverify = ctypes.c_uint()

2061

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2062

crt, 0, ctypes.byref(crtverify))

1373

(gnutls.library.functions

1374

.gnutls_openpgp_crt_verify_self(crt, 0,

1375

ctypes.byref(crtverify)))

2063

1376

if crtverify.value != 0:

2064

1377

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2065

raise gnutls.errors.CertificateSecurityError(

2066

"Verify failed")

1378

raise (gnutls.errors.CertificateSecurityError

1379

("Verify failed"))

2067

1380

# New buffer for the fingerprint

2068

1381

buf = ctypes.create_string_buffer(20)

2069

1382

buf_len = ctypes.c_size_t()

2070

1383

# Get the fingerprint from the certificate into the buffer

2071

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2072

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

1384

(gnutls.library.functions

1385

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

1386

ctypes.byref(buf_len)))

2073

1387

# Deinit the certificate

2074

1388

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2075

1389

# Convert the buffer to a Python bytestring

2076

1390

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

2077

1391

# Convert the bytestring to hexadecimal notation

2078

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

1392

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

2079

1393

return hex_fpr

2080

1394

2081

1395

2082

1396

class MultiprocessingMixIn(object):

2083

1397

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

2084

2085

1398

def sub_process_main(self, request, address):

2086

1399

try:

2087

1400

self.finish_request(request, address)

2088

except Exception:

1401

except:

2089

1402

self.handle_error(request, address)

2090

1403

self.close_request(request)

2091

1404

2092

1405

def process_request(self, request, address):

2093

1406

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

2094

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

2095

args = (request, address))

2096

proc.start()

2097

return proc

1407

multiprocessing.Process(target = self.sub_process_main,

1408

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

2098

1409

2099

1410

2100

1411

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2101

1412

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

2102

2103

1413

def process_request(self, request, client_address):

2104

1414

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

2105

1415

2107

1417

"""

2108

1418

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2109

1419

2110

proc = MultiprocessingMixIn.process_request(self, request,

2111

client_address)

1420

super(MultiprocessingMixInWithPipe,

1421

self).process_request(request, client_address)

2112

1422

self.child_pipe.close()

2113

self.add_pipe(parent_pipe, proc)

1423

self.add_pipe(parent_pipe)

2114

1424

2115

def add_pipe(self, parent_pipe, proc):

1425

def add_pipe(self, parent_pipe):

2116

1426

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

2117

raise NotImplementedError()

1427

raise NotImplementedError

2118

1428

2119

1429

2120

1430

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2126

1436

interface: None or a network interface name (string)

2127

1437

use_ipv6: Boolean; to use IPv6 or not

2128

1438

"""

2129

2130

1439

def __init__(self, server_address, RequestHandlerClass,

2131

interface=None,

2132

use_ipv6=True,

2133

socketfd=None):

2134

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

2135

creating a new one with socket.socket().

2136

"""

1440

interface=None, use_ipv6=True):

2137

1441

self.interface = interface

2138

1442

if use_ipv6:

2139

1443

self.address_family = socket.AF_INET6

2140

if socketfd is not None:

2141

# Save the file descriptor

2142

self.socketfd = socketfd

2143

# Save the original socket.socket() function

2144

self.socket_socket = socket.socket

2145

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

2146

#

2147

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

2148

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

2149

# patching socket.socket.)

2150

#

2151

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

2152

@functools.wraps(socket.socket)

2153

def socket_wrapper(*args, **kwargs):

2154

# Restore original function so subsequent calls are

2155

# not affected.

2156

socket.socket = self.socket_socket

2157

del self.socket_socket

2158

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

2159

# saved file descriptor.

2160

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

2161

# Replace socket.socket() function with wrapper

2162

socket.socket = socket_wrapper

2163

# The socketserver.TCPServer.__init__ will call

2164

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

2165

# socket_wrapper(), if socketfd was set.

2166

1444

socketserver.TCPServer.__init__(self, server_address,

2167

1445

RequestHandlerClass)

2168

2169

1446

def server_bind(self):

2170

1447

"""This overrides the normal server_bind() function

2171

1448

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

2177

1454

self.interface)

2178

1455

else:

2179

1456

try:

2180

self.socket.setsockopt(

2181

socket.SOL_SOCKET, SO_BINDTODEVICE,

2182

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

1457

self.socket.setsockopt(socket.SOL_SOCKET,

1458

SO_BINDTODEVICE,

1459

str(self.interface

1460

+ '\0'))

2183

1461

except socket.error as error:

2184

if error.errno == errno.EPERM:

2185

logger.error("No permission to bind to"

2186

" interface %s", self.interface)

2187

elif error.errno == errno.ENOPROTOOPT:

1462

if error[0] == errno.EPERM:

1463

logger.error("No permission to"

1464

" bind to interface %s",

1465

self.interface)

1466

elif error[0] == errno.ENOPROTOOPT:

2188

1467

logger.error("SO_BINDTODEVICE not available;"

2189

1468

" cannot bind to interface %s",

2190

1469

self.interface)

2191

elif error.errno == errno.ENODEV:

2192

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

2193

" cannot bind", self.interface)

2194

1470

else:

2195

1471

raise

2196

1472

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

2199

1475

if self.address_family == socket.AF_INET6:

2200

1476

any_address = "::" # in6addr_any

2201

1477

else:

2202

any_address = "0.0.0.0" # INADDR_ANY

1478

any_address = socket.INADDR_ANY

2203

1479

self.server_address = (any_address,

2204

1480

self.server_address[1])

2205

1481

elif not self.server_address[1]:

2206

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

1482

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

1483

0)

2207

1484

# if self.interface:

2208

1485

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

2209

1486

# 0, # port

2223

1500

2224

1501

Assumes a gobject.MainLoop event loop.

2225

1502

"""

2226

2227

1503

def __init__(self, server_address, RequestHandlerClass,

2228

interface=None,

2229

use_ipv6=True,

2230

clients=None,

2231

gnutls_priority=None,

2232

use_dbus=True,

2233

socketfd=None):

1504

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

1505

gnutls_priority=None, use_dbus=True):

2234

1506

self.enabled = False

2235

1507

self.clients = clients

2236

1508

if self.clients is None:

2237

self.clients = {}

1509

self.clients = set()

2238

1510

self.use_dbus = use_dbus

2239

1511

self.gnutls_priority = gnutls_priority

2240

1512

IPv6_TCPServer.__init__(self, server_address,

2241

1513

RequestHandlerClass,

2242

1514

interface = interface,

2243

use_ipv6 = use_ipv6,

2244

socketfd = socketfd)

2245

1515

use_ipv6 = use_ipv6)

2246

1516

def server_activate(self):

2247

1517

if self.enabled:

2248

1518

return socketserver.TCPServer.server_activate(self)

2249

2250

1519

def enable(self):

2251

1520

self.enabled = True

2252

2253

def add_pipe(self, parent_pipe, proc):

1521

def add_pipe(self, parent_pipe):

2254

1522

# Call "handle_ipc" for both data and EOF events

2255

gobject.io_add_watch(

2256

parent_pipe.fileno(),

2257

gobject.IO_IN | gobject.IO_HUP,

2258

functools.partial(self.handle_ipc,

2259

parent_pipe = parent_pipe,

2260

proc = proc))

2261

2262

def handle_ipc(self, source, condition,

2263

parent_pipe=None,

2264

proc = None,

1523

gobject.io_add_watch(parent_pipe.fileno(),

1524

gobject.IO_IN | gobject.IO_HUP,

1525

functools.partial(self.handle_ipc,

1526

parent_pipe = parent_pipe))

1527

1528

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

2265

1529

client_object=None):

2266

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

2267

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

2268

# Wait for other process to exit

2269

proc.join()

1530

condition_names = {

1531

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

1532

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

1533

# blocking).

1534

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

1535

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

1536

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

1537

# broken, usually for pipes and

1538

# sockets).

1539

}

1540

conditions_string = ' | '.join(name

1541

for cond, name in

1542

condition_names.iteritems()

1543

if cond & condition)

1544

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

1545

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

2270

1546

return False

2271

1547

2272

1548

# Read a request from the child

2277

1553

fpr = request[1]

2278

1554

address = request[2]

2279

1555

2280

for c in self.clients.itervalues():

1556

for c in self.clients:

2281

1557

if c.fingerprint == fpr:

2282

1558

client = c

2283

1559

break

2286

1562

"dress: %s", fpr, address)

2287

1563

if self.use_dbus:

2288

1564

# Emit D-Bus signal

2289

mandos_dbus_service.ClientNotFound(fpr,

2290

address[0])

1565

mandos_dbus_service.ClientNotFound(fpr, address[0])

2291

1566

parent_pipe.send(False)

2292

1567

return False

2293

1568

2294

gobject.io_add_watch(

2295

parent_pipe.fileno(),

2296

gobject.IO_IN | gobject.IO_HUP,

2297

functools.partial(self.handle_ipc,

2298

parent_pipe = parent_pipe,

2299

proc = proc,

2300

client_object = client))

1569

gobject.io_add_watch(parent_pipe.fileno(),

1570

gobject.IO_IN | gobject.IO_HUP,

1571

functools.partial(self.handle_ipc,

1572

parent_pipe = parent_pipe,

1573

client_object = client))

2301

1574

parent_pipe.send(True)

2302

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

2303

# same fileno

1575

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

2304

1576

return False

2305

1577

if command == 'funcall':

2306

1578

funcname = request[1]

2307

1579

args = request[2]

2308

1580

kwargs = request[3]

2309

1581

2310

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

2311

funcname)(*args,

2312

**kwargs)))

1582

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

2313

1583

2314

1584

if command == 'getattr':

2315

1585

attrname = request[1]

2316

if isinstance(client_object.__getattribute__(attrname),

2317

collections.Callable):

2318

parent_pipe.send(('function', ))

1586

if callable(client_object.__getattribute__(attrname)):

1587

parent_pipe.send(('function',))

2319

1588

else:

2320

parent_pipe.send((

2321

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

1589

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

2322

1590

2323

1591

if command == 'setattr':

2324

1592

attrname = request[1]

2328

1596

return True

2329

1597

2330

1598

2331

def rfc3339_duration_to_delta(duration):

2332

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

2333

2334

>>> rfc3339_duration_to_delta("P7D")

2335

datetime.timedelta(7)

2336

>>> rfc3339_duration_to_delta("PT60S")

2337

datetime.timedelta(0, 60)

2338

>>> rfc3339_duration_to_delta("PT60M")

2339

datetime.timedelta(0, 3600)

2340

>>> rfc3339_duration_to_delta("PT24H")

2341

datetime.timedelta(1)

2342

>>> rfc3339_duration_to_delta("P1W")

2343

datetime.timedelta(7)

2344

>>> rfc3339_duration_to_delta("PT5M30S")

2345

datetime.timedelta(0, 330)

2346

>>> rfc3339_duration_to_delta("P1DT3M20S")

2347

datetime.timedelta(1, 200)

2348

"""

2349

2350

# Parsing an RFC 3339 duration with regular expressions is not

2351

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

2352

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

2353

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

2354

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

2355

# avoid excessive use of external libraries.

2356

2357

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

2358

Token = collections.namedtuple("Token", (

2359

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

2360

# a "group" containing digits

2361

"value", # datetime.timedelta or None

2362

"followers")) # Tokens valid after this token

2363

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

2364

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

2365

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

2366

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

2367

datetime.timedelta(seconds=1),

2368

frozenset((token_end, )))

2369

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

2370

datetime.timedelta(minutes=1),

2371

frozenset((token_second, token_end)))

2372

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

2373

datetime.timedelta(hours=1),

2374

frozenset((token_minute, token_end)))

2375

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

2376

None,

2377

frozenset((token_hour, token_minute,

2378

token_second)))

2379

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

2380

datetime.timedelta(days=1),

2381

frozenset((token_time, token_end)))

2382

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

2383

datetime.timedelta(weeks=4),

2384

frozenset((token_day, token_end)))

2385

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

2386

datetime.timedelta(weeks=52),

2387

frozenset((token_month, token_end)))

2388

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

2389

datetime.timedelta(weeks=1),

2390

frozenset((token_end, )))

2391

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

2392

frozenset((token_year, token_month,

2393

token_day, token_time,

2394

token_week)))

2395

# Define starting values

2396

value = datetime.timedelta() # Value so far

2397

found_token = None

2398

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

2399

s = duration # String left to parse

2400

# Loop until end token is found

2401

while found_token is not token_end:

2402

# Search for any currently valid tokens

2403

for token in followers:

2404

match = token.regexp.match(s)

2405

if match is not None:

2406

# Token found

2407

if token.value is not None:

2408

# Value found, parse digits

2409

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

2410

# Add to value so far

2411

value += factor * token.value

2412

# Strip token from string

2413

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

2414

# Go to found token

2415

found_token = token

2416

# Set valid next tokens

2417

followers = found_token.followers

2418

break

2419

else:

2420

# No currently valid tokens were found

2421

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

2422

.format(duration))

2423

# End token found

2424

return value

2425

2426

2427

1599

def string_to_delta(interval):

2428

1600

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

2429

1601

2440

1612

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

2441

1613

datetime.timedelta(0, 330)

2442

1614

"""

2443

2444

try:

2445

return rfc3339_duration_to_delta(interval)

2446

except ValueError:

2447

pass

2448

2449

1615

timevalue = datetime.timedelta(0)

2450

1616

for s in interval.split():

2451

1617

try:

2452

suffix = s[-1]

1618

suffix = unicode(s[-1])

2453

1619

value = int(s[:-1])

2454

1620

if suffix == "d":

2455

1621

delta = datetime.timedelta(value)

2462

1628

elif suffix == "w":

2463

1629

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

2464

1630

else:

2465

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

2466

except IndexError as e:

1631

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

1632

except (ValueError, IndexError) as e:

2467

1633

raise ValueError(*(e.args))

2468

1634

timevalue += delta

2469

1635

return timevalue

2470

1636

2471

1637

1638

def if_nametoindex(interface):

1639

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

1640

1641

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

1642

global if_nametoindex

1643

try:

1644

if_nametoindex = (ctypes.cdll.LoadLibrary

1645

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

1646

.if_nametoindex)

1647

except (OSError, AttributeError):

1648

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

1649

def if_nametoindex(interface):

1650

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

1651

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

1652

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

1653

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1654

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

1655

interface))

1656

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

1657

ifreq[16:20])[0]

1658

return interface_index

1659

return if_nametoindex(interface)

1660

1661

2472

1662

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

2473

1663

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

2474

1664

2482

1672

sys.exit()

2483

1673

if not noclose:

2484

1674

# Close all standard open file descriptors

2485

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

1675

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

2486

1676

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

2487

1677

raise OSError(errno.ENODEV,

2488

"{} not a character device"

2489

.format(os.devnull))

1678

"%s not a character device"

1679

% os.path.devnull)

2490

1680

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

2491

1681

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

2492

1682

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

2501

1691

2502

1692

parser = argparse.ArgumentParser()

2503

1693

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

2504

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

1694

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

2505

1695

help="show version number and exit")

2506

1696

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

2507

1697

help="Bind to interface IF")

2513

1703

help="Run self-test")

2514

1704

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

2515

1705

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

2516

" to terminal", default=None)

1706

" to terminal")

2517

1707

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

2518

1708

help="Debug level for stdout output")

2519

1709

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

2526

1716

" files")

2527

1717

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

2528

1718

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

2529

" system bus interface", default=None)

1719

" system bus interface")

2530

1720

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

2531

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

2532

default=None)

2533

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

2534

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

2535

" state", default=None)

2536

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

2537

help="Specify a file descriptor to a network"

2538

" socket to use instead of creating one")

2539

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

2540

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

2541

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

2542

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

2543

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

2544

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

2545

default=None)

2546

1721

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

2547

1722

options = parser.parse_args()

2548

1723

2549

1724

if options.check:

2550

1725

import doctest

2551

fail_count, test_count = doctest.testmod()

2552

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

1726

doctest.testmod()

1727

sys.exit()

2553

1728

2554

1729

# Default values for config file for server-global settings

2555

1730

server_defaults = { "interface": "",

2557

1732

"port": "",

2558

1733

"debug": "False",

2559

1734

"priority":

2560

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

2561

":+SIGN-DSA-SHA256",

1735

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

2562

1736

"servicename": "Mandos",

2563

1737

"use_dbus": "True",

2564

1738

"use_ipv6": "True",

2565

1739

"debuglevel": "",

2566

"restore": "True",

2567

"socket": "",

2568

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

2569

"foreground": "False",

2570

"zeroconf": "True",

2571

}

1740

}

2572

1741

2573

1742

# Parse config file for server-global settings

2574

1743

server_config = configparser.SafeConfigParser(server_defaults)

2575

1744

del server_defaults

2576

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

1745

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

1746

"mandos.conf"))

2577

1747

# Convert the SafeConfigParser object to a dict

2578

1748

server_settings = server_config.defaults()

2579

1749

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

2580

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

1750

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

2581

1751

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

2582

1752

option)

2583

1753

if server_settings["port"]:

2584

1754

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

2585

1755

"port")

2586

if server_settings["socket"]:

2587

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

2588

"socket")

2589

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

2590

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

2591

# happen with a supplied network socket.

2592

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

2593

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

2594

["socket"])

2595

1756

del server_config

2596

1757

2597

1758

# Override the settings from the config file with command line

2598

1759

# options, if set.

2599

1760

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

2600

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

2601

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

2602

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

1761

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

1762

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

2603

1763

value = getattr(options, option)

2604

1764

if value is not None:

2605

1765

server_settings[option] = value

2606

1766

del options

2607

1767

# Force all strings to be unicode

2608

1768

for option in server_settings.keys():

2609

if isinstance(server_settings[option], bytes):

2610

server_settings[option] = (server_settings[option]

2611

.decode("utf-8"))

2612

# Force all boolean options to be boolean

2613

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

2614

"foreground", "zeroconf"):

2615

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

2616

# Debug implies foreground

2617

if server_settings["debug"]:

2618

server_settings["foreground"] = True

1769

if type(server_settings[option]) is str:

1770

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

2619

1771

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

2620

1772

2621

1773

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

2622

1774

2623

if (not server_settings["zeroconf"]

2624

and not (server_settings["port"]

2625

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

2626

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

2627

2628

1775

# For convenience

2629

1776

debug = server_settings["debug"]

2630

1777

debuglevel = server_settings["debuglevel"]

2631

1778

use_dbus = server_settings["use_dbus"]

2632

1779

use_ipv6 = server_settings["use_ipv6"]

2633

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

2634

stored_state_file)

2635

foreground = server_settings["foreground"]

2636

zeroconf = server_settings["zeroconf"]

2637

2638

if debug:

2639

initlogger(debug, logging.DEBUG)

2640

else:

2641

if not debuglevel:

2642

initlogger(debug)

2643

else:

2644

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

2645

initlogger(debug, level)

2646

1780

2647

1781

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

2648

syslogger.setFormatter(

2649

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

2650

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

2651

server_settings["servicename"])))

1782

syslogger.setFormatter(logging.Formatter

1783

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

1784

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

1785

% server_settings["servicename"]))

2652

1786

2653

1787

# Parse config file with clients

2654

client_config = configparser.SafeConfigParser(Client

2655

.client_defaults)

1788

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

1789

"extended_timeout": "15m",

1790

"interval": "2m",

1791

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

1792

"host": "",

1793

"approval_delay": "0s",

1794

"approval_duration": "1s",

1795

}

1796

client_config = configparser.SafeConfigParser(client_defaults)

2656

1797

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

2657

1798

"clients.conf"))

2658

1799

2659

1800

global mandos_dbus_service

2660

1801

mandos_dbus_service = None

2661

1802

2662

socketfd = None

2663

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

2664

socketfd = server_settings["socket"]

2665

tcp_server = MandosServer(

2666

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

2667

ClientHandler,

2668

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

2669

use_ipv6=use_ipv6,

2670

gnutls_priority=server_settings["priority"],

2671

use_dbus=use_dbus,

2672

socketfd=socketfd)

2673

if not foreground:

2674

pidfilename = "/run/mandos.pid"

2675

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

2676

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

2677

pidfile = None

1803

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

1804

server_settings["port"]),

1805

ClientHandler,

1806

interface=(server_settings["interface"]

1807

or None),

1808

use_ipv6=use_ipv6,

1809

gnutls_priority=

1810

server_settings["priority"],

1811

use_dbus=use_dbus)

1812

if not debug:

1813

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

2678

1814

try:

2679

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

2680

except IOError as e:

2681

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

2682

exc_info=e)

1815

pidfile = open(pidfilename, "w")

1816

except IOError:

1817

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

2683

1818

2684

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

1819

try:

1820

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

1821

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

1822

except KeyError:

2685

1823

try:

2686

uid = pwd.getpwnam(name).pw_uid

2687

gid = pwd.getpwnam(name).pw_gid

2688

break

1824

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

1825

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

2689

1826

except KeyError:

2690

continue

2691

else:

2692

uid = 65534

2693

gid = 65534

1827

try:

1828

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

1829

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

1830

except KeyError:

1831

uid = 65534

1832

gid = 65534

2694

1833

try:

2695

1834

os.setgid(gid)

2696

1835

os.setuid(uid)

2697

1836

except OSError as error:

2698

if error.errno != errno.EPERM:

2699

raise

1837

if error[0] != errno.EPERM:

1838

raise error

1839

1840

if not debug and not debuglevel:

1841

syslogger.setLevel(logging.WARNING)

1842

console.setLevel(logging.WARNING)

1843

if debuglevel:

1844

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

1845

syslogger.setLevel(level)

1846

console.setLevel(level)

2700

1847

2701

1848

if debug:

2702

1849

# Enable all possible GnuTLS debugging

2709

1856

def debug_gnutls(level, string):

2710

1857

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

2711

1858

2712

gnutls.library.functions.gnutls_global_set_log_function(

2713

debug_gnutls)

1859

(gnutls.library.functions

1860

.gnutls_global_set_log_function(debug_gnutls))

2714

1861

2715

1862

# Redirect stdin so all checkers get /dev/null

2716

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

1863

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

2717

1864

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

2718

1865

if null > 2:

2719

1866

os.close(null)

1867

else:

1868

# No console logging

1869

logger.removeHandler(console)

2720

1870

2721

1871

# Need to fork before connecting to D-Bus

2722

if not foreground:

1872

if not debug:

2723

1873

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

2724

1874

daemon()

2725

1875

2726

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

2727

# need to inform gobject that threads will be used.

2728

gobject.threads_init()

2729

2730

1876

global main_loop

2731

1877

# From the Avahi example code

2732

DBusGMainLoop(set_as_default=True)

1878

DBusGMainLoop(set_as_default=True )

2733

1879

main_loop = gobject.MainLoop()

2734

1880

bus = dbus.SystemBus()

2735

1881

# End of Avahi example code

2736

1882

if use_dbus:

2737

1883

try:

2738

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

2739

bus,

2740

do_not_queue=True)

2741

old_bus_name = dbus.service.BusName(

2742

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

2743

do_not_queue=True)

2744

except dbus.exceptions.DBusException as e:

2745

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

1884

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

1885

bus, do_not_queue=True)

1886

except dbus.exceptions.NameExistsException as e:

1887

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

2746

1888

use_dbus = False

2747

1889

server_settings["use_dbus"] = False

2748

1890

tcp_server.use_dbus = False

2749

if zeroconf:

2750

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2751

service = AvahiServiceToSyslog(

2752

name = server_settings["servicename"],

2753

servicetype = "_mandos._tcp",

2754

protocol = protocol,

2755

bus = bus)

2756

if server_settings["interface"]:

2757

service.interface = if_nametoindex(

2758

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

1891

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

1892

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

1893

servicetype = "_mandos._tcp",

1894

protocol = protocol, bus = bus)

1895

if server_settings["interface"]:

1896

service.interface = (if_nametoindex

1897

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

2759

1898

2760

1899

global multiprocessing_manager

2761

1900

multiprocessing_manager = multiprocessing.Manager()

2763

1902

client_class = Client

2764

1903

if use_dbus:

2765

1904

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

2766

2767

client_settings = Client.config_parser(client_config)

2768

old_client_settings = {}

2769

clients_data = {}

2770

2771

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

2772

global wnull

2773

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

2774

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

2775

# mode

2776

if debug or not foreground:

2777

wnull.close()

2778

2779

# Get client data and settings from last running state.

2780

if server_settings["restore"]:

2781

try:

2782

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

2783

clients_data, old_client_settings = pickle.load(

2784

stored_state)

2785

os.remove(stored_state_path)

2786

except IOError as e:

2787

if e.errno == errno.ENOENT:

2788

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

2789

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

2790

else:

2791

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

2792

exc_info=e)

2793

raise

2794

except EOFError as e:

2795

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

2796

"EOFError:",

2797

exc_info=e)

2798

2799

with PGPEngine() as pgp:

2800

for client_name, client in clients_data.items():

2801

# Skip removed clients

2802

if client_name not in client_settings:

2803

continue

2804

2805

# Decide which value to use after restoring saved state.

2806

# We have three different values: Old config file,

2807

# new config file, and saved state.

2808

# New config value takes precedence if it differs from old

2809

# config value, otherwise use saved state.

2810

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

2811

try:

2812

# For each value in new config, check if it

2813

# differs from the old config value (Except for

2814

# the "secret" attribute)

2815

if (name != "secret"

2816

and (value !=

2817

old_client_settings[client_name][name])):

2818

client[name] = value

2819

except KeyError:

2820

pass

2821

2822

# Clients who has passed its expire date can still be

2823

# enabled if its last checker was successful. A Client

2824

# whose checker succeeded before we stored its state is

2825

# assumed to have successfully run all checkers during

2826

# downtime.

2827

if client["enabled"]:

2828

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

2829

if not client["last_checked_ok"]:

2830

logger.warning(

2831

"disabling client {} - Client never "

2832

"performed a successful checker".format(

2833

client_name))

2834

client["enabled"] = False

2835

elif client["last_checker_status"] != 0:

2836

logger.warning(

2837

"disabling client {} - Client last"

2838

" checker failed with error code"

2839

" {}".format(

2840

client_name,

2841

client["last_checker_status"]))

2842

client["enabled"] = False

2843

else:

2844

client["expires"] = (

2845

datetime.datetime.utcnow()

2846

+ client["timeout"])

2847

logger.debug("Last checker succeeded,"

2848

" keeping {} enabled".format(

2849

client_name))

1905

def client_config_items(config, section):

1906

special_settings = {

1907

"approved_by_default":

1908

lambda: config.getboolean(section,

1909

"approved_by_default"),

1910

}

1911

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

2850

1912

try:

2851

client["secret"] = pgp.decrypt(

2852

client["encrypted_secret"],

2853

client_settings[client_name]["secret"])

2854

except PGPError:

2855

# If decryption fails, we use secret from new settings

2856

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

2857

client_name))

2858

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

2859

["secret"])

2860

2861

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

2862

for client_name in (set(old_client_settings)

2863

- set(client_settings)):

2864

del clients_data[client_name]

2865

for client_name in (set(client_settings)

2866

- set(old_client_settings)):

2867

clients_data[client_name] = client_settings[client_name]

2868

2869

# Create all client objects

2870

for client_name, client in clients_data.items():

2871

tcp_server.clients[client_name] = client_class(

2872

name = client_name,

2873

settings = client,

2874

server_settings = server_settings)

2875

1913

yield (name, special_settings[name]())

1914

except KeyError:

1915

yield (name, value)

1916

1917

tcp_server.clients.update(set(

1918

client_class(name = section,

1919

config= dict(client_config_items(

1920

client_config, section)))

1921

for section in client_config.sections()))

2876

1922

if not tcp_server.clients:

2877

1923

logger.warning("No clients defined")

2878

2879

if not foreground:

2880

if pidfile is not None:

2881

pid = os.getpid()

2882

try:

2883

with pidfile:

2884

print(pid, file=pidfile)

2885

except IOError:

2886

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

2887

pidfilename, pid)

2888

del pidfile

1924

1925

if not debug:

1926

try:

1927

with pidfile:

1928

pid = os.getpid()

1929

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

1930

del pidfile

1931

except IOError:

1932

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

1933

pidfilename, pid)

1934

except NameError:

1935

# "pidfile" was never created

1936

pass

2889

1937

del pidfilename

1938

1939

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

2890

1940

2891

1941

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

2892

1942

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

2893

1943

2894

1944

if use_dbus:

2895

2896

@alternate_dbus_interfaces(

2897

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

2898

class MandosDBusService(DBusObjectWithObjectManager):

1945

class MandosDBusService(dbus.service.Object):

2899

1946

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

2900

2901

1947

def __init__(self):

2902

1948

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

2903

2904

_interface = "se.recompile.Mandos"

1949

_interface = "se.bsnet.fukt.Mandos"

2905

1950

2906

1951

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

2907

1952

def ClientAdded(self, objpath):

2913

1958

"D-Bus signal"

2914

1959

pass

2915

1960

2916

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

2917

"true"})

2918

1961

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

2919

1962

def ClientRemoved(self, objpath, name):

2920

1963

"D-Bus signal"

2921

1964

pass

2922

1965

2923

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

2924

"true"})

2925

1966

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

2926

1967

def GetAllClients(self):

2927

1968

"D-Bus method"

2928

return dbus.Array(c.dbus_object_path for c in

2929

tcp_server.clients.itervalues())

1969

return dbus.Array(c.dbus_object_path

1970

for c in tcp_server.clients)

2930

1971

2931

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

2932

"true"})

2933

1972

@dbus.service.method(_interface,

2934

1973

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

2935

1974

def GetAllClientsWithProperties(self):

2936

1975

"D-Bus method"

2937

1976

return dbus.Dictionary(

2938

{ c.dbus_object_path: c.GetAll(

2939

"se.recompile.Mandos.Client")

2940

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

1977

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

1978

for c in tcp_server.clients),

2941

1979

signature="oa{sv}")

2942

1980

2943

1981

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

2944

1982

def RemoveClient(self, object_path):

2945

1983

"D-Bus method"

2946

for c in tcp_server.clients.itervalues():

1984

for c in tcp_server.clients:

2947

1985

if c.dbus_object_path == object_path:

2948

del tcp_server.clients[c.name]

1986

tcp_server.clients.remove(c)

2949

1987

c.remove_from_connection()

2950

# Don't signal the disabling

1988

# Don't signal anything except ClientRemoved

2951

1989

c.disable(quiet=True)

2952

# Emit D-Bus signal for removal

2953

self.client_removed_signal(c)

1990

# Emit D-Bus signal

1991

self.ClientRemoved(object_path, c.name)

2954

1992

return

2955

1993

raise KeyError(object_path)

2956

1994

2957

1995

del _interface

2958

2959

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

2960

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

2961

def GetManagedObjects(self):

2962

"""D-Bus method"""

2963

return dbus.Dictionary(

2964

{ client.dbus_object_path:

2965

dbus.Dictionary(

2966

{ interface: client.GetAll(interface)

2967

for interface in

2968

client._get_all_interface_names()})

2969

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

2970

2971

def client_added_signal(self, client):

2972

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

2973

if use_dbus:

2974

# New standard signal

2975

self.InterfacesAdded(

2976

client.dbus_object_path,

2977

dbus.Dictionary(

2978

{ interface: client.GetAll(interface)

2979

for interface in

2980

client._get_all_interface_names()}))

2981

# Old signal

2982

self.ClientAdded(client.dbus_object_path)

2983

2984

def client_removed_signal(self, client):

2985

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

2986

if use_dbus:

2987

# New standard signal

2988

self.InterfacesRemoved(

2989

client.dbus_object_path,

2990

client._get_all_interface_names())

2991

# Old signal

2992

self.ClientRemoved(client.dbus_object_path,

2993

client.name)

2994

1996

2995

1997

mandos_dbus_service = MandosDBusService()

2996

1998

2997

1999

def cleanup():

2998

2000

"Cleanup function; run on exit"

2999

if zeroconf:

3000

service.cleanup()

3001

3002

multiprocessing.active_children()

3003

wnull.close()

3004

if not (tcp_server.clients or client_settings):

3005

return

3006

3007

# Store client before exiting. Secrets are encrypted with key

3008

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

3009

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

3010

clients = {}

3011

with PGPEngine() as pgp:

3012

for client in tcp_server.clients.itervalues():

3013

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

3014

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

3015

key)

3016

client_dict = {}

3017

3018

# A list of attributes that can not be pickled

3019

# + secret.

3020

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

3021

"checker", "server_settings" }

3022

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

3023

.Object):

3024

exclude.add(name)

3025

3026

client_dict["encrypted_secret"] = (client

3027

.encrypted_secret)

3028

for attr in client.client_structure:

3029

if attr not in exclude:

3030

client_dict[attr] = getattr(client, attr)

3031

3032

clients[client.name] = client_dict

3033

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

3034

3035

try:

3036

with tempfile.NamedTemporaryFile(

3037

mode='wb',

3038

suffix=".pickle",

3039

prefix='clients-',

3040

dir=os.path.dirname(stored_state_path),

3041

delete=False) as stored_state:

3042

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

3043

tempname = stored_state.name

3044

os.rename(tempname, stored_state_path)

3045

except (IOError, OSError) as e:

3046

if not debug:

3047

try:

3048

os.remove(tempname)

3049

except NameError:

3050

pass

3051

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

3052

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

3053

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

3054

else:

3055

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

3056

exc_info=e)

3057

raise

3058

3059

# Delete all clients, and settings from config

2001

service.cleanup()

2002

3060

2003

while tcp_server.clients:

3061

name, client = tcp_server.clients.popitem()

2004

client = tcp_server.clients.pop()

3062

2005

if use_dbus:

3063

2006

client.remove_from_connection()

3064

# Don't signal the disabling

2007

client.disable_hook = None

2008

# Don't signal anything except ClientRemoved

3065

2009

client.disable(quiet=True)

3066

# Emit D-Bus signal for removal

3067

mandos_dbus_service.client_removed_signal(client)

3068

client_settings.clear()

2010

if use_dbus:

2011

# Emit D-Bus signal

2012

mandos_dbus_service.ClientRemoved(client.dbus_object_path,

2013

client.name)

3069

2014

3070

2015

atexit.register(cleanup)

3071

2016

3072

for client in tcp_server.clients.itervalues():

2017

for client in tcp_server.clients:

3073

2018

if use_dbus:

3074

# Emit D-Bus signal for adding

3075

mandos_dbus_service.client_added_signal(client)

3076

# Need to initiate checking of clients

3077

if client.enabled:

3078

client.init_checker()

2019

# Emit D-Bus signal

2020

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2021

client.enable()

3079

2022

3080

2023

tcp_server.enable()

3081

2024

tcp_server.server_activate()

3082

2025

3083

2026

# Find out what port we got

3084

if zeroconf:

3085

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

2027

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

3086

2028

if use_ipv6:

3087

2029

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

3088

" flowinfo %d, scope_id %d",

3089

*tcp_server.socket.getsockname())

2030

" flowinfo %d, scope_id %d"

2031

% tcp_server.socket.getsockname())

3090

2032

else: # IPv4

3091

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

3092

*tcp_server.socket.getsockname())

2033

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

2034

% tcp_server.socket.getsockname())

3093

2035

3094

2036

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

3095

2037

3096

2038

try:

3097

if zeroconf:

3098

# From the Avahi example code

3099

try:

3100

service.activate()

3101

except dbus.exceptions.DBusException as error:

3102

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

3103

cleanup()

3104

sys.exit(1)

3105

# End of Avahi example code

2039

# From the Avahi example code

2040

try:

2041

service.activate()

2042

except dbus.exceptions.DBusException as error:

2043

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

2044

cleanup()

2045

sys.exit(1)

2046

# End of Avahi example code

3106

2047

3107

2048

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

3108

2049

lambda *args, **kwargs:

3112

2053

logger.debug("Starting main loop")

3113

2054

main_loop.run()

3114

2055

except AvahiError as error:

3115

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

2056

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

3116

2057

cleanup()

3117

2058

sys.exit(1)

3118

2059

except KeyboardInterrupt: